cmds.h File Reference

Commands API

Copyright (C) 2003 Timothy Ringenbach <omarvo@hotmail.com>. More...

#include "conversation.h"

Include dependency graph for cmds.h:

Go to the source code of this file.

#define	GAIM_CMD_FUNC(func)   ((GaimCmdFunc)func)
typedef enum _GaimCmdPriority	GaimCmdPriority
typedef enum _GaimCmdFlag	GaimCmdFlag
typedef enum _GaimCmdStatus	GaimCmdStatus
typedef enum _GaimCmdRet	GaimCmdRet
typedef GaimCmdRet(*	GaimCmdFunc )(GaimConversation *, const gchar *cmd, gchar **args, gchar **error, void *data)
typedef guint	GaimCmdId
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	_GaimCmdRet { GAIM_CMD_RET_OK, GAIM_CMD_RET_FAILED, GAIM_CMD_RET_CONTINUE }
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_VERYHIGH = 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 }
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)
	Register a new command with the core.
void	gaim_cmd_unregister (GaimCmdId id)
	Unregister a command with the core.
GaimCmdStatus	gaim_cmd_do_command (GaimConversation *conv, const gchar *cmdline, const gchar *markup, gchar **errormsg)
	Do a command.
GList *	gaim_cmd_list (GaimConversation *conv)
	List registered commands.
GList *	gaim_cmd_help (GaimConversation *conv, const gchar *cmd)
	Get the help string for a command.

---

Detailed Description

Commands API

Copyright (C) 2003 Timothy Ringenbach <omarvo@hotmail.com>.

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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

---

Enumeration Type Documentation

enum _GaimCmdRet

Enumerator: 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.

---

Function Documentation

GaimCmdStatus gaim_cmd_do_command (  GaimConversation *  conv, const gchar *  cmdline, const gchar *  markup, gchar **  errormsg )

Do a command. Normally the UI calls this to perform a command. This might also be useful if aliases are ever implemented. Parameters: conv  The conversation the command was typed in. cmdline  The command the user typed (including all arguments) as a single string. The caller doesn't have to do any parsing, except removing the command prefix, which the core has no knowledge of. cmd should not contain any formatting, and should be in plain text (no html entities). markup  This is the same as cmd, but is the formatted version. It should be in HTML, with < > and &, at least, escaped to html entities, and should include both the default formatting and any extra manual formatting. errormsg  If the command failed errormsg is filled in with the appropriate error message. It must be freed by the caller with g_free(). Returns: A GaimCmdStatus indicated if the command succeeded or failed.

GList* gaim_cmd_help (  GaimConversation *  conv, const gchar *  cmd )

Get the help string for a command. Returns the help strings for a given command in the form of a GList, one node for each matching command. Parameters: conv  The conversation, or NULL for no context. cmd  The command. No wildcards accepted, but returns help for all commands if NULL. Returns: A GList of const char*s, which is the help string for that command.

GList* gaim_cmd_list (  GaimConversation *  conv  )

List registered commands. Returns a GList (which must be freed by the caller) of all commands that are valid in the context of conv, or all commands, if conv is NULL. Don't keep this list around past the main loop, or anything else that might unregister a command, as the char*'s used get freed then. Parameters: conv  The conversation, or NULL. Returns: A GList of const char*, which must be freed with g_list_free().

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 )

Register a new command with the core. The command will only happen if commands are enabled, which is a UI pref. UIs don't have to support commands at all. Parameters: cmd  The command. This should be a UTF8 (or ASCII) string, with no spaces or other white space. 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 GAIM_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. 'W' Matches a single word, with formatting. 's' Matches the rest of the arguments after this point, as a single string. 'S' Same as 's' but with formatting. If args is the empty string, then the command accepts no arguments. The args passed to callback func will be a 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. p  This is the priority. Higher priority commands will be run first, and usually the first command will stop any others from being called. 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 be called. prpl_id  This is the prpl's id string. This is only meaningful is the proper flag is set. func  This is the function to call when someone enters this command. helpstr  This is a whitespace sensitive, UTF-8, HTML string describing how to use the command. The preferred format of this string shall be the commands name, followed by a space and any arguments it accpets (if it takes any arguments, otherwise no space), follow by a colon, two spaces, and a description of the command in sentence form. No slash before the command name. data  User defined data to pass to the GaimCmdFunc Returns: A GaimCmdId. This is only used for calling gaim_cmd_unregister. Returns NULL on failure.

void gaim_cmd_unregister (  GaimCmdId  id  )

Unregister a command with the core. All registered commands must be unregistered, if they're registered by a plugin or something else that might go away. Normally this is called when the plugin unloads itself. Parameters: id  The GaimCmdId to unregister.

---