updates. New data types.

[silc.git] / lib / silcclient / command.h

diff --git a/lib/silcclient/command.h b/lib/silcclient/command.h
index dfe4f586d4d19349b8bfae98cc576791bbb727f3..a9699527323d29351f2dc83cb10fbf1f936a4cdd 100644 (file)
--- a/lib/silcclient/command.h
+++ b/lib/silcclient/command.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
 
-  Copyright (C) 1997 - 2000 Pekka Riikonen
+  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
@@ -21,8 +21,6 @@
 #ifndef COMMAND_H
 #define COMMAND_H
 
-#include "command_reply.h"
-
 /* 
    Structure holding one command and pointer to its function. 
 
@@ -55,38 +53,46 @@ typedef struct {
   SilcCommand cmd;
   char *name;
   SilcCommandFlag flags;
-  unsigned int max_args;
+  uint32 max_args;
 } SilcClientCommand;
 
 /* All client commands */
 extern SilcClientCommand silc_command_list[];
 
-/* Context sent as argument to all commands */
+/* 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 {
   SilcClient client;
   SilcClientConnection conn;
   SilcClientCommand *command;
-  unsigned int argc;
+  uint32 argc;
   unsigned char **argv;
-  unsigned int *argv_lens;
-  unsigned int *argv_types;
+  uint32 *argv_lens;
+  uint32 *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. */
-/* XXX This support may added for commands as well and not just command
-   replies, if needed later. */
 typedef struct SilcClientCommandPendingStruct {
   SilcCommand reply_cmd;
   SilcCommandCb callback;
+  SilcClientPendingDestructor destructor;
   void *context;
-  unsigned short ident;
+  uint16 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 */
@@ -98,32 +104,30 @@ extern SilcClientCommandPending *silc_command_pending;
 void silc_client_command_##func(void *context)
 
 /* Executed pending command callback */
-#define SILC_CLIENT_COMMAND_EXEC_PENDING(ctx, cmd)                     \
+#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)                       \
 do {                                                                   \
-  if ((ctx)->callback) {                                               \
-    (*ctx->callback)(ctx->context);                                    \
-    silc_client_command_pending_del((ctx)->sock->user_data, (cmd),     \
-                                   (ctx)->ident);                      \
-  }                                                                    \
+  silc_client_command_pending_del((ctx)->sock->user_data, (cmd),       \
+                                 (ctx)->ident);                        \
+  if (ctx->destructor)                                                 \
+    (*ctx->destructor)(ctx->context);                                  \
 } while(0)
 
-/* Prototypes */
-void silc_client_command_free(SilcClientCommandContext cmd);
-void silc_client_send_command(SilcClient client, SilcClientConnection conn,
-                             SilcCommand command, unsigned int argc, ...);
-SilcClientCommand *silc_client_command_find(const char *name);
-void silc_client_command_pending(SilcClientConnection conn,
-                                SilcCommand reply_cmd,
-                                unsigned short ident,
-                                SilcCommandCb callback,
-                                void *context);
+/* Prototypes (some prototypes are in the silcapi.h file) */
 void silc_client_command_pending_del(SilcClientConnection conn,
                                     SilcCommand reply_cmd,
-                                    unsigned short ident);
+                                    uint16 ident);
 int silc_client_command_pending_check(SilcClientConnection conn,
                                      SilcClientCommandReplyContext ctx,
                                      SilcCommand command, 
-                                     unsigned short ident);
+                                     uint16 ident);
+
 SILC_CLIENT_CMD_FUNC(whois);
 SILC_CLIENT_CMD_FUNC(whowas);
 SILC_CLIENT_CMD_FUNC(identify);
@@ -143,9 +147,9 @@ SILC_CLIENT_CMD_FUNC(umode);
 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(die);
+SILC_CLIENT_CMD_FUNC(shutdown);
 SILC_CLIENT_CMD_FUNC(silcoper);
 SILC_CLIENT_CMD_FUNC(leave);
 SILC_CLIENT_CMD_FUNC(users);