2009-09-10 10:31:40 +00:00
|
|
|
/*
|
|
|
|
* 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 <http://www.fsf.org/copyleft/gpl.txt>.
|
|
|
|
*
|
|
|
|
* 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 <getopt.h>
|
|
|
|
|
2009-09-10 10:44:06 +00:00
|
|
|
/**
|
|
|
|
* Maximum number of commands.
|
|
|
|
*/
|
|
|
|
#define MAX_COMMANDS 10
|
|
|
|
|
2009-09-10 10:31:40 +00:00
|
|
|
/**
|
|
|
|
* Maximum number of options in a command (+1)
|
|
|
|
*/
|
2009-09-11 15:17:56 +00:00
|
|
|
#define MAX_OPTIONS 20
|
2009-09-10 10:31:40 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Maximum number of usage summary lines (+1)
|
|
|
|
*/
|
2009-09-11 15:17:56 +00:00
|
|
|
#define MAX_LINES 10
|
2009-09-10 10:31:40 +00:00
|
|
|
|
|
|
|
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];
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2009-09-10 10:44:06 +00:00
|
|
|
* Options of the active command.
|
2009-09-10 10:31:40 +00:00
|
|
|
*/
|
|
|
|
extern struct option command_opts[];
|
|
|
|
|
2009-09-15 08:20:22 +00:00
|
|
|
/**
|
|
|
|
* Short option string of the active command.
|
|
|
|
*/
|
|
|
|
extern char command_optstring[];
|
|
|
|
|
2009-09-10 10:31:40 +00:00
|
|
|
/**
|
|
|
|
* Register a command.
|
|
|
|
*/
|
2009-09-10 10:44:06 +00:00
|
|
|
void command_register(command_t command);
|
2009-09-10 10:31:40 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Dispatch commands.
|
|
|
|
*/
|
|
|
|
int command_dispatch(int argc, char *argv[]);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Show usage information of active command.
|
|
|
|
*/
|
2009-09-10 10:44:06 +00:00
|
|
|
int command_usage(char *error);
|
2009-09-10 10:31:40 +00:00
|
|
|
|
|
|
|
#endif /* COMMAND_H_ @}*/
|