2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
7 * include/data.h: This file defines all data structures used by i3
13 #define SN_API_NOT_YET_FROZEN 1
14 #include <libsn/sn-launcher.h>
16 #include <xcb/randr.h>
17 #include <xcb/xcb_atom.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_1PIXEL = 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;
64 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
65 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
66 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
67 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
68 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
69 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
70 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
71 BIND_MODE_SWITCH = (1 << 8)
75 * Stores a rectangle, for example the size of a window, the child window etc.
76 * It needs to be packed so that the compiler will not add any padding bytes.
77 * (it is used in src/ewmh.c for example)
79 * Note that x and y can contain signed values in some cases (for example when
80 * used for the coordinates of a window, which can be set outside of the
81 * visible area, but not when specifying the position of a workspace for the
82 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
91 } __attribute__((packed));
94 * Stores the reserved pixels on each screen edge read from a
95 * _NET_WM_STRUT_PARTIAL.
106 * Stores a width/height pair, used as part of deco_render_params to check
107 * whether the rects width/height have changed.
110 struct width_height {
116 * Stores the parameters for rendering a window decoration. This structure is
117 * cached in every Con and no re-rendering will be done if the parameters have
118 * not changed (only the pixmaps will be copied).
121 struct deco_render_params {
122 struct Colortriple *color;
124 struct width_height con_rect;
125 struct width_height con_window_rect;
132 * Stores which workspace (by name) goes to which output.
135 struct Workspace_Assignment {
139 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
142 struct Ignore_Event {
147 SLIST_ENTRY(Ignore_Event) ignore_events;
151 * Stores internal information about a startup sequence, like the workspace it
155 struct Startup_Sequence {
156 /** startup ID for this sequence, generated by libstartup-notification */
158 /** workspace on which this startup was initiated */
160 /** libstartup-notification context for this launch */
161 SnLauncherContext *context;
163 TAILQ_ENTRY(Startup_Sequence) sequences;
167 * Regular expression wrapper. It contains the pattern itself as a string (like
168 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
169 * pcre_extra data returned by pcre_study().
171 * This makes it easier to have a useful logfile, including the matching or
172 * non-matching pattern.
181 /******************************************************************************
183 *****************************************************************************/
186 * Holds a keybinding, consisting of a keycode combined with modifiers and the
187 * command which is executed as soon as the key is pressed (see src/cfgparse.y)
191 /** Symbol the user specified in configfile, if any. This needs to be
192 * stored with the binding to be able to re-convert it into a keycode
193 * if the keyboard mapping changes (using Xmodmap for example) */
196 /** Only in use if symbol != NULL. Gets set to the value to which the
197 * symbol got translated when binding. Useful for unbinding and
198 * checking which binding was used when a key press event comes in.
200 * This is an array of number_keycodes size. */
201 xcb_keycode_t *translated_to;
203 uint32_t number_keycodes;
205 /** Keycode to bind */
208 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
211 /** Command, like in command mode */
214 TAILQ_ENTRY(Binding) bindings;
218 * Holds a command specified by either an:
221 * in the config (see src/config.c)
225 /** Command, like in command mode */
227 /** no_startup_id flag for start_application(). Determines whether a
228 * startup notification context/ID should be created. */
230 TAILQ_ENTRY(Autostart) autostarts;
231 TAILQ_ENTRY(Autostart) autostarts_always;
235 * An Output is a physical output on your graphics driver. Outputs which
236 * are currently in use have (output->active == true). Each output has a
237 * position and a mode. An output usually corresponds to one connected
238 * screen (except if you are running multiple screens in clone mode).
242 /** Output id, so that we can requery the output directly later */
243 xcb_randr_output_t id;
244 /** Name of the output */
247 /** Pointer to the Con which represents this output */
250 /** Whether the output is currently active (has a CRTC attached with a
254 /** Internal flags, necessary for querying RandR screens (happens in
260 /** x, y, width, height */
263 TAILQ_ENTRY(xoutput) outputs;
267 * A 'Window' is a type which contains an xcb_window_t and all the related
268 * information (hints like _NET_WM_NAME for that window).
274 /** Holds the xcb_window_t (just an ID) for the leader window (logical
275 * parent for toolwindows and similar floating windows) */
277 xcb_window_t transient_for;
280 char *class_instance;
282 /** The name of the window as it will be passed to X11 (in UCS2 if the
283 * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
286 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
287 * sets "buddy list"). Useful to match specific windows in assignments or
291 /** Flag to force re-rendering the decoration upon changes */
294 /** The name of the window as used in JSON (in UTF-8 if the application
295 * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
298 /** The length of the name in glyphs (not bytes) */
301 /** Whether the application used _NET_WM_NAME */
302 bool uses_net_wm_name;
304 /** Whether the application needs to receive WM_TAKE_FOCUS */
305 bool needs_take_focus;
307 /** Whether the window says it is a dock window */
308 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
310 /** Pixels the window reserves. left/right/top/bottom */
311 struct reservedpx reserved;
313 /** Pointers to the Assignments which were already ran for this Window
314 * (assignments run only once) */
315 uint32_t nr_assignments;
316 Assignment **ran_assignments;
320 * A "match" is a data structure which acts like a mask or expression to match
321 * certain windows or not. For example, when using commands, you can specify a
322 * command like this: [title="*Firefox*"] kill. The title member of the match
323 * data structure will then be filled and i3 will check each window using
324 * match_matches_window() to find the windows affected by this command.
329 struct regex *application;
331 struct regex *instance;
343 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
345 /* Where the window looking for a match should be inserted:
347 * M_HERE = the matched container will be replaced by the window
349 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
350 * M_BELOW = the window will be inserted as a child of the matched container
354 enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
356 TAILQ_ENTRY(Match) matches;
360 * An Assignment makes specific windows go to a specific workspace/output or
361 * run a command for that window. With this mechanism, the user can -- for
362 * example -- assign his browser to workspace "www". Checking if a window is
363 * assigned works by comparing the Match data structure with the window (see
364 * match_matches_window()).
368 /** type of this assignment:
370 * A_COMMAND = run the specified command for the matching window
371 * A_TO_WORKSPACE = assign the matching window to the specified workspace
372 * A_TO_OUTPUT = assign the matching window to the specified output
374 * While the type is a bitmask, only one value can be set at a time. It is
375 * a bitmask to allow filtering for multiple types, for example in the
376 * assignment_for() function.
381 A_COMMAND = (1 << 0),
382 A_TO_WORKSPACE = (1 << 1),
383 A_TO_OUTPUT = (1 << 2)
386 /** the criteria to check if a window matches */
389 /** destination workspace/output/command, depending on the type */
396 TAILQ_ENTRY(Assignment) assignments;
400 * A 'Con' represents everything from the X11 root window down to a single X11 window.
413 orientation_t orientation;
417 struct Rect window_rect;
418 struct Rect deco_rect;
419 /** the geometry this window requested when getting mapped */
420 struct Rect geometry;
424 /** the workspace number, if this Con is of type CT_WORKSPACE and the
425 * workspace is not a named workspace (for named workspaces, num == -1) */
428 /* a sticky-group is an identifier which bundles several containers to a
429 * group. The contents are shared between all of them, that is they are
430 * displayed on whichever of the containers is currently visible */
433 /* user-definable mark to jump to this container later */
438 /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
439 * apply an aspect ratio to windows (think of MPlayer) */
440 int proportional_width;
441 int proportional_height;
442 /* the wanted size of the window, used in combination with size
443 * increments (see below). */
447 /* the x11 border pixel attribute */
450 /* minimum increment size specified for the window (in pixels) */
452 int height_increment;
454 struct Window *window;
456 /* Should this container be marked urgent? This gets set when the window
457 * inside this container (if any) sets the urgency hint, for example. */
460 /* ids/pixmap/graphics context for the frame window */
463 xcb_gcontext_t pm_gc;
464 bool pixmap_recreated;
466 /** Cache for the decoration rendering */
467 struct deco_render_params *deco_render_params;
469 /* Only workspace-containers can have floating clients */
470 TAILQ_HEAD(floating_head, Con) floating_head;
472 TAILQ_HEAD(nodes_head, Con) nodes_head;
473 TAILQ_HEAD(focus_head, Con) focus_head;
475 TAILQ_HEAD(swallow_head, Match) swallow_head;
477 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
478 enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2, L_DOCKAREA = 3, L_OUTPUT = 4 } layout;
479 border_style_t border_style;
480 /** floating? (= not in tiling layout) This cannot be simply a bool
481 * because we want to keep track of whether the status was set by the
482 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
483 * user. The user’s choice overwrites automatic mode, of course. The
484 * order of the values is important because we check with >=
485 * FLOATING_AUTO_ON if a client is floating. */
487 FLOATING_AUTO_OFF = 0,
488 FLOATING_USER_OFF = 1,
489 FLOATING_AUTO_ON = 2,
493 /** This counter contains the number of UnmapNotify events for this
494 * container (or, more precisely, for its ->frame) which should be ignored.
495 * UnmapNotify events need to be ignored when they are caused by i3 itself,
496 * for example when reparenting or when unmapping the window on a workspace
498 uint8_t ignore_unmap;
500 TAILQ_ENTRY(Con) nodes;
501 TAILQ_ENTRY(Con) focused;
502 TAILQ_ENTRY(Con) all_cons;
503 TAILQ_ENTRY(Con) floating_windows;
506 void(*on_remove_child)(Con *);
510 SCRATCHPAD_FRESH = 1,
511 SCRATCHPAD_CHANGED = 2