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
12 #define SN_API_NOT_YET_FROZEN 1
13 #include <libsn/sn-launcher.h>
15 #include <xcb/randr.h>
24 * To get the big concept: There are helper structures like struct
25 * Workspace_Assignment. Every struct which is also defined as type (see
26 * forward definitions) is considered to be a major structure, thus important.
28 * The following things are all stored in a 'Con', from very high level (the
29 * biggest Cons) to very small (a single window):
31 * 1) X11 root window (as big as all your outputs combined)
32 * 2) output (like LVDS1)
33 * 3) content container, dockarea containers
36 * ... (you can arbitrarily nest split containers)
37 * 6) X11 window containers
41 /* Forward definitions */
42 typedef struct Binding Binding;
43 typedef struct Rect Rect;
44 typedef struct xoutput Output;
45 typedef struct Con Con;
46 typedef struct Match Match;
47 typedef struct Assignment Assignment;
48 typedef struct Window i3Window;
51 /******************************************************************************
53 *****************************************************************************/
54 typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
55 typedef enum { NO_ORIENTATION = 0, HORIZ, VERT } orientation_t;
56 typedef enum { BS_NORMAL = 0, BS_NONE = 1, BS_PIXEL = 2 } border_style_t;
58 /** parameter to specify whether tree_close() and x_window_kill() should kill
59 * only this specific window or the whole X11 client */
60 typedef enum { DONT_KILL_WINDOW = 0, KILL_WINDOW = 1, KILL_CLIENT = 2 } kill_window_t;
62 /** describes if the window is adjacent to the output (physical screen) edges. */
63 typedef enum { ADJ_NONE = 0,
64 ADJ_LEFT_SCREEN_EDGE = (1 << 0),
65 ADJ_RIGHT_SCREEN_EDGE = (1 << 1),
66 ADJ_UPPER_SCREEN_EDGE = (1 << 2),
67 ADJ_LOWER_SCREEN_EDGE = (1 << 4)} adjacent_t;
71 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
72 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
73 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
74 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
75 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
76 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
77 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
78 BIND_MODE_SWITCH = (1 << 8)
82 * Container layouts. See Con::layout.
95 * Stores a rectangle, for example the size of a window, the child window etc.
96 * It needs to be packed so that the compiler will not add any padding bytes.
97 * (it is used in src/ewmh.c for example)
99 * Note that x and y can contain signed values in some cases (for example when
100 * used for the coordinates of a window, which can be set outside of the
101 * visible area, but not when specifying the position of a workspace for the
102 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
111 } __attribute__((packed));
114 * Stores the reserved pixels on each screen edge read from a
115 * _NET_WM_STRUT_PARTIAL.
126 * Stores a width/height pair, used as part of deco_render_params to check
127 * whether the rects width/height have changed.
130 struct width_height {
136 * Stores the parameters for rendering a window decoration. This structure is
137 * cached in every Con and no re-rendering will be done if the parameters have
138 * not changed (only the pixmaps will be copied).
141 struct deco_render_params {
142 struct Colortriple *color;
144 struct width_height con_rect;
145 struct width_height con_window_rect;
148 layout_t parent_layout;
153 * Stores which workspace (by name) goes to which output.
156 struct Workspace_Assignment {
160 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
163 struct Ignore_Event {
168 SLIST_ENTRY(Ignore_Event) ignore_events;
172 * Stores internal information about a startup sequence, like the workspace it
176 struct Startup_Sequence {
177 /** startup ID for this sequence, generated by libstartup-notification */
179 /** workspace on which this startup was initiated */
181 /** libstartup-notification context for this launch */
182 SnLauncherContext *context;
183 /** time at which this sequence should be deleted (after it was marked as
187 TAILQ_ENTRY(Startup_Sequence) sequences;
191 * Regular expression wrapper. It contains the pattern itself as a string (like
192 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
193 * pcre_extra data returned by pcre_study().
195 * This makes it easier to have a useful logfile, including the matching or
196 * non-matching pattern.
205 /******************************************************************************
207 *****************************************************************************/
210 * Holds a keybinding, consisting of a keycode combined with modifiers and the
211 * command which is executed as soon as the key is pressed (see
212 * src/config_parser.c)
216 /** If true, the binding should be executed upon a KeyRelease event, not a
217 * KeyPress (the default). */
219 /* This binding will only be executed upon KeyPress events */
221 /* This binding will be executed either upon a KeyRelease event, or… */
222 B_UPON_KEYRELEASE = 1,
223 /* …upon a KeyRelease event, even if the modifiers don’t match. This
224 * state is triggered from get_binding() when the corresponding
225 * KeyPress (!) happens, so that users can release the modifier keys
226 * before releasing the actual key. */
227 B_UPON_KEYRELEASE_IGNORE_MODS = 2,
230 uint32_t number_keycodes;
232 /** Keycode to bind */
235 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
238 /** Symbol the user specified in configfile, if any. This needs to be
239 * stored with the binding to be able to re-convert it into a keycode
240 * if the keyboard mapping changes (using Xmodmap for example) */
243 /** Only in use if symbol != NULL. Gets set to the value to which the
244 * symbol got translated when binding. Useful for unbinding and
245 * checking which binding was used when a key press event comes in.
247 * This is an array of number_keycodes size. */
248 xcb_keycode_t *translated_to;
251 /** Command, like in command mode */
254 TAILQ_ENTRY(Binding) bindings;
258 * Holds a command specified by either an:
261 * in the config (see src/config.c)
265 /** Command, like in command mode */
267 /** no_startup_id flag for start_application(). Determines whether a
268 * startup notification context/ID should be created. */
270 TAILQ_ENTRY(Autostart) autostarts;
271 TAILQ_ENTRY(Autostart) autostarts_always;
275 * An Output is a physical output on your graphics driver. Outputs which
276 * are currently in use have (output->active == true). Each output has a
277 * position and a mode. An output usually corresponds to one connected
278 * screen (except if you are running multiple screens in clone mode).
282 /** Output id, so that we can requery the output directly later */
283 xcb_randr_output_t id;
285 /** Whether the output is currently active (has a CRTC attached with a
289 /** Internal flags, necessary for querying RandR screens (happens in
295 /** Name of the output */
298 /** Pointer to the Con which represents this output */
301 /** x, y, width, height */
304 TAILQ_ENTRY(xoutput) outputs;
308 * A 'Window' is a type which contains an xcb_window_t and all the related
309 * information (hints like _NET_WM_NAME for that window).
315 /** Holds the xcb_window_t (just an ID) for the leader window (logical
316 * parent for toolwindows and similar floating windows) */
318 xcb_window_t transient_for;
320 /** Pointers to the Assignments which were already ran for this Window
321 * (assignments run only once) */
322 uint32_t nr_assignments;
323 Assignment **ran_assignments;
326 char *class_instance;
328 /** The name of the window. */
331 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
332 * sets "buddy list"). Useful to match specific windows in assignments or
336 /** Flag to force re-rendering the decoration upon changes */
339 /** Whether the application used _NET_WM_NAME */
340 bool uses_net_wm_name;
342 /** Whether the application needs to receive WM_TAKE_FOCUS */
343 bool needs_take_focus;
345 /** Whether this window accepts focus. We store this inverted so that the
346 * default will be 'accepts focus'. */
347 bool doesnt_accept_focus;
349 /** Whether the window says it is a dock window */
350 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
352 /** When this window was marked urgent. 0 means not urgent */
353 struct timeval urgent;
355 /** Pixels the window reserves. left/right/top/bottom */
356 struct reservedpx reserved;
358 /** Depth of the window */
363 * A "match" is a data structure which acts like a mask or expression to match
364 * certain windows or not. For example, when using commands, you can specify a
365 * command like this: [title="*Firefox*"] kill. The title member of the match
366 * data structure will then be filled and i3 will check each window using
367 * match_matches_window() to find the windows affected by this command.
372 struct regex *application;
374 struct regex *instance;
376 struct regex *window_role;
390 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
393 /* Where the window looking for a match should be inserted:
395 * M_HERE = the matched container will be replaced by the window
397 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
398 * M_BELOW = the window will be inserted as a child of the matched container
402 enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
404 TAILQ_ENTRY(Match) matches;
406 /* Whether this match was generated when restarting i3 inplace.
407 * Leads to not setting focus when managing a new window, because the old
408 * focus stack should be restored. */
413 * An Assignment makes specific windows go to a specific workspace/output or
414 * run a command for that window. With this mechanism, the user can -- for
415 * example -- assign his browser to workspace "www". Checking if a window is
416 * assigned works by comparing the Match data structure with the window (see
417 * match_matches_window()).
421 /** type of this assignment:
423 * A_COMMAND = run the specified command for the matching window
424 * A_TO_WORKSPACE = assign the matching window to the specified workspace
425 * A_TO_OUTPUT = assign the matching window to the specified output
427 * While the type is a bitmask, only one value can be set at a time. It is
428 * a bitmask to allow filtering for multiple types, for example in the
429 * assignment_for() function.
434 A_COMMAND = (1 << 0),
435 A_TO_WORKSPACE = (1 << 1),
436 A_TO_OUTPUT = (1 << 2)
439 /** the criteria to check if a window matches */
442 /** destination workspace/output/command, depending on the type */
449 TAILQ_ENTRY(Assignment) assignments;
452 /** Fullscreen modes. Used by Con.fullscreen_mode. */
453 typedef enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode_t;
456 * A 'Con' represents everything from the X11 root window down to a single X11 window.
462 /* Should this container be marked urgent? This gets set when the window
463 * inside this container (if any) sets the urgency hint, for example. */
466 /** This counter contains the number of UnmapNotify events for this
467 * container (or, more precisely, for its ->frame) which should be ignored.
468 * UnmapNotify events need to be ignored when they are caused by i3 itself,
469 * for example when reparenting or when unmapping the window on a workspace
471 uint8_t ignore_unmap;
473 /* ids/pixmap/graphics context for the frame window */
474 bool pixmap_recreated;
477 xcb_gcontext_t pm_gc;
488 /** the workspace number, if this Con is of type CT_WORKSPACE and the
489 * workspace is not a named workspace (for named workspaces, num == -1) */
495 struct Rect window_rect;
496 struct Rect deco_rect;
497 /** the geometry this window requested when getting mapped */
498 struct Rect geometry;
502 /* a sticky-group is an identifier which bundles several containers to a
503 * group. The contents are shared between all of them, that is they are
504 * displayed on whichever of the containers is currently visible */
507 /* user-definable mark to jump to this container later */
512 /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */
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 fullscreen_mode_t 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 */