gri3-wm/include/commands.h

320 lines
6.6 KiB
C
Raw Normal View History

/*
* vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
* © 2009 Michael Stapelberg and contributors (see also: LICENSE)
*
* commands.c: all command functions (see commands_parser.c)
*
*/
#pragma once
#include "commands_parser.h"
/** The beginning of the prototype for every cmd_ function. */
#define I3_CMD Match *current_match, struct CommandResultIR *cmd_output
2012-01-27 23:32:40 +01:00
/**
* Initializes the specified 'Match' data structure and the initial state of
* commands.c for matching target windows of a command.
*
*/
void cmd_criteria_init(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* A match specification just finished (the closing square bracket was found),
* so we filter the list of owindows.
*
*/
void cmd_criteria_match_windows(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Interprets a ctype=cvalue pair and adds it to the current match
* specification.
*
*/
void cmd_criteria_add(I3_CMD, const char *ctype, const char *cvalue);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move [window|container] [to] workspace
* next|prev|next_on_output|prev_on_output'.
*
*/
void cmd_move_con_to_workspace(I3_CMD, const char *which);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move [window|container] [to] workspace back_and_forth'.
*
*/
void cmd_move_con_to_workspace_back_and_forth(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move [window|container] [to] workspace <name>'.
*
*/
void cmd_move_con_to_workspace_name(I3_CMD, const char *name);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move [window|container] [to] workspace number <number>'.
*
*/
void cmd_move_con_to_workspace_number(I3_CMD, const char *which);
2015-09-05 08:31:45 +02:00
/**
* Implementation of 'resize set <px> [px] <px> [px]'.
*
*/
void cmd_resize_set(I3_CMD, long cwidth, long cheight);
2015-09-05 08:31:45 +02:00
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'resize grow|shrink <direction> [<px> px] [or <ppt> ppt]'.
*
*/
void cmd_resize(I3_CMD, const char *way, const char *direction, long resize_px, long resize_ppt);
2012-01-27 23:32:40 +01:00
/**
2015-06-09 23:13:40 +02:00
* Implementation of 'border normal|pixel [<n>]', 'border none|1pixel|toggle'.
2012-01-27 23:32:40 +01:00
*
*/
void cmd_border(I3_CMD, const char *border_style_str, const char *border_width);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'nop <comment>'.
*
*/
void cmd_nop(I3_CMD, const char *comment);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'append_layout <path>'.
*
*/
void cmd_append_layout(I3_CMD, const char *path);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'workspace next|prev|next_on_output|prev_on_output'.
*
*/
void cmd_workspace(I3_CMD, const char *which);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'workspace [--no-auto-back-and-forth] number <number>'
*
*/
void cmd_workspace_number(I3_CMD, const char *which, const char *no_auto_back_and_forth);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'workspace back_and_forth'.
*
*/
void cmd_workspace_back_and_forth(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'workspace [--no-auto-back-and-forth] <name>'
2012-01-27 23:32:40 +01:00
*
*/
void cmd_workspace_name(I3_CMD, const char *name, const char *no_auto_back_and_forth);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'mark [--add|--replace] [--toggle] <mark>'
2012-01-27 23:32:40 +01:00
*
*/
void cmd_mark(I3_CMD, const char *mark, const char *mode, const char *toggle);
2013-07-16 00:33:14 +02:00
/**
* Implementation of 'unmark [mark]'
*
*/
void cmd_unmark(I3_CMD, const char *mark);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'mode <string>'.
*
*/
void cmd_mode(I3_CMD, const char *mode);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move [window|container] [to] output <str>'.
*
*/
void cmd_move_con_to_output(I3_CMD, const char *name);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move [window|container] [to] mark <str>'.
*
*/
void cmd_move_con_to_mark(I3_CMD, const char *mark);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'floating enable|disable|toggle'
*
*/
void cmd_floating(I3_CMD, const char *floating_mode);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move workspace to [output] <str>'.
*
*/
void cmd_move_workspace_to_output(I3_CMD, const char *name);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'split v|h|vertical|horizontal'.
*
*/
void cmd_split(I3_CMD, const char *direction);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'kill [window|client]'.
2012-01-27 23:32:40 +01:00
*
*/
void cmd_kill(I3_CMD, const char *kill_mode_str);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'exec [--no-startup-id] <command>'.
*
*/
void cmd_exec(I3_CMD, const char *nosn, const char *command);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'focus left|right|up|down'.
*
*/
void cmd_focus_direction(I3_CMD, const char *direction);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'focus tiling|floating|mode_toggle'.
*
*/
void cmd_focus_window_mode(I3_CMD, const char *window_mode);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'focus parent|child'.
*
*/
void cmd_focus_level(I3_CMD, const char *level);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'focus'.
*
*/
void cmd_focus(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'fullscreen [enable|disable|toggle] [global]'.
2012-01-27 23:32:40 +01:00
*
*/
void cmd_fullscreen(I3_CMD, const char *action, const char *fullscreen_mode);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'sticky enable|disable|toggle'.
*
*/
void cmd_sticky(I3_CMD, const char *action);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move <direction> [<pixels> [px]]'.
*
*/
void cmd_move_direction(I3_CMD, const char *direction, long move_px);
2012-01-27 23:32:40 +01:00
/**
Introduce splith/splitv layouts, remove orientation With this commit, the "default" layout is replaced by the splith and splitv layouts. splith is equivalent to default with orientation horizontal and splitv is equivalent to default with orientation vertical. The "split h" and "split v" commands continue to work as before, they split the current container and you will end up in a split container with layout splith (after "split h") or splitv (after "split v"). To change a splith container into a splitv container, use either "layout splitv" or "layout toggle split". The latter command is used in the default config as mod+l (previously "layout default"). In case you have "layout default" in your config file, it is recommended to just replace it by "layout toggle split", which will work as "layout default" did before when pressing it once, but toggle between horizontal/vertical when pressing it repeatedly. The rationale behind this commit is that it’s cleaner to have all parameters that influence how windows are rendered in the layout itself rather than having a special parameter in combination with only one layout. This enables us to change existing split containers in all cases without breaking existing features (see ticket #464). Also, users should feel more confident about whether they are actually splitting or just changing an existing split container now. As a nice side-effect, this commit brings back the "layout toggle" feature we once had in i3 version 3 (see the userguide). AFAIK, it is safe to use in-place restart to upgrade into versions after this commit (switching to an older version will break your layout, though). Fixes #464
2012-08-04 03:04:00 +02:00
* Implementation of 'layout default|stacked|stacking|tabbed|splitv|splith'.
2012-01-27 23:32:40 +01:00
*
*/
void cmd_layout(I3_CMD, const char *layout_str);
2012-01-27 23:32:40 +01:00
Introduce splith/splitv layouts, remove orientation With this commit, the "default" layout is replaced by the splith and splitv layouts. splith is equivalent to default with orientation horizontal and splitv is equivalent to default with orientation vertical. The "split h" and "split v" commands continue to work as before, they split the current container and you will end up in a split container with layout splith (after "split h") or splitv (after "split v"). To change a splith container into a splitv container, use either "layout splitv" or "layout toggle split". The latter command is used in the default config as mod+l (previously "layout default"). In case you have "layout default" in your config file, it is recommended to just replace it by "layout toggle split", which will work as "layout default" did before when pressing it once, but toggle between horizontal/vertical when pressing it repeatedly. The rationale behind this commit is that it’s cleaner to have all parameters that influence how windows are rendered in the layout itself rather than having a special parameter in combination with only one layout. This enables us to change existing split containers in all cases without breaking existing features (see ticket #464). Also, users should feel more confident about whether they are actually splitting or just changing an existing split container now. As a nice side-effect, this commit brings back the "layout toggle" feature we once had in i3 version 3 (see the userguide). AFAIK, it is safe to use in-place restart to upgrade into versions after this commit (switching to an older version will break your layout, though). Fixes #464
2012-08-04 03:04:00 +02:00
/**
* Implementation of 'layout toggle [all|split]'.
*
*/
void cmd_layout_toggle(I3_CMD, const char *toggle_mode);
Introduce splith/splitv layouts, remove orientation With this commit, the "default" layout is replaced by the splith and splitv layouts. splith is equivalent to default with orientation horizontal and splitv is equivalent to default with orientation vertical. The "split h" and "split v" commands continue to work as before, they split the current container and you will end up in a split container with layout splith (after "split h") or splitv (after "split v"). To change a splith container into a splitv container, use either "layout splitv" or "layout toggle split". The latter command is used in the default config as mod+l (previously "layout default"). In case you have "layout default" in your config file, it is recommended to just replace it by "layout toggle split", which will work as "layout default" did before when pressing it once, but toggle between horizontal/vertical when pressing it repeatedly. The rationale behind this commit is that it’s cleaner to have all parameters that influence how windows are rendered in the layout itself rather than having a special parameter in combination with only one layout. This enables us to change existing split containers in all cases without breaking existing features (see ticket #464). Also, users should feel more confident about whether they are actually splitting or just changing an existing split container now. As a nice side-effect, this commit brings back the "layout toggle" feature we once had in i3 version 3 (see the userguide). AFAIK, it is safe to use in-place restart to upgrade into versions after this commit (switching to an older version will break your layout, though). Fixes #464
2012-08-04 03:04:00 +02:00
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'exit'.
2012-01-27 23:32:40 +01:00
*
*/
void cmd_exit(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'reload'.
2012-01-27 23:32:40 +01:00
*
*/
void cmd_reload(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'restart'.
2012-01-27 23:32:40 +01:00
*
*/
void cmd_restart(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'open'.
2012-01-27 23:32:40 +01:00
*
*/
void cmd_open(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'focus output <output>'.
*
*/
void cmd_focus_output(I3_CMD, const char *name);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move [window|container] [to] [absolute] position <px> [px] <px> [px]
*
*/
void cmd_move_window_to_position(I3_CMD, const char *method, long x, long y);
/**
* Implementation of 'move [window|container] [to] [absolute] position center
*
*/
void cmd_move_window_to_center(I3_CMD, const char *method);
/**
* Implementation of 'move [window|container] [to] position mouse'
*
*/
void cmd_move_window_to_mouse(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'move scratchpad'.
*
*/
void cmd_move_scratchpad(I3_CMD);
2012-01-27 23:32:40 +01:00
/**
* Implementation of 'scratchpad show'.
*
*/
void cmd_scratchpad_show(I3_CMD);
/**
* Implementation of 'title_format <format>'
*
*/
void cmd_title_format(I3_CMD, const char *format);
/**
* Implementation of 'rename workspace <name> to <name>'
*
*/
void cmd_rename_workspace(I3_CMD, const char *old_name, const char *new_name);
introduced i3 command for changing the hidden state and the mode of i3bar The hidden_state and mode of each i3bar instance can now be controlled from within i3. Therefore, two new i3 command were introduced: _ bar hidden_state show|hide|toggle [<bar_id>] show: always show the bar hide: normal hide mode toggle: toggle between show and hide (individually for each bar) _ bar mode dock|hide|invisible|toggle [<bar_id>] hide,dock: like before invisible: always keep the bar hidden toggle: toggle between dock and hide (individually for each bar) This patch introduces a hidden_state ("hidden_state hide|show") in the barconfig, which indicates the current hidden_state of each i3bar instance. It only affects the bar when in hide mode. Additionally, a new invisible mode was introduced. In order to change the hidden_state or mode of the bar from i3, a barconfig-update event was introduced, for which a bar can subscribe and the bar then gets notified about the currently set hidden_state and mode in its barconfig. For convenience, an id field ("id <bar_id>") was added to the barconfig, where one can set the desired id for the corresponding bar. If the id is not specified, i3 will deterministically choose an id; otherwise, with the previous random approach for finding a new id, which is actually not shared with i3bar, as it would determine its id on startup, the event-subscription would be destroyed on reload. Still, this issue remains when manually changing the bar_id in the config and then reloading. fixes #833, #651
2013-05-25 14:30:00 +02:00
/**
* Implementation of 'bar (hidden_state hide|show|toggle)|(mode dock|hide|invisible|toggle) [<bar_id>]'
*
*/
void cmd_bar(I3_CMD, const char *bar_type, const char *bar_value, const char *bar_id);
introduced i3 command for changing the hidden state and the mode of i3bar The hidden_state and mode of each i3bar instance can now be controlled from within i3. Therefore, two new i3 command were introduced: _ bar hidden_state show|hide|toggle [<bar_id>] show: always show the bar hide: normal hide mode toggle: toggle between show and hide (individually for each bar) _ bar mode dock|hide|invisible|toggle [<bar_id>] hide,dock: like before invisible: always keep the bar hidden toggle: toggle between dock and hide (individually for each bar) This patch introduces a hidden_state ("hidden_state hide|show") in the barconfig, which indicates the current hidden_state of each i3bar instance. It only affects the bar when in hide mode. Additionally, a new invisible mode was introduced. In order to change the hidden_state or mode of the bar from i3, a barconfig-update event was introduced, for which a bar can subscribe and the bar then gets notified about the currently set hidden_state and mode in its barconfig. For convenience, an id field ("id <bar_id>") was added to the barconfig, where one can set the desired id for the corresponding bar. If the id is not specified, i3 will deterministically choose an id; otherwise, with the previous random approach for finding a new id, which is actually not shared with i3bar, as it would determine its id on startup, the event-subscription would be destroyed on reload. Still, this issue remains when manually changing the bar_id in the config and then reloading. fixes #833, #651
2013-05-25 14:30:00 +02:00
/*
* Implementation of 'shmlog <size>|toggle|on|off'
*
*/
void cmd_shmlog(I3_CMD, const char *argument);
/*
* Implementation of 'debuglog toggle|on|off'
*
*/
void cmd_debuglog(I3_CMD, const char *argument);