i3/include/commands_parser.h
Michael Stapelberg e114b3dba2 Refactor the interface of commands.c
This change has two implications:

1) tree_render() will now be called precisely once for input which consists of
   multiple commands (like "focus left; focus right"). Also, the caller of
   parse_command() has to call it. This makes us able to fix tickets such as
   ticket #608 (where multiple tree_render() calls are noticable).

2) The output of a command is now a JSON array of return values of the
   individual subcommands. In the case of "focus left; focus right", this is:

   [{"success":true}, {"success":true}]

   While this is incompatible with what i3 returned before, the return value of
   commands was undocumented and therefore not subject to our API stability.
2012-02-15 20:57:25 +00:00

33 lines
970 B
C

/*
* 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
/*
* Holds the result of a call to any command. When calling
* parse_command("floating enable, border none"), the parser will internally
* use a struct CommandResult when calling cmd_floating and cmd_border.
* parse_command will also return another struct CommandResult, whose
* json_output is set to a map of individual json_outputs and whose
* needs_tree_trender is true if any individual needs_tree_render was true.
*
*/
struct CommandResult {
/* The JSON-serialized output of this command. */
char *json_output;
/* Whether the command requires calling tree_render. */
bool needs_tree_render;
};
struct CommandResult *parse_command(const char *input);
#endif