diff libpurple/cmds.h @ 15822:32c366eeeb99

sed -ie 's/gaim/purple/g'

--- a/libpurple/cmds.h	Mon Mar 19 06:11:46 2007 +0000
+++ b/libpurple/cmds.h	Mon Mar 19 07:01:17 2007 +0000
@@ -19,8 +19,8 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
-#ifndef _GAIM_CMDS_H_
-#define _GAIM_CMDS_H_
+#ifndef _PURPLE_CMDS_H_
+#define _PURPLE_CMDS_H_
 
 #include "conversation.h"
 
@@ -29,48 +29,48 @@
 /**************************************************************************/
 /*@{*/
 
-typedef enum _GaimCmdPriority GaimCmdPriority;
-typedef enum _GaimCmdFlag     GaimCmdFlag;
-typedef enum _GaimCmdStatus   GaimCmdStatus;
-typedef enum _GaimCmdRet      GaimCmdRet;
+typedef enum _PurpleCmdPriority PurpleCmdPriority;
+typedef enum _PurpleCmdFlag     PurpleCmdFlag;
+typedef enum _PurpleCmdStatus   PurpleCmdStatus;
+typedef enum _PurpleCmdRet      PurpleCmdRet;
 
-enum _GaimCmdStatus {
-	GAIM_CMD_STATUS_OK,
-	GAIM_CMD_STATUS_FAILED,
-	GAIM_CMD_STATUS_NOT_FOUND,
-	GAIM_CMD_STATUS_WRONG_ARGS,
-	GAIM_CMD_STATUS_WRONG_PRPL,
-	GAIM_CMD_STATUS_WRONG_TYPE,
+enum _PurpleCmdStatus {
+	PURPLE_CMD_STATUS_OK,
+	PURPLE_CMD_STATUS_FAILED,
+	PURPLE_CMD_STATUS_NOT_FOUND,
+	PURPLE_CMD_STATUS_WRONG_ARGS,
+	PURPLE_CMD_STATUS_WRONG_PRPL,
+	PURPLE_CMD_STATUS_WRONG_TYPE,
 };
 
-enum _GaimCmdRet {
-	GAIM_CMD_RET_OK,       /**< Everything's okay. Don't look for another command to call. */
-	GAIM_CMD_RET_FAILED,   /**< The command failed, but stop looking.*/
-	GAIM_CMD_RET_CONTINUE, /**< Continue, looking for other commands with the same name to call. */
+enum _PurpleCmdRet {
+	PURPLE_CMD_RET_OK,       /**< Everything's okay. Don't look for another command to call. */
+	PURPLE_CMD_RET_FAILED,   /**< The command failed, but stop looking.*/
+	PURPLE_CMD_RET_CONTINUE, /**< Continue, looking for other commands with the same name to call. */
 };
 
-#define GAIM_CMD_FUNC(func) ((GaimCmdFunc)func)
+#define PURPLE_CMD_FUNC(func) ((PurpleCmdFunc)func)
 
-typedef GaimCmdRet (*GaimCmdFunc)(GaimConversation *, const gchar *cmd,
+typedef PurpleCmdRet (*PurpleCmdFunc)(PurpleConversation *, const gchar *cmd,
                                   gchar **args, gchar **error, void *data);
-typedef guint GaimCmdId;
+typedef guint PurpleCmdId;
 
-enum _GaimCmdPriority {
-	GAIM_CMD_P_VERY_LOW  = -1000,
-	GAIM_CMD_P_LOW       =     0,
-	GAIM_CMD_P_DEFAULT   =  1000,
-	GAIM_CMD_P_PRPL      =  2000,
-	GAIM_CMD_P_PLUGIN    =  3000,
-	GAIM_CMD_P_ALIAS     =  4000,
-	GAIM_CMD_P_HIGH      =  5000,
-	GAIM_CMD_P_VERY_HIGH =  6000,
+enum _PurpleCmdPriority {
+	PURPLE_CMD_P_VERY_LOW  = -1000,
+	PURPLE_CMD_P_LOW       =     0,
+	PURPLE_CMD_P_DEFAULT   =  1000,
+	PURPLE_CMD_P_PRPL      =  2000,
+	PURPLE_CMD_P_PLUGIN    =  3000,
+	PURPLE_CMD_P_ALIAS     =  4000,
+	PURPLE_CMD_P_HIGH      =  5000,
+	PURPLE_CMD_P_VERY_HIGH =  6000,
 };
 
-enum _GaimCmdFlag {
-	GAIM_CMD_FLAG_IM               = 0x01,
-	GAIM_CMD_FLAG_CHAT             = 0x02,
-	GAIM_CMD_FLAG_PRPL_ONLY        = 0x04,
-	GAIM_CMD_FLAG_ALLOW_WRONG_ARGS = 0x08,
+enum _PurpleCmdFlag {
+	PURPLE_CMD_FLAG_IM               = 0x01,
+	PURPLE_CMD_FLAG_CHAT             = 0x02,
+	PURPLE_CMD_FLAG_PRPL_ONLY        = 0x04,
+	PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS = 0x08,
 };
 
 
@@ -93,9 +93,9 @@
  *
  * @param cmd The command. This should be a UTF8 (or ASCII) string, with no spaces
  *            or other white space.
- * @param args This tells Gaim how to parse the arguments to the command for you.
- *             If what the user types doesn't match, Gaim will keep looking for another
- *             command, unless the flag @c GAIM_CMD_FLAG_ALLOW_WRONG_ARGS is passed in f.
+ * @param args This tells Purple how to parse the arguments to the command for you.
+ *             If what the user types doesn't match, Purple will keep looking for another
+ *             command, unless the flag @c PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed in f.
  *             This string contains no whitespace, and uses a single character for each argument.
  *             The recognized characters are:
  *               'w' Matches a single word.
@@ -105,11 +105,11 @@
  *             If args is the empty string, then the command accepts no arguments.
  *             The args passed to callback func will be a @c NULL terminated array of null
  *             terminated strings, and will always match the number of arguments asked for,
- *             unless GAIM_CMD_FLAG_ALLOW_WRONG_ARGS is passed.
+ *             unless PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed.
  * @param p This is the priority. Higher priority commands will be run first, and usually the
  *          first command will stop any others from being called.
- * @param f These are the flags. You need to at least pass one of GAIM_CMD_FLAG_IM or
- *          GAIM_CMD_FLAG_CHAT (can may pass both) in order for the command to ever actually
+ * @param f These are the flags. You need to at least pass one of PURPLE_CMD_FLAG_IM or
+ *          PURPLE_CMD_FLAG_CHAT (can may pass both) in order for the command to ever actually
  *          be called.
  * @param prpl_id This is the prpl's id string. This is only meaningful if the proper flag is set.
  * @param func This is the function to call when someone enters this command.
@@ -118,12 +118,12 @@
  *                and any arguments it accepts (if it takes any arguments, otherwise no space), followed
  *                by a colon, two spaces, and a description of the command in sentence form. No slash
  *                before the command name.
- * @param data User defined data to pass to the GaimCmdFunc
- * @return A GaimCmdId. This is only used for calling gaim_cmd_unregister.
+ * @param data User defined data to pass to the PurpleCmdFunc
+ * @return A PurpleCmdId. This is only used for calling purple_cmd_unregister.
  *         Returns 0 on failure.
  */
-GaimCmdId gaim_cmd_register(const gchar *cmd, const gchar *args, GaimCmdPriority p, GaimCmdFlag f,
-                             const gchar *prpl_id, GaimCmdFunc func, const gchar *helpstr, void *data);
+PurpleCmdId purple_cmd_register(const gchar *cmd, const gchar *args, PurpleCmdPriority p, PurpleCmdFlag f,
+                             const gchar *prpl_id, PurpleCmdFunc func, const gchar *helpstr, void *data);
 
 /**
  * Unregister a command with the core.
@@ -132,9 +132,9 @@
  * or something else that might go away. Normally this is called when the plugin
  * unloads itself.
  *
- * @param id The GaimCmdId to unregister.
+ * @param id The PurpleCmdId to unregister.
  */
-void gaim_cmd_unregister(GaimCmdId id);
+void purple_cmd_unregister(PurpleCmdId id);
 
 /**
  * Do a command.
@@ -152,9 +152,9 @@
  *               include both the default formatting and any extra manual formatting.
  * @param errormsg If the command failed errormsg is filled in with the appropriate error
  *                 message. It must be freed by the caller with g_free().
- * @return A GaimCmdStatus indicated if the command succeeded or failed.
+ * @return A PurpleCmdStatus indicated if the command succeeded or failed.
  */
-GaimCmdStatus gaim_cmd_do_command(GaimConversation *conv, const gchar *cmdline,
+PurpleCmdStatus purple_cmd_do_command(PurpleConversation *conv, const gchar *cmdline,
                                   const gchar *markup, gchar **errormsg);
 
 /**
@@ -168,7 +168,7 @@
  * @param conv The conversation, or @c NULL.
  * @return A GList of const char*, which must be freed with g_list_free().
  */
-GList *gaim_cmd_list(GaimConversation *conv);
+GList *purple_cmd_list(PurpleConversation *conv);
 
 /**
  * Get the help string for a command.
@@ -182,7 +182,7 @@
  * @return A GList of const char*s, which is the help string
  *         for that command.
  */
-GList *gaim_cmd_help(GaimConversation *conv, const gchar *cmd);
+GList *purple_cmd_help(PurpleConversation *conv, const gchar *cmd);
 
 /*@}*/
 
@@ -190,4 +190,4 @@
 }
 #endif
 
-#endif /* _GAIM_CMDS_H_ */
+#endif /* _PURPLE_CMDS_H_ */