File size: 9,795 Bytes
c7436b1 | 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 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 | #ifndef CLI_H
#define CLI_H
#include <stdio.h>
#include "indexed_list.h"
#include "stream.h"
#include "dict.h"
#include "mystring.h"
/* ************************************************************************* */
/* Defines. */
/* ************************************************************************* */
#define P_OPTIONAL 0x00
#define P_REQUIRED 0x01
#define P_ALLOW_UNNAMED 0x02
#define P_SWITCH 0x04
#define P_LAST_ARG 0x08
typedef struct {
const char *long_param;
int flags;
} Param_t;
class Args;
typedef struct {
const char *cmd; // Command string
int (*proc)(Stream& outf, Args& args); // Procedure handling the command . Return value is HTTP error code
const char *descr; // Description of the command
const int param_count; // automatically generated number of parameters
const Param_t *params; // Supported Parameters
const char *switches; // Known / supported switches
bool allow_unnamed; // allow superfluous unnamed arguments
} CliCommand_t;
class Args : public Dict<const char *, const char *>
{
IndexedList<const char *>unnamed;
char *cmd;
mstring switches;
char *Trim(char *word)
{
if (!word) {
return NULL;
}
while (*word == ' ')
word++;
int n=strlen(word)-1;
while(n >= 0 && (word[n] == ' ')) {
word[n--] = 0;
}
if (*word == '\"' && word[n] == '\"') {
word[n--] = 0;
word++;
}
return word;
}
void long_arg(char *str)
{
int len = strlen(str);
char *val = NULL;
bool quoted = false;
for (int i=0;i<len;i++) {
if((str[i] == '=') && !quoted) {
str[i] = 0;
val = &str[i+1];
break;
} else if(str[i] == '\"') {
quoted = !quoted;
}
}
set(Trim(str), Trim(val));
}
void short_arg(char *str)
{
int len = strlen(str);
for (int i=0;i<len;i++) {
char *val = NULL;
if(str[i+1] == '=') {
str[i+1] = 0;
set(Trim(&str[i]), Trim(&str[i+2]));
break;
} else { // single letter
switches += str[i];
}
}
}
public:
Args() : Dict(8, NULL, NULL, strcmp), cmd(NULL), unnamed(4, NULL), switches(8)
{
}
Args(const char *args) : Dict(8, NULL, NULL, strcmp), unnamed(4, NULL), switches(8)
{
Parse(args);
}
virtual ~Args()
{
if(cmd) {
delete[] cmd;
}
}
void ClearArgs()
{
clear(); // clears the dict
unnamed.clear_list();
switches = "";
}
int Parse(const char *args)
{
ClearArgs();
// no string => done
if (!args) {
return 0;
}
// This function takes an argument string and unravels it into a dictionary.
// The string can contain switches, named arguments, or unnamed arguments:
// -a : Switch a set to true.
// -ab : Switch a set to true, and switch b set to true
// --longname=string: Long named argument with 'string' as value
// blah: unnamed argument with 'blah' as value. The unnamed arguments are stored in a separate list and
// matched later to the function specification
// Let's first split the string in pieces by replacing the spaces with nulls. Our own cmd is the owner
// so we can have null-terminated string slices as an array of const char *.
bool quoted = false;
IndexedList<char *> slices(8, NULL);
int len = strlen(args);
cmd = new char[len+1];
strcpy(cmd, args);
int last = 0;
for (int i=0;i<=len;i++) {
if (!cmd[i] || (cmd[i] == '\n') || (cmd[i] == ' ' && !quoted)) {
cmd[i] = 0;
if (i - last >= 1) {
slices.append(cmd + last);
}
last = i+1;
} else if(cmd[i] == '\"') {
quoted = !quoted;
}
}
// Now lets go through all the slices and pick those that start with -- and -.
// All others will be added to unnamed.
int words = slices.get_elements();
for(int i=0;i<words;i++) {
if (slices[i][0] == '-') {
if (slices[i][1] == '-') {
long_arg(slices[i]+2);
} else {
short_arg(slices[i]+1);
}
} else {
if (strlen(slices[i]) > 0) {
unnamed.append(Trim(slices[i]));
}
}
}
return 1;
}
int Validate(const CliCommand_t& def)
{
int errors = 0;
// checks if all elements from the dictionary are
// actually valid commands
uint32_t matched = 0;
for (int i=0; i < get_elements(); i++) {
const char *k = get_key(i);
const Param_t *p = def.params;
bool found = false;
for(int j=0; p[j].long_param; j++) {
if (strcmp(k, p[j].long_param) == 0) {
matched |= (1 << j);
found = true;
break;
}
}
if(!found) {
printf("--> Function %s does not have parameter %s\n", def.cmd, k);
errors ++;
}
}
// check if all switches are valid
for (int i=0; i < switches.length(); i++) {
char requested = switches.c_str()[i];
bool ok = false;
for(int j=0; j < strlen(def.switches); j++) {
if (requested == def.switches[j]) {
ok = true;
break;
}
}
if (!ok) {
printf("--> Function %s does not understand switch %c\n", def.cmd, requested);
errors ++;
}
}
// now see if there are any unmatched parameters
// that could be attached to the unnamed args
const Param_t *p = def.params;
for(int i=0; p[i].long_param; i++) {
if (!(matched & (1 << i))) {
if(p[i].flags & P_ALLOW_UNNAMED) {
int idx = (p[i].flags & P_LAST_ARG) ? unnamed.get_elements()-1 : 0;
const char *arg = unnamed[idx];
if (arg) {
unnamed.remove_idx(idx);
set(p[i].long_param, arg);
matched |= (1 << i);
}
}
}
}
// Now check if all required arguments are actually given
p = def.params;
for(int i=0; p[i].long_param; i++) {
if (!(matched & (1 << i))) {
if(p[i].flags & P_REQUIRED) {
printf("--> Function %s requires parameter %s\n", def.cmd, p[i].long_param);
errors ++;
}
}
}
// Check if the function accepts the unnamed arguments if there are any left
if (get_number_of_unnamed_args() > 0 && !def.allow_unnamed) {
printf("--> Function %s does not allow superfluous unnamed arguments.\n", def.cmd);
errors ++;
}
return errors;
}
void dump_args(void)
{
printf("Named Arguments:\n");
dump();
printf("Unnamed Arguments:\n");
for(int i=0;i<unnamed.get_elements();i++) {
printf(" '%s'\n", unnamed[i]);
}
printf("Switches: %s\n", switches.c_str());
}
void add_unnamed(const char *str)
{
unnamed.append(str);
}
int get_number_of_unnamed_args()
{
return unnamed.get_elements();
}
const char *get_unnamed_arg(int idx)
{
return unnamed[idx];
}
bool check_switch(char s)
{
const char *sw = switches.c_str();
for (int i=0; i<strlen(sw); i++) {
if (sw[i] == s) {
return true;
}
}
return false;
}
};
#ifndef NR_OF_EL
#define NR_OF_EL(a) (sizeof(a) / sizeof(a[0]))
#endif
#define ARRAY(...) __VA_ARGS__
//#define P_END ARRAY({ NULL, 0})
#define mprintf(...) outf.format(__VA_ARGS__)
#define CLI_COMMAND(NAME, DESCR, PARAMS, SWITCHES, UNNAMED) \
static int Do ## NAME(Stream& outf, Args& args); \
const Param_t c_params ## NAME[] = PARAMS; \
const CliCommand_t cli_ ## NAME = \
{ ((const char*) #NAME ), \
((int(*)(Stream&, Args&)) Do ## NAME), \
((const char*) DESCR ), \
((const int)sizeof(c_params ## NAME) / sizeof(Param_t)), \
((const Param_t *) c_params ## NAME ), \
((const char*) SWITCHES ), \
((bool) UNNAMED ), \
}; \
CliCommandRegistrar RegisterCli_ ## NAME(& cli_ ## NAME); \
static int Do ## NAME(Stream& outf, Args& args)
IndexedList<const CliCommand_t *> *getCliCommandList(void);
class CliCommandRegistrar
{
public:
CliCommandRegistrar(const CliCommand_t *func) {
getCliCommandList()->append(func);
}
};
#endif /* CLI_H */
|