screen: move screen_paint() to screen_paint.c

[ncmpc.git] / src / plugin.h

diff --git a/src/plugin.h b/src/plugin.h
index b8bf90167d7c1ca63d7428a82ad92199e399c545..9f2d77154c135037f3107e79f9d92be41849ee10 100644 (file)
--- a/src/plugin.h
+++ b/src/plugin.h
@@ -1,6 +1,6 @@
-/*
- * (c) 2004-2008 The Music Player Daemon Project
- * http://www.musicpd.org/
+/* ncmpc (Ncurses MPD Client)
+ * (c) 2004-2017 The Music Player Daemon Project
+ * Project homepage: http://musicpd.org
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -11,9 +11,10 @@
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #ifndef PLUGIN_H
@@ -33,10 +34,16 @@ struct plugin_list {
  * When a plugin cycle is finished, this function is called.  In any
  * case, plugin_stop() has to be called to free all memory.
  *
- * @param result the plugin's output (stdout) on success; NULL on failure
+ * @param result the plugin's output (stdout) on success; summary of all error
+ * messages on failure as determined by success
+ * @param success result of the plugin cycle; true if result is meaningful
+ * output, false if result contains error messages
+ * @param plugin_name the name of the plugin which succeeded; becomes invalid
+ * when plugin_stop is called (i.e. strdup it if you need it afterwards).
  * @param data the caller defined pointer passed to plugin_run()
  */
-typedef void (*plugin_callback_t)(const GString *result, void *data);
+typedef void (*plugin_callback_t)(const GString *result, const bool success,
+                                 const char *plugin_name, void *data);
 
 /**
  * This object represents a cycle through all available plugins, until