plugin: add constructor and destructor
[ncmpc-debian.git] / src / plugin.hxx
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2018 The Music Player Daemon Project
3  * Project homepage: http://musicpd.org
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19
20 #ifndef PLUGIN_H
21 #define PLUGIN_H
22
23 #include <glib.h>
24
25 /**
26  * A list of registered plugins.
27  */
28 struct PluginList {
29         GPtrArray *plugins;
30
31         PluginList()
32                 :plugins(g_ptr_array_new()) {}
33
34         ~PluginList();
35 };
36
37 /**
38  * When a plugin cycle is finished, this function is called.  In any
39  * case, plugin_stop() has to be called to free all memory.
40  *
41  * @param result the plugin's output (stdout) on success; summary of all error
42  * messages on failure as determined by success
43  * @param success result of the plugin cycle; true if result is meaningful
44  * output, false if result contains error messages
45  * @param plugin_name the name of the plugin which succeeded; becomes invalid
46  * when plugin_stop is called (i.e. strdup it if you need it afterwards).
47  * @param data the caller defined pointer passed to plugin_run()
48  */
49 typedef void (*plugin_callback_t)(const GString *result, const bool success,
50                                   const char *plugin_name, void *data);
51
52 /**
53  * This object represents a cycle through all available plugins, until
54  * a plugin returns a positive result.
55  */
56 struct plugin_cycle;
57
58 /**
59  * Load all plugins (executables) in a directory.
60  */
61 bool
62 plugin_list_load_directory(PluginList *list, const char *path);
63
64 /**
65  * Run plugins in this list, until one returns success (or until the
66  * plugin list is exhausted).
67  *
68  * @param list the plugin list
69  * @param args nullptr terminated command line arguments passed to the
70  * plugin programs
71  * @param callback the callback function which will be called when a
72  * result is available
73  * @param callback_data caller defined pointer which is passed to the
74  * callback function
75  */
76 struct plugin_cycle *
77 plugin_run(PluginList *list, const char *const*args,
78            plugin_callback_t callback, void *callback_data);
79
80 /**
81  * Stops the plugin cycle and frees resources.  This can be called to
82  * abort the current cycle, or after the plugin_callback_t has been
83  * invoked.
84  */
85 void
86 plugin_stop(struct plugin_cycle *invocation);
87
88 #endif