src/pki/command.h

   1 /*
   2  * Copyright (C) 2009 Martin Willi
   3  * Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 /**
  17  * @defgroup command command
  18  * @{ @ingroup pki
  19  */
  20
  21 #ifndef COMMAND_H_
  22 #define COMMAND_H_
  23
  24 #define _GNU_SOURCE
  25 #include <getopt.h>
  26
  27 /**
  28  * Maximum number of commands.
  29  */
  30 #define MAX_COMMANDS 10
  31
  32 /**
  33  * Maximum number of options in a command (+1)
  34  */
  35 #define MAX_OPTIONS 20
  36
  37 /**
  38  * Maximum number of usage summary lines (+1)
  39  */
  40 #define MAX_LINES 10
  41
  42 typedef struct command_t command_t;
  43 typedef enum command_type_t command_type_t;
  44
  45 /**
  46  * Command specification.
  47  */
  48 struct command_t {
  49         /** Function implementing the command */
  50         int (*call)(int, char*[]);
  51         /** short option character */
  52         char op;
  53         /** long option string */
  54         char *cmd;
  55         /** description of the command */
  56         char *description;
  57         /** usage summary of the command */
  58         char *line[MAX_LINES];
  59         /** list of options the command accepts */
  60         struct {
  61                 /** long option string of the option */
  62                 char *name;
  63                 /** short option character of the option */
  64                 char op;
  65                 /** expected argument to option, no/req/opt_argument */
  66                 int arg;
  67                 /** description of the option */
  68                 char *desc;
  69         } options[MAX_OPTIONS];
  70 };
  71
  72 /**
  73  * Options of the active command.
  74  */
  75 extern struct option command_opts[];
  76
  77 /**
  78  * Register a command.
  79  */
  80 void command_register(command_t command);
  81
  82 /**
  83  * Dispatch commands.
  84  */
  85 int command_dispatch(int argc, char *argv[]);
  86
  87 /**
  88  * Show usage information of active command.
  89  */
  90 int command_usage(char *error);
  91
  92 #endif /* COMMAND_H_ @}*/