i3/include/commands_parser.h

/*
 * vim:ts=4:sw=4:expandtab
 *
 * i3 - an improved dynamic tiling window manager
 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
 *
 * commands.c: all command functions (see commands_parser.c)
 *
 */
#ifndef _COMMANDS_PARSER_H
#define _COMMANDS_PARSER_H

char *parse_command(const char *input);

#endif
Implement a new parser for commands. (+test) On the rationale of using a custom parser instead of a lex/yacc one, see this quote from src/commands_parser.c: We use a hand-written parser instead of lex/yacc because our commands are easy for humans, not for computers. Thus, it’s quite hard to specify a context-free grammar for the commands. A PEG grammar would be easier, but there’s downsides to every PEG parser generator I have come accross so far. This parser is basically a state machine which looks for literals or strings and can push either on a stack. After identifying a literal or string, it will either transition to the current state, to a different state, or call a function (like cmd_move()). Special care has been taken that error messages are useful and the code is well testable (when compiled with -DTEST_PARSER it will output to stdout instead of actually calling any function). During the migration phase (I plan to completely switch to this parser before 4.2 will be released), the new parser will parse every command you send to i3 and save the resulting call stack. Then, the old parser will parse your input and actually execute the commands. Afterwards, both call stacks will be compared and any differences will be logged. The new parser works with 100% of the test suite and produces identical call stacks. 2012-01-14 14:53:29 -05:00			`/*`
			`* vim:ts=4:sw=4:expandtab`
			`*`
			`* i3 - an improved dynamic tiling window manager`
			`* © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)`
			`*`
			`* commands.c: all command functions (see commands_parser.c)`
			`*`
			`*/`
			`#ifndef _COMMANDS_PARSER_H`
			`#define _COMMANDS_PARSER_H`

			`char parse_command(const char input);`

			`#endif`