]> git.sur5r.net Git - i3/i3/blob - parser-specs/commands.spec
Merge branch 'master' into next
[i3/i3] / parser-specs / commands.spec
1 # vim:ts=2:sw=2:expandtab
2 #
3 # i3 - an improved dynamic tiling window manager
4 # © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
5 #
6 # parser-specs/commands.spec: Specification file for generate-command-parser.pl
7 # which will generate the appropriate header files for our C parser.
8 #
9 # Use :source highlighting.vim in vim to get syntax highlighting
10 # for this file.
11
12 state INITIAL:
13   # We have an end token here for all the commands which just call some
14   # function without using an explicit 'end' token.
15   end ->
16   '[' -> call cmd_criteria_init(); CRITERIA
17   'move' -> MOVE
18   'exec' -> EXEC
19   'exit' -> call cmd_exit()
20   'restart' -> call cmd_restart()
21   'reload' -> call cmd_reload()
22   'shmlog' -> SHMLOG
23   'debuglog' -> DEBUGLOG
24   'border' -> BORDER
25   'layout' -> LAYOUT
26   'append_layout' -> APPEND_LAYOUT
27   'workspace' -> WORKSPACE
28   'focus' -> FOCUS
29   'kill' -> KILL
30   'open' -> call cmd_open()
31   'fullscreen' -> FULLSCREEN
32   'split' -> SPLIT
33   'floating' -> FLOATING
34   'mark' -> MARK
35   'unmark' -> UNMARK
36   'resize' -> RESIZE
37   'rename' -> RENAME
38   'nop' -> NOP
39   'scratchpad' -> SCRATCHPAD
40   'mode' -> MODE
41   'bar' -> BAR
42
43 state CRITERIA:
44   ctype = 'class' -> CRITERION
45   ctype = 'instance' -> CRITERION
46   ctype = 'window_role' -> CRITERION
47   ctype = 'con_id' -> CRITERION
48   ctype = 'id' -> CRITERION
49   ctype = 'con_mark' -> CRITERION
50   ctype = 'title' -> CRITERION
51   ctype = 'urgent' -> CRITERION
52   ']' -> call cmd_criteria_match_windows(); INITIAL
53
54 state CRITERION:
55   '=' -> CRITERION_STR
56
57 state CRITERION_STR:
58   cvalue = word
59       -> call cmd_criteria_add($ctype, $cvalue); CRITERIA
60
61 # exec [--no-startup-id] <command>
62 state EXEC:
63   nosn = '--no-startup-id'
64       ->
65   command = string
66       -> call cmd_exec($nosn, $command)
67
68 # shmlog <size>|toggle|on|off
69 state SHMLOG:
70   # argument may be a number
71   argument = string
72     -> call cmd_shmlog($argument)
73
74 # debuglog toggle|on|off
75 state DEBUGLOG:
76   argument = 'toggle', 'on', 'off'
77     -> call cmd_debuglog($argument)
78
79 # border normal|none|1pixel|toggle|1pixel
80 state BORDER:
81   border_style = 'normal', 'pixel'
82     -> BORDER_WIDTH
83   border_style = 'none', 'toggle'
84     -> call cmd_border($border_style, "0")
85   border_style = '1pixel'
86     -> call cmd_border($border_style, "1")
87
88 state BORDER_WIDTH:
89   end
90     -> call cmd_border($border_style, "2")
91   border_width = word
92     -> call cmd_border($border_style, $border_width)
93
94 # layout default|stacked|stacking|tabbed|splitv|splith
95 # layout toggle [split|all]
96 state LAYOUT:
97   layout_mode = 'default', 'stacked', 'stacking', 'tabbed', 'splitv', 'splith'
98       -> call cmd_layout($layout_mode)
99   'toggle'
100       -> LAYOUT_TOGGLE
101
102 # layout toggle [split|all]
103 state LAYOUT_TOGGLE:
104   end
105       -> call cmd_layout_toggle($toggle_mode)
106   toggle_mode = 'split', 'all'
107       -> call cmd_layout_toggle($toggle_mode)
108
109 # append_layout <path>
110 state APPEND_LAYOUT:
111   path = string -> call cmd_append_layout($path)
112
113 # workspace next|prev|next_on_output|prev_on_output
114 # workspace back_and_forth
115 # workspace <name>
116 # workspace number <number>
117 state WORKSPACE:
118   direction = 'next_on_output', 'prev_on_output', 'next', 'prev'
119       -> call cmd_workspace($direction)
120   'back_and_forth'
121       -> call cmd_workspace_back_and_forth()
122   'number'
123       -> WORKSPACE_NUMBER
124   workspace = string 
125       -> call cmd_workspace_name($workspace)
126
127 state WORKSPACE_NUMBER:
128   workspace = string
129       -> call cmd_workspace_number($workspace)
130
131 # focus left|right|up|down
132 # focus output <output>
133 # focus tiling|floating|mode_toggle
134 # focus parent|child
135 # focus
136 state FOCUS:
137   direction = 'left', 'right', 'up', 'down'
138       -> call cmd_focus_direction($direction)
139   'output'
140       -> FOCUS_OUTPUT
141   window_mode = 'tiling', 'floating', 'mode_toggle'
142       -> call cmd_focus_window_mode($window_mode)
143   level = 'parent', 'child'
144       -> call cmd_focus_level($level)
145   end
146       -> call cmd_focus()
147
148 state FOCUS_OUTPUT:
149   output = string
150       -> call cmd_focus_output($output)
151
152 # kill [window|client]
153 state KILL:
154   kill_mode = 'window', 'client'
155       -> call cmd_kill($kill_mode)
156   end
157       -> call cmd_kill($kill_mode)
158
159 # fullscreen [global]
160 state FULLSCREEN:
161   fullscreen_mode = 'global'
162       -> call cmd_fullscreen($fullscreen_mode)
163   end
164       -> call cmd_fullscreen($fullscreen_mode)
165
166 # split v|h|vertical|horizontal
167 state SPLIT:
168   direction = 'horizontal', 'vertical', 'v', 'h'
169       -> call cmd_split($direction)
170
171 # floating enable|disable|toggle
172 state FLOATING:
173   floating = 'enable', 'disable', 'toggle'
174       -> call cmd_floating($floating)
175
176 # mark <mark>
177 state MARK:
178   mark = string
179       -> call cmd_mark($mark)
180
181 # unmark [mark]
182 state UNMARK:
183   end
184       -> call cmd_unmark($mark)
185   mark = string
186       -> call cmd_unmark($mark)
187
188 # resize
189 state RESIZE:
190   way = 'grow', 'shrink'
191       -> RESIZE_DIRECTION
192
193 state RESIZE_DIRECTION:
194   direction = 'up', 'down', 'left', 'right', 'width', 'height'
195       -> RESIZE_PX
196
197 state RESIZE_PX:
198   resize_px = word
199       -> RESIZE_TILING
200   end
201       -> call cmd_resize($way, $direction, "10", "10")
202
203 state RESIZE_TILING:
204   'px'
205       ->
206   'or'
207       -> RESIZE_TILING_OR
208   end
209       -> call cmd_resize($way, $direction, $resize_px, "10")
210
211 state RESIZE_TILING_OR:
212   resize_ppt = word
213       -> RESIZE_TILING_FINAL
214
215 state RESIZE_TILING_FINAL:
216   'ppt', end
217       -> call cmd_resize($way, $direction, $resize_px, $resize_ppt)
218
219 # rename workspace <name> to <name>
220 # rename workspace to <name>
221 state RENAME:
222   'workspace'
223       -> RENAME_WORKSPACE
224
225 state RENAME_WORKSPACE:
226   old_name = 'to'
227       -> RENAME_WORKSPACE_LIKELY_TO
228   old_name = word
229       -> RENAME_WORKSPACE_TO
230
231 state RENAME_WORKSPACE_LIKELY_TO:
232   'to'
233       -> RENAME_WORKSPACE_NEW_NAME
234   new_name = word
235       -> call cmd_rename_workspace(NULL, $new_name)
236
237 state RENAME_WORKSPACE_TO:
238   'to'
239       -> RENAME_WORKSPACE_NEW_NAME
240
241 state RENAME_WORKSPACE_NEW_NAME:
242   end
243       -> call cmd_rename_workspace(NULL, "to")
244   new_name = string
245       -> call cmd_rename_workspace($old_name, $new_name)
246
247 # move <direction> [<pixels> [px]]
248 # move [window|container] [to] workspace [<str>|next|prev|next_on_output|prev_on_output|current]
249 # move [window|container] [to] output <str>
250 # move [window|container] [to] scratchpad
251 # move workspace to [output] <str>
252 # move scratchpad
253 # move [window|container] [to] [absolute] position [ [<pixels> [px] <pixels> [px]] | center ]
254 state MOVE:
255   'window'
256       ->
257   'container'
258       ->
259   'to'
260       ->
261   'workspace'
262       -> MOVE_WORKSPACE
263   'output'
264       -> MOVE_TO_OUTPUT
265   'scratchpad'
266       -> call cmd_move_scratchpad()
267   direction = 'left', 'right', 'up', 'down'
268       -> MOVE_DIRECTION
269   method = 'position'
270       -> MOVE_TO_POSITION
271   method = 'absolute'
272       -> MOVE_TO_ABSOLUTE_POSITION
273
274 state MOVE_DIRECTION:
275   pixels = word
276       -> MOVE_DIRECTION_PX
277   end
278       -> call cmd_move_direction($direction, "10")
279
280 state MOVE_DIRECTION_PX:
281   'px'
282       -> call cmd_move_direction($direction, $pixels)
283   end
284       -> call cmd_move_direction($direction, $pixels)
285
286 state MOVE_WORKSPACE:
287   'to '
288       -> MOVE_WORKSPACE_TO_OUTPUT
289   workspace = 'next_on_output', 'prev_on_output', 'next', 'prev', 'current'
290       -> call cmd_move_con_to_workspace($workspace)
291   'back_and_forth'
292       -> call cmd_move_con_to_workspace_back_and_forth()
293   'number'
294       -> MOVE_WORKSPACE_NUMBER
295   workspace = string
296       -> call cmd_move_con_to_workspace_name($workspace)
297
298 state MOVE_WORKSPACE_NUMBER:
299   number = string
300       -> call cmd_move_con_to_workspace_number($number)
301
302 state MOVE_TO_OUTPUT:
303   output = string
304       -> call cmd_move_con_to_output($output)
305
306 state MOVE_WORKSPACE_TO_OUTPUT:
307   'output'
308       ->
309   output = string
310       -> call cmd_move_workspace_to_output($output)
311
312 state MOVE_TO_ABSOLUTE_POSITION:
313   'position'
314       -> MOVE_TO_POSITION
315
316 state MOVE_TO_POSITION:
317   'center'
318       -> call cmd_move_window_to_center($method)
319   coord_x = word
320       -> MOVE_TO_POSITION_X
321
322 state MOVE_TO_POSITION_X:
323   'px'
324       ->
325   coord_y = word
326       -> MOVE_TO_POSITION_Y
327
328 state MOVE_TO_POSITION_Y:
329   'px', end
330       -> call cmd_move_window_to_position($method, $coord_x, $coord_y)
331
332 # mode <string>
333 state MODE:
334   mode = string
335       -> call cmd_mode($mode)
336
337 state NOP:
338   comment = string
339       -> call cmd_nop($comment)
340
341 state SCRATCHPAD:
342   'show'
343       -> call cmd_scratchpad_show()
344
345 # bar (hidden_state hide|show|toggle)|(mode dock|hide|invisible|toggle) [<bar_id>]
346 state BAR:
347   bar_type = 'hidden_state'
348       -> BAR_HIDDEN_STATE
349   bar_type = 'mode'
350       -> BAR_MODE
351
352 state BAR_HIDDEN_STATE:
353   bar_value = 'hide', 'show', 'toggle'
354       -> BAR_W_ID
355
356 state BAR_MODE:
357   bar_value = 'dock', 'hide', 'invisible', 'toggle'
358       -> BAR_W_ID
359
360 state BAR_W_ID:
361   bar_id = word
362       ->
363   end
364       -> call cmd_bar($bar_type, $bar_value, $bar_id)