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 * Binding input types. See Binding::input_type.
103 * Stores a rectangle, for example the size of a window, the child window etc.
104 * It needs to be packed so that the compiler will not add any padding bytes.
105 * (it is used in src/ewmh.c for example)
107 * Note that x and y can contain signed values in some cases (for example when
108 * used for the coordinates of a window, which can be set outside of the
109 * visible area, but not when specifying the position of a workspace for the
110 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
119 } __attribute__((packed));
122 * Stores the reserved pixels on each screen edge read from a
123 * _NET_WM_STRUT_PARTIAL.
134 * Stores a width/height pair, used as part of deco_render_params to check
135 * whether the rects width/height have changed.
138 struct width_height {
144 * Stores the parameters for rendering a window decoration. This structure is
145 * cached in every Con and no re-rendering will be done if the parameters have
146 * not changed (only the pixmaps will be copied).
149 struct deco_render_params {
150 struct Colortriple *color;
152 struct width_height con_rect;
153 struct width_height con_window_rect;
156 layout_t parent_layout;
161 * Stores which workspace (by name) goes to which output.
164 struct Workspace_Assignment {
168 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
171 struct Ignore_Event {
176 SLIST_ENTRY(Ignore_Event) ignore_events;
180 * Stores internal information about a startup sequence, like the workspace it
184 struct Startup_Sequence {
185 /** startup ID for this sequence, generated by libstartup-notification */
187 /** workspace on which this startup was initiated */
189 /** libstartup-notification context for this launch */
190 SnLauncherContext *context;
191 /** time at which this sequence should be deleted (after it was marked as
195 TAILQ_ENTRY(Startup_Sequence) sequences;
199 * Regular expression wrapper. It contains the pattern itself as a string (like
200 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
201 * pcre_extra data returned by pcre_study().
203 * This makes it easier to have a useful logfile, including the matching or
204 * non-matching pattern.
213 /******************************************************************************
215 *****************************************************************************/
218 * Holds a keybinding, consisting of a keycode combined with modifiers and the
219 * command which is executed as soon as the key is pressed (see
220 * src/config_parser.c)
224 /* The type of input this binding is for. (Mouse bindings are not yet
225 * implemented. All bindings are currently assumed to be keyboard bindings.) */
226 input_type_t input_type;
228 /** If true, the binding should be executed upon a KeyRelease event, not a
229 * KeyPress (the default). */
231 /* This binding will only be executed upon KeyPress events */
233 /* This binding will be executed either upon a KeyRelease event, or… */
234 B_UPON_KEYRELEASE = 1,
235 /* …upon a KeyRelease event, even if the modifiers don’t match. This
236 * state is triggered from get_binding() when the corresponding
237 * KeyPress (!) happens, so that users can release the modifier keys
238 * before releasing the actual key. */
239 B_UPON_KEYRELEASE_IGNORE_MODS = 2,
242 uint32_t number_keycodes;
244 /** Keycode to bind */
247 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
250 /** Symbol the user specified in configfile, if any. This needs to be
251 * stored with the binding to be able to re-convert it into a keycode
252 * if the keyboard mapping changes (using Xmodmap for example) */
255 /** Only in use if symbol != NULL. Gets set to the value to which the
256 * symbol got translated when binding. Useful for unbinding and
257 * checking which binding was used when a key press event comes in.
259 * This is an array of number_keycodes size. */
260 xcb_keycode_t *translated_to;
263 /** Command, like in command mode */
266 TAILQ_ENTRY(Binding) bindings;
270 * Holds a command specified by either an:
273 * in the config (see src/config.c)
277 /** Command, like in command mode */
279 /** no_startup_id flag for start_application(). Determines whether a
280 * startup notification context/ID should be created. */
282 TAILQ_ENTRY(Autostart) autostarts;
283 TAILQ_ENTRY(Autostart) autostarts_always;
287 * An Output is a physical output on your graphics driver. Outputs which
288 * are currently in use have (output->active == true). Each output has a
289 * position and a mode. An output usually corresponds to one connected
290 * screen (except if you are running multiple screens in clone mode).
294 /** Output id, so that we can requery the output directly later */
295 xcb_randr_output_t id;
297 /** Whether the output is currently active (has a CRTC attached with a
301 /** Internal flags, necessary for querying RandR screens (happens in
307 /** Name of the output */
310 /** Pointer to the Con which represents this output */
313 /** x, y, width, height */
316 TAILQ_ENTRY(xoutput) outputs;
320 * A 'Window' is a type which contains an xcb_window_t and all the related
321 * information (hints like _NET_WM_NAME for that window).
327 /** Holds the xcb_window_t (just an ID) for the leader window (logical
328 * parent for toolwindows and similar floating windows) */
330 xcb_window_t transient_for;
332 /** Pointers to the Assignments which were already ran for this Window
333 * (assignments run only once) */
334 uint32_t nr_assignments;
335 Assignment **ran_assignments;
338 char *class_instance;
340 /** The name of the window. */
343 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
344 * sets "buddy list"). Useful to match specific windows in assignments or
348 /** Flag to force re-rendering the decoration upon changes */
351 /** Whether the application used _NET_WM_NAME */
352 bool uses_net_wm_name;
354 /** Whether the application needs to receive WM_TAKE_FOCUS */
355 bool needs_take_focus;
357 /** Whether this window accepts focus. We store this inverted so that the
358 * default will be 'accepts focus'. */
359 bool doesnt_accept_focus;
361 /** Whether the window says it is a dock window */
362 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
364 /** When this window was marked urgent. 0 means not urgent */
365 struct timeval urgent;
367 /** Pixels the window reserves. left/right/top/bottom */
368 struct reservedpx reserved;
370 /** Depth of the window */
375 * A "match" is a data structure which acts like a mask or expression to match
376 * certain windows or not. For example, when using commands, you can specify a
377 * command like this: [title="*Firefox*"] kill. The title member of the match
378 * data structure will then be filled and i3 will check each window using
379 * match_matches_window() to find the windows affected by this command.
384 struct regex *application;
386 struct regex *instance;
388 struct regex *window_role;
402 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
405 /* Where the window looking for a match should be inserted:
407 * M_HERE = the matched container will be replaced by the window
409 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
410 * M_BELOW = the window will be inserted as a child of the matched container
414 enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
416 TAILQ_ENTRY(Match) matches;
418 /* Whether this match was generated when restarting i3 inplace.
419 * Leads to not setting focus when managing a new window, because the old
420 * focus stack should be restored. */
425 * An Assignment makes specific windows go to a specific workspace/output or
426 * run a command for that window. With this mechanism, the user can -- for
427 * example -- assign his browser to workspace "www". Checking if a window is
428 * assigned works by comparing the Match data structure with the window (see
429 * match_matches_window()).
433 /** type of this assignment:
435 * A_COMMAND = run the specified command for the matching window
436 * A_TO_WORKSPACE = assign the matching window to the specified workspace
437 * A_TO_OUTPUT = assign the matching window to the specified output
439 * While the type is a bitmask, only one value can be set at a time. It is
440 * a bitmask to allow filtering for multiple types, for example in the
441 * assignment_for() function.
446 A_COMMAND = (1 << 0),
447 A_TO_WORKSPACE = (1 << 1),
448 A_TO_OUTPUT = (1 << 2)
451 /** the criteria to check if a window matches */
454 /** destination workspace/output/command, depending on the type */
461 TAILQ_ENTRY(Assignment) assignments;
464 /** Fullscreen modes. Used by Con.fullscreen_mode. */
465 typedef enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode_t;
468 * A 'Con' represents everything from the X11 root window down to a single X11 window.
474 /* Should this container be marked urgent? This gets set when the window
475 * inside this container (if any) sets the urgency hint, for example. */
478 /** This counter contains the number of UnmapNotify events for this
479 * container (or, more precisely, for its ->frame) which should be ignored.
480 * UnmapNotify events need to be ignored when they are caused by i3 itself,
481 * for example when reparenting or when unmapping the window on a workspace
483 uint8_t ignore_unmap;
485 /* ids/pixmap/graphics context for the frame window */
486 bool pixmap_recreated;
489 xcb_gcontext_t pm_gc;
500 /** the workspace number, if this Con is of type CT_WORKSPACE and the
501 * workspace is not a named workspace (for named workspaces, num == -1) */
507 struct Rect window_rect;
508 struct Rect deco_rect;
509 /** the geometry this window requested when getting mapped */
510 struct Rect geometry;
514 /* a sticky-group is an identifier which bundles several containers to a
515 * group. The contents are shared between all of them, that is they are
516 * displayed on whichever of the containers is currently visible */
519 /* user-definable mark to jump to this container later */
524 /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */
526 /* the wanted size of the window, used in combination with size
527 * increments (see below). */
531 /* the x11 border pixel attribute */
533 int current_border_width;
535 /* minimum increment size specified for the window (in pixels) */
537 int height_increment;
539 struct Window *window;
541 /* timer used for disabling urgency */
542 struct ev_timer *urgency_timer;
544 /** Cache for the decoration rendering */
545 struct deco_render_params *deco_render_params;
547 /* Only workspace-containers can have floating clients */
548 TAILQ_HEAD(floating_head, Con) floating_head;
550 TAILQ_HEAD(nodes_head, Con) nodes_head;
551 TAILQ_HEAD(focus_head, Con) focus_head;
553 TAILQ_HEAD(swallow_head, Match) swallow_head;
555 fullscreen_mode_t fullscreen_mode;
556 /* layout is the layout of this container: one of split[v|h], stacked or
557 * tabbed. Special containers in the tree (above workspaces) have special
558 * layouts like dockarea or output.
560 * last_split_layout is one of splitv or splith to support the old "layout
561 * default" command which by now should be "layout splitv" or "layout
562 * splith" explicitly.
564 * workspace_layout is only for type == CT_WORKSPACE cons. When you change
565 * the layout of a workspace without any children, i3 cannot just set the
566 * layout (because workspaces need to be splitv/splith to allow focus
567 * parent and opening new containers). Instead, it stores the requested
568 * layout in workspace_layout and creates a new split container with that
569 * layout whenever a new container is attached to the workspace. */
570 layout_t layout, last_split_layout, workspace_layout;
571 border_style_t border_style;
572 /** floating? (= not in tiling layout) This cannot be simply a bool
573 * because we want to keep track of whether the status was set by the
574 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
575 * user. The user’s choice overwrites automatic mode, of course. The
576 * order of the values is important because we check with >=
577 * FLOATING_AUTO_ON if a client is floating. */
579 FLOATING_AUTO_OFF = 0,
580 FLOATING_USER_OFF = 1,
581 FLOATING_AUTO_ON = 2,
585 TAILQ_ENTRY(Con) nodes;
586 TAILQ_ENTRY(Con) focused;
587 TAILQ_ENTRY(Con) all_cons;
588 TAILQ_ENTRY(Con) floating_windows;
591 void(*on_remove_child)(Con *);
594 /* Not a scratchpad window. */
597 /* Just moved to scratchpad, not resized by the user yet.
598 * Window will be auto-centered and sized appropriately. */
599 SCRATCHPAD_FRESH = 1,
601 /* The user changed position/size of the scratchpad window. */
602 SCRATCHPAD_CHANGED = 2
605 /* The ID of this container before restarting. Necessary to correctly
606 * interpret back-references in the JSON (such as the focus stack). */
609 /* Depth of the container window */