/* * Copyright (C) 2009 Martin Willi * Hochschule fuer Technik Rapperswil * * 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. See . * * 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. */ /** * @defgroup command command * @{ @ingroup pki */ #ifndef COMMAND_H_ #define COMMAND_H_ #define _GNU_SOURCE #include /** * Maximum number of commands. */ #define MAX_COMMANDS 10 /** * Maximum number of options in a command (+1) */ #define MAX_OPTIONS 20 /** * Maximum number of usage summary lines (+1) */ #define MAX_LINES 10 typedef struct command_t command_t; typedef enum command_type_t command_type_t; /** * Command specification. */ struct command_t { /** Function implementing the command */ int (*call)(int, char*[]); /** short option character */ char op; /** long option string */ char *cmd; /** description of the command */ char *description; /** usage summary of the command */ char *line[MAX_LINES]; /** list of options the command accepts */ struct { /** long option string of the option */ char *name; /** short option character of the option */ char op; /** expected argument to option, no/req/opt_argument */ int arg; /** description of the option */ char *desc; } options[MAX_OPTIONS]; }; /** * Options of the active command. */ extern struct option command_opts[]; /** * Register a command. */ void command_register(command_t command); /** * Dispatch commands. */ int command_dispatch(int argc, char *argv[]); /** * Show usage information of active command. */ int command_usage(char *error); #endif /* COMMAND_H_ @}*/