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>
107 # TODO: new_float is not in the userguide yet
108 # TODO: pixel is not in the userguide yet
110 border = 'normal', 'pixel'
112 border = '1pixel', 'none'
113 -> call cfg_new_window($windowtype, $border, -1)
115 state NEW_WINDOW_PIXELS:
117 -> call cfg_new_window($windowtype, $border, 2)
119 -> NEW_WINDOW_PIXELS_PX
121 state NEW_WINDOW_PIXELS_PX:
125 -> call cfg_new_window($windowtype, $border, &width)
127 # hide_edge_borders <none|vertical|horizontal|both>
128 # also hide_edge_borders <bool> for compatibility
129 state HIDE_EDGE_BORDERS:
130 hide_borders = 'none', 'vertical', 'horizontal', 'both'
131 -> call cfg_hide_edge_borders($hide_borders)
132 hide_borders = '1', 'yes', 'true', 'on', 'enable', 'active'
133 -> call cfg_hide_edge_borders($hide_borders)
135 # for_window <criteria> command
138 -> call cfg_criteria_init(FOR_WINDOW_COMMAND); CRITERIA
140 state FOR_WINDOW_COMMAND:
142 -> call cfg_for_window($command)
144 # assign <criteria> [→] workspace
147 -> call cfg_criteria_init(ASSIGN_WORKSPACE); CRITERIA
149 state ASSIGN_WORKSPACE:
153 -> call cfg_assign($workspace)
155 # no_focus <criteria>
158 -> call cfg_criteria_init(NO_FOCUS_END); CRITERIA
162 -> call cfg_no_focus()
164 # Criteria: Used by for_window and assign.
166 ctype = 'class' -> CRITERION
167 ctype = 'instance' -> CRITERION
168 ctype = 'window_role' -> CRITERION
169 ctype = 'con_id' -> CRITERION
170 ctype = 'id' -> CRITERION
171 ctype = 'window_type' -> CRITERION
172 ctype = 'con_mark' -> CRITERION
173 ctype = 'title' -> CRITERION
174 ctype = 'urgent' -> CRITERION
176 -> call cfg_criteria_pop_state()
183 -> call cfg_criteria_add($ctype, $cvalue); CRITERIA
185 # focus_follows_mouse bool
186 state FOCUS_FOLLOWS_MOUSE:
188 -> call cfg_focus_follows_mouse($value)
190 # mouse_warping warping_t
192 value = 'none', 'output'
193 -> call cfg_mouse_warping($value)
195 # force_focus_wrapping
196 state FORCE_FOCUS_WRAPPING:
198 -> call cfg_force_focus_wrapping($value)
201 state FORCE_XINERAMA:
203 -> call cfg_force_xinerama($value)
205 # workspace_back_and_forth
206 state WORKSPACE_BACK_AND_FORTH:
208 -> call cfg_workspace_back_and_forth($value)
211 # fake_outputs (for testcases)
214 -> call cfg_fake_outputs($outputs)
216 # force_display_urgency_hint <timeout> ms
217 state FORCE_DISPLAY_URGENCY_HINT:
219 -> FORCE_DISPLAY_URGENCY_HINT_MS
224 -> call cfg_show_marks($value)
226 state FORCE_DISPLAY_URGENCY_HINT_MS:
230 -> call cfg_force_display_urgency_hint(&duration_ms)
232 # delay_exit_on_zero_displays <delay> ms
233 state DELAY_EXIT_ON_ZERO_DISPLAYS:
235 -> DELAY_EXIT_ON_ZERO_DISPLAYS_MS
237 state DELAY_EXIT_ON_ZERO_DISPLAYS_MS:
241 -> call cfg_delay_exit_on_zero_displays(&duration_ms)
243 # focus_on_window_activation <smart|urgent|focus|none>
244 state FOCUS_ON_WINDOW_ACTIVATION:
246 -> call cfg_focus_on_window_activation($mode)
248 # workspace <workspace> output <output>
253 state WORKSPACE_OUTPUT:
255 -> WORKSPACE_OUTPUT_STR
257 state WORKSPACE_OUTPUT_STR:
259 -> call cfg_workspace($workspace, $output)
264 -> call cfg_ipc_socket($path)
266 # restart_state <path> (for testcases)
269 -> call cfg_restart_state($path)
271 # popup_during_fullscreen
272 state POPUP_DURING_FULLSCREEN:
273 value = 'ignore', 'leave_fullscreen', 'smart'
274 -> call cfg_popup_during_fullscreen($value)
276 # client.background <hexcolor>
279 -> call cfg_color_single($colorclass, $color)
281 # colorclass border background text indicator
286 state COLOR_BACKGROUND:
294 state COLOR_INDICATOR:
296 -> call cfg_color($colorclass, $border, $background, $text, $indicator)
298 -> call cfg_color($colorclass, $border, $background, $text, NULL)
300 # <exec|exec_always> [--no-startup-id] command
302 no_startup_id = '--no-startup-id'
305 -> call cfg_exec($exectype, $no_startup_id, $command)
310 -> call cfg_font($font)
314 release = '--release'
318 whole_window = '--whole-window'
320 modifiers = 'Mod1', 'Mod2', 'Mod3', 'Mod4', 'Mod5', 'Shift', 'Control', 'Ctrl', 'Mode_switch', '$mod'
328 release = '--release'
332 whole_window = '--whole-window'
335 -> call cfg_binding($bindtype, $modifiers, $key, $release, $border, $whole_window, $command)
337 ################################################################################
339 ################################################################################
343 -> call cfg_enter_mode($modename); MODEBRACE
354 '#' -> MODE_IGNORE_LINE
355 'set' -> MODE_IGNORE_LINE
356 bindtype = 'bindsym', 'bindcode', 'bind'
361 # We ignore comments and 'set' lines (variables).
362 state MODE_IGNORE_LINE:
367 release = '--release'
371 whole_window = '--whole-window'
373 modifiers = 'Mod1', 'Mod2', 'Mod3', 'Mod4', 'Mod5', 'Shift', 'Control', 'Ctrl', 'Mode_switch', '$mod'
380 state MODE_BINDCOMMAND:
381 release = '--release'
385 whole_window = '--whole-window'
388 -> call cfg_mode_binding($bindtype, $modifiers, $key, $release, $border, $whole_window, $command); MODE
390 ################################################################################
391 # Bar configuration (i3bar)
392 ################################################################################
403 '#' -> BAR_IGNORE_LINE
404 'set' -> BAR_IGNORE_LINE
405 'i3bar_command' -> BAR_BAR_COMMAND
406 'status_command' -> BAR_STATUS_COMMAND
407 'socket_path' -> BAR_SOCKET_PATH
409 'hidden_state' -> BAR_HIDDEN_STATE
411 'modifier' -> BAR_MODIFIER
412 'wheel_up_cmd' -> BAR_WHEEL_UP_CMD
413 'wheel_down_cmd' -> BAR_WHEEL_DOWN_CMD
414 'position' -> BAR_POSITION
415 'output' -> BAR_OUTPUT
416 'tray_output' -> BAR_TRAY_OUTPUT
418 'separator_symbol' -> BAR_SEPARATOR_SYMBOL
419 'binding_mode_indicator' -> BAR_BINDING_MODE_INDICATOR
420 'workspace_buttons' -> BAR_WORKSPACE_BUTTONS
421 'strip_workspace_numbers' -> BAR_STRIP_WORKSPACE_NUMBERS
422 'verbose' -> BAR_VERBOSE
423 'colors' -> BAR_COLORS_BRACE
425 -> call cfg_bar_finish(); INITIAL
427 # We ignore comments and 'set' lines (variables).
428 state BAR_IGNORE_LINE:
432 state BAR_BAR_COMMAND:
434 -> call cfg_bar_i3bar_command($command); BAR
436 state BAR_STATUS_COMMAND:
438 -> call cfg_bar_status_command($command); BAR
440 state BAR_SOCKET_PATH:
442 -> call cfg_bar_socket_path($path); BAR
445 mode = 'dock', 'hide', 'invisible'
446 -> call cfg_bar_mode($mode); BAR
448 state BAR_HIDDEN_STATE:
449 hidden_state = 'hide', 'show'
450 -> call cfg_bar_hidden_state($hidden_state); BAR
454 -> call cfg_bar_id($bar_id); BAR
457 modifier = 'Mod1', 'Mod2', 'Mod3', 'Mod4', 'Mod5', 'Control', 'Ctrl', 'Shift'
458 -> call cfg_bar_modifier($modifier); BAR
460 state BAR_WHEEL_UP_CMD:
462 -> call cfg_bar_wheel_up_cmd($command); BAR
464 state BAR_WHEEL_DOWN_CMD:
466 -> call cfg_bar_wheel_down_cmd($command); BAR
469 position = 'top', 'bottom'
470 -> call cfg_bar_position($position); BAR
474 -> call cfg_bar_output($output); BAR
476 state BAR_TRAY_OUTPUT:
478 -> call cfg_bar_tray_output($output); BAR
482 -> call cfg_bar_font($font); BAR
484 state BAR_SEPARATOR_SYMBOL:
486 -> call cfg_bar_separator_symbol($separator); BAR
488 state BAR_BINDING_MODE_INDICATOR:
490 -> call cfg_bar_binding_mode_indicator($value); BAR
492 state BAR_WORKSPACE_BUTTONS:
494 -> call cfg_bar_workspace_buttons($value); BAR
496 state BAR_STRIP_WORKSPACE_NUMBERS:
498 -> call cfg_bar_strip_workspace_numbers($value); BAR
502 -> call cfg_bar_verbose($value); BAR
504 state BAR_COLORS_BRACE:
512 '#' -> BAR_COLORS_IGNORE_LINE
513 'set' -> BAR_COLORS_IGNORE_LINE
514 colorclass = 'background', 'statusline', 'separator'
516 colorclass = 'focused_workspace', 'active_workspace', 'inactive_workspace', 'urgent_workspace'
521 # We ignore comments and 'set' lines (variables).
522 state BAR_COLORS_IGNORE_LINE:
526 state BAR_COLORS_SINGLE:
528 -> call cfg_bar_color_single($colorclass, $color); BAR_COLORS
530 state BAR_COLORS_BORDER:
532 -> BAR_COLORS_BACKGROUND
534 state BAR_COLORS_BACKGROUND:
538 state BAR_COLORS_TEXT:
540 -> call cfg_bar_color($colorclass, $border, $background, NULL); BAR_COLORS
542 -> call cfg_bar_color($colorclass, $border, $background, $text); BAR_COLORS