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>
25 * To get the big concept: There are helper structures like struct
26 * Workspace_Assignment. Every struct which is also defined as type (see
27 * forward definitions) is considered to be a major structure, thus important.
29 * The following things are all stored in a 'Con', from very high level (the
30 * biggest Cons) to very small (a single window):
32 * 1) X11 root window (as big as all your outputs combined)
33 * 2) output (like LVDS1)
34 * 3) content container, dockarea containers
37 * ... (you can arbitrarily nest split containers)
38 * 6) X11 window containers
42 /* Forward definitions */
43 typedef struct Binding Binding;
44 typedef struct Rect Rect;
45 typedef struct xoutput Output;
46 typedef struct Con Con;
47 typedef struct Match Match;
48 typedef struct Assignment Assignment;
49 typedef struct Window i3Window;
52 /******************************************************************************
54 *****************************************************************************/
55 typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
56 typedef enum { NO_ORIENTATION = 0, HORIZ, VERT } orientation_t;
57 typedef enum { BS_NORMAL = 0, BS_NONE = 1, BS_PIXEL = 2 } border_style_t;
59 /** parameter to specify whether tree_close() and x_window_kill() should kill
60 * only this specific window or the whole X11 client */
61 typedef enum { DONT_KILL_WINDOW = 0, KILL_WINDOW = 1, KILL_CLIENT = 2 } kill_window_t;
63 /** describes if the window is adjacent to the output (physical screen) edges. */
64 typedef enum { ADJ_NONE = 0,
65 ADJ_LEFT_SCREEN_EDGE = (1 << 0),
66 ADJ_RIGHT_SCREEN_EDGE = (1 << 1),
67 ADJ_UPPER_SCREEN_EDGE = (1 << 2),
68 ADJ_LOWER_SCREEN_EDGE = (1 << 4)} adjacent_t;
72 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
73 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
74 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
75 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
76 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
77 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
78 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
79 BIND_MODE_SWITCH = (1 << 8)
83 * Container layouts. See Con::layout.
96 * Stores a rectangle, for example the size of a window, the child window etc.
97 * It needs to be packed so that the compiler will not add any padding bytes.
98 * (it is used in src/ewmh.c for example)
100 * Note that x and y can contain signed values in some cases (for example when
101 * used for the coordinates of a window, which can be set outside of the
102 * visible area, but not when specifying the position of a workspace for the
103 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
112 } __attribute__((packed));
115 * Stores the reserved pixels on each screen edge read from a
116 * _NET_WM_STRUT_PARTIAL.
127 * Stores a width/height pair, used as part of deco_render_params to check
128 * whether the rects width/height have changed.
131 struct width_height {
137 * Stores the parameters for rendering a window decoration. This structure is
138 * cached in every Con and no re-rendering will be done if the parameters have
139 * not changed (only the pixmaps will be copied).
142 struct deco_render_params {
143 struct Colortriple *color;
145 struct width_height con_rect;
146 struct width_height con_window_rect;
149 layout_t parent_layout;
154 * Stores which workspace (by name) goes to which output.
157 struct Workspace_Assignment {
161 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
164 struct Ignore_Event {
169 SLIST_ENTRY(Ignore_Event) ignore_events;
173 * Stores internal information about a startup sequence, like the workspace it
177 struct Startup_Sequence {
178 /** startup ID for this sequence, generated by libstartup-notification */
180 /** workspace on which this startup was initiated */
182 /** libstartup-notification context for this launch */
183 SnLauncherContext *context;
184 /** time at which this sequence should be deleted (after it was marked as
188 TAILQ_ENTRY(Startup_Sequence) sequences;
192 * Regular expression wrapper. It contains the pattern itself as a string (like
193 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
194 * pcre_extra data returned by pcre_study().
196 * This makes it easier to have a useful logfile, including the matching or
197 * non-matching pattern.
206 /******************************************************************************
208 *****************************************************************************/
211 * Holds a keybinding, consisting of a keycode combined with modifiers and the
212 * command which is executed as soon as the key is pressed (see
213 * src/config_parser.c)
217 /** If true, the binding should be executed upon a KeyRelease event, not a
218 * KeyPress (the default). */
220 /* This binding will only be executed upon KeyPress events */
222 /* This binding will be executed either upon a KeyRelease event, or… */
223 B_UPON_KEYRELEASE = 1,
224 /* …upon a KeyRelease event, even if the modifiers don’t match. This
225 * state is triggered from get_binding() when the corresponding
226 * KeyPress (!) happens, so that users can release the modifier keys
227 * before releasing the actual key. */
228 B_UPON_KEYRELEASE_IGNORE_MODS = 2,
231 uint32_t number_keycodes;
233 /** Keycode to bind */
236 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
239 /** Symbol the user specified in configfile, if any. This needs to be
240 * stored with the binding to be able to re-convert it into a keycode
241 * if the keyboard mapping changes (using Xmodmap for example) */
244 /** Only in use if symbol != NULL. Gets set to the value to which the
245 * symbol got translated when binding. Useful for unbinding and
246 * checking which binding was used when a key press event comes in.
248 * This is an array of number_keycodes size. */
249 xcb_keycode_t *translated_to;
252 /** Command, like in command mode */
255 TAILQ_ENTRY(Binding) bindings;
259 * Holds a command specified by either an:
262 * in the config (see src/config.c)
266 /** Command, like in command mode */
268 /** no_startup_id flag for start_application(). Determines whether a
269 * startup notification context/ID should be created. */
271 TAILQ_ENTRY(Autostart) autostarts;
272 TAILQ_ENTRY(Autostart) autostarts_always;
276 * An Output is a physical output on your graphics driver. Outputs which
277 * are currently in use have (output->active == true). Each output has a
278 * position and a mode. An output usually corresponds to one connected
279 * screen (except if you are running multiple screens in clone mode).
283 /** Output id, so that we can requery the output directly later */
284 xcb_randr_output_t id;
286 /** Whether the output is currently active (has a CRTC attached with a
290 /** Internal flags, necessary for querying RandR screens (happens in
296 /** Name of the output */
299 /** Pointer to the Con which represents this output */
302 /** x, y, width, height */
305 TAILQ_ENTRY(xoutput) outputs;
309 * A 'Window' is a type which contains an xcb_window_t and all the related
310 * information (hints like _NET_WM_NAME for that window).
316 /** Holds the xcb_window_t (just an ID) for the leader window (logical
317 * parent for toolwindows and similar floating windows) */
319 xcb_window_t transient_for;
321 /** Pointers to the Assignments which were already ran for this Window
322 * (assignments run only once) */
323 uint32_t nr_assignments;
324 Assignment **ran_assignments;
327 char *class_instance;
329 /** The name of the window. */
332 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
333 * sets "buddy list"). Useful to match specific windows in assignments or
337 /** Flag to force re-rendering the decoration upon changes */
340 /** Whether the application used _NET_WM_NAME */
341 bool uses_net_wm_name;
343 /** Whether the application needs to receive WM_TAKE_FOCUS */
344 bool needs_take_focus;
346 /** Whether this window accepts focus. We store this inverted so that the
347 * default will be 'accepts focus'. */
348 bool doesnt_accept_focus;
350 /** Whether the window says it is a dock window */
351 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
353 /** When this window was marked urgent. 0 means not urgent */
354 struct timeval urgent;
356 /** Pixels the window reserves. left/right/top/bottom */
357 struct reservedpx reserved;
359 /** Depth of the window */
364 * A "match" is a data structure which acts like a mask or expression to match
365 * certain windows or not. For example, when using commands, you can specify a
366 * command like this: [title="*Firefox*"] kill. The title member of the match
367 * data structure will then be filled and i3 will check each window using
368 * match_matches_window() to find the windows affected by this command.
373 struct regex *application;
375 struct regex *instance;
391 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
394 /* Where the window looking for a match should be inserted:
396 * M_HERE = the matched container will be replaced by the window
398 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
399 * M_BELOW = the window will be inserted as a child of the matched container
403 enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
405 TAILQ_ENTRY(Match) matches;
407 /* Whether this match was generated when restarting i3 inplace.
408 * Leads to not setting focus when managing a new window, because the old
409 * focus stack should be restored. */
414 * An Assignment makes specific windows go to a specific workspace/output or
415 * run a command for that window. With this mechanism, the user can -- for
416 * example -- assign his browser to workspace "www". Checking if a window is
417 * assigned works by comparing the Match data structure with the window (see
418 * match_matches_window()).
422 /** type of this assignment:
424 * A_COMMAND = run the specified command for the matching window
425 * A_TO_WORKSPACE = assign the matching window to the specified workspace
426 * A_TO_OUTPUT = assign the matching window to the specified output
428 * While the type is a bitmask, only one value can be set at a time. It is
429 * a bitmask to allow filtering for multiple types, for example in the
430 * assignment_for() function.
435 A_COMMAND = (1 << 0),
436 A_TO_WORKSPACE = (1 << 1),
437 A_TO_OUTPUT = (1 << 2)
440 /** the criteria to check if a window matches */
443 /** destination workspace/output/command, depending on the type */
450 TAILQ_ENTRY(Assignment) assignments;
454 * A 'Con' represents everything from the X11 root window down to a single X11 window.
460 /* Should this container be marked urgent? This gets set when the window
461 * inside this container (if any) sets the urgency hint, for example. */
464 /** This counter contains the number of UnmapNotify events for this
465 * container (or, more precisely, for its ->frame) which should be ignored.
466 * UnmapNotify events need to be ignored when they are caused by i3 itself,
467 * for example when reparenting or when unmapping the window on a workspace
469 uint8_t ignore_unmap;
471 /* ids/pixmap/graphics context for the frame window */
472 bool pixmap_recreated;
475 xcb_gcontext_t pm_gc;
486 /** the workspace number, if this Con is of type CT_WORKSPACE and the
487 * workspace is not a named workspace (for named workspaces, num == -1) */
493 struct Rect window_rect;
494 struct Rect deco_rect;
495 /** the geometry this window requested when getting mapped */
496 struct Rect geometry;
500 /* a sticky-group is an identifier which bundles several containers to a
501 * group. The contents are shared between all of them, that is they are
502 * displayed on whichever of the containers is currently visible */
505 /* user-definable mark to jump to this container later */
510 /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
511 * apply an aspect ratio to windows (think of MPlayer) */
512 int proportional_width;
513 int proportional_height;
514 /* the wanted size of the window, used in combination with size
515 * increments (see below). */
519 /* the x11 border pixel attribute */
521 int current_border_width;
523 /* minimum increment size specified for the window (in pixels) */
525 int height_increment;
527 struct Window *window;
529 /* timer used for disabling urgency */
530 struct ev_timer *urgency_timer;
532 /** Cache for the decoration rendering */
533 struct deco_render_params *deco_render_params;
535 /* Only workspace-containers can have floating clients */
536 TAILQ_HEAD(floating_head, Con) floating_head;
538 TAILQ_HEAD(nodes_head, Con) nodes_head;
539 TAILQ_HEAD(focus_head, Con) focus_head;
541 TAILQ_HEAD(swallow_head, Match) swallow_head;
543 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
544 /* layout is the layout of this container: one of split[v|h], stacked or
545 * tabbed. Special containers in the tree (above workspaces) have special
546 * layouts like dockarea or output.
548 * last_split_layout is one of splitv or splith to support the old "layout
549 * default" command which by now should be "layout splitv" or "layout
550 * splith" explicitly.
552 * workspace_layout is only for type == CT_WORKSPACE cons. When you change
553 * the layout of a workspace without any children, i3 cannot just set the
554 * layout (because workspaces need to be splitv/splith to allow focus
555 * parent and opening new containers). Instead, it stores the requested
556 * layout in workspace_layout and creates a new split container with that
557 * layout whenever a new container is attached to the workspace. */
558 layout_t layout, last_split_layout, workspace_layout;
559 border_style_t border_style;
560 /** floating? (= not in tiling layout) This cannot be simply a bool
561 * because we want to keep track of whether the status was set by the
562 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
563 * user. The user’s choice overwrites automatic mode, of course. The
564 * order of the values is important because we check with >=
565 * FLOATING_AUTO_ON if a client is floating. */
567 FLOATING_AUTO_OFF = 0,
568 FLOATING_USER_OFF = 1,
569 FLOATING_AUTO_ON = 2,
573 TAILQ_ENTRY(Con) nodes;
574 TAILQ_ENTRY(Con) focused;
575 TAILQ_ENTRY(Con) all_cons;
576 TAILQ_ENTRY(Con) floating_windows;
579 void(*on_remove_child)(Con *);
582 /* Not a scratchpad window. */
585 /* Just moved to scratchpad, not resized by the user yet.
586 * Window will be auto-centered and sized appropriately. */
587 SCRATCHPAD_FRESH = 1,
589 /* The user changed position/size of the scratchpad window. */
590 SCRATCHPAD_CHANGED = 2
593 /* The ID of this container before restarting. Necessary to correctly
594 * interpret back-references in the JSON (such as the focus stack). */
597 /* Depth of the container window */