X-Git-Url: https://git.sur5r.net/?p=i3%2Fi3;a=blobdiff_plain;f=src%2Fcommands_parser.c;h=4299c008335570ced9c8daebc12bdaa1cefd74e9;hp=af0afe02a69b80cb13d3eb0d50e2dc30661333ac;hb=HEAD;hpb=fc27c19761b47fa449514395f7ea2a21654f515d diff --git a/src/commands_parser.c b/src/commands_parser.c index af0afe02..4299c008 100644 --- a/src/commands_parser.c +++ b/src/commands_parser.c @@ -2,7 +2,7 @@ * vim:ts=4:sw=4:expandtab * * i3 - an improved dynamic tiling window manager - * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE) + * © 2009 Michael Stapelberg and contributors (see also: LICENSE) * * commands_parser.c: hand-written parser to parse commands (commands are what * you bind on keys and what you can send to i3 using the IPC interface, like @@ -11,7 +11,7 @@ * 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. + * there’s downsides to every PEG parser generator I have come across 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 @@ -23,6 +23,8 @@ * instead of actually calling any function). * */ +#include "all.h" + #include #include #include @@ -30,8 +32,9 @@ #include #include -#include "all.h" -#include "queue.h" +// Macros to make the YAJL API a bit easier to use. +#define y(x, ...) (command_output.json_gen != NULL ? yajl_gen_##x(command_output.json_gen, ##__VA_ARGS__) : 0) +#define ystr(str) (command_output.json_gen != NULL ? yajl_gen_string(command_output.json_gen, (unsigned char *)str, strlen(str)) : 0) /******************************************************************************* * The data structures used for parsing. Essentially the current state and a @@ -41,7 +44,7 @@ * input parser-specs/commands.spec. ******************************************************************************/ -#include "GENERATED_enums.h" +#include "GENERATED_command_enums.h" typedef struct token { char *name; @@ -58,7 +61,7 @@ typedef struct tokenptr { int n; } cmdp_token_ptr; -#include "GENERATED_tokens.h" +#include "GENERATED_command_tokens.h" /******************************************************************************* * The (small) stack where identified literals are stored during the parsing @@ -68,7 +71,14 @@ typedef struct tokenptr { struct stack_entry { /* Just a pointer, not dynamically allocated. */ const char *identifier; - char *str; + enum { + STACK_STR = 0, + STACK_LONG = 1, + } type; + union { + char *str; + long num; + } val; }; /* 10 entries should be enough for everybody. */ @@ -85,86 +95,75 @@ static void push_string(const char *identifier, char *str) { continue; /* Found a free slot, let’s store it here. */ stack[c].identifier = identifier; - stack[c].str = str; + stack[c].val.str = str; + stack[c].type = STACK_STR; + return; + } + + /* When we arrive here, the stack is full. This should not happen and + * means there’s either a bug in this parser or the specification + * contains a command with more than 10 identified tokens. */ + fprintf(stderr, "BUG: commands_parser stack full. This means either a bug " + "in the code, or a new command which contains more than " + "10 identified tokens.\n"); + exit(1); +} + +// TODO move to a common util +static void push_long(const char *identifier, long num) { + for (int c = 0; c < 10; c++) { + if (stack[c].identifier != NULL) { + continue; + } + + stack[c].identifier = identifier; + stack[c].val.num = num; + stack[c].type = STACK_LONG; return; } /* When we arrive here, the stack is full. This should not happen and * means there’s either a bug in this parser or the specification * contains a command with more than 10 identified tokens. */ - printf("argh! stack full\n"); + fprintf(stderr, "BUG: commands_parser stack full. This means either a bug " + "in the code, or a new command which contains more than " + "10 identified tokens.\n"); exit(1); } -// XXX: ideally, this would be const char. need to check if that works with all -// called functions. -static char *get_string(const char *identifier) { - DLOG("Getting string %s from stack...\n", identifier); +// TODO move to a common util +static const char *get_string(const char *identifier) { for (int c = 0; c < 10; c++) { if (stack[c].identifier == NULL) break; if (strcmp(identifier, stack[c].identifier) == 0) - return stack[c].str; + return stack[c].val.str; } return NULL; } -static void clear_stack() { - DLOG("clearing stack.\n"); +// TODO move to a common util +static long get_long(const char *identifier) { for (int c = 0; c < 10; c++) { - if (stack[c].str != NULL) - free(stack[c].str); - stack[c].identifier = NULL; - stack[c].str = NULL; + if (stack[c].identifier == NULL) + break; + if (strcmp(identifier, stack[c].identifier) == 0) + return stack[c].val.num; } -} - -// TODO: remove this if it turns out we don’t need it for testing. -#if 0 -/******************************************************************************* - * A dynamically growing linked list which holds the criteria for the current - * command. - ******************************************************************************/ - -typedef struct criterion { - char *type; - char *value; - - TAILQ_ENTRY(criterion) criteria; -} criterion; -static TAILQ_HEAD(criteria_head, criterion) criteria = - TAILQ_HEAD_INITIALIZER(criteria); - -/* - * Stores the given type/value in the list of criteria. - * Accepts a pointer as first argument, since it is 'call'ed by the parser. - * - */ -static void push_criterion(void *unused_criteria, const char *type, - const char *value) { - struct criterion *criterion = malloc(sizeof(struct criterion)); - criterion->type = strdup(type); - criterion->value = strdup(value); - TAILQ_INSERT_TAIL(&criteria, criterion, criteria); + return 0; } -/* - * Clears the criteria linked list. - * Accepts a pointer as first argument, since it is 'call'ed by the parser. - * - */ -static void clear_criteria(void *unused_criteria) { - struct criterion *criterion; - while (!TAILQ_EMPTY(&criteria)) { - criterion = TAILQ_FIRST(&criteria); - free(criterion->type); - free(criterion->value); - TAILQ_REMOVE(&criteria, criterion, criteria); - free(criterion); +// TODO move to a common util +static void clear_stack(void) { + for (int c = 0; c < 10; c++) { + if (stack[c].type == STACK_STR) + free(stack[c].val.str); + stack[c].identifier = NULL; + stack[c].val.str = NULL; + stack[c].val.num = 0; } } -#endif /******************************************************************************* * The parser itself. @@ -174,16 +173,21 @@ static cmdp_state state; #ifndef TEST_PARSER static Match current_match; #endif -static char *json_output; - -#include "GENERATED_call.h" +static struct CommandResultIR subcommand_output; +static struct CommandResultIR command_output; +#include "GENERATED_command_call.h" static void next_state(const cmdp_token *token) { if (token->next_state == __CALL) { - DLOG("should call stuff, yay. call_id = %d\n", - token->extra.call_identifier); - json_output = GENERATED_call(token->extra.call_identifier); + subcommand_output.json_gen = command_output.json_gen; + subcommand_output.needs_tree_render = false; + GENERATED_call(token->extra.call_identifier, &subcommand_output); + state = subcommand_output.next_state; + /* If any subcommand requires a tree_render(), we need to make the + * whole parser result request a tree_render(). */ + if (subcommand_output.needs_tree_render) + command_output.needs_tree_render = true; clear_stack(); return; } @@ -194,11 +198,79 @@ static void next_state(const cmdp_token *token) { } } -/* TODO: Return parsing errors via JSON. */ -char *parse_command(const char *input) { - DLOG("new parser handling: %s\n", input); +/* + * Parses a string (or word, if as_word is true). Extracted out of + * parse_command so that it can be used in src/workspace.c for interpreting + * workspace commands. + * + */ +char *parse_string(const char **walk, bool as_word) { + const char *beginning = *walk; + /* Handle quoted strings (or words). */ + if (**walk == '"') { + beginning++; + (*walk)++; + for (; **walk != '\0' && **walk != '"'; (*walk)++) + if (**walk == '\\' && *(*walk + 1) != '\0') + (*walk)++; + } else { + if (!as_word) { + /* For a string (starting with 's'), the delimiters are + * comma (,) and semicolon (;) which introduce a new + * operation or command, respectively. Also, newlines + * end a command. */ + while (**walk != ';' && **walk != ',' && + **walk != '\0' && **walk != '\r' && + **walk != '\n') + (*walk)++; + } else { + /* For a word, the delimiters are white space (' ' or + * '\t'), closing square bracket (]), comma (,) and + * semicolon (;). */ + while (**walk != ' ' && **walk != '\t' && + **walk != ']' && **walk != ',' && + **walk != ';' && **walk != '\r' && + **walk != '\n' && **walk != '\0') + (*walk)++; + } + } + if (*walk == beginning) + return NULL; + + char *str = scalloc(*walk - beginning + 1, 1); + /* We copy manually to handle escaping of characters. */ + int inpos, outpos; + for (inpos = 0, outpos = 0; + inpos < (*walk - beginning); + inpos++, outpos++) { + /* We only handle escaped double quotes and backslashes to not break + * backwards compatibility with people using \w in regular expressions + * etc. */ + if (beginning[inpos] == '\\' && (beginning[inpos + 1] == '"' || beginning[inpos + 1] == '\\')) + inpos++; + str[outpos] = beginning[inpos]; + } + + return str; +} + +/* + * Parses and executes the given command. If a caller-allocated yajl_gen is + * passed, a json reply will be generated in the format specified by the ipc + * protocol. Pass NULL if no json reply is required. + * + * Free the returned CommandResult with command_result_free(). + */ +CommandResult *parse_command(const char *input, yajl_gen gen) { + DLOG("COMMAND: *%s*\n", input); state = INITIAL; - json_output = NULL; + CommandResult *result = scalloc(1, sizeof(CommandResult)); + + /* A YAJL JSON generator used for formatting replies. */ + command_output.json_gen = gen; + + y(array_open); + command_output.needs_tree_render = false; const char *walk = input; const size_t len = strlen(input); @@ -206,33 +278,30 @@ char *parse_command(const char *input) { const cmdp_token *token; bool token_handled; - // TODO: make this testable +// TODO: make this testable #ifndef TEST_PARSER - cmd_criteria_init(¤t_match); + cmd_criteria_init(¤t_match, &subcommand_output); #endif /* The "<=" operator is intentional: We also handle the terminating 0-byte * explicitly by looking for an 'end' token. */ - while ((walk - input) <= len) { - /* skip whitespace before every token */ - while ((*walk == ' ' || *walk == '\t') && *walk != '\0') + while ((size_t)(walk - input) <= len) { + /* skip whitespace and newlines before every token */ + while ((*walk == ' ' || *walk == '\t' || + *walk == '\r' || *walk == '\n') && + *walk != '\0') walk++; - DLOG("remaining input = %s\n", walk); - cmdp_token_ptr *ptr = &(tokens[state]); token_handled = false; for (c = 0; c < ptr->n; c++) { token = &(ptr->array[c]); - DLOG("trying token %d = %s\n", c, token->name); /* A literal. */ if (token->name[0] == '\'') { - DLOG("literal\n"); if (strncasecmp(walk, token->name + 1, strlen(token->name) - 1) == 0) { - DLOG("found literal, moving to next state\n"); if (token->identifier != NULL) - push_string(token->identifier, strdup(token->name + 1)); + push_string(token->identifier, sstrdup(token->name + 1)); walk += strlen(token->name) - 1; next_state(token); token_handled = true; @@ -241,38 +310,35 @@ char *parse_command(const char *input) { continue; } + if (strcmp(token->name, "number") == 0) { + /* Handle numbers. We only accept decimal numbers for now. */ + char *end = NULL; + errno = 0; + long int num = strtol(walk, &end, 10); + if ((errno == ERANGE && (num == LONG_MIN || num == LONG_MAX)) || + (errno != 0 && num == 0)) + continue; + + /* No valid numbers found */ + if (end == walk) + continue; + + if (token->identifier != NULL) + push_long(token->identifier, num); + + /* Set walk to the first non-number character */ + walk = end; + next_state(token); + token_handled = true; + break; + } + if (strcmp(token->name, "string") == 0 || strcmp(token->name, "word") == 0) { - DLOG("parsing this as a string\n"); - const char *beginning = walk; - /* Handle quoted strings (or words). */ - if (*walk == '"') { - beginning++; - walk++; - while (*walk != '"' || *(walk-1) == '\\') - walk++; - } else { - if (token->name[0] == 's') { - /* For a string (starting with 's'), the delimiters are - * comma (,) and semicolon (;) which introduce a new - * operation or command, respectively. */ - while (*walk != ';' && *walk != ',' && *walk != '\0') - walk++; - } else { - /* For a word, the delimiters are white space (' ' or - * '\t'), closing square bracket (]), comma (,) and - * semicolon (;). */ - while (*walk != ' ' && *walk != '\t' && *walk != ']' && - *walk != ',' && *walk != ';' && *walk != '\0') - walk++; - } - } - if (walk != beginning) { - char *str = calloc(walk-beginning + 1, 1); - strncpy(str, beginning, walk-beginning); + char *str = parse_string(&walk, (token->name[0] != 's')); + if (str != NULL) { if (token->identifier) push_string(token->identifier, str); - DLOG("str is \"%s\"\n", str); /* If we are at the end of a quoted string, skip the ending * double quote. */ if (*walk == '"') @@ -284,24 +350,22 @@ char *parse_command(const char *input) { } if (strcmp(token->name, "end") == 0) { - DLOG("checking for the end token.\n"); if (*walk == '\0' || *walk == ',' || *walk == ';') { - DLOG("yes, indeed. end\n"); next_state(token); token_handled = true; - /* To make sure we start with an appropriate matching +/* To make sure we start with an appropriate matching * datastructure for commands which do *not* specify any * criteria, we re-initialize the criteria system after * every command. */ - // TODO: make this testable +// TODO: make this testable #ifndef TEST_PARSER if (*walk == '\0' || *walk == ';') - cmd_criteria_init(¤t_match); + cmd_criteria_init(¤t_match, &subcommand_output); #endif walk++; break; - } - } + } + } } if (!token_handled) { @@ -315,7 +379,7 @@ char *parse_command(const char *input) { * full input, and underline the position where the parser * currently is. */ char *errormessage; - char *possible_tokens = malloc(tokenlen + 1); + char *possible_tokens = smalloc(tokenlen + 1); char *tokenwalk = possible_tokens; for (c = 0; c < ptr->n; c++) { token = &(ptr->array[c]); @@ -340,29 +404,62 @@ char *parse_command(const char *input) { } } *tokenwalk = '\0'; - asprintf(&errormessage, "Expected one of these tokens: %s", - possible_tokens); + sasprintf(&errormessage, "Expected one of these tokens: %s", + possible_tokens); free(possible_tokens); /* Contains the same amount of characters as 'input' has, but with * the unparseable part highlighted using ^ characters. */ - char *position = malloc(len + 1); + char *position = smalloc(len + 1); for (const char *copywalk = input; *copywalk != '\0'; copywalk++) position[(copywalk - input)] = (copywalk >= walk ? '^' : ' '); position[len] = '\0'; - printf("%s\n", errormessage); - printf("Your command: %s\n", input); - printf(" %s\n", position); + ELOG("%s\n", errormessage); + ELOG("Your command: %s\n", input); + ELOG(" %s\n", position); + + result->parse_error = true; + result->error_message = errormessage; + + /* Format this error message as a JSON reply. */ + y(map_open); + ystr("success"); + y(bool, false); + /* We set parse_error to true to distinguish this from other + * errors. i3-nagbar is spawned upon keypresses only for parser + * errors. */ + ystr("parse_error"); + y(bool, true); + ystr("error"); + ystr(errormessage); + ystr("input"); + ystr(input); + ystr("errorposition"); + ystr(position); + y(map_close); free(position); - free(errormessage); + clear_stack(); break; } } - DLOG("json_output = %s\n", json_output); - return json_output; + y(array_close); + + result->needs_tree_render = command_output.needs_tree_render; + return result; +} + +/* + * Frees a CommandResult + */ +void command_result_free(CommandResult *result) { + if (result == NULL) + return; + + FREE(result->error_message); + FREE(result); } /******************************************************************************* @@ -374,11 +471,11 @@ char *parse_command(const char *input) { /* * Logs the given message to stdout while prefixing the current time to it, - * but only if the corresponding debug loglevel was activated. + * but only if debug logging was activated. * This is to be called by DLOG() which includes filename/linenumber * */ -void debuglog(uint64_t lev, char *fmt, ...) { +void debuglog(char *fmt, ...) { va_list args; va_start(args, fmt); @@ -387,11 +484,25 @@ void debuglog(uint64_t lev, char *fmt, ...) { va_end(args); } +void errorlog(char *fmt, ...) { + va_list args; + + va_start(args, fmt); + vfprintf(stderr, fmt, args); + va_end(args); +} + int main(int argc, char *argv[]) { if (argc < 2) { fprintf(stderr, "Syntax: %s \n", argv[0]); return 1; } - parse_command(argv[1]); + yajl_gen gen = yajl_gen_alloc(NULL); + + CommandResult *result = parse_command(argv[1], gen); + + command_result_free(result); + + yajl_gen_free(gen); } #endif