/*
- command.h
+ command.h
- Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
+ Author: Pekka Riikonen <priikone@silcnet.org>
Copyright (C) 1997 - 2001 Pekka Riikonen
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.
-
+ the Free Software Foundation; version 2 of the License.
+
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
#ifndef COMMAND_H
#define COMMAND_H
-/*
- Structure holding one command and pointer to its function.
-
- SilcCommandCb cb
-
- Callback function called when this command is executed.
-
- SilcCommand cmd
-
- The actual command. These are defined in silccore/silccommand.h
-
- char *name
-
- Logical name of the command. This is the visible command name
- that user uses when calling command. Eg. NICK.
-
- SilcCommandFlag flags
+#include "command_reply.h"
- Flags for the command. These set how command behaves on different
- situations. Server sets these flags as well, but to be sure
- that our client never sends wrong commands we preserve the
- flags on client side as well.
+/* Structure holding one command and pointer to its function. This
+ structure is allocate into the commands list, and is returned
+ for example by silc_client_command_find function.
- XXX: We preserve these so that we define them but currently we
- don't check the flags at all.
+ To call a command: command->command(cmd, NULL);
+ To call a command reply: command->reply(cmd, NULL);
*/
-typedef struct {
- SilcCommandCb cb;
- SilcCommand cmd;
- char *name;
- SilcCommandFlag flags;
- unsigned int max_args;
-} SilcClientCommand;
-
-/* All client commands */
-extern SilcClientCommand silc_command_list[];
+struct SilcClientCommandStruct {
+ SilcCommand cmd; /* Command type */
+ SilcCommandCb command; /* Command function */
+ SilcCommandCb reply; /* Command reply callback */
+ char *name; /* Name of the command (optional) */
+ SilcUInt8 max_args; /* Maximum arguments (optional) */
+ SilcUInt16 ident; /* Identifier for command (optional) */
+ struct SilcClientCommandStruct *next;
+};
/* Context sent as argument to all commands. This is used by the library
and application should use this as well. However, application may
choose to use some own context for its own local command. All library
commands, however, must use this context. */
-typedef struct {
+struct SilcClientCommandContextStruct {
SilcClient client;
SilcClientConnection conn;
- SilcClientCommand *command;
- unsigned int argc;
+ SilcClientCommand command;
+ SilcUInt32 argc;
unsigned char **argv;
- unsigned int *argv_lens;
- unsigned int *argv_types;
+ SilcUInt32 *argv_lens;
+ SilcUInt32 *argv_types;
int pending; /* Command is being re-processed when TRUE */
int users; /* Reference counter */
-} *SilcClientCommandContext;
-
-#include "silcapi.h"
+};
/* Structure holding pending commands. If command is pending it will be
executed after command reply has been executed. */
typedef struct SilcClientCommandPendingStruct {
SilcCommand reply_cmd;
SilcCommandCb callback;
- SilcClientPendingDestructor destructor;
void *context;
- unsigned short ident;
+ SilcUInt16 ident;
struct SilcClientCommandPendingStruct *next;
} SilcClientCommandPending;
/* List of pending commands */
extern SilcClientCommandPending *silc_command_pending;
-#include "command_reply.h"
/* Macros */
-/* Macro used for command declaration in command list structure */
-#define SILC_CLIENT_CMD(func, cmd, name, flags, args) \
-{ silc_client_command_##func, SILC_COMMAND_##cmd, name, flags, args }
+/* Macro used for command registering and unregistering */
+#define SILC_CLIENT_CMD(func, cmd, name, args) \
+silc_client_command_register(client, SILC_COMMAND_##cmd, name, \
+ silc_client_command_##func, \
+ silc_client_command_reply_##func, args, 0)
+#define SILC_CLIENT_CMDU(func, cmd, name) \
+silc_client_command_unregister(client, SILC_COMMAND_##cmd, \
+ silc_client_command_##func, \
+ silc_client_command_reply_##func, 0)
/* Macro used to declare command functions */
-#define SILC_CLIENT_CMD_FUNC(func) \
-void silc_client_command_##func(void *context)
+#define SILC_CLIENT_CMD_FUNC(func) \
+void silc_client_command_##func(void *context, void *context2)
/* Executed pending command callback */
-#define SILC_CLIENT_PENDING_EXEC(ctx, cmd) \
-do { \
- if ((ctx)->callback) \
- (*ctx->callback)(ctx->context); \
-} while(0)
-
-/* Execute destructor for pending command */
-#define SILC_CLIENT_PENDING_DESTRUCTOR(ctx, cmd) \
+#define SILC_CLIENT_PENDING_EXEC(ctx, cmd) \
do { \
+ if ((ctx)->callback) \
+ (*ctx->callback)(ctx->context, ctx); \
silc_client_command_pending_del((ctx)->sock->user_data, (cmd), \
(ctx)->ident); \
- if (ctx->destructor) \
- (*ctx->destructor)(ctx->context); \
} while(0)
-/* Prototypes (some prototypes are in the silcapi.h file) */
+bool silc_client_command_register(SilcClient client,
+ SilcCommand command,
+ const char *name,
+ SilcCommandCb command_function,
+ SilcCommandCb command_reply_function,
+ SilcUInt8 max_args,
+ SilcUInt16 ident);
+bool silc_client_command_unregister(SilcClient client,
+ SilcCommand command,
+ SilcCommandCb command_function,
+ SilcCommandCb command_reply_function,
+ SilcUInt16 ident);
+void silc_client_commands_register(SilcClient client);
+void silc_client_commands_unregister(SilcClient client);
void silc_client_command_pending_del(SilcClientConnection conn,
SilcCommand reply_cmd,
- unsigned short ident);
+ SilcUInt16 ident);
int silc_client_command_pending_check(SilcClientConnection conn,
SilcClientCommandReplyContext ctx,
SilcCommand command,
- unsigned short ident);
+ SilcUInt16 ident);
SILC_CLIENT_CMD_FUNC(whois);
SILC_CLIENT_CMD_FUNC(whowas);
SILC_CLIENT_CMD_FUNC(cmode);
SILC_CLIENT_CMD_FUNC(cumode);
SILC_CLIENT_CMD_FUNC(kick);
-SILC_CLIENT_CMD_FUNC(restart);
+SILC_CLIENT_CMD_FUNC(ban);
SILC_CLIENT_CMD_FUNC(close);
SILC_CLIENT_CMD_FUNC(shutdown);
SILC_CLIENT_CMD_FUNC(silcoper);
SILC_CLIENT_CMD_FUNC(leave);
SILC_CLIENT_CMD_FUNC(users);
+SILC_CLIENT_CMD_FUNC(getkey);
#endif
projects / silc.git / blobdiff