switch from GMainLoop to boost::asio
[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 <vector>
24 #include <string>
25
26 namespace boost { namespace asio { class io_service; }}
27
28 /**
29  * A list of registered plugins.
30  */
31 struct PluginList {
32         std::vector<std::string> plugins;
33 };
34
35 /**
36  * When a plugin cycle is finished, this function is called.  In any
37  * case, plugin_stop() has to be called to free all memory.
38  *
39  * @param result the plugin's output (stdout) on success; summary of all error
40  * messages on failure as determined by success
41  * @param success result of the plugin cycle; true if result is meaningful
42  * output, false if result contains error messages
43  * @param plugin_name the name of the plugin which succeeded; becomes invalid
44  * when plugin_stop is called (i.e. strdup it if you need it afterwards).
45  * @param data the caller defined pointer passed to plugin_run()
46  */
47 typedef void (*plugin_callback_t)(std::string &&result, const bool success,
48                                   const char *plugin_name, void *data);
49
50 /**
51  * This object represents a cycle through all available plugins, until
52  * a plugin returns a positive result.
53  */
54 struct PluginCycle;
55
56 /**
57  * Load all plugins (executables) in a directory.
58  */
59 bool
60 plugin_list_load_directory(PluginList *list, const char *path);
61
62 /**
63  * Run plugins in this list, until one returns success (or until the
64  * plugin list is exhausted).
65  *
66  * @param list the plugin list
67  * @param args nullptr terminated command line arguments passed to the
68  * plugin programs; they must remain valid while the plugin runs
69  * @param callback the callback function which will be called when a
70  * result is available
71  * @param callback_data caller defined pointer which is passed to the
72  * callback function
73  */
74 PluginCycle *
75 plugin_run(boost::asio::io_service &io_service,
76            PluginList *list, const char *const*args,
77            plugin_callback_t callback, void *callback_data);
78
79 /**
80  * Stops the plugin cycle and frees resources.  This can be called to
81  * abort the current cycle, or after the plugin_callback_t has been
82  * invoked.
83  */
84 void
85 plugin_stop(PluginCycle *invocation);
86
87 #endif