1 # vim:ts=2:sw=2:expandtab
3 # i3 - an improved dynamic tiling window manager
4 # © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6 # parser-specs/config.spec: Specification file for generate-command-parser.pl
7 # which will generate the appropriate header files for our C parser.
9 # Use :source highlighting.vim in vim to get syntax highlighting
12 # TODO: should we implement an include statement for the criteria part so we DRY?
15 # We have an end token here for all the commands which just call some
16 # function without using an explicit 'end' token.
21 bindtype = 'bindsym', 'bindcode', 'bind' -> BINDING
25 'floating_minimum_size' -> FLOATING_MINIMUM_SIZE_WIDTH
26 'floating_maximum_size' -> FLOATING_MAXIMUM_SIZE_WIDTH
27 'floating_modifier' -> FLOATING_MODIFIER
28 'default_orientation' -> DEFAULT_ORIENTATION
29 'workspace_layout' -> WORKSPACE_LAYOUT
30 windowtype = 'new_window', 'new_float' -> NEW_WINDOW
31 'hide_edge_borders' -> HIDE_EDGE_BORDERS
32 'for_window' -> FOR_WINDOW
34 'no_focus' -> NO_FOCUS
35 'focus_follows_mouse' -> FOCUS_FOLLOWS_MOUSE
36 'mouse_warping' -> MOUSE_WARPING
37 'force_focus_wrapping' -> FORCE_FOCUS_WRAPPING
38 'force_xinerama', 'force-xinerama' -> FORCE_XINERAMA
39 'workspace_auto_back_and_forth' -> WORKSPACE_BACK_AND_FORTH
40 'fake_outputs', 'fake-outputs' -> FAKE_OUTPUTS
41 'force_display_urgency_hint' -> FORCE_DISPLAY_URGENCY_HINT
42 'delay_exit_on_zero_displays' -> DELAY_EXIT_ON_ZERO_DISPLAYS
43 'focus_on_window_activation' -> FOCUS_ON_WINDOW_ACTIVATION
44 'show_marks' -> SHOW_MARKS
45 'workspace' -> WORKSPACE
46 'ipc_socket', 'ipc-socket' -> IPC_SOCKET
47 'restart_state' -> RESTART_STATE
48 'popup_during_fullscreen' -> POPUP_DURING_FULLSCREEN
49 exectype = 'exec_always', 'exec' -> EXEC
50 colorclass = 'client.background'
52 colorclass = 'client.focused_inactive', 'client.focused', 'client.unfocused', 'client.urgent', 'client.placeholder'
55 # We ignore comments and 'set' lines (variables).
60 # floating_minimum_size <width> x <height>
61 state FLOATING_MINIMUM_SIZE_WIDTH:
63 -> FLOATING_MINIMUM_SIZE_X
65 state FLOATING_MINIMUM_SIZE_X:
67 -> FLOATING_MINIMUM_SIZE_HEIGHT
69 state FLOATING_MINIMUM_SIZE_HEIGHT:
71 -> call cfg_floating_minimum_size(&width, &height)
73 # floating_maximum_size <width> x <height>
74 state FLOATING_MAXIMUM_SIZE_WIDTH:
76 -> FLOATING_MAXIMUM_SIZE_X
78 state FLOATING_MAXIMUM_SIZE_X:
80 -> FLOATING_MAXIMUM_SIZE_HEIGHT
82 state FLOATING_MAXIMUM_SIZE_HEIGHT:
84 -> call cfg_floating_maximum_size(&width, &height)
86 # floating_modifier <modifier>
87 state FLOATING_MODIFIER:
88 modifiers = 'Mod1', 'Mod2', 'Mod3', 'Mod4', 'Mod5', 'Shift', 'Control', 'Ctrl'
93 -> call cfg_floating_modifier($modifiers)
95 # default_orientation <horizontal|vertical|auto>
96 state DEFAULT_ORIENTATION:
97 orientation = 'horizontal', 'vertical', 'auto'
98 -> call cfg_default_orientation($orientation)
100 # workspace_layout <default|stacking|tabbed>
101 state WORKSPACE_LAYOUT:
102 layout = 'default', 'stacking', 'stacked', 'tabbed'
103 -> call cfg_workspace_layout($layout)
105 # new_window <normal|1pixel|none>
106 # new_float <normal|1pixel|none>
108 border = 'normal', 'pixel'
110 border = '1pixel', 'none'
111 -> call cfg_new_window($windowtype, $border, -1)
113 state NEW_WINDOW_PIXELS:
115 -> call cfg_new_window($windowtype, $border, 2)
117 -> NEW_WINDOW_PIXELS_PX
119 state NEW_WINDOW_PIXELS_PX:
123 -> call cfg_new_window($windowtype, $border, &width)
125 # hide_edge_borders <none|vertical|horizontal|both>
126 # also hide_edge_borders <bool> for compatibility
127 state HIDE_EDGE_BORDERS:
128 hide_borders = 'none', 'vertical', 'horizontal', 'both'
129 -> call cfg_hide_edge_borders($hide_borders)
130 hide_borders = '1', 'yes', 'true', 'on', 'enable', 'active'
131 -> call cfg_hide_edge_borders($hide_borders)
133 # for_window <criteria> command
136 -> call cfg_criteria_init(FOR_WINDOW_COMMAND); CRITERIA
138 state FOR_WINDOW_COMMAND:
140 -> call cfg_for_window($command)
142 # assign <criteria> [→] workspace
145 -> call cfg_criteria_init(ASSIGN_WORKSPACE); CRITERIA
147 state ASSIGN_WORKSPACE:
151 -> call cfg_assign($workspace)
153 # no_focus <criteria>
156 -> call cfg_criteria_init(NO_FOCUS_END); CRITERIA
160 -> call cfg_no_focus()
162 # Criteria: Used by for_window and assign.
164 ctype = 'class' -> CRITERION
165 ctype = 'instance' -> CRITERION
166 ctype = 'window_role' -> CRITERION
167 ctype = 'con_id' -> CRITERION
168 ctype = 'id' -> CRITERION
169 ctype = 'window_type' -> CRITERION
170 ctype = 'con_mark' -> CRITERION
171 ctype = 'title' -> CRITERION
172 ctype = 'urgent' -> CRITERION
174 -> call cfg_criteria_pop_state()
181 -> call cfg_criteria_add($ctype, $cvalue); CRITERIA
183 # focus_follows_mouse bool
184 state FOCUS_FOLLOWS_MOUSE:
186 -> call cfg_focus_follows_mouse($value)
188 # mouse_warping warping_t
190 value = 'none', 'output'
191 -> call cfg_mouse_warping($value)
193 # force_focus_wrapping
194 state FORCE_FOCUS_WRAPPING:
196 -> call cfg_force_focus_wrapping($value)
199 state FORCE_XINERAMA:
201 -> call cfg_force_xinerama($value)
203 # workspace_back_and_forth
204 state WORKSPACE_BACK_AND_FORTH:
206 -> call cfg_workspace_back_and_forth($value)
209 # fake_outputs (for testcases)
212 -> call cfg_fake_outputs($outputs)
214 # force_display_urgency_hint <timeout> ms
215 state FORCE_DISPLAY_URGENCY_HINT:
217 -> FORCE_DISPLAY_URGENCY_HINT_MS
222 -> call cfg_show_marks($value)
224 state FORCE_DISPLAY_URGENCY_HINT_MS:
228 -> call cfg_force_display_urgency_hint(&duration_ms)
230 # delay_exit_on_zero_displays <delay> ms
231 state DELAY_EXIT_ON_ZERO_DISPLAYS:
233 -> DELAY_EXIT_ON_ZERO_DISPLAYS_MS
235 state DELAY_EXIT_ON_ZERO_DISPLAYS_MS:
239 -> call cfg_delay_exit_on_zero_displays(&duration_ms)
241 # focus_on_window_activation <smart|urgent|focus|none>
242 state FOCUS_ON_WINDOW_ACTIVATION:
244 -> call cfg_focus_on_window_activation($mode)
246 # workspace <workspace> output <output>
251 state WORKSPACE_OUTPUT:
253 -> WORKSPACE_OUTPUT_STR
255 state WORKSPACE_OUTPUT_STR:
257 -> call cfg_workspace($workspace, $output)
262 -> call cfg_ipc_socket($path)
264 # restart_state <path> (for testcases)
267 -> call cfg_restart_state($path)
269 # popup_during_fullscreen
270 state POPUP_DURING_FULLSCREEN:
271 value = 'ignore', 'leave_fullscreen', 'smart'
272 -> call cfg_popup_during_fullscreen($value)
274 # client.background <hexcolor>
277 -> call cfg_color_single($colorclass, $color)
279 # colorclass border background text indicator
284 state COLOR_BACKGROUND:
292 state COLOR_INDICATOR:
294 -> call cfg_color($colorclass, $border, $background, $text, $indicator)
296 -> call cfg_color($colorclass, $border, $background, $text, NULL)
298 # <exec|exec_always> [--no-startup-id] command
300 no_startup_id = '--no-startup-id'
303 -> call cfg_exec($exectype, $no_startup_id, $command)
308 -> call cfg_font($font)
312 release = '--release'
316 whole_window = '--whole-window'
318 modifiers = 'Mod1', 'Mod2', 'Mod3', 'Mod4', 'Mod5', 'Shift', 'Control', 'Ctrl', 'Mode_switch', '$mod'
326 release = '--release'
330 whole_window = '--whole-window'
333 -> call cfg_binding($bindtype, $modifiers, $key, $release, $border, $whole_window, $command)
335 ################################################################################
337 ################################################################################
341 -> call cfg_enter_mode($modename); MODEBRACE
352 '#' -> MODE_IGNORE_LINE
353 'set' -> MODE_IGNORE_LINE
354 bindtype = 'bindsym', 'bindcode', 'bind'
359 # We ignore comments and 'set' lines (variables).
360 state MODE_IGNORE_LINE:
365 release = '--release'
369 whole_window = '--whole-window'
371 modifiers = 'Mod1', 'Mod2', 'Mod3', 'Mod4', 'Mod5', 'Shift', 'Control', 'Ctrl', 'Mode_switch', '$mod'
378 state MODE_BINDCOMMAND:
379 release = '--release'
383 whole_window = '--whole-window'
386 -> call cfg_mode_binding($bindtype, $modifiers, $key, $release, $border, $whole_window, $command); MODE
388 ################################################################################
389 # Bar configuration (i3bar)
390 ################################################################################
396 -> call cfg_bar_start(); BAR
401 '#' -> BAR_IGNORE_LINE
402 'set' -> BAR_IGNORE_LINE
403 'i3bar_command' -> BAR_BAR_COMMAND
404 'status_command' -> BAR_STATUS_COMMAND
405 'socket_path' -> BAR_SOCKET_PATH
407 'hidden_state' -> BAR_HIDDEN_STATE
409 'modifier' -> BAR_MODIFIER
410 'wheel_up_cmd' -> BAR_WHEEL_UP_CMD
411 'wheel_down_cmd' -> BAR_WHEEL_DOWN_CMD
412 'bindsym' -> BAR_BINDSYM
413 'position' -> BAR_POSITION
414 'output' -> BAR_OUTPUT
415 'tray_output' -> BAR_TRAY_OUTPUT
417 'separator_symbol' -> BAR_SEPARATOR_SYMBOL
418 'binding_mode_indicator' -> BAR_BINDING_MODE_INDICATOR
419 'workspace_buttons' -> BAR_WORKSPACE_BUTTONS
420 'strip_workspace_numbers' -> BAR_STRIP_WORKSPACE_NUMBERS
421 'verbose' -> BAR_VERBOSE
422 'colors' -> BAR_COLORS_BRACE
424 -> call cfg_bar_finish(); INITIAL
426 # We ignore comments and 'set' lines (variables).
427 state BAR_IGNORE_LINE:
431 state BAR_BAR_COMMAND:
433 -> call cfg_bar_i3bar_command($command); BAR
435 state BAR_STATUS_COMMAND:
437 -> call cfg_bar_status_command($command); BAR
439 state BAR_SOCKET_PATH:
441 -> call cfg_bar_socket_path($path); BAR
444 mode = 'dock', 'hide', 'invisible'
445 -> call cfg_bar_mode($mode); BAR
447 state BAR_HIDDEN_STATE:
448 hidden_state = 'hide', 'show'
449 -> call cfg_bar_hidden_state($hidden_state); BAR
453 -> call cfg_bar_id($bar_id); BAR
456 modifier = 'Mod1', 'Mod2', 'Mod3', 'Mod4', 'Mod5', 'Control', 'Ctrl', 'Shift'
457 -> call cfg_bar_modifier($modifier); BAR
459 state BAR_WHEEL_UP_CMD:
461 -> call cfg_bar_wheel_up_cmd($command); BAR
463 state BAR_WHEEL_DOWN_CMD:
465 -> call cfg_bar_wheel_down_cmd($command); BAR
469 -> BAR_BINDSYM_COMMAND
471 state BAR_BINDSYM_COMMAND:
473 -> call cfg_bar_bindsym($button, $command); BAR
476 position = 'top', 'bottom'
477 -> call cfg_bar_position($position); BAR
481 -> call cfg_bar_output($output); BAR
483 state BAR_TRAY_OUTPUT:
485 -> call cfg_bar_tray_output($output); BAR
489 -> call cfg_bar_font($font); BAR
491 state BAR_SEPARATOR_SYMBOL:
493 -> call cfg_bar_separator_symbol($separator); BAR
495 state BAR_BINDING_MODE_INDICATOR:
497 -> call cfg_bar_binding_mode_indicator($value); BAR
499 state BAR_WORKSPACE_BUTTONS:
501 -> call cfg_bar_workspace_buttons($value); BAR
503 state BAR_STRIP_WORKSPACE_NUMBERS:
505 -> call cfg_bar_strip_workspace_numbers($value); BAR
509 -> call cfg_bar_verbose($value); BAR
511 state BAR_COLORS_BRACE:
519 '#' -> BAR_COLORS_IGNORE_LINE
520 'set' -> BAR_COLORS_IGNORE_LINE
521 colorclass = 'background', 'statusline', 'separator'
523 colorclass = 'focused_workspace', 'active_workspace', 'inactive_workspace', 'urgent_workspace', 'binding_mode'
528 # We ignore comments and 'set' lines (variables).
529 state BAR_COLORS_IGNORE_LINE:
533 state BAR_COLORS_SINGLE:
535 -> call cfg_bar_color_single($colorclass, $color); BAR_COLORS
537 state BAR_COLORS_BORDER:
539 -> BAR_COLORS_BACKGROUND
541 state BAR_COLORS_BACKGROUND:
545 state BAR_COLORS_TEXT:
547 -> call cfg_bar_color($colorclass, $border, $background, NULL); BAR_COLORS
549 -> call cfg_bar_color($colorclass, $border, $background, $text); BAR_COLORS