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
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;
49 typedef struct mark_t mark_t;
51 /******************************************************************************
53 *****************************************************************************/
54 typedef enum { D_LEFT,
58 typedef enum { NO_ORIENTATION = 0,
61 typedef enum { BS_NORMAL = 0,
63 BS_PIXEL = 2 } border_style_t;
65 /** parameter to specify whether tree_close_internal() and x_window_kill() should kill
66 * only this specific window or the whole X11 client */
67 typedef enum { DONT_KILL_WINDOW = 0,
69 KILL_CLIENT = 2 } kill_window_t;
71 /** describes if the window is adjacent to the output (physical screen) edges. */
72 typedef enum { ADJ_NONE = 0,
73 ADJ_LEFT_SCREEN_EDGE = (1 << 0),
74 ADJ_RIGHT_SCREEN_EDGE = (1 << 1),
75 ADJ_UPPER_SCREEN_EDGE = (1 << 2),
76 ADJ_LOWER_SCREEN_EDGE = (1 << 4) } adjacent_t;
78 typedef enum { HEBM_NONE = ADJ_NONE,
79 HEBM_VERTICAL = ADJ_LEFT_SCREEN_EDGE | ADJ_RIGHT_SCREEN_EDGE,
80 HEBM_HORIZONTAL = ADJ_UPPER_SCREEN_EDGE | ADJ_LOWER_SCREEN_EDGE,
81 HEBM_BOTH = HEBM_VERTICAL | HEBM_HORIZONTAL,
82 HEBM_SMART = (1 << 5) } hide_edge_borders_mode_t;
84 typedef enum { MM_REPLACE,
88 * Container layouts. See Con::layout.
101 * Binding input types. See Binding::input_type.
109 * Bitmask for matching XCB_XKB_GROUP_1 to XCB_XKB_GROUP_4.
112 I3_XKB_GROUP_MASK_ANY = 0,
113 I3_XKB_GROUP_MASK_1 = (1 << 0),
114 I3_XKB_GROUP_MASK_2 = (1 << 1),
115 I3_XKB_GROUP_MASK_3 = (1 << 2),
116 I3_XKB_GROUP_MASK_4 = (1 << 3)
117 } i3_xkb_group_mask_t;
120 * The lower 16 bits contain a xcb_key_but_mask_t, the higher 16 bits contain
121 * an i3_xkb_group_mask_t. This type is necessary for the fallback logic to
122 * work when handling XKB groups (see ticket #1775) and makes the code which
123 * locates keybindings upon KeyPress/KeyRelease events simpler.
125 typedef uint32_t i3_event_state_mask_t;
128 * Mouse pointer warping modes.
131 POINTER_WARPING_OUTPUT = 0,
132 POINTER_WARPING_NONE = 1
136 * Stores a rectangle, for example the size of a window, the child window etc.
137 * It needs to be packed so that the compiler will not add any padding bytes.
138 * (it is used in src/ewmh.c for example)
140 * Note that x and y can contain signed values in some cases (for example when
141 * used for the coordinates of a window, which can be set outside of the
142 * visible area, but not when specifying the position of a workspace for the
143 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
152 } __attribute__((packed));
155 * Stores the reserved pixels on each screen edge read from a
156 * _NET_WM_STRUT_PARTIAL.
167 * Stores a width/height pair, used as part of deco_render_params to check
168 * whether the rects width/height have changed.
171 struct width_height {
177 * Stores the parameters for rendering a window decoration. This structure is
178 * cached in every Con and no re-rendering will be done if the parameters have
179 * not changed (only the pixmaps will be copied).
182 struct deco_render_params {
183 struct Colortriple *color;
185 struct width_height con_rect;
186 struct width_height con_window_rect;
189 layout_t parent_layout;
194 * Stores which workspace (by name or number) goes to which output.
197 struct Workspace_Assignment {
201 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
204 struct Ignore_Event {
209 SLIST_ENTRY(Ignore_Event) ignore_events;
213 * Stores internal information about a startup sequence, like the workspace it
217 struct Startup_Sequence {
218 /** startup ID for this sequence, generated by libstartup-notification */
220 /** workspace on which this startup was initiated */
222 /** libstartup-notification context for this launch */
223 SnLauncherContext *context;
224 /** time at which this sequence should be deleted (after it was marked as
228 TAILQ_ENTRY(Startup_Sequence) sequences;
232 * Regular expression wrapper. It contains the pattern itself as a string (like
233 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
234 * pcre_extra data returned by pcre_study().
236 * This makes it easier to have a useful logfile, including the matching or
237 * non-matching pattern.
247 * Stores a resolved keycode (from a keysym), including the modifier mask. Will
248 * be passed to xcb_grab_key().
251 struct Binding_Keycode {
252 xcb_keycode_t keycode;
253 i3_event_state_mask_t modifiers;
254 TAILQ_ENTRY(Binding_Keycode) keycodes;
257 /******************************************************************************
259 *****************************************************************************/
262 * Holds a keybinding, consisting of a keycode combined with modifiers and the
263 * command which is executed as soon as the key is pressed (see
264 * src/config_parser.c)
268 /* The type of input this binding is for. (Mouse bindings are not yet
269 * implemented. All bindings are currently assumed to be keyboard bindings.) */
270 input_type_t input_type;
272 /** If true, the binding should be executed upon a KeyRelease event, not a
273 * KeyPress (the default). */
275 /* This binding will only be executed upon KeyPress events */
277 /* This binding will be executed either upon a KeyRelease event, or… */
278 B_UPON_KEYRELEASE = 1,
279 /* …upon a KeyRelease event, even if the modifiers don’t match. This
280 * state is triggered from get_binding() when the corresponding
281 * KeyPress (!) happens, so that users can release the modifier keys
282 * before releasing the actual key. */
283 B_UPON_KEYRELEASE_IGNORE_MODS = 2,
286 /** If this is true for a mouse binding, the binding should be executed
287 * when the button is pressed over the window border. */
290 /** If this is true for a mouse binding, the binding should be executed
291 * when the button is pressed over any part of the window, not just the
292 * title bar (default). */
295 /** Keycode to bind */
298 /** Bitmask which is applied against event->state for KeyPress and
299 * KeyRelease events to determine whether this binding applies to the
301 i3_event_state_mask_t event_state_mask;
303 /** Symbol the user specified in configfile, if any. This needs to be
304 * stored with the binding to be able to re-convert it into a keycode
305 * if the keyboard mapping changes (using Xmodmap for example) */
308 /** Only in use if symbol != NULL. Contains keycodes which generate the
309 * specified symbol. Useful for unbinding and checking which binding was
310 * used when a key press event comes in. */
311 TAILQ_HEAD(keycodes_head, Binding_Keycode) keycodes_head;
313 /** Command, like in command mode */
316 TAILQ_ENTRY(Binding) bindings;
320 * Holds a command specified by either an:
323 * in the config (see src/config.c)
327 /** Command, like in command mode */
329 /** no_startup_id flag for start_application(). Determines whether a
330 * startup notification context/ID should be created. */
332 TAILQ_ENTRY(Autostart) autostarts;
333 TAILQ_ENTRY(Autostart) autostarts_always;
337 * An Output is a physical output on your graphics driver. Outputs which
338 * are currently in use have (output->active == true). Each output has a
339 * position and a mode. An output usually corresponds to one connected
340 * screen (except if you are running multiple screens in clone mode).
344 /** Output id, so that we can requery the output directly later */
345 xcb_randr_output_t id;
347 /** Whether the output is currently active (has a CRTC attached with a
351 /** Internal flags, necessary for querying RandR screens (happens in
357 /** Name of the output */
360 /** Pointer to the Con which represents this output */
363 /** x, y, width, height */
366 TAILQ_ENTRY(xoutput) outputs;
370 * A 'Window' is a type which contains an xcb_window_t and all the related
371 * information (hints like _NET_WM_NAME for that window).
377 /** Holds the xcb_window_t (just an ID) for the leader window (logical
378 * parent for toolwindows and similar floating windows) */
380 xcb_window_t transient_for;
382 /** Pointers to the Assignments which were already ran for this Window
383 * (assignments run only once) */
384 uint32_t nr_assignments;
385 Assignment **ran_assignments;
388 char *class_instance;
390 /** The name of the window. */
393 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
394 * sets "buddy list"). Useful to match specific windows in assignments or
398 /** Flag to force re-rendering the decoration upon changes */
401 /** Whether the application used _NET_WM_NAME */
402 bool uses_net_wm_name;
404 /** Whether the application needs to receive WM_TAKE_FOCUS */
405 bool needs_take_focus;
407 /** Whether this window accepts focus. We store this inverted so that the
408 * default will be 'accepts focus'. */
409 bool doesnt_accept_focus;
411 /** The _NET_WM_WINDOW_TYPE for this window. */
412 xcb_atom_t window_type;
414 /** The _NET_WM_DESKTOP for this window. */
417 /** Whether the window says it is a dock window */
420 W_DOCK_BOTTOM = 2 } dock;
422 /** When this window was marked urgent. 0 means not urgent */
423 struct timeval urgent;
425 /** Pixels the window reserves. left/right/top/bottom */
426 struct reservedpx reserved;
428 /** Depth of the window */
431 /* the wanted size of the window, used in combination with size
432 * increments (see below). */
436 /* minimum increment size specified for the window (in pixels) */
438 int height_increment;
440 /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */
445 * A "match" is a data structure which acts like a mask or expression to match
446 * certain windows or not. For example, when using commands, you can specify a
447 * command like this: [title="*Firefox*"] kill. The title member of the match
448 * data structure will then be filled and i3 will check each window using
449 * match_matches_window() to find the windows affected by this command.
453 /* Set if a criterion was specified incorrectly. */
457 struct regex *application;
459 struct regex *instance;
461 struct regex *window_role;
462 struct regex *workspace;
463 xcb_atom_t window_type;
479 WM_FLOATING } window_mode;
482 /* Where the window looking for a match should be inserted:
484 * M_HERE = the matched container will be replaced by the window
486 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
487 * M_BELOW = the window will be inserted as a child of the matched container
493 M_BELOW } insert_where;
495 TAILQ_ENTRY(Match) matches;
497 /* Whether this match was generated when restarting i3 inplace.
498 * Leads to not setting focus when managing a new window, because the old
499 * focus stack should be restored. */
504 * An Assignment makes specific windows go to a specific workspace/output or
505 * run a command for that window. With this mechanism, the user can -- for
506 * example -- assign their browser to workspace "www". Checking if a window is
507 * assigned works by comparing the Match data structure with the window (see
508 * match_matches_window()).
512 /** type of this assignment:
514 * A_COMMAND = run the specified command for the matching window
515 * A_TO_WORKSPACE = assign the matching window to the specified workspace
516 * A_NO_FOCUS = don't focus matched window when it is managed
518 * While the type is a bitmask, only one value can be set at a time. It is
519 * a bitmask to allow filtering for multiple types, for example in the
520 * assignment_for() function.
525 A_COMMAND = (1 << 0),
526 A_TO_WORKSPACE = (1 << 1),
527 A_NO_FOCUS = (1 << 2)
530 /** the criteria to check if a window matches */
533 /** destination workspace/command, depending on the type */
539 TAILQ_ENTRY(Assignment) assignments;
542 /** Fullscreen modes. Used by Con.fullscreen_mode. */
543 typedef enum { CF_NONE = 0,
545 CF_GLOBAL = 2 } fullscreen_mode_t;
550 TAILQ_ENTRY(mark_t) marks;
554 * A 'Con' represents everything from the X11 root window down to a single X11 window.
560 /* Should this container be marked urgent? This gets set when the window
561 * inside this container (if any) sets the urgency hint, for example. */
564 /** This counter contains the number of UnmapNotify events for this
565 * container (or, more precisely, for its ->frame) which should be ignored.
566 * UnmapNotify events need to be ignored when they are caused by i3 itself,
567 * for example when reparenting or when unmapping the window on a workspace
569 uint8_t ignore_unmap;
571 /* The surface used for the frame window. */
573 surface_t frame_buffer;
574 bool pixmap_recreated;
585 /** the workspace number, if this Con is of type CT_WORKSPACE and the
586 * workspace is not a named workspace (for named workspaces, num == -1) */
591 /* The position and size for this con. These coordinates are absolute. Note
592 * that the rect of a container does not include the decoration. */
594 /* The position and size of the actual client window. These coordinates are
595 * relative to the container's rect. */
596 struct Rect window_rect;
597 /* The position and size of the container's decoration. These coordinates
598 * are relative to the container's parent's rect. */
599 struct Rect deco_rect;
600 /** the geometry this window requested when getting mapped */
601 struct Rect geometry;
605 /** The format with which the window's name should be displayed. */
608 /* a sticky-group is an identifier which bundles several containers to a
609 * group. The contents are shared between all of them, that is they are
610 * displayed on whichever of the containers is currently visible */
613 /* user-definable marks to jump to this container later */
614 TAILQ_HEAD(marks_head, mark_t) marks_head;
615 /* cached to decide whether a redraw is needed */
620 /* the x11 border pixel attribute */
622 int current_border_width;
624 struct Window *window;
626 /* timer used for disabling urgency */
627 struct ev_timer *urgency_timer;
629 /** Cache for the decoration rendering */
630 struct deco_render_params *deco_render_params;
632 /* Only workspace-containers can have floating clients */
633 TAILQ_HEAD(floating_head, Con) floating_head;
635 TAILQ_HEAD(nodes_head, Con) nodes_head;
636 TAILQ_HEAD(focus_head, Con) focus_head;
638 TAILQ_HEAD(swallow_head, Match) swallow_head;
640 fullscreen_mode_t fullscreen_mode;
642 /* Whether this window should stick to the glass. This corresponds to
643 * the _NET_WM_STATE_STICKY atom and will only be respected if the
644 * window is floating. */
647 /* layout is the layout of this container: one of split[v|h], stacked or
648 * tabbed. Special containers in the tree (above workspaces) have special
649 * layouts like dockarea or output.
651 * last_split_layout is one of splitv or splith to support the old "layout
652 * default" command which by now should be "layout splitv" or "layout
653 * splith" explicitly.
655 * workspace_layout is only for type == CT_WORKSPACE cons. When you change
656 * the layout of a workspace without any children, i3 cannot just set the
657 * layout (because workspaces need to be splitv/splith to allow focus
658 * parent and opening new containers). Instead, it stores the requested
659 * layout in workspace_layout and creates a new split container with that
660 * layout whenever a new container is attached to the workspace. */
661 layout_t layout, last_split_layout, workspace_layout;
662 border_style_t border_style;
663 /** floating? (= not in tiling layout) This cannot be simply a bool
664 * because we want to keep track of whether the status was set by the
665 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
666 * user. The user’s choice overwrites automatic mode, of course. The
667 * order of the values is important because we check with >=
668 * FLOATING_AUTO_ON if a client is floating. */
670 FLOATING_AUTO_OFF = 0,
671 FLOATING_USER_OFF = 1,
672 FLOATING_AUTO_ON = 2,
676 TAILQ_ENTRY(Con) nodes;
677 TAILQ_ENTRY(Con) focused;
678 TAILQ_ENTRY(Con) all_cons;
679 TAILQ_ENTRY(Con) floating_windows;
682 void (*on_remove_child)(Con *);
685 /* Not a scratchpad window. */
688 /* Just moved to scratchpad, not resized by the user yet.
689 * Window will be auto-centered and sized appropriately. */
690 SCRATCHPAD_FRESH = 1,
692 /* The user changed position/size of the scratchpad window. */
693 SCRATCHPAD_CHANGED = 2
696 /* The ID of this container before restarting. Necessary to correctly
697 * interpret back-references in the JSON (such as the focus stack). */
700 /* Depth of the container window */
703 /* The colormap for this con if a custom one is used. */
704 xcb_colormap_t colormap;