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_1PIXEL = 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;
141 * Stores which workspace (by name) goes to which output.
144 struct Workspace_Assignment {
148 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
151 struct Ignore_Event {
156 SLIST_ENTRY(Ignore_Event) ignore_events;
160 * Stores internal information about a startup sequence, like the workspace it
164 struct Startup_Sequence {
165 /** startup ID for this sequence, generated by libstartup-notification */
167 /** workspace on which this startup was initiated */
169 /** libstartup-notification context for this launch */
170 SnLauncherContext *context;
171 /** time at which this sequence should be deleted (after it was marked as
175 TAILQ_ENTRY(Startup_Sequence) sequences;
179 * Regular expression wrapper. It contains the pattern itself as a string (like
180 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
181 * pcre_extra data returned by pcre_study().
183 * This makes it easier to have a useful logfile, including the matching or
184 * non-matching pattern.
193 /******************************************************************************
195 *****************************************************************************/
198 * Holds a keybinding, consisting of a keycode combined with modifiers and the
199 * command which is executed as soon as the key is pressed (see src/cfgparse.y)
203 /** Symbol the user specified in configfile, if any. This needs to be
204 * stored with the binding to be able to re-convert it into a keycode
205 * if the keyboard mapping changes (using Xmodmap for example) */
208 /** Only in use if symbol != NULL. Gets set to the value to which the
209 * symbol got translated when binding. Useful for unbinding and
210 * checking which binding was used when a key press event comes in.
212 * This is an array of number_keycodes size. */
213 xcb_keycode_t *translated_to;
215 uint32_t number_keycodes;
217 /** Keycode to bind */
220 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
223 /** Command, like in command mode */
226 TAILQ_ENTRY(Binding) bindings;
230 * Holds a command specified by either an:
233 * in the config (see src/config.c)
237 /** Command, like in command mode */
239 /** no_startup_id flag for start_application(). Determines whether a
240 * startup notification context/ID should be created. */
242 TAILQ_ENTRY(Autostart) autostarts;
243 TAILQ_ENTRY(Autostart) autostarts_always;
247 * An Output is a physical output on your graphics driver. Outputs which
248 * are currently in use have (output->active == true). Each output has a
249 * position and a mode. An output usually corresponds to one connected
250 * screen (except if you are running multiple screens in clone mode).
254 /** Output id, so that we can requery the output directly later */
255 xcb_randr_output_t id;
256 /** Name of the output */
259 /** Pointer to the Con which represents this output */
262 /** Whether the output is currently active (has a CRTC attached with a
266 /** Internal flags, necessary for querying RandR screens (happens in
272 /** x, y, width, height */
275 TAILQ_ENTRY(xoutput) outputs;
279 * A 'Window' is a type which contains an xcb_window_t and all the related
280 * information (hints like _NET_WM_NAME for that window).
286 /** Holds the xcb_window_t (just an ID) for the leader window (logical
287 * parent for toolwindows and similar floating windows) */
289 xcb_window_t transient_for;
292 char *class_instance;
294 /** The name of the window. */
297 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
298 * sets "buddy list"). Useful to match specific windows in assignments or
302 /** Flag to force re-rendering the decoration upon changes */
305 /** Whether the application used _NET_WM_NAME */
306 bool uses_net_wm_name;
308 /** Whether the application needs to receive WM_TAKE_FOCUS */
309 bool needs_take_focus;
311 /** When this window was marked urgent. 0 means not urgent */
312 struct timeval urgent;
314 /** Whether this window accepts focus. We store this inverted so that the
315 * default will be 'accepts focus'. */
316 bool doesnt_accept_focus;
318 /** Whether the window says it is a dock window */
319 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
321 /** Pixels the window reserves. left/right/top/bottom */
322 struct reservedpx reserved;
324 /** Pointers to the Assignments which were already ran for this Window
325 * (assignments run only once) */
326 uint32_t nr_assignments;
327 Assignment **ran_assignments;
329 /** Depth of the window */
334 * A "match" is a data structure which acts like a mask or expression to match
335 * certain windows or not. For example, when using commands, you can specify a
336 * command like this: [title="*Firefox*"] kill. The title member of the match
337 * data structure will then be filled and i3 will check each window using
338 * match_matches_window() to find the windows affected by this command.
343 struct regex *application;
345 struct regex *instance;
362 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
364 /* Where the window looking for a match should be inserted:
366 * M_HERE = the matched container will be replaced by the window
368 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
369 * M_BELOW = the window will be inserted as a child of the matched container
373 enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
375 /* Whether this match was generated when restarting i3 inplace.
376 * Leads to not setting focus when managing a new window, because the old
377 * focus stack should be restored. */
380 TAILQ_ENTRY(Match) matches;
384 * An Assignment makes specific windows go to a specific workspace/output or
385 * run a command for that window. With this mechanism, the user can -- for
386 * example -- assign his browser to workspace "www". Checking if a window is
387 * assigned works by comparing the Match data structure with the window (see
388 * match_matches_window()).
392 /** type of this assignment:
394 * A_COMMAND = run the specified command for the matching window
395 * A_TO_WORKSPACE = assign the matching window to the specified workspace
396 * A_TO_OUTPUT = assign the matching window to the specified output
398 * While the type is a bitmask, only one value can be set at a time. It is
399 * a bitmask to allow filtering for multiple types, for example in the
400 * assignment_for() function.
405 A_COMMAND = (1 << 0),
406 A_TO_WORKSPACE = (1 << 1),
407 A_TO_OUTPUT = (1 << 2)
410 /** the criteria to check if a window matches */
413 /** destination workspace/output/command, depending on the type */
420 TAILQ_ENTRY(Assignment) assignments;
424 * A 'Con' represents everything from the X11 root window down to a single X11 window.
429 /** whether this is a split container or not */
442 struct Rect window_rect;
443 struct Rect deco_rect;
444 /** the geometry this window requested when getting mapped */
445 struct Rect geometry;
449 /** the workspace number, if this Con is of type CT_WORKSPACE and the
450 * workspace is not a named workspace (for named workspaces, num == -1) */
453 /* a sticky-group is an identifier which bundles several containers to a
454 * group. The contents are shared between all of them, that is they are
455 * displayed on whichever of the containers is currently visible */
458 /* user-definable mark to jump to this container later */
463 /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
464 * apply an aspect ratio to windows (think of MPlayer) */
465 int proportional_width;
466 int proportional_height;
467 /* the wanted size of the window, used in combination with size
468 * increments (see below). */
472 /* the x11 border pixel attribute */
475 /* minimum increment size specified for the window (in pixels) */
477 int height_increment;
479 struct Window *window;
481 /* Should this container be marked urgent? This gets set when the window
482 * inside this container (if any) sets the urgency hint, for example. */
485 /* ids/pixmap/graphics context for the frame window */
488 xcb_gcontext_t pm_gc;
489 bool pixmap_recreated;
491 /** Cache for the decoration rendering */
492 struct deco_render_params *deco_render_params;
494 /* Only workspace-containers can have floating clients */
495 TAILQ_HEAD(floating_head, Con) floating_head;
497 TAILQ_HEAD(nodes_head, Con) nodes_head;
498 TAILQ_HEAD(focus_head, Con) focus_head;
500 TAILQ_HEAD(swallow_head, Match) swallow_head;
502 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
511 } layout, last_split_layout;
512 border_style_t border_style;
513 /** floating? (= not in tiling layout) This cannot be simply a bool
514 * because we want to keep track of whether the status was set by the
515 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
516 * user. The user’s choice overwrites automatic mode, of course. The
517 * order of the values is important because we check with >=
518 * FLOATING_AUTO_ON if a client is floating. */
520 FLOATING_AUTO_OFF = 0,
521 FLOATING_USER_OFF = 1,
522 FLOATING_AUTO_ON = 2,
526 /** This counter contains the number of UnmapNotify events for this
527 * container (or, more precisely, for its ->frame) which should be ignored.
528 * UnmapNotify events need to be ignored when they are caused by i3 itself,
529 * for example when reparenting or when unmapping the window on a workspace
531 uint8_t ignore_unmap;
533 TAILQ_ENTRY(Con) nodes;
534 TAILQ_ENTRY(Con) focused;
535 TAILQ_ENTRY(Con) all_cons;
536 TAILQ_ENTRY(Con) floating_windows;
539 void(*on_remove_child)(Con *);
543 SCRATCHPAD_FRESH = 1,
544 SCRATCHPAD_CHANGED = 2
547 /* The ID of this container before restarting. Necessary to correctly
548 * interpret back-references in the JSON (such as the focus stack). */