git.sur5r.net Git - i3/i3/blob - src/commands_parser.c

   1 #undef I3__FILE__
   2 #define I3__FILE__ "commands_parser.c"
   3 /*
   4  * vim:ts=4:sw=4:expandtab
   5  *
   6  * i3 - an improved dynamic tiling window manager
   7  * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
   8  *
   9  * commands_parser.c: hand-written parser to parse commands (commands are what
  10  * you bind on keys and what you can send to i3 using the IPC interface, like
  11  * 'move left' or 'workspace 4').
  12  *
  13  * We use a hand-written parser instead of lex/yacc because our commands are
  14  * easy for humans, not for computers. Thus, it’s quite hard to specify a
  15  * context-free grammar for the commands. A PEG grammar would be easier, but
  16  * there’s downsides to every PEG parser generator I have come accross so far.
  17  *
  18  * This parser is basically a state machine which looks for literals or strings
  19  * and can push either on a stack. After identifying a literal or string, it
  20  * will either transition to the current state, to a different state, or call a
  21  * function (like cmd_move()).
  22  *
  23  * Special care has been taken that error messages are useful and the code is
  24  * well testable (when compiled with -DTEST_PARSER it will output to stdout
  25  * instead of actually calling any function).
  26  *
  27  */
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <unistd.h>
  32 #include <stdbool.h>
  33 #include <stdint.h>
  34
  35 #include "all.h"
  36
  37 // Macros to make the YAJL API a bit easier to use.
  38 #define y(x, ...) yajl_gen_ ## x (command_output.json_gen, ##__VA_ARGS__)
  39 #define ystr(str) yajl_gen_string(command_output.json_gen, (unsigned char*)str, strlen(str))
  40
  41 /*******************************************************************************
  42  * The data structures used for parsing. Essentially the current state and a
  43  * list of tokens for that state.
  44  *
  45  * The GENERATED_* files are generated by generate-commands-parser.pl with the
  46  * input parser-specs/commands.spec.
  47  ******************************************************************************/
  48
  49 #include "GENERATED_enums.h"
  50
  51 typedef struct token {
  52     char *name;
  53     char *identifier;
  54     /* This might be __CALL */
  55     cmdp_state next_state;
  56     union {
  57         uint16_t call_identifier;
  58     } extra;
  59 } cmdp_token;
  60
  61 typedef struct tokenptr {
  62     cmdp_token *array;
  63     int n;
  64 } cmdp_token_ptr;
  65
  66 #include "GENERATED_tokens.h"
  67
  68 /*******************************************************************************
  69  * The (small) stack where identified literals are stored during the parsing
  70  * of a single command (like $workspace).
  71  ******************************************************************************/
  72
  73 struct stack_entry {
  74     /* Just a pointer, not dynamically allocated. */
  75     const char *identifier;
  76     char *str;
  77 };
  78
  79 /* 10 entries should be enough for everybody. */
  80 static struct stack_entry stack[10];
  81
  82 /*
  83  * Pushes a string (identified by 'identifier') on the stack. We simply use a
  84  * single array, since the number of entries we have to store is very small.
  85  *
  86  */
  87 static void push_string(const char *identifier, char *str) {
  88     for (int c = 0; c < 10; c++) {
  89         if (stack[c].identifier != NULL)
  90             continue;
  91         /* Found a free slot, let’s store it here. */
  92         stack[c].identifier = identifier;
  93         stack[c].str = str;
  94         return;
  95     }
  96
  97     /* When we arrive here, the stack is full. This should not happen and
  98      * means there’s either a bug in this parser or the specification
  99      * contains a command with more than 10 identified tokens. */
 100     fprintf(stderr, "BUG: commands_parser stack full. This means either a bug "
 101                     "in the code, or a new command which contains more than "
 102                     "10 identified tokens.\n");
 103     exit(1);
 104 }
 105
 106 // XXX: ideally, this would be const char. need to check if that works with all
 107 // called functions.
 108 static char *get_string(const char *identifier) {
 109     for (int c = 0; c < 10; c++) {
 110         if (stack[c].identifier == NULL)
 111             break;
 112         if (strcmp(identifier, stack[c].identifier) == 0)
 113             return stack[c].str;
 114     }
 115     return NULL;
 116 }
 117
 118 static void clear_stack(void) {
 119     for (int c = 0; c < 10; c++) {
 120         if (stack[c].str != NULL)
 121             free(stack[c].str);
 122         stack[c].identifier = NULL;
 123         stack[c].str = NULL;
 124     }
 125 }
 126
 127 // TODO: remove this if it turns out we don’t need it for testing.
 128 #if 0
 129 /*******************************************************************************
 130  * A dynamically growing linked list which holds the criteria for the current
 131  * command.
 132  ******************************************************************************/
 133
 134 typedef struct criterion {
 135     char *type;
 136     char *value;
 137
 138     TAILQ_ENTRY(criterion) criteria;
 139 } criterion;
 140
 141 static TAILQ_HEAD(criteria_head, criterion) criteria =
 142   TAILQ_HEAD_INITIALIZER(criteria);
 143
 144 /*
 145  * Stores the given type/value in the list of criteria.
 146  * Accepts a pointer as first argument, since it is 'call'ed by the parser.
 147  *
 148  */
 149 static void push_criterion(void *unused_criteria, const char *type,
 150                            const char *value) {
 151     struct criterion *criterion = malloc(sizeof(struct criterion));
 152     criterion->type = strdup(type);
 153     criterion->value = strdup(value);
 154     TAILQ_INSERT_TAIL(&criteria, criterion, criteria);
 155 }
 156
 157 /*
 158  * Clears the criteria linked list.
 159  * Accepts a pointer as first argument, since it is 'call'ed by the parser.
 160  *
 161  */
 162 static void clear_criteria(void *unused_criteria) {
 163     struct criterion *criterion;
 164     while (!TAILQ_EMPTY(&criteria)) {
 165         criterion = TAILQ_FIRST(&criteria);
 166         free(criterion->type);
 167         free(criterion->value);
 168         TAILQ_REMOVE(&criteria, criterion, criteria);
 169         free(criterion);
 170     }
 171 }
 172 #endif
 173
 174 /*******************************************************************************
 175  * The parser itself.
 176  ******************************************************************************/
 177
 178 static cmdp_state state;
 179 #ifndef TEST_PARSER
 180 static Match current_match;
 181 #endif
 182 static struct CommandResult subcommand_output;
 183 static struct CommandResult command_output;
 184
 185 #include "GENERATED_call.h"
 186
 187
 188 static void next_state(const cmdp_token *token) {
 189     if (token->next_state == __CALL) {
 190         subcommand_output.json_gen = command_output.json_gen;
 191         subcommand_output.needs_tree_render = false;
 192         GENERATED_call(token->extra.call_identifier, &subcommand_output);
 193         /* If any subcommand requires a tree_render(), we need to make the
 194          * whole parser result request a tree_render(). */
 195         if (subcommand_output.needs_tree_render)
 196             command_output.needs_tree_render = true;
 197         clear_stack();
 198         return;
 199     }
 200
 201     state = token->next_state;
 202     if (state == INITIAL) {
 203         clear_stack();
 204     }
 205 }
 206
 207 /* TODO: Return parsing errors via JSON. */
 208 struct CommandResult *parse_command(const char *input) {
 209     DLOG("COMMAND: *%s*\n", input);
 210     state = INITIAL;
 211
 212 /* A YAJL JSON generator used for formatting replies. */
 213 #if YAJL_MAJOR >= 2
 214     command_output.json_gen = yajl_gen_alloc(NULL);
 215 #else
 216     command_output.json_gen = yajl_gen_alloc(NULL, NULL);
 217 #endif
 218
 219     y(array_open);
 220     command_output.needs_tree_render = false;
 221
 222     const char *walk = input;
 223     const size_t len = strlen(input);
 224     int c;
 225     const cmdp_token *token;
 226     bool token_handled;
 227
 228     // TODO: make this testable
 229 #ifndef TEST_PARSER
 230     cmd_criteria_init(&current_match, &subcommand_output);
 231 #endif
 232
 233     /* The "<=" operator is intentional: We also handle the terminating 0-byte
 234      * explicitly by looking for an 'end' token. */
 235     while ((walk - input) <= len) {
 236         /* skip whitespace and newlines before every token */
 237         while ((*walk == ' ' || *walk == '\t' ||
 238                 *walk == '\r' || *walk == '\n') && *walk != '\0')
 239             walk++;
 240
 241         cmdp_token_ptr *ptr = &(tokens[state]);
 242         token_handled = false;
 243         for (c = 0; c < ptr->n; c++) {
 244             token = &(ptr->array[c]);
 245
 246             /* A literal. */
 247             if (token->name[0] == '\'') {
 248                 if (strncasecmp(walk, token->name + 1, strlen(token->name) - 1) == 0) {
 249                     if (token->identifier != NULL)
 250                         push_string(token->identifier, sstrdup(token->name + 1));
 251                     walk += strlen(token->name) - 1;
 252                     next_state(token);
 253                     token_handled = true;
 254                     break;
 255                 }
 256                 continue;
 257             }
 258
 259             if (strcmp(token->name, "string") == 0 ||
 260                 strcmp(token->name, "word") == 0) {
 261                 const char *beginning = walk;
 262                 /* Handle quoted strings (or words). */
 263                 if (*walk == '"') {
 264                     beginning++;
 265                     walk++;
 266                     while (*walk != '\0' && (*walk != '"' || *(walk-1) == '\\'))
 267                         walk++;
 268                 } else {
 269                     if (token->name[0] == 's') {
 270                         /* For a string (starting with 's'), the delimiters are
 271                          * comma (,) and semicolon (;) which introduce a new
 272                          * operation or command, respectively. Also, newlines
 273                          * end a command. */
 274                         while (*walk != ';' && *walk != ',' &&
 275                                *walk != '\0' && *walk != '\r' &&
 276                                *walk != '\n')
 277                             walk++;
 278                     } else {
 279                         /* For a word, the delimiters are white space (' ' or
 280                          * '\t'), closing square bracket (]), comma (,) and
 281                          * semicolon (;). */
 282                         while (*walk != ' ' && *walk != '\t' &&
 283                                *walk != ']' && *walk != ',' &&
 284                                *walk !=  ';' && *walk != '\r' &&
 285                                *walk != '\n' && *walk != '\0')
 286                             walk++;
 287                     }
 288                 }
 289                 if (walk != beginning) {
 290                     char *str = scalloc(walk-beginning + 1);
 291                     /* We copy manually to handle escaping of characters. */
 292                     int inpos, outpos;
 293                     for (inpos = 0, outpos = 0;
 294                          inpos < (walk-beginning);
 295                          inpos++, outpos++) {
 296                         /* We only handle escaped double quotes to not break
 297                          * backwards compatibility with people using \w in
 298                          * regular expressions etc. */
 299                         if (beginning[inpos] == '\\' && beginning[inpos+1] == '"')
 300                             inpos++;
 301                         str[outpos] = beginning[inpos];
 302                     }
 303                     if (token->identifier)
 304                         push_string(token->identifier, str);
 305                     /* If we are at the end of a quoted string, skip the ending
 306                      * double quote. */
 307                     if (*walk == '"')
 308                         walk++;
 309                     next_state(token);
 310                     token_handled = true;
 311                     break;
 312                 }
 313             }
 314
 315             if (strcmp(token->name, "end") == 0) {
 316                 if (*walk == '\0' || *walk == ',' || *walk == ';') {
 317                     next_state(token);
 318                     token_handled = true;
 319                     /* To make sure we start with an appropriate matching
 320                      * datastructure for commands which do *not* specify any
 321                      * criteria, we re-initialize the criteria system after
 322                      * every command. */
 323                     // TODO: make this testable
 324 #ifndef TEST_PARSER
 325                     if (*walk == '\0' || *walk == ';')
 326                         cmd_criteria_init(&current_match, &subcommand_output);
 327 #endif
 328                     walk++;
 329                     break;
 330                }
 331            }
 332         }
 333
 334         if (!token_handled) {
 335             /* Figure out how much memory we will need to fill in the names of
 336              * all tokens afterwards. */
 337             int tokenlen = 0;
 338             for (c = 0; c < ptr->n; c++)
 339                 tokenlen += strlen(ptr->array[c].name) + strlen("'', ");
 340
 341             /* Build up a decent error message. We include the problem, the
 342              * full input, and underline the position where the parser
 343              * currently is. */
 344             char *errormessage;
 345             char *possible_tokens = smalloc(tokenlen + 1);
 346             char *tokenwalk = possible_tokens;
 347             for (c = 0; c < ptr->n; c++) {
 348                 token = &(ptr->array[c]);
 349                 if (token->name[0] == '\'') {
 350                     /* A literal is copied to the error message enclosed with
 351                      * single quotes. */
 352                     *tokenwalk++ = '\'';
 353                     strcpy(tokenwalk, token->name + 1);
 354                     tokenwalk += strlen(token->name + 1);
 355                     *tokenwalk++ = '\'';
 356                 } else {
 357                     /* Any other token is copied to the error message enclosed
 358                      * with angle brackets. */
 359                     *tokenwalk++ = '<';
 360                     strcpy(tokenwalk, token->name);
 361                     tokenwalk += strlen(token->name);
 362                     *tokenwalk++ = '>';
 363                 }
 364                 if (c < (ptr->n - 1)) {
 365                     *tokenwalk++ = ',';
 366                     *tokenwalk++ = ' ';
 367                 }
 368             }
 369             *tokenwalk = '\0';
 370             sasprintf(&errormessage, "Expected one of these tokens: %s",
 371                       possible_tokens);
 372             free(possible_tokens);
 373
 374             /* Contains the same amount of characters as 'input' has, but with
 375              * the unparseable part highlighted using ^ characters. */
 376             char *position = smalloc(len + 1);
 377             for (const char *copywalk = input; *copywalk != '\0'; copywalk++)
 378                 position[(copywalk - input)] = (copywalk >= walk ? '^' : ' ');
 379             position[len] = '\0';
 380
 381             ELOG("%s\n", errormessage);
 382             ELOG("Your command: %s\n", input);
 383             ELOG("              %s\n", position);
 384
 385             /* Format this error message as a JSON reply. */
 386             y(map_open);
 387             ystr("success");
 388             y(bool, false);
 389             ystr("error");
 390             ystr(errormessage);
 391             ystr("input");
 392             ystr(input);
 393             ystr("errorposition");
 394             ystr(position);
 395             y(map_close);
 396
 397             free(position);
 398             free(errormessage);
 399             clear_stack();
 400             break;
 401         }
 402     }
 403
 404     y(array_close);
 405
 406     return &command_output;
 407 }
 408
 409 /*******************************************************************************
 410  * Code for building the stand-alone binary test.commands_parser which is used
 411  * by t/187-commands-parser.t.
 412  ******************************************************************************/
 413
 414 #ifdef TEST_PARSER
 415
 416 /*
 417  * Logs the given message to stdout while prefixing the current time to it,
 418  * but only if debug logging was activated.
 419  * This is to be called by DLOG() which includes filename/linenumber
 420  *
 421  */
 422 void debuglog(char *fmt, ...) {
 423     va_list args;
 424
 425     va_start(args, fmt);
 426     fprintf(stdout, "# ");
 427     vfprintf(stdout, fmt, args);
 428     va_end(args);
 429 }
 430
 431 void errorlog(char *fmt, ...) {
 432     va_list args;
 433
 434     va_start(args, fmt);
 435     vfprintf(stderr, fmt, args);
 436     va_end(args);
 437 }
 438
 439 int main(int argc, char *argv[]) {
 440     if (argc < 2) {
 441         fprintf(stderr, "Syntax: %s <command>\n", argv[0]);
 442         return 1;
 443     }
 444     parse_command(argv[1]);
 445 }
 446 #endif