2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * include/data.h: This file defines all data structures used by i3
14 #define SN_API_NOT_YET_FROZEN 1
15 #include <libsn/sn-launcher.h>
17 #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;
50 typedef struct mark_t mark_t;
52 /******************************************************************************
54 *****************************************************************************/
55 typedef enum { D_LEFT,
59 typedef enum { NO_ORIENTATION = 0,
62 typedef enum { BS_NORMAL = 0,
64 BS_PIXEL = 2 } border_style_t;
66 /** parameter to specify whether tree_close_internal() and x_window_kill() should kill
67 * only this specific window or the whole X11 client */
68 typedef enum { DONT_KILL_WINDOW = 0,
70 KILL_CLIENT = 2 } kill_window_t;
72 /** describes if the window is adjacent to the output (physical screen) edges. */
73 typedef enum { ADJ_NONE = 0,
74 ADJ_LEFT_SCREEN_EDGE = (1 << 0),
75 ADJ_RIGHT_SCREEN_EDGE = (1 << 1),
76 ADJ_UPPER_SCREEN_EDGE = (1 << 2),
77 ADJ_LOWER_SCREEN_EDGE = (1 << 4) } adjacent_t;
79 typedef enum { HEBM_NONE = ADJ_NONE,
80 HEBM_VERTICAL = ADJ_LEFT_SCREEN_EDGE | ADJ_RIGHT_SCREEN_EDGE,
81 HEBM_HORIZONTAL = ADJ_UPPER_SCREEN_EDGE | ADJ_LOWER_SCREEN_EDGE,
82 HEBM_BOTH = HEBM_VERTICAL | HEBM_HORIZONTAL,
83 HEBM_SMART = (1 << 5) } hide_edge_borders_mode_t;
85 typedef enum { MM_REPLACE,
89 * Container layouts. See Con::layout.
102 * Binding input types. See Binding::input_type.
110 * Bitmask for matching XCB_XKB_GROUP_1 to XCB_XKB_GROUP_4.
113 I3_XKB_GROUP_MASK_ANY = 0,
114 I3_XKB_GROUP_MASK_1 = (1 << 0),
115 I3_XKB_GROUP_MASK_2 = (1 << 1),
116 I3_XKB_GROUP_MASK_3 = (1 << 2),
117 I3_XKB_GROUP_MASK_4 = (1 << 3)
118 } i3_xkb_group_mask_t;
121 * The lower 16 bits contain a xcb_key_but_mask_t, the higher 16 bits contain
122 * an i3_xkb_group_mask_t. This type is necessary for the fallback logic to
123 * work when handling XKB groups (see ticket #1775) and makes the code which
124 * locates keybindings upon KeyPress/KeyRelease events simpler.
126 typedef uint32_t i3_event_state_mask_t;
129 * Mouse pointer warping modes.
132 POINTER_WARPING_OUTPUT = 0,
133 POINTER_WARPING_NONE = 1
137 * Focus wrapping modes.
140 FOCUS_WRAPPING_OFF = 0,
141 FOCUS_WRAPPING_ON = 1,
142 FOCUS_WRAPPING_FORCE = 2
146 * Stores a rectangle, for example the size of a window, the child window etc.
147 * It needs to be packed so that the compiler will not add any padding bytes.
148 * (it is used in src/ewmh.c for example)
150 * Note that x and y can contain signed values in some cases (for example when
151 * used for the coordinates of a window, which can be set outside of the
152 * visible area, but not when specifying the position of a workspace for the
153 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
162 } __attribute__((packed));
165 * Stores the reserved pixels on each screen edge read from a
166 * _NET_WM_STRUT_PARTIAL.
177 * Stores a width/height pair, used as part of deco_render_params to check
178 * whether the rects width/height have changed.
181 struct width_height {
187 * Stores the parameters for rendering a window decoration. This structure is
188 * cached in every Con and no re-rendering will be done if the parameters have
189 * not changed (only the pixmaps will be copied).
192 struct deco_render_params {
193 struct Colortriple *color;
195 struct width_height con_rect;
196 struct width_height con_window_rect;
199 layout_t parent_layout;
204 * Stores which workspace (by name or number) goes to which output.
207 struct Workspace_Assignment {
211 TAILQ_ENTRY(Workspace_Assignment)
215 struct Ignore_Event {
220 SLIST_ENTRY(Ignore_Event)
225 * Stores internal information about a startup sequence, like the workspace it
229 struct Startup_Sequence {
230 /** startup ID for this sequence, generated by libstartup-notification */
232 /** workspace on which this startup was initiated */
234 /** libstartup-notification context for this launch */
235 SnLauncherContext *context;
236 /** time at which this sequence should be deleted (after it was marked as
240 TAILQ_ENTRY(Startup_Sequence)
245 * Regular expression wrapper. It contains the pattern itself as a string (like
246 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
247 * pcre_extra data returned by pcre_study().
249 * This makes it easier to have a useful logfile, including the matching or
250 * non-matching pattern.
260 * Stores a resolved keycode (from a keysym), including the modifier mask. Will
261 * be passed to xcb_grab_key().
264 struct Binding_Keycode {
265 xcb_keycode_t keycode;
266 i3_event_state_mask_t modifiers;
268 TAILQ_ENTRY(Binding_Keycode)
272 /******************************************************************************
274 *****************************************************************************/
277 * Holds a keybinding, consisting of a keycode combined with modifiers and the
278 * command which is executed as soon as the key is pressed (see
279 * src/config_parser.c)
283 /* The type of input this binding is for. (Mouse bindings are not yet
284 * implemented. All bindings are currently assumed to be keyboard bindings.) */
285 input_type_t input_type;
287 /** If true, the binding should be executed upon a KeyRelease event, not a
288 * KeyPress (the default). */
290 /* This binding will only be executed upon KeyPress events */
292 /* This binding will be executed either upon a KeyRelease event, or… */
293 B_UPON_KEYRELEASE = 1,
294 /* …upon a KeyRelease event, even if the modifiers don’t match. This
295 * state is triggered from get_binding() when the corresponding
296 * KeyPress (!) happens, so that users can release the modifier keys
297 * before releasing the actual key. */
298 B_UPON_KEYRELEASE_IGNORE_MODS = 2,
301 /** If this is true for a mouse binding, the binding should be executed
302 * when the button is pressed over the window border. */
305 /** If this is true for a mouse binding, the binding should be executed
306 * when the button is pressed over any part of the window, not just the
307 * title bar (default). */
310 /** If this is true for a mouse binding, the binding should only be
311 * executed if the button press was not on the titlebar. */
312 bool exclude_titlebar;
314 /** Keycode to bind */
317 /** Bitmask which is applied against event->state for KeyPress and
318 * KeyRelease events to determine whether this binding applies to the
320 i3_event_state_mask_t event_state_mask;
322 /** Symbol the user specified in configfile, if any. This needs to be
323 * stored with the binding to be able to re-convert it into a keycode
324 * if the keyboard mapping changes (using Xmodmap for example) */
327 /** Only in use if symbol != NULL. Contains keycodes which generate the
328 * specified symbol. Useful for unbinding and checking which binding was
329 * used when a key press event comes in. */
330 TAILQ_HEAD(keycodes_head, Binding_Keycode)
333 /** Command, like in command mode */
341 * Holds a command specified by either an:
344 * in the config (see src/config.c)
348 /** Command, like in command mode */
350 /** no_startup_id flag for start_application(). Determines whether a
351 * startup notification context/ID should be created. */
354 TAILQ_ENTRY(Autostart)
357 TAILQ_ENTRY(Autostart)
364 SLIST_ENTRY(output_name)
369 * An Output is a physical output on your graphics driver. Outputs which
370 * are currently in use have (output->active == true). Each output has a
371 * position and a mode. An output usually corresponds to one connected
372 * screen (except if you are running multiple screens in clone mode).
376 /** Output id, so that we can requery the output directly later */
377 xcb_randr_output_t id;
379 /** Whether the output is currently active (has a CRTC attached with a
383 /** Internal flags, necessary for querying RandR screens (happens in
389 /** List of names for the output.
390 * An output always has at least one name; the first name is
391 * considered the primary one. */
392 SLIST_HEAD(names_head, output_name)
395 /** Pointer to the Con which represents this output */
398 /** x, y, width, height */
406 * A 'Window' is a type which contains an xcb_window_t and all the related
407 * information (hints like _NET_WM_NAME for that window).
413 /** Holds the xcb_window_t (just an ID) for the leader window (logical
414 * parent for toolwindows and similar floating windows) */
416 xcb_window_t transient_for;
418 /** Pointers to the Assignments which were already ran for this Window
419 * (assignments run only once) */
420 uint32_t nr_assignments;
421 Assignment **ran_assignments;
424 char *class_instance;
426 /** The name of the window. */
429 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
430 * sets "buddy list"). Useful to match specific windows in assignments or
434 /** Flag to force re-rendering the decoration upon changes */
437 /** Whether the application used _NET_WM_NAME */
438 bool uses_net_wm_name;
440 /** Whether the application needs to receive WM_TAKE_FOCUS */
441 bool needs_take_focus;
443 /** Whether this window accepts focus. We store this inverted so that the
444 * default will be 'accepts focus'. */
445 bool doesnt_accept_focus;
447 /** The _NET_WM_WINDOW_TYPE for this window. */
448 xcb_atom_t window_type;
450 /** The _NET_WM_DESKTOP for this window. */
453 /** Whether the window says it is a dock window */
456 W_DOCK_BOTTOM = 2 } dock;
458 /** When this window was marked urgent. 0 means not urgent */
459 struct timeval urgent;
461 /** Pixels the window reserves. left/right/top/bottom */
462 struct reservedpx reserved;
464 /** Depth of the window */
467 /* the wanted size of the window, used in combination with size
468 * increments (see below). */
472 /* minimum increment size specified for the window (in pixels) */
474 int height_increment;
476 /* Minimum size specified for the window. */
480 /* Maximum size specified for the window. */
484 /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */
489 * A "match" is a data structure which acts like a mask or expression to match
490 * certain windows or not. For example, when using commands, you can specify a
491 * command like this: [title="*Firefox*"] kill. The title member of the match
492 * data structure will then be filled and i3 will check each window using
493 * match_matches_window() to find the windows affected by this command.
497 /* Set if a criterion was specified incorrectly. */
501 struct regex *application;
503 struct regex *instance;
505 struct regex *window_role;
506 struct regex *workspace;
507 xcb_atom_t window_type;
523 WM_FLOATING } window_mode;
526 /* Where the window looking for a match should be inserted:
528 * M_HERE = the matched container will be replaced by the window
530 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
531 * M_BELOW = the window will be inserted as a child of the matched container
537 M_BELOW } insert_where;
542 /* Whether this match was generated when restarting i3 inplace.
543 * Leads to not setting focus when managing a new window, because the old
544 * focus stack should be restored. */
549 * An Assignment makes specific windows go to a specific workspace/output or
550 * run a command for that window. With this mechanism, the user can -- for
551 * example -- assign their browser to workspace "www". Checking if a window is
552 * assigned works by comparing the Match data structure with the window (see
553 * match_matches_window()).
557 /** type of this assignment:
559 * A_COMMAND = run the specified command for the matching window
560 * A_TO_WORKSPACE = assign the matching window to the specified workspace
561 * A_NO_FOCUS = don't focus matched window when it is managed
563 * While the type is a bitmask, only one value can be set at a time. It is
564 * a bitmask to allow filtering for multiple types, for example in the
565 * assignment_for() function.
570 A_COMMAND = (1 << 0),
571 A_TO_WORKSPACE = (1 << 1),
572 A_NO_FOCUS = (1 << 2),
573 A_TO_WORKSPACE_NUMBER = (1 << 3),
574 A_TO_OUTPUT = (1 << 4)
577 /** the criteria to check if a window matches */
580 /** destination workspace/command/output, depending on the type */
587 TAILQ_ENTRY(Assignment)
591 /** Fullscreen modes. Used by Con.fullscreen_mode. */
592 typedef enum { CF_NONE = 0,
594 CF_GLOBAL = 2 } fullscreen_mode_t;
604 * A 'Con' represents everything from the X11 root window down to a single X11 window.
610 /* Should this container be marked urgent? This gets set when the window
611 * inside this container (if any) sets the urgency hint, for example. */
614 /** This counter contains the number of UnmapNotify events for this
615 * container (or, more precisely, for its ->frame) which should be ignored.
616 * UnmapNotify events need to be ignored when they are caused by i3 itself,
617 * for example when reparenting or when unmapping the window on a workspace
619 uint8_t ignore_unmap;
621 /* The surface used for the frame window. */
623 surface_t frame_buffer;
624 bool pixmap_recreated;
635 /** the workspace number, if this Con is of type CT_WORKSPACE and the
636 * workspace is not a named workspace (for named workspaces, num == -1) */
641 /* The position and size for this con. These coordinates are absolute. Note
642 * that the rect of a container does not include the decoration. */
644 /* The position and size of the actual client window. These coordinates are
645 * relative to the container's rect. */
646 struct Rect window_rect;
647 /* The position and size of the container's decoration. These coordinates
648 * are relative to the container's parent's rect. */
649 struct Rect deco_rect;
650 /** the geometry this window requested when getting mapped */
651 struct Rect geometry;
655 /** The format with which the window's name should be displayed. */
658 /* a sticky-group is an identifier which bundles several containers to a
659 * group. The contents are shared between all of them, that is they are
660 * displayed on whichever of the containers is currently visible */
663 /* user-definable marks to jump to this container later */
664 TAILQ_HEAD(marks_head, mark_t)
666 /* cached to decide whether a redraw is needed */
671 /* the x11 border pixel attribute */
673 int current_border_width;
675 struct Window *window;
677 /* timer used for disabling urgency */
678 struct ev_timer *urgency_timer;
680 /** Cache for the decoration rendering */
681 struct deco_render_params *deco_render_params;
683 /* Only workspace-containers can have floating clients */
684 TAILQ_HEAD(floating_head, Con)
687 TAILQ_HEAD(nodes_head, Con)
690 TAILQ_HEAD(focus_head, Con)
693 TAILQ_HEAD(swallow_head, Match)
696 fullscreen_mode_t fullscreen_mode;
698 /* Whether this window should stick to the glass. This corresponds to
699 * the _NET_WM_STATE_STICKY atom and will only be respected if the
700 * window is floating. */
703 /* layout is the layout of this container: one of split[v|h], stacked or
704 * tabbed. Special containers in the tree (above workspaces) have special
705 * layouts like dockarea or output.
707 * last_split_layout is one of splitv or splith to support the old "layout
708 * default" command which by now should be "layout splitv" or "layout
709 * splith" explicitly.
711 * workspace_layout is only for type == CT_WORKSPACE cons. When you change
712 * the layout of a workspace without any children, i3 cannot just set the
713 * layout (because workspaces need to be splitv/splith to allow focus
714 * parent and opening new containers). Instead, it stores the requested
715 * layout in workspace_layout and creates a new split container with that
716 * layout whenever a new container is attached to the workspace. */
717 layout_t layout, last_split_layout, workspace_layout;
718 border_style_t border_style;
719 /** floating? (= not in tiling layout) This cannot be simply a bool
720 * because we want to keep track of whether the status was set by the
721 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
722 * user. The user’s choice overwrites automatic mode, of course. The
723 * order of the values is important because we check with >=
724 * FLOATING_AUTO_ON if a client is floating. */
726 FLOATING_AUTO_OFF = 0,
727 FLOATING_USER_OFF = 1,
728 FLOATING_AUTO_ON = 2,
745 void (*on_remove_child)(Con *);
748 /* Not a scratchpad window. */
751 /* Just moved to scratchpad, not resized by the user yet.
752 * Window will be auto-centered and sized appropriately. */
753 SCRATCHPAD_FRESH = 1,
755 /* The user changed position/size of the scratchpad window. */
756 SCRATCHPAD_CHANGED = 2
759 /* The ID of this container before restarting. Necessary to correctly
760 * interpret back-references in the JSON (such as the focus stack). */
763 /* Depth of the container window */
766 /* The colormap for this con if a custom one is used. */
767 xcb_colormap_t colormap;