2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
7 * include/data.h: This file defines all data structures used by i3
13 #define SN_API_NOT_YET_FROZEN 1
14 #include <libsn/sn-launcher.h>
16 #include <xcb/randr.h>
17 #include <xcb/xcb_atom.h>
26 * To get the big concept: There are helper structures like struct
27 * Workspace_Assignment. Every struct which is also defined as type (see
28 * forward definitions) is considered to be a major structure, thus important.
30 * The following things are all stored in a 'Con', from very high level (the
31 * biggest Cons) to very small (a single window):
33 * 1) X11 root window (as big as all your outputs combined)
34 * 2) output (like LVDS1)
35 * 3) content container, dockarea containers
38 * ... (you can arbitrarily nest split containers)
39 * 6) X11 window containers
43 /* Forward definitions */
44 typedef struct Binding Binding;
45 typedef struct Rect Rect;
46 typedef struct xoutput Output;
47 typedef struct Con Con;
48 typedef struct Match Match;
49 typedef struct Assignment Assignment;
50 typedef struct Window i3Window;
53 /******************************************************************************
55 *****************************************************************************/
56 typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
57 typedef enum { NO_ORIENTATION = 0, HORIZ, VERT } orientation_t;
58 typedef enum { BS_NORMAL = 0, BS_NONE = 1, BS_PIXEL = 2 } border_style_t;
60 /** parameter to specify whether tree_close() and x_window_kill() should kill
61 * only this specific window or the whole X11 client */
62 typedef enum { DONT_KILL_WINDOW = 0, KILL_WINDOW = 1, KILL_CLIENT = 2 } kill_window_t;
64 /** describes if the window is adjacent to the output (physical screen) edges. */
65 typedef enum { ADJ_NONE = 0,
66 ADJ_LEFT_SCREEN_EDGE = (1 << 0),
67 ADJ_RIGHT_SCREEN_EDGE = (1 << 1),
68 ADJ_UPPER_SCREEN_EDGE = (1 << 2),
69 ADJ_LOWER_SCREEN_EDGE = (1 << 4)} adjacent_t;
73 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
74 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
75 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
76 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
77 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
78 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
79 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
80 BIND_MODE_SWITCH = (1 << 8)
84 * Stores a rectangle, for example the size of a window, the child window etc.
85 * It needs to be packed so that the compiler will not add any padding bytes.
86 * (it is used in src/ewmh.c for example)
88 * Note that x and y can contain signed values in some cases (for example when
89 * used for the coordinates of a window, which can be set outside of the
90 * visible area, but not when specifying the position of a workspace for the
91 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
100 } __attribute__((packed));
103 * Stores the reserved pixels on each screen edge read from a
104 * _NET_WM_STRUT_PARTIAL.
115 * Stores a width/height pair, used as part of deco_render_params to check
116 * whether the rects width/height have changed.
119 struct width_height {
125 * Stores the parameters for rendering a window decoration. This structure is
126 * cached in every Con and no re-rendering will be done if the parameters have
127 * not changed (only the pixmaps will be copied).
130 struct deco_render_params {
131 struct Colortriple *color;
133 struct width_height con_rect;
134 struct width_height con_window_rect;
138 orientation_t parent_orientation;
142 * Stores which workspace (by name) goes to which output.
145 struct Workspace_Assignment {
149 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
152 struct Ignore_Event {
157 SLIST_ENTRY(Ignore_Event) ignore_events;
161 * Stores internal information about a startup sequence, like the workspace it
165 struct Startup_Sequence {
166 /** startup ID for this sequence, generated by libstartup-notification */
168 /** workspace on which this startup was initiated */
170 /** libstartup-notification context for this launch */
171 SnLauncherContext *context;
172 /** time at which this sequence should be deleted (after it was marked as
176 TAILQ_ENTRY(Startup_Sequence) sequences;
180 * Regular expression wrapper. It contains the pattern itself as a string (like
181 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
182 * pcre_extra data returned by pcre_study().
184 * This makes it easier to have a useful logfile, including the matching or
185 * non-matching pattern.
194 /******************************************************************************
196 *****************************************************************************/
199 * Holds a keybinding, consisting of a keycode combined with modifiers and the
200 * command which is executed as soon as the key is pressed (see src/cfgparse.y)
204 /** If true, the binding should be executed upon a KeyRelease event, not a
205 * KeyPress (the default). */
207 /* This binding will only be executed upon KeyPress events */
209 /* This binding will be executed either upon a KeyRelease event, or… */
210 B_UPON_KEYRELEASE = 1,
211 /* …upon a KeyRelease event, even if the modifiers don’t match. This
212 * state is triggered from get_binding() when the corresponding
213 * KeyPress (!) happens, so that users can release the modifier keys
214 * before releasing the actual key. */
215 B_UPON_KEYRELEASE_IGNORE_MODS = 2,
218 /** Symbol the user specified in configfile, if any. This needs to be
219 * stored with the binding to be able to re-convert it into a keycode
220 * if the keyboard mapping changes (using Xmodmap for example) */
223 /** Only in use if symbol != NULL. Gets set to the value to which the
224 * symbol got translated when binding. Useful for unbinding and
225 * checking which binding was used when a key press event comes in.
227 * This is an array of number_keycodes size. */
228 xcb_keycode_t *translated_to;
230 uint32_t number_keycodes;
232 /** Keycode to bind */
235 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
238 /** Command, like in command mode */
241 TAILQ_ENTRY(Binding) bindings;
245 * Holds a command specified by either an:
248 * in the config (see src/config.c)
252 /** Command, like in command mode */
254 /** no_startup_id flag for start_application(). Determines whether a
255 * startup notification context/ID should be created. */
257 TAILQ_ENTRY(Autostart) autostarts;
258 TAILQ_ENTRY(Autostart) autostarts_always;
262 * An Output is a physical output on your graphics driver. Outputs which
263 * are currently in use have (output->active == true). Each output has a
264 * position and a mode. An output usually corresponds to one connected
265 * screen (except if you are running multiple screens in clone mode).
269 /** Output id, so that we can requery the output directly later */
270 xcb_randr_output_t id;
271 /** Name of the output */
274 /** Pointer to the Con which represents this output */
277 /** Whether the output is currently active (has a CRTC attached with a
281 /** Internal flags, necessary for querying RandR screens (happens in
287 /** x, y, width, height */
290 TAILQ_ENTRY(xoutput) outputs;
294 * A 'Window' is a type which contains an xcb_window_t and all the related
295 * information (hints like _NET_WM_NAME for that window).
301 /** Holds the xcb_window_t (just an ID) for the leader window (logical
302 * parent for toolwindows and similar floating windows) */
304 xcb_window_t transient_for;
307 char *class_instance;
309 /** The name of the window. */
312 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
313 * sets "buddy list"). Useful to match specific windows in assignments or
317 /** Flag to force re-rendering the decoration upon changes */
320 /** Whether the application used _NET_WM_NAME */
321 bool uses_net_wm_name;
323 /** Whether the application needs to receive WM_TAKE_FOCUS */
324 bool needs_take_focus;
326 /** When this window was marked urgent. 0 means not urgent */
327 struct timeval urgent;
329 /** Whether this window accepts focus. We store this inverted so that the
330 * default will be 'accepts focus'. */
331 bool doesnt_accept_focus;
333 /** Whether the window says it is a dock window */
334 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
336 /** Pixels the window reserves. left/right/top/bottom */
337 struct reservedpx reserved;
339 /** Pointers to the Assignments which were already ran for this Window
340 * (assignments run only once) */
341 uint32_t nr_assignments;
342 Assignment **ran_assignments;
344 /** Depth of the window */
349 * A "match" is a data structure which acts like a mask or expression to match
350 * certain windows or not. For example, when using commands, you can specify a
351 * command like this: [title="*Firefox*"] kill. The title member of the match
352 * data structure will then be filled and i3 will check each window using
353 * match_matches_window() to find the windows affected by this command.
358 struct regex *application;
360 struct regex *instance;
377 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
379 /* Where the window looking for a match should be inserted:
381 * M_HERE = the matched container will be replaced by the window
383 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
384 * M_BELOW = the window will be inserted as a child of the matched container
388 enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
390 /* Whether this match was generated when restarting i3 inplace.
391 * Leads to not setting focus when managing a new window, because the old
392 * focus stack should be restored. */
395 TAILQ_ENTRY(Match) matches;
399 * An Assignment makes specific windows go to a specific workspace/output or
400 * run a command for that window. With this mechanism, the user can -- for
401 * example -- assign his browser to workspace "www". Checking if a window is
402 * assigned works by comparing the Match data structure with the window (see
403 * match_matches_window()).
407 /** type of this assignment:
409 * A_COMMAND = run the specified command for the matching window
410 * A_TO_WORKSPACE = assign the matching window to the specified workspace
411 * A_TO_OUTPUT = assign the matching window to the specified output
413 * While the type is a bitmask, only one value can be set at a time. It is
414 * a bitmask to allow filtering for multiple types, for example in the
415 * assignment_for() function.
420 A_COMMAND = (1 << 0),
421 A_TO_WORKSPACE = (1 << 1),
422 A_TO_OUTPUT = (1 << 2)
425 /** the criteria to check if a window matches */
428 /** destination workspace/output/command, depending on the type */
435 TAILQ_ENTRY(Assignment) assignments;
439 * A 'Con' represents everything from the X11 root window down to a single X11 window.
455 struct Rect window_rect;
456 struct Rect deco_rect;
457 /** the geometry this window requested when getting mapped */
458 struct Rect geometry;
462 /** the workspace number, if this Con is of type CT_WORKSPACE and the
463 * workspace is not a named workspace (for named workspaces, num == -1) */
466 /* a sticky-group is an identifier which bundles several containers to a
467 * group. The contents are shared between all of them, that is they are
468 * displayed on whichever of the containers is currently visible */
471 /* user-definable mark to jump to this container later */
476 /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
477 * apply an aspect ratio to windows (think of MPlayer) */
478 int proportional_width;
479 int proportional_height;
480 /* the wanted size of the window, used in combination with size
481 * increments (see below). */
485 /* the x11 border pixel attribute */
487 int current_border_width;
489 /* minimum increment size specified for the window (in pixels) */
491 int height_increment;
493 struct Window *window;
495 /* Should this container be marked urgent? This gets set when the window
496 * inside this container (if any) sets the urgency hint, for example. */
499 /* timer used for disabling urgency */
500 struct ev_timer *urgency_timer;
502 /* ids/pixmap/graphics context for the frame window */
505 xcb_gcontext_t pm_gc;
506 bool pixmap_recreated;
508 /** Cache for the decoration rendering */
509 struct deco_render_params *deco_render_params;
511 /* Only workspace-containers can have floating clients */
512 TAILQ_HEAD(floating_head, Con) floating_head;
514 TAILQ_HEAD(nodes_head, Con) nodes_head;
515 TAILQ_HEAD(focus_head, Con) focus_head;
517 TAILQ_HEAD(swallow_head, Match) swallow_head;
519 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
520 /* layout is the layout of this container: one of split[v|h], stacked or
521 * tabbed. Special containers in the tree (above workspaces) have special
522 * layouts like dockarea or output.
524 * last_split_layout is one of splitv or splith to support the old "layout
525 * default" command which by now should be "layout splitv" or "layout
526 * splith" explicitly.
528 * workspace_layout is only for type == CT_WORKSPACE cons. When you change
529 * the layout of a workspace without any children, i3 cannot just set the
530 * layout (because workspaces need to be splitv/splith to allow focus
531 * parent and opening new containers). Instead, it stores the requested
532 * layout in workspace_layout and creates a new split container with that
533 * layout whenever a new container is attached to the workspace. */
542 } layout, last_split_layout, workspace_layout;
543 border_style_t border_style;
544 /** floating? (= not in tiling layout) This cannot be simply a bool
545 * because we want to keep track of whether the status was set by the
546 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
547 * user. The user’s choice overwrites automatic mode, of course. The
548 * order of the values is important because we check with >=
549 * FLOATING_AUTO_ON if a client is floating. */
551 FLOATING_AUTO_OFF = 0,
552 FLOATING_USER_OFF = 1,
553 FLOATING_AUTO_ON = 2,
557 /** This counter contains the number of UnmapNotify events for this
558 * container (or, more precisely, for its ->frame) which should be ignored.
559 * UnmapNotify events need to be ignored when they are caused by i3 itself,
560 * for example when reparenting or when unmapping the window on a workspace
562 uint8_t ignore_unmap;
564 TAILQ_ENTRY(Con) nodes;
565 TAILQ_ENTRY(Con) focused;
566 TAILQ_ENTRY(Con) all_cons;
567 TAILQ_ENTRY(Con) floating_windows;
570 void(*on_remove_child)(Con *);
574 SCRATCHPAD_FRESH = 1,
575 SCRATCHPAD_CHANGED = 2
578 /* The ID of this container before restarting. Necessary to correctly
579 * interpret back-references in the JSON (such as the focus stack). */