Changes between Version 4 and Version 5 of CHowTo/CommandAPIHowTo

Timestamp:

Nov 13, 2009, 11:32:01 PM (14 years ago)

Author:

hamiltont

Comment:

added TOC, changed the command from /debug to /log to avoid builtin /debug command

CHowTo/CommandAPIHowTo

@@ -3 +3 @@
 The command API is a method by which you can add commands to libpurple clients.  Pidgin and Finch use the / character to denote a command, much like many IRC clients.  This document will explain how to make your plugin add commands. Again we will assume that you have completed the [wiki:CHowTo/BasicPluginHowto Basic C Plugin Howto].  We'll also continue to assume that you're using Pidgin 2.0.2 for these How-To documents as described there.
 
+[[TOC(inline,noheading)]]
 
 ''This document is incomplete.  It has been saved to the wiki to ensure the current work is not lost.  It should be finished soon.''
@@ -82 +83 @@
 
 
-/* The callback function for our /debug command. This function simply prints
+/* The callback function for our /log command. This function simply prints
  * whatever was entered as the argument to the debug command into the debug 
  * log. */
 static PurpleCmdRet 
-debug_cb(PurpleConversation *conv, const gchar *cmd, gchar **args, gchar **error, void *data)
-{
-  purple_debug_misc(PLUGIN_ID, "debug_cb called\n");
+log_cb(PurpleConversation *conv, const gchar *cmd, gchar **args, gchar **error, void *data)
+{
+  purple_debug_misc(PLUGIN_ID, "log_cb called\n");
   purple_debug_misc(PLUGIN_ID, "message = %s\n", args[0]);
 
@@ -121 +122 @@
 {
   /* Declare all vars up front. Avoids warnings on some compilers */
-  gchar *debug_help = NULL;
+  gchar *log_help = NULL;
   gchar *notify_help = NULL;
   
@@ -127 +128 @@
   command_example = plugin;
 
-  /* Help message for debug command, in the correct format */
-  debug_help = "debug <debug message here>:  Prints a message to the debug log.";
-
-  /* Register a command to allow a user to enter /debug some message and have
+  /* Help message for log command, in the correct format */
+  log_help = "log <log message here>:  Prints a message to the debug log.";
+
+  /* Register a command to allow a user to enter /log some message and have
    * that message stored to the log. This command runs with default priority,
    * can only be used in a standard chat message, not while in group chat
    * mode */ 
   purple_cmd_register 
-    ("debug",                       /* command name */ 
+    ("log",                         /* command name */ 
      "s",                           /* command arguments */
      PURPLE_CMD_P_DEFAULT,          /* command priority */  
@@ -144 +145 @@
                                        plugin ID */
      
-     debug_cb,                      /* Name of the callback
+     log_cb,                        /* Name of the callback
                                        function */
-     debug_help,
+     log_help,
 
      NULL                           /* We do not need any special
@@ -153 +154 @@
         
 
-  /* Help message for debug command, in the correct format */
+  /* Help message for notify command, in the correct format */
   notify_help = "notify <notify word here>:  Pops up a notification with the word you enter.";
 
@@ -221 +222 @@
 }
 
-PURPLE_INIT_PLUGIN(debugexample, init_plugin, info)
+PURPLE_INIT_PLUGIN(commandexample, init_plugin, info)
 
 }}}
@@ -229 +230 @@
 As before, run make command_example.so (make -f Makefile.mingw command_example.dll for you Windows types) to build the plugin. Copy the resulting command_example.so to ~/.purple/plugins, or copy the resulting command_example.dll to %APPDATA%\.purple\plugins.
 
-To test (we will assume you are using Pidgin), go to Tools->Plugins and enable the Command API Example plugin. Also, go to Help->Debug Window to show the Debug Window. Open an IM chat session, and type ''/debug my debug message here''. Your message should show up in the debug window. Then type ''/notify Hello!''. You should receive a notification box saying Hello! Also, be sure to try ''/notify Hello World!'' and not that the command fails, because you input multiple arguments (2) when it was only expecting a single value. 
+To test (we will assume you are using Pidgin), go to Tools->Plugins and enable the Command API Example plugin. Also, go to Help->Debug Window to show the Debug Window. Open an IM chat session, and type ''/log my log message here''. Your message should show up in the Debug Window. Then type ''/notify Hello!''. You should receive a notification box saying Hello! Also, be sure to try ''/notify Hello World!'' and not that the command fails, because you input multiple arguments (2) when it was only expecting a single value. 
 
 == Beyond the Command API ==
 The command API provides a basic command framework for plugins, which can be an extremely valuable resource to plugin authors.  The other areas we didn't cover here include much of the true power of the command API, but we will leave those as an area for your exploration at least for now.  This document is done, but there are still others in the [wiki:CHowTo C Plugin How-To] for you to explore!
 
-== Updates to this page ==
-  * Don't use /debug, it conflicts with a built in command
-  * add TOC
+== Updates Needed to this page ==
   * Need to clean up the commands (purple_cmd_unregister) at unload.