changeset 19953:0715328a0be3

Add the debug example plugin

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libpurple/plugins/debug_example.c	Sat Sep 08 04:16:05 2007 +0000
@@ -0,0 +1,128 @@
+/*
+ * Debug Example Plugin
+ *
+ * Copyright (C) 2007, John Bailey <[e-mail]>
+ *
+ * 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 the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02111-1301, USA.
+ *
+ */
+
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
+/* We're including glib.h again for the gboolean type. */
+#include <glib.h>
+
+/* This is the required definition of PURPLE_PLUGINS as required for a plugin,
+ * but we protect it with an #ifndef because config.h may define it for us
+ * already and this would cause an unneeded compiler warning. */
+#ifndef PURPLE_PLUGINS
+# define PURPLE_PLUGINS
+#endif
+
+/* Here we're including the necessary libpurple headers for this plugin.  Note
+ * that we're including them in alphabetical order.  This isn't necessary but
+ * we do this throughout our source for consistency. */
+#include "debug.h"
+#include "plugin.h"
+#include "version.h"
+
+/* It's more convenient to type PLUGIN_ID all the time than it is to type
+ * "core-debugexample", so define this convenience macro. */
+#define PLUGIN_ID "core-debugexample"
+
+/* Common practice in third-party plugins is to define convenience macros for
+ * many of the fields of the plugin info struct, so we'll do that for the
+ * purposes of demonstration. */
+#define PLUGIN_AUTHOR "John Bailey <[e-mail]>"
+
+/* As we've covered before, libpurple calls this function, if present, when it
+ * loads the plugin.  Here we're using it to show off the capabilities of the
+ * debug API and just blindly returning TRUE to tell libpurple it's safe to
+ * continue loading. */
+static gboolean
+plugin_load(PurplePlugin *plugin)
+{
+	/* Define these for convenience--we're just using them to show the
+	 * similarities of the debug functions to the standard printf(). */
+	gint i = 256;
+	gfloat f = 512.1024;
+	const gchar *s = "example string";
+
+	/* Introductory message */
+	purple_debug_info(PLUGIN_ID,
+		"Called plugin_load.  Beginning debug demonstration\n");
+
+	/* Show off the debug API a bit */
+	purple_debug_misc(PLUGIN_ID,
+		"MISC level debug message.  i = %d, f = %f, s = %s\n", i, f, s);
+
+	purple_debug_info(PLUGIN_ID,
+		"INFO level debug message.  i = %d, f = %f, s = %s\n", i, f, s);
+
+	purple_debug_warning(PLUGIN_ID,
+		"WARNING level debug message.  i = %d, f = %f, s = %s\n", i, f, s);
+
+	purple_debug_error(PLUGIN_ID,
+		"ERROR level debug message.  i = %d, f = %f, s = %s\n", i, f, s);
+
+	purple_debug_fatal(PLUGIN_ID,
+		"FATAL level debug message. i = %d, f = %f, s = %s\n", i, f, s);
+
+	/* Now just return TRUE to tell libpurple to finish loading. */
+	return TRUE;
+}
+
+static PurplePluginInfo info = {
+	PURPLE_PLUGIN_MAGIC,        /* magic number */
+	PURPLE_MAJOR_VERSION,       /* purple major */
+	PURPLE_MINOR_VERSION,       /* purple minor */
+	PURPLE_PLUGIN_STANDARD,     /* plugin type */
+	NULL,                       /* UI requirement */
+	0,                          /* flags */
+	NULL,                       /* dependencies */
+	PURPLE_PRIORITY_DEFAULT,    /* priority */
+
+	PLUGIN_ID,                  /* id */
+	"Debug API Example",        /* name */
+	VERSION,                    /* version */
+	"Debug API Example",        /* summary */
+	"Debug API Example",        /* description */
+	PLUGIN_AUTHOR,              /* author */
+	"http://pidgin.im",         /* homepage */
+
+	plugin_load,                /* load */
+	NULL,                       /* unload */
+	NULL,                       /* destroy */
+
+	NULL,                       /* ui info */
+	NULL,                       /* extra info */
+	NULL,                       /* prefs info */
+	NULL,                       /* actions */
+	NULL,                       /* reserved */
+	NULL,                       /* reserved */
+	NULL,                       /* reserved */
+	NULL                        /* reserved */
+};
+
+static void
+init_plugin(PurplePlugin *plugin)
+{
+}
+
+PURPLE_INIT_PLUGIN(debugexample, init_plugin, info)
+