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>
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_1PIXEL = 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;
65 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
66 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
67 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
68 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
69 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
70 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
71 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
72 BIND_MODE_SWITCH = (1 << 8)
76 * Stores a rectangle, for example the size of a window, the child window etc.
77 * It needs to be packed so that the compiler will not add any padding bytes.
78 * (it is used in src/ewmh.c for example)
80 * Note that x and y can contain signed values in some cases (for example when
81 * used for the coordinates of a window, which can be set outside of the
82 * visible area, but not when specifying the position of a workspace for the
83 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
92 } __attribute__((packed));
95 * Stores the reserved pixels on each screen edge read from a
96 * _NET_WM_STRUT_PARTIAL.
107 * Stores a width/height pair, used as part of deco_render_params to check
108 * whether the rects width/height have changed.
111 struct width_height {
117 * Stores the parameters for rendering a window decoration. This structure is
118 * cached in every Con and no re-rendering will be done if the parameters have
119 * not changed (only the pixmaps will be copied).
122 struct deco_render_params {
123 struct Colortriple *color;
125 struct width_height con_rect;
126 struct width_height con_window_rect;
133 * Stores which workspace (by name) goes to which output.
136 struct Workspace_Assignment {
140 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
143 struct Ignore_Event {
148 SLIST_ENTRY(Ignore_Event) ignore_events;
152 * Stores internal information about a startup sequence, like the workspace it
156 struct Startup_Sequence {
157 /** startup ID for this sequence, generated by libstartup-notification */
159 /** workspace on which this startup was initiated */
161 /** libstartup-notification context for this launch */
162 SnLauncherContext *context;
164 TAILQ_ENTRY(Startup_Sequence) sequences;
168 * Regular expression wrapper. It contains the pattern itself as a string (like
169 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
170 * pcre_extra data returned by pcre_study().
172 * This makes it easier to have a useful logfile, including the matching or
173 * non-matching pattern.
182 /******************************************************************************
184 *****************************************************************************/
187 * Holds a keybinding, consisting of a keycode combined with modifiers and the
188 * command which is executed as soon as the key is pressed (see src/cfgparse.y)
192 /** Symbol the user specified in configfile, if any. This needs to be
193 * stored with the binding to be able to re-convert it into a keycode
194 * if the keyboard mapping changes (using Xmodmap for example) */
197 /** Only in use if symbol != NULL. Gets set to the value to which the
198 * symbol got translated when binding. Useful for unbinding and
199 * checking which binding was used when a key press event comes in.
201 * This is an array of number_keycodes size. */
202 xcb_keycode_t *translated_to;
204 uint32_t number_keycodes;
206 /** Keycode to bind */
209 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
212 /** Command, like in command mode */
215 TAILQ_ENTRY(Binding) bindings;
219 * Holds a command specified by either an:
222 * in the config (see src/config.c)
226 /** Command, like in command mode */
228 /** no_startup_id flag for start_application(). Determines whether a
229 * startup notification context/ID should be created. */
231 TAILQ_ENTRY(Autostart) autostarts;
232 TAILQ_ENTRY(Autostart) autostarts_always;
236 * An Output is a physical output on your graphics driver. Outputs which
237 * are currently in use have (output->active == true). Each output has a
238 * position and a mode. An output usually corresponds to one connected
239 * screen (except if you are running multiple screens in clone mode).
243 /** Output id, so that we can requery the output directly later */
244 xcb_randr_output_t id;
245 /** Name of the output */
248 /** Pointer to the Con which represents this output */
251 /** Whether the output is currently active (has a CRTC attached with a
255 /** Internal flags, necessary for querying RandR screens (happens in
261 /** x, y, width, height */
264 TAILQ_ENTRY(xoutput) outputs;
268 * A 'Window' is a type which contains an xcb_window_t and all the related
269 * information (hints like _NET_WM_NAME for that window).
275 /** Holds the xcb_window_t (just an ID) for the leader window (logical
276 * parent for toolwindows and similar floating windows) */
278 xcb_window_t transient_for;
281 char *class_instance;
283 /** The name of the window as it will be passed to X11 (in UCS2 if the
284 * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
287 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
288 * sets "buddy list"). Useful to match specific windows in assignments or
292 /** Flag to force re-rendering the decoration upon changes */
295 /** The name of the window as used in JSON (in UTF-8 if the application
296 * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
299 /** The length of the name in glyphs (not bytes) */
302 /** Whether the application used _NET_WM_NAME */
303 bool uses_net_wm_name;
305 /** Whether the application needs to receive WM_TAKE_FOCUS */
306 bool needs_take_focus;
308 /** When this window was marked urgent. 0 means not urgent */
309 struct timeval urgent;
311 /** Whether this window accepts focus. We store this inverted so that the
312 * default will be 'accepts focus'. */
313 bool doesnt_accept_focus;
315 /** Whether the window says it is a dock window */
316 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
318 /** Pixels the window reserves. left/right/top/bottom */
319 struct reservedpx reserved;
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;
326 /** Depth of the window */
331 * A "match" is a data structure which acts like a mask or expression to match
332 * certain windows or not. For example, when using commands, you can specify a
333 * command like this: [title="*Firefox*"] kill. The title member of the match
334 * data structure will then be filled and i3 will check each window using
335 * match_matches_window() to find the windows affected by this command.
340 struct regex *application;
342 struct regex *instance;
359 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
361 /* Where the window looking for a match should be inserted:
363 * M_HERE = the matched container will be replaced by the window
365 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
366 * M_BELOW = the window will be inserted as a child of the matched container
370 enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
372 /* Whether this match was generated when restarting i3 inplace.
373 * Leads to not setting focus when managing a new window, because the old
374 * focus stack should be restored. */
377 TAILQ_ENTRY(Match) matches;
381 * An Assignment makes specific windows go to a specific workspace/output or
382 * run a command for that window. With this mechanism, the user can -- for
383 * example -- assign his browser to workspace "www". Checking if a window is
384 * assigned works by comparing the Match data structure with the window (see
385 * match_matches_window()).
389 /** type of this assignment:
391 * A_COMMAND = run the specified command for the matching window
392 * A_TO_WORKSPACE = assign the matching window to the specified workspace
393 * A_TO_OUTPUT = assign the matching window to the specified output
395 * While the type is a bitmask, only one value can be set at a time. It is
396 * a bitmask to allow filtering for multiple types, for example in the
397 * assignment_for() function.
402 A_COMMAND = (1 << 0),
403 A_TO_WORKSPACE = (1 << 1),
404 A_TO_OUTPUT = (1 << 2)
407 /** the criteria to check if a window matches */
410 /** destination workspace/output/command, depending on the type */
417 TAILQ_ENTRY(Assignment) assignments;
421 * A 'Con' represents everything from the X11 root window down to a single X11 window.
426 /** whether this is a split container or not */
439 struct Rect window_rect;
440 struct Rect deco_rect;
441 /** the geometry this window requested when getting mapped */
442 struct Rect geometry;
446 /** the workspace number, if this Con is of type CT_WORKSPACE and the
447 * workspace is not a named workspace (for named workspaces, num == -1) */
450 /* a sticky-group is an identifier which bundles several containers to a
451 * group. The contents are shared between all of them, that is they are
452 * displayed on whichever of the containers is currently visible */
455 /* user-definable mark to jump to this container later */
460 /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
461 * apply an aspect ratio to windows (think of MPlayer) */
462 int proportional_width;
463 int proportional_height;
464 /* the wanted size of the window, used in combination with size
465 * increments (see below). */
469 /* the x11 border pixel attribute */
472 /* minimum increment size specified for the window (in pixels) */
474 int height_increment;
476 struct Window *window;
478 /* Should this container be marked urgent? This gets set when the window
479 * inside this container (if any) sets the urgency hint, for example. */
482 /* ids/pixmap/graphics context for the frame window */
485 xcb_gcontext_t pm_gc;
486 bool pixmap_recreated;
488 /** Cache for the decoration rendering */
489 struct deco_render_params *deco_render_params;
491 /* Only workspace-containers can have floating clients */
492 TAILQ_HEAD(floating_head, Con) floating_head;
494 TAILQ_HEAD(nodes_head, Con) nodes_head;
495 TAILQ_HEAD(focus_head, Con) focus_head;
497 TAILQ_HEAD(swallow_head, Match) swallow_head;
499 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
508 } layout, last_split_layout;
509 border_style_t border_style;
510 /** floating? (= not in tiling layout) This cannot be simply a bool
511 * because we want to keep track of whether the status was set by the
512 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
513 * user. The user’s choice overwrites automatic mode, of course. The
514 * order of the values is important because we check with >=
515 * FLOATING_AUTO_ON if a client is floating. */
517 FLOATING_AUTO_OFF = 0,
518 FLOATING_USER_OFF = 1,
519 FLOATING_AUTO_ON = 2,
523 /** This counter contains the number of UnmapNotify events for this
524 * container (or, more precisely, for its ->frame) which should be ignored.
525 * UnmapNotify events need to be ignored when they are caused by i3 itself,
526 * for example when reparenting or when unmapping the window on a workspace
528 uint8_t ignore_unmap;
530 TAILQ_ENTRY(Con) nodes;
531 TAILQ_ENTRY(Con) focused;
532 TAILQ_ENTRY(Con) all_cons;
533 TAILQ_ENTRY(Con) floating_windows;
536 void(*on_remove_child)(Con *);
540 SCRATCHPAD_FRESH = 1,
541 SCRATCHPAD_CHANGED = 2
544 /* The ID of this container before restarting. Necessary to correctly
545 * interpret back-references in the JSON (such as the focus stack). */