blob: 9cf036bf24d3783f53412d2476fbf251dd3f3df8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
* 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_
/**
* Maximum number of commands (+1).
*/
#define MAX_COMMANDS 12
/**
* Maximum number of options in a command (+3)
*/
#define MAX_OPTIONS 36
/**
* Maximum number of usage summary lines (+1)
*/
#define MAX_LINES 10
typedef struct command_t command_t;
typedef struct command_option_t command_option_t;
typedef enum command_type_t command_type_t;
/**
* Option specification
*/
struct command_option_t {
/** 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;
};
/**
* Command specification.
*/
struct command_t {
/** Function implementing the command */
int (*call)();
/** 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 */
command_option_t options[MAX_OPTIONS];
};
/**
* Get the next option, as with getopt.
*/
int command_getopt(char **arg);
/**
* 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_ @}*/
|
