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;
50 /******************************************************************************
52 *****************************************************************************/
53 typedef enum { D_LEFT,
57 typedef enum { NO_ORIENTATION = 0,
60 typedef enum { BS_NORMAL = 0,
62 BS_PIXEL = 2 } border_style_t;
64 /** parameter to specify whether tree_close() and x_window_kill() should kill
65 * only this specific window or the whole X11 client */
66 typedef enum { DONT_KILL_WINDOW = 0,
68 KILL_CLIENT = 2 } kill_window_t;
70 /** describes if the window is adjacent to the output (physical screen) edges. */
71 typedef enum { ADJ_NONE = 0,
72 ADJ_LEFT_SCREEN_EDGE = (1 << 0),
73 ADJ_RIGHT_SCREEN_EDGE = (1 << 1),
74 ADJ_UPPER_SCREEN_EDGE = (1 << 2),
75 ADJ_LOWER_SCREEN_EDGE = (1 << 4) } adjacent_t;
79 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
80 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
81 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
82 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
83 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
84 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
85 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
86 BIND_MODE_SWITCH = (1 << 8)
90 * Container layouts. See Con::layout.
103 * Binding input types. See Binding::input_type.
111 * Mouse pointer warping modes.
114 POINTER_WARPING_OUTPUT = 0,
115 POINTER_WARPING_NONE = 1
119 * Stores a rectangle, for example the size of a window, the child window etc.
120 * It needs to be packed so that the compiler will not add any padding bytes.
121 * (it is used in src/ewmh.c for example)
123 * Note that x and y can contain signed values in some cases (for example when
124 * used for the coordinates of a window, which can be set outside of the
125 * visible area, but not when specifying the position of a workspace for the
126 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
135 } __attribute__((packed));
138 * Stores the reserved pixels on each screen edge read from a
139 * _NET_WM_STRUT_PARTIAL.
150 * Stores a width/height pair, used as part of deco_render_params to check
151 * whether the rects width/height have changed.
154 struct width_height {
160 * Stores the parameters for rendering a window decoration. This structure is
161 * cached in every Con and no re-rendering will be done if the parameters have
162 * not changed (only the pixmaps will be copied).
165 struct deco_render_params {
166 struct Colortriple *color;
168 struct width_height con_rect;
169 struct width_height con_window_rect;
172 layout_t parent_layout;
177 * Stores which workspace (by name or number) goes to which output.
180 struct Workspace_Assignment {
184 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
187 struct Ignore_Event {
192 SLIST_ENTRY(Ignore_Event) ignore_events;
196 * Stores internal information about a startup sequence, like the workspace it
200 struct Startup_Sequence {
201 /** startup ID for this sequence, generated by libstartup-notification */
203 /** workspace on which this startup was initiated */
205 /** libstartup-notification context for this launch */
206 SnLauncherContext *context;
207 /** time at which this sequence should be deleted (after it was marked as
211 TAILQ_ENTRY(Startup_Sequence) sequences;
215 * Regular expression wrapper. It contains the pattern itself as a string (like
216 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
217 * pcre_extra data returned by pcre_study().
219 * This makes it easier to have a useful logfile, including the matching or
220 * non-matching pattern.
229 /******************************************************************************
231 *****************************************************************************/
234 * Holds a keybinding, consisting of a keycode combined with modifiers and the
235 * command which is executed as soon as the key is pressed (see
236 * src/config_parser.c)
240 /* The type of input this binding is for. (Mouse bindings are not yet
241 * implemented. All bindings are currently assumed to be keyboard bindings.) */
242 input_type_t input_type;
244 /** If true, the binding should be executed upon a KeyRelease event, not a
245 * KeyPress (the default). */
247 /* This binding will only be executed upon KeyPress events */
249 /* This binding will be executed either upon a KeyRelease event, or… */
250 B_UPON_KEYRELEASE = 1,
251 /* …upon a KeyRelease event, even if the modifiers don’t match. This
252 * state is triggered from get_binding() when the corresponding
253 * KeyPress (!) happens, so that users can release the modifier keys
254 * before releasing the actual key. */
255 B_UPON_KEYRELEASE_IGNORE_MODS = 2,
258 /** If this is true for a mouse binding, the binding should be executed
259 * when the button is pressed over the window border. */
262 /** If this is true for a mouse binding, the binding should be executed
263 * when the button is pressed over any part of the window, not just the
264 * title bar (default). */
267 uint32_t number_keycodes;
269 /** Keycode to bind */
272 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
275 /** Symbol the user specified in configfile, if any. This needs to be
276 * stored with the binding to be able to re-convert it into a keycode
277 * if the keyboard mapping changes (using Xmodmap for example) */
280 /** Only in use if symbol != NULL. Gets set to the value to which the
281 * symbol got translated when binding. Useful for unbinding and
282 * checking which binding was used when a key press event comes in.
284 * This is an array of number_keycodes size. */
285 xcb_keycode_t *translated_to;
287 /** Command, like in command mode */
290 TAILQ_ENTRY(Binding) bindings;
294 * Holds a command specified by either an:
297 * in the config (see src/config.c)
301 /** Command, like in command mode */
303 /** no_startup_id flag for start_application(). Determines whether a
304 * startup notification context/ID should be created. */
306 TAILQ_ENTRY(Autostart) autostarts;
307 TAILQ_ENTRY(Autostart) autostarts_always;
311 * An Output is a physical output on your graphics driver. Outputs which
312 * are currently in use have (output->active == true). Each output has a
313 * position and a mode. An output usually corresponds to one connected
314 * screen (except if you are running multiple screens in clone mode).
318 /** Output id, so that we can requery the output directly later */
319 xcb_randr_output_t id;
321 /** Whether the output is currently active (has a CRTC attached with a
325 /** Internal flags, necessary for querying RandR screens (happens in
331 /** Name of the output */
334 /** Pointer to the Con which represents this output */
337 /** x, y, width, height */
340 TAILQ_ENTRY(xoutput) outputs;
344 * A 'Window' is a type which contains an xcb_window_t and all the related
345 * information (hints like _NET_WM_NAME for that window).
351 /** Holds the xcb_window_t (just an ID) for the leader window (logical
352 * parent for toolwindows and similar floating windows) */
354 xcb_window_t transient_for;
356 /** Pointers to the Assignments which were already ran for this Window
357 * (assignments run only once) */
358 uint32_t nr_assignments;
359 Assignment **ran_assignments;
362 char *class_instance;
364 /** The name of the window. */
366 /** The format with which the window's name should be displayed. */
369 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
370 * sets "buddy list"). Useful to match specific windows in assignments or
374 /** Flag to force re-rendering the decoration upon changes */
377 /** Whether the application used _NET_WM_NAME */
378 bool uses_net_wm_name;
380 /** Whether the application needs to receive WM_TAKE_FOCUS */
381 bool needs_take_focus;
383 /** Whether this window accepts focus. We store this inverted so that the
384 * default will be 'accepts focus'. */
385 bool doesnt_accept_focus;
387 /** The _NET_WM_WINDOW_TYPE for this window. */
388 xcb_atom_t window_type;
390 /** Whether the window says it is a dock window */
393 W_DOCK_BOTTOM = 2 } dock;
395 /** When this window was marked urgent. 0 means not urgent */
396 struct timeval urgent;
398 /** Pixels the window reserves. left/right/top/bottom */
399 struct reservedpx reserved;
401 /** Depth of the window */
406 * A "match" is a data structure which acts like a mask or expression to match
407 * certain windows or not. For example, when using commands, you can specify a
408 * command like this: [title="*Firefox*"] kill. The title member of the match
409 * data structure will then be filled and i3 will check each window using
410 * match_matches_window() to find the windows affected by this command.
415 struct regex *application;
417 struct regex *instance;
419 struct regex *window_role;
420 struct regex *workspace;
421 xcb_atom_t window_type;
437 M_FLOATING } floating;
440 /* Where the window looking for a match should be inserted:
442 * M_HERE = the matched container will be replaced by the window
444 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
445 * M_BELOW = the window will be inserted as a child of the matched container
451 M_BELOW } insert_where;
453 TAILQ_ENTRY(Match) matches;
455 /* Whether this match was generated when restarting i3 inplace.
456 * Leads to not setting focus when managing a new window, because the old
457 * focus stack should be restored. */
462 * An Assignment makes specific windows go to a specific workspace/output or
463 * run a command for that window. With this mechanism, the user can -- for
464 * example -- assign their browser to workspace "www". Checking if a window is
465 * assigned works by comparing the Match data structure with the window (see
466 * match_matches_window()).
470 /** type of this assignment:
472 * A_COMMAND = run the specified command for the matching window
473 * A_TO_WORKSPACE = assign the matching window to the specified workspace
474 * A_NO_FOCUS = don't focus matched window when it is managed
476 * While the type is a bitmask, only one value can be set at a time. It is
477 * a bitmask to allow filtering for multiple types, for example in the
478 * assignment_for() function.
483 A_COMMAND = (1 << 0),
484 A_TO_WORKSPACE = (1 << 1),
485 A_NO_FOCUS = (1 << 2)
488 /** the criteria to check if a window matches */
491 /** destination workspace/command, depending on the type */
497 TAILQ_ENTRY(Assignment) assignments;
500 /** Fullscreen modes. Used by Con.fullscreen_mode. */
501 typedef enum { CF_NONE = 0,
503 CF_GLOBAL = 2 } fullscreen_mode_t;
506 * A 'Con' represents everything from the X11 root window down to a single X11 window.
512 /* Should this container be marked urgent? This gets set when the window
513 * inside this container (if any) sets the urgency hint, for example. */
516 /** This counter contains the number of UnmapNotify events for this
517 * container (or, more precisely, for its ->frame) which should be ignored.
518 * UnmapNotify events need to be ignored when they are caused by i3 itself,
519 * for example when reparenting or when unmapping the window on a workspace
521 uint8_t ignore_unmap;
523 /* ids/pixmap/graphics context for the frame window */
524 bool pixmap_recreated;
527 xcb_gcontext_t pm_gc;
538 /** the workspace number, if this Con is of type CT_WORKSPACE and the
539 * workspace is not a named workspace (for named workspaces, num == -1) */
545 struct Rect window_rect;
546 struct Rect deco_rect;
547 /** the geometry this window requested when getting mapped */
548 struct Rect geometry;
552 /* a sticky-group is an identifier which bundles several containers to a
553 * group. The contents are shared between all of them, that is they are
554 * displayed on whichever of the containers is currently visible */
557 /* user-definable mark to jump to this container later */
559 /* cached to decide whether a redraw is needed */
564 /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */
566 /* the wanted size of the window, used in combination with size
567 * increments (see below). */
571 /* the x11 border pixel attribute */
573 int current_border_width;
575 /* minimum increment size specified for the window (in pixels) */
577 int height_increment;
579 struct Window *window;
581 /* timer used for disabling urgency */
582 struct ev_timer *urgency_timer;
584 /** Cache for the decoration rendering */
585 struct deco_render_params *deco_render_params;
587 /* Only workspace-containers can have floating clients */
588 TAILQ_HEAD(floating_head, Con) floating_head;
590 TAILQ_HEAD(nodes_head, Con) nodes_head;
591 TAILQ_HEAD(focus_head, Con) focus_head;
593 TAILQ_HEAD(swallow_head, Match) swallow_head;
595 fullscreen_mode_t fullscreen_mode;
596 /* layout is the layout of this container: one of split[v|h], stacked or
597 * tabbed. Special containers in the tree (above workspaces) have special
598 * layouts like dockarea or output.
600 * last_split_layout is one of splitv or splith to support the old "layout
601 * default" command which by now should be "layout splitv" or "layout
602 * splith" explicitly.
604 * workspace_layout is only for type == CT_WORKSPACE cons. When you change
605 * the layout of a workspace without any children, i3 cannot just set the
606 * layout (because workspaces need to be splitv/splith to allow focus
607 * parent and opening new containers). Instead, it stores the requested
608 * layout in workspace_layout and creates a new split container with that
609 * layout whenever a new container is attached to the workspace. */
610 layout_t layout, last_split_layout, workspace_layout;
611 border_style_t border_style;
612 /** floating? (= not in tiling layout) This cannot be simply a bool
613 * because we want to keep track of whether the status was set by the
614 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
615 * user. The user’s choice overwrites automatic mode, of course. The
616 * order of the values is important because we check with >=
617 * FLOATING_AUTO_ON if a client is floating. */
619 FLOATING_AUTO_OFF = 0,
620 FLOATING_USER_OFF = 1,
621 FLOATING_AUTO_ON = 2,
625 TAILQ_ENTRY(Con) nodes;
626 TAILQ_ENTRY(Con) focused;
627 TAILQ_ENTRY(Con) all_cons;
628 TAILQ_ENTRY(Con) floating_windows;
631 void (*on_remove_child)(Con *);
634 /* Not a scratchpad window. */
637 /* Just moved to scratchpad, not resized by the user yet.
638 * Window will be auto-centered and sized appropriately. */
639 SCRATCHPAD_FRESH = 1,
641 /* The user changed position/size of the scratchpad window. */
642 SCRATCHPAD_CHANGED = 2
645 /* The ID of this container before restarting. Necessary to correctly
646 * interpret back-references in the JSON (such as the focus stack). */
649 /* Depth of the container window */