2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
7 * commands_parser.c: hand-written parser to parse commands (commands are what
8 * you bind on keys and what you can send to i3 using the IPC interface, like
9 * 'move left' or 'workspace 4').
11 * We use a hand-written parser instead of lex/yacc because our commands are
12 * easy for humans, not for computers. Thus, it’s quite hard to specify a
13 * context-free grammar for the commands. A PEG grammar would be easier, but
14 * there’s downsides to every PEG parser generator I have come accross so far.
16 * This parser is basically a state machine which looks for literals or strings
17 * and can push either on a stack. After identifying a literal or string, it
18 * will either transition to the current state, to a different state, or call a
19 * function (like cmd_move()).
21 * Special care has been taken that error messages are useful and the code is
22 * well testable (when compiled with -DTEST_PARSER it will output to stdout
23 * instead of actually calling any function).
35 /*******************************************************************************
36 * The data structures used for parsing. Essentially the current state and a
37 * list of tokens for that state.
39 * The GENERATED_* files are generated by generate-commands-parser.pl with the
40 * input parser-specs/commands.spec.
41 ******************************************************************************/
43 #include "GENERATED_enums.h"
45 typedef struct token {
48 /* This might be __CALL */
49 cmdp_state next_state;
51 uint16_t call_identifier;
55 typedef struct tokenptr {
60 #include "GENERATED_tokens.h"
62 /*******************************************************************************
63 * The (small) stack where identified literals are stored during the parsing
64 * of a single command (like $workspace).
65 ******************************************************************************/
68 /* Just a pointer, not dynamically allocated. */
69 const char *identifier;
73 /* 10 entries should be enough for everybody. */
74 static struct stack_entry stack[10];
77 * Pushes a string (identified by 'identifier') on the stack. We simply use a
78 * single array, since the number of entries we have to store is very small.
81 static void push_string(const char *identifier, char *str) {
82 for (int c = 0; c < 10; c++) {
83 if (stack[c].identifier != NULL)
85 /* Found a free slot, let’s store it here. */
86 stack[c].identifier = identifier;
91 /* When we arrive here, the stack is full. This should not happen and
92 * means there’s either a bug in this parser or the specification
93 * contains a command with more than 10 identified tokens. */
94 printf("argh! stack full\n");
98 // XXX: ideally, this would be const char. need to check if that works with all
100 static char *get_string(const char *identifier) {
101 DLOG("Getting string %s from stack...\n", identifier);
102 for (int c = 0; c < 10; c++) {
103 if (stack[c].identifier == NULL)
105 if (strcmp(identifier, stack[c].identifier) == 0)
111 static void clear_stack() {
112 DLOG("clearing stack.\n");
113 for (int c = 0; c < 10; c++) {
114 if (stack[c].str != NULL)
116 stack[c].identifier = NULL;
121 // TODO: remove this if it turns out we don’t need it for testing.
123 /*******************************************************************************
124 * A dynamically growing linked list which holds the criteria for the current
126 ******************************************************************************/
128 typedef struct criterion {
132 TAILQ_ENTRY(criterion) criteria;
135 static TAILQ_HEAD(criteria_head, criterion) criteria =
136 TAILQ_HEAD_INITIALIZER(criteria);
139 * Stores the given type/value in the list of criteria.
140 * Accepts a pointer as first argument, since it is 'call'ed by the parser.
143 static void push_criterion(void *unused_criteria, const char *type,
145 struct criterion *criterion = malloc(sizeof(struct criterion));
146 criterion->type = strdup(type);
147 criterion->value = strdup(value);
148 TAILQ_INSERT_TAIL(&criteria, criterion, criteria);
152 * Clears the criteria linked list.
153 * Accepts a pointer as first argument, since it is 'call'ed by the parser.
156 static void clear_criteria(void *unused_criteria) {
157 struct criterion *criterion;
158 while (!TAILQ_EMPTY(&criteria)) {
159 criterion = TAILQ_FIRST(&criteria);
160 free(criterion->type);
161 free(criterion->value);
162 TAILQ_REMOVE(&criteria, criterion, criteria);
168 /*******************************************************************************
170 ******************************************************************************/
172 static cmdp_state state;
174 static Match current_match;
176 static char *json_output;
178 #include "GENERATED_call.h"
181 static void next_state(const cmdp_token *token) {
182 if (token->next_state == __CALL) {
183 DLOG("should call stuff, yay. call_id = %d\n",
184 token->extra.call_identifier);
185 json_output = GENERATED_call(token->extra.call_identifier);
190 state = token->next_state;
191 if (state == INITIAL) {
196 /* TODO: Return parsing errors via JSON. */
197 char *parse_command(const char *input) {
198 DLOG("new parser handling: %s\n", input);
202 const char *walk = input;
203 const size_t len = strlen(input);
205 const cmdp_token *token;
208 // TODO: make this testable
210 cmd_criteria_init(¤t_match);
213 /* The "<=" operator is intentional: We also handle the terminating 0-byte
214 * explicitly by looking for an 'end' token. */
215 while ((walk - input) <= len) {
216 /* skip whitespace and newlines before every token */
217 while ((*walk == ' ' || *walk == '\t' ||
218 *walk == '\r' || *walk == '\n') && *walk != '\0')
221 DLOG("remaining input = %s\n", walk);
223 cmdp_token_ptr *ptr = &(tokens[state]);
224 token_handled = false;
225 for (c = 0; c < ptr->n; c++) {
226 token = &(ptr->array[c]);
227 DLOG("trying token %d = %s\n", c, token->name);
230 if (token->name[0] == '\'') {
232 if (strncasecmp(walk, token->name + 1, strlen(token->name) - 1) == 0) {
233 DLOG("found literal, moving to next state\n");
234 if (token->identifier != NULL)
235 push_string(token->identifier, sstrdup(token->name + 1));
236 walk += strlen(token->name) - 1;
238 token_handled = true;
244 if (strcmp(token->name, "string") == 0 ||
245 strcmp(token->name, "word") == 0) {
246 DLOG("parsing this as a string\n");
247 const char *beginning = walk;
248 /* Handle quoted strings (or words). */
252 while (*walk != '"' || *(walk-1) == '\\')
255 if (token->name[0] == 's') {
256 /* For a string (starting with 's'), the delimiters are
257 * comma (,) and semicolon (;) which introduce a new
258 * operation or command, respectively. Also, newlines
260 while (*walk != ';' && *walk != ',' &&
261 *walk != '\0' && *walk != '\r' &&
265 /* For a word, the delimiters are white space (' ' or
266 * '\t'), closing square bracket (]), comma (,) and
268 while (*walk != ' ' && *walk != '\t' &&
269 *walk != ']' && *walk != ',' &&
270 *walk != ';' && *walk != '\r' &&
271 *walk != '\n' && *walk != '\0')
275 if (walk != beginning) {
276 char *str = scalloc(walk-beginning + 1);
277 strncpy(str, beginning, walk-beginning);
278 if (token->identifier)
279 push_string(token->identifier, str);
280 DLOG("str is \"%s\"\n", str);
281 /* If we are at the end of a quoted string, skip the ending
286 token_handled = true;
291 if (strcmp(token->name, "end") == 0) {
292 DLOG("checking for the end token.\n");
293 if (*walk == '\0' || *walk == ',' || *walk == ';') {
294 DLOG("yes, indeed. end\n");
296 token_handled = true;
297 /* To make sure we start with an appropriate matching
298 * datastructure for commands which do *not* specify any
299 * criteria, we re-initialize the criteria system after
301 // TODO: make this testable
303 if (*walk == '\0' || *walk == ';')
304 cmd_criteria_init(¤t_match);
312 if (!token_handled) {
313 /* Figure out how much memory we will need to fill in the names of
314 * all tokens afterwards. */
316 for (c = 0; c < ptr->n; c++)
317 tokenlen += strlen(ptr->array[c].name) + strlen("'', ");
319 /* Build up a decent error message. We include the problem, the
320 * full input, and underline the position where the parser
323 char *possible_tokens = smalloc(tokenlen + 1);
324 char *tokenwalk = possible_tokens;
325 for (c = 0; c < ptr->n; c++) {
326 token = &(ptr->array[c]);
327 if (token->name[0] == '\'') {
328 /* A literal is copied to the error message enclosed with
331 strcpy(tokenwalk, token->name + 1);
332 tokenwalk += strlen(token->name + 1);
335 /* Any other token is copied to the error message enclosed
336 * with angle brackets. */
338 strcpy(tokenwalk, token->name);
339 tokenwalk += strlen(token->name);
342 if (c < (ptr->n - 1)) {
348 sasprintf(&errormessage, "Expected one of these tokens: %s",
350 free(possible_tokens);
352 /* Contains the same amount of characters as 'input' has, but with
353 * the unparseable part highlighted using ^ characters. */
354 char *position = smalloc(len + 1);
355 for (const char *copywalk = input; *copywalk != '\0'; copywalk++)
356 position[(copywalk - input)] = (copywalk >= walk ? '^' : ' ');
357 position[len] = '\0';
359 printf("%s\n", errormessage);
360 printf("Your command: %s\n", input);
361 printf(" %s\n", position);
369 DLOG("json_output = %s\n", json_output);
373 /*******************************************************************************
374 * Code for building the stand-alone binary test.commands_parser which is used
375 * by t/187-commands-parser.t.
376 ******************************************************************************/
381 * Logs the given message to stdout while prefixing the current time to it,
382 * but only if the corresponding debug loglevel was activated.
383 * This is to be called by DLOG() which includes filename/linenumber
386 void debuglog(uint64_t lev, char *fmt, ...) {
390 fprintf(stderr, "# ");
391 vfprintf(stderr, fmt, args);
395 int main(int argc, char *argv[]) {
397 fprintf(stderr, "Syntax: %s <command>\n", argv[0]);
400 parse_command(argv[1]);