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 * Stores a rectangle, for example the size of a window, the child window etc.
138 * It needs to be packed so that the compiler will not add any padding bytes.
139 * (it is used in src/ewmh.c for example)
141 * Note that x and y can contain signed values in some cases (for example when
142 * used for the coordinates of a window, which can be set outside of the
143 * visible area, but not when specifying the position of a workspace for the
144 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
153 } __attribute__((packed));
156 * Stores the reserved pixels on each screen edge read from a
157 * _NET_WM_STRUT_PARTIAL.
168 * Stores a width/height pair, used as part of deco_render_params to check
169 * whether the rects width/height have changed.
172 struct width_height {
178 * Stores the parameters for rendering a window decoration. This structure is
179 * cached in every Con and no re-rendering will be done if the parameters have
180 * not changed (only the pixmaps will be copied).
183 struct deco_render_params {
184 struct Colortriple *color;
186 struct width_height con_rect;
187 struct width_height con_window_rect;
190 layout_t parent_layout;
195 * Stores which workspace (by name or number) goes to which output.
198 struct Workspace_Assignment {
202 TAILQ_ENTRY(Workspace_Assignment)
206 struct Ignore_Event {
211 SLIST_ENTRY(Ignore_Event)
216 * Stores internal information about a startup sequence, like the workspace it
220 struct Startup_Sequence {
221 /** startup ID for this sequence, generated by libstartup-notification */
223 /** workspace on which this startup was initiated */
225 /** libstartup-notification context for this launch */
226 SnLauncherContext *context;
227 /** time at which this sequence should be deleted (after it was marked as
231 TAILQ_ENTRY(Startup_Sequence)
236 * Regular expression wrapper. It contains the pattern itself as a string (like
237 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
238 * pcre_extra data returned by pcre_study().
240 * This makes it easier to have a useful logfile, including the matching or
241 * non-matching pattern.
251 * Stores a resolved keycode (from a keysym), including the modifier mask. Will
252 * be passed to xcb_grab_key().
255 struct Binding_Keycode {
256 xcb_keycode_t keycode;
257 i3_event_state_mask_t modifiers;
259 TAILQ_ENTRY(Binding_Keycode)
263 /******************************************************************************
265 *****************************************************************************/
268 * Holds a keybinding, consisting of a keycode combined with modifiers and the
269 * command which is executed as soon as the key is pressed (see
270 * src/config_parser.c)
274 /* The type of input this binding is for. (Mouse bindings are not yet
275 * implemented. All bindings are currently assumed to be keyboard bindings.) */
276 input_type_t input_type;
278 /** If true, the binding should be executed upon a KeyRelease event, not a
279 * KeyPress (the default). */
281 /* This binding will only be executed upon KeyPress events */
283 /* This binding will be executed either upon a KeyRelease event, or… */
284 B_UPON_KEYRELEASE = 1,
285 /* …upon a KeyRelease event, even if the modifiers don’t match. This
286 * state is triggered from get_binding() when the corresponding
287 * KeyPress (!) happens, so that users can release the modifier keys
288 * before releasing the actual key. */
289 B_UPON_KEYRELEASE_IGNORE_MODS = 2,
292 /** If this is true for a mouse binding, the binding should be executed
293 * when the button is pressed over the window border. */
296 /** If this is true for a mouse binding, the binding should be executed
297 * when the button is pressed over any part of the window, not just the
298 * title bar (default). */
301 /** Keycode to bind */
304 /** Bitmask which is applied against event->state for KeyPress and
305 * KeyRelease events to determine whether this binding applies to the
307 i3_event_state_mask_t event_state_mask;
309 /** Symbol the user specified in configfile, if any. This needs to be
310 * stored with the binding to be able to re-convert it into a keycode
311 * if the keyboard mapping changes (using Xmodmap for example) */
314 /** Only in use if symbol != NULL. Contains keycodes which generate the
315 * specified symbol. Useful for unbinding and checking which binding was
316 * used when a key press event comes in. */
317 TAILQ_HEAD(keycodes_head, Binding_Keycode)
320 /** Command, like in command mode */
328 * Holds a command specified by either an:
331 * in the config (see src/config.c)
335 /** Command, like in command mode */
337 /** no_startup_id flag for start_application(). Determines whether a
338 * startup notification context/ID should be created. */
341 TAILQ_ENTRY(Autostart)
344 TAILQ_ENTRY(Autostart)
349 * An Output is a physical output on your graphics driver. Outputs which
350 * are currently in use have (output->active == true). Each output has a
351 * position and a mode. An output usually corresponds to one connected
352 * screen (except if you are running multiple screens in clone mode).
356 /** Output id, so that we can requery the output directly later */
357 xcb_randr_output_t id;
359 /** Whether the output is currently active (has a CRTC attached with a
363 /** Internal flags, necessary for querying RandR screens (happens in
369 /** Name of the output */
372 /** Pointer to the Con which represents this output */
375 /** x, y, width, height */
383 * A 'Window' is a type which contains an xcb_window_t and all the related
384 * information (hints like _NET_WM_NAME for that window).
390 /** Holds the xcb_window_t (just an ID) for the leader window (logical
391 * parent for toolwindows and similar floating windows) */
393 xcb_window_t transient_for;
395 /** Pointers to the Assignments which were already ran for this Window
396 * (assignments run only once) */
397 uint32_t nr_assignments;
398 Assignment **ran_assignments;
401 char *class_instance;
403 /** The name of the window. */
406 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
407 * sets "buddy list"). Useful to match specific windows in assignments or
411 /** Flag to force re-rendering the decoration upon changes */
414 /** Whether the application used _NET_WM_NAME */
415 bool uses_net_wm_name;
417 /** Whether the application needs to receive WM_TAKE_FOCUS */
418 bool needs_take_focus;
420 /** Whether this window accepts focus. We store this inverted so that the
421 * default will be 'accepts focus'. */
422 bool doesnt_accept_focus;
424 /** The _NET_WM_WINDOW_TYPE for this window. */
425 xcb_atom_t window_type;
427 /** The _NET_WM_DESKTOP for this window. */
430 /** Whether the window says it is a dock window */
433 W_DOCK_BOTTOM = 2 } dock;
435 /** When this window was marked urgent. 0 means not urgent */
436 struct timeval urgent;
438 /** Pixels the window reserves. left/right/top/bottom */
439 struct reservedpx reserved;
441 /** Depth of the window */
444 /* the wanted size of the window, used in combination with size
445 * increments (see below). */
449 /* minimum increment size specified for the window (in pixels) */
451 int height_increment;
453 /* Minimum size specified for the window. */
457 /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */
462 * A "match" is a data structure which acts like a mask or expression to match
463 * certain windows or not. For example, when using commands, you can specify a
464 * command like this: [title="*Firefox*"] kill. The title member of the match
465 * data structure will then be filled and i3 will check each window using
466 * match_matches_window() to find the windows affected by this command.
470 /* Set if a criterion was specified incorrectly. */
474 struct regex *application;
476 struct regex *instance;
478 struct regex *window_role;
479 struct regex *workspace;
480 xcb_atom_t window_type;
496 WM_FLOATING } window_mode;
499 /* Where the window looking for a match should be inserted:
501 * M_HERE = the matched container will be replaced by the window
503 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
504 * M_BELOW = the window will be inserted as a child of the matched container
510 M_BELOW } insert_where;
515 /* Whether this match was generated when restarting i3 inplace.
516 * Leads to not setting focus when managing a new window, because the old
517 * focus stack should be restored. */
522 * An Assignment makes specific windows go to a specific workspace/output or
523 * run a command for that window. With this mechanism, the user can -- for
524 * example -- assign their browser to workspace "www". Checking if a window is
525 * assigned works by comparing the Match data structure with the window (see
526 * match_matches_window()).
530 /** type of this assignment:
532 * A_COMMAND = run the specified command for the matching window
533 * A_TO_WORKSPACE = assign the matching window to the specified workspace
534 * A_NO_FOCUS = don't focus matched window when it is managed
536 * While the type is a bitmask, only one value can be set at a time. It is
537 * a bitmask to allow filtering for multiple types, for example in the
538 * assignment_for() function.
543 A_COMMAND = (1 << 0),
544 A_TO_WORKSPACE = (1 << 1),
545 A_NO_FOCUS = (1 << 2)
548 /** the criteria to check if a window matches */
551 /** destination workspace/command, depending on the type */
557 TAILQ_ENTRY(Assignment)
561 /** Fullscreen modes. Used by Con.fullscreen_mode. */
562 typedef enum { CF_NONE = 0,
564 CF_GLOBAL = 2 } fullscreen_mode_t;
574 * A 'Con' represents everything from the X11 root window down to a single X11 window.
580 /* Should this container be marked urgent? This gets set when the window
581 * inside this container (if any) sets the urgency hint, for example. */
584 /** This counter contains the number of UnmapNotify events for this
585 * container (or, more precisely, for its ->frame) which should be ignored.
586 * UnmapNotify events need to be ignored when they are caused by i3 itself,
587 * for example when reparenting or when unmapping the window on a workspace
589 uint8_t ignore_unmap;
591 /* The surface used for the frame window. */
593 surface_t frame_buffer;
594 bool pixmap_recreated;
605 /** the workspace number, if this Con is of type CT_WORKSPACE and the
606 * workspace is not a named workspace (for named workspaces, num == -1) */
611 /* The position and size for this con. These coordinates are absolute. Note
612 * that the rect of a container does not include the decoration. */
614 /* The position and size of the actual client window. These coordinates are
615 * relative to the container's rect. */
616 struct Rect window_rect;
617 /* The position and size of the container's decoration. These coordinates
618 * are relative to the container's parent's rect. */
619 struct Rect deco_rect;
620 /** the geometry this window requested when getting mapped */
621 struct Rect geometry;
625 /** The format with which the window's name should be displayed. */
628 /* a sticky-group is an identifier which bundles several containers to a
629 * group. The contents are shared between all of them, that is they are
630 * displayed on whichever of the containers is currently visible */
633 /* user-definable marks to jump to this container later */
634 TAILQ_HEAD(marks_head, mark_t)
636 /* cached to decide whether a redraw is needed */
641 /* the x11 border pixel attribute */
643 int current_border_width;
645 struct Window *window;
647 /* timer used for disabling urgency */
648 struct ev_timer *urgency_timer;
650 /** Cache for the decoration rendering */
651 struct deco_render_params *deco_render_params;
653 /* Only workspace-containers can have floating clients */
654 TAILQ_HEAD(floating_head, Con)
657 TAILQ_HEAD(nodes_head, Con)
660 TAILQ_HEAD(focus_head, Con)
663 TAILQ_HEAD(swallow_head, Match)
666 fullscreen_mode_t fullscreen_mode;
668 /* Whether this window should stick to the glass. This corresponds to
669 * the _NET_WM_STATE_STICKY atom and will only be respected if the
670 * window is floating. */
673 /* layout is the layout of this container: one of split[v|h], stacked or
674 * tabbed. Special containers in the tree (above workspaces) have special
675 * layouts like dockarea or output.
677 * last_split_layout is one of splitv or splith to support the old "layout
678 * default" command which by now should be "layout splitv" or "layout
679 * splith" explicitly.
681 * workspace_layout is only for type == CT_WORKSPACE cons. When you change
682 * the layout of a workspace without any children, i3 cannot just set the
683 * layout (because workspaces need to be splitv/splith to allow focus
684 * parent and opening new containers). Instead, it stores the requested
685 * layout in workspace_layout and creates a new split container with that
686 * layout whenever a new container is attached to the workspace. */
687 layout_t layout, last_split_layout, workspace_layout;
688 border_style_t border_style;
689 /** floating? (= not in tiling layout) This cannot be simply a bool
690 * because we want to keep track of whether the status was set by the
691 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
692 * user. The user’s choice overwrites automatic mode, of course. The
693 * order of the values is important because we check with >=
694 * FLOATING_AUTO_ON if a client is floating. */
696 FLOATING_AUTO_OFF = 0,
697 FLOATING_USER_OFF = 1,
698 FLOATING_AUTO_ON = 2,
715 void (*on_remove_child)(Con *);
718 /* Not a scratchpad window. */
721 /* Just moved to scratchpad, not resized by the user yet.
722 * Window will be auto-centered and sized appropriately. */
723 SCRATCHPAD_FRESH = 1,
725 /* The user changed position/size of the scratchpad window. */
726 SCRATCHPAD_CHANGED = 2
729 /* The ID of this container before restarting. Necessary to correctly
730 * interpret back-references in the JSON (such as the focus stack). */
733 /* Depth of the container window */
736 /* The colormap for this con if a custom one is used. */
737 xcb_colormap_t colormap;