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
14 #define SN_API_NOT_YET_FROZEN 1
15 #include <libsn/sn-launcher.h>
17 #include <xcb/randr.h>
18 #include <xcb/xcb_atom.h>
25 * To get the big concept: There are helper structures like struct Colorpixel
26 * or struct Stack_Window. Everything which is also defined as type (see
27 * forward definitions) is considered to be a major structure, thus important.
29 * Let’s start from the biggest to the smallest:
35 /* Forward definitions */
36 typedef struct Font i3Font;
37 typedef struct Binding Binding;
38 typedef struct Rect Rect;
39 typedef struct xoutput Output;
40 typedef struct Con Con;
41 typedef struct Match Match;
42 typedef struct Assignment Assignment;
43 typedef struct Window i3Window;
46 /******************************************************************************
48 *****************************************************************************/
49 typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
50 typedef enum { NO_ORIENTATION = 0, HORIZ, VERT } orientation_t;
51 typedef enum { BS_NORMAL = 0, BS_NONE = 1, BS_1PIXEL = 2 } border_style_t;
53 /** parameter to specify whether tree_close() and x_window_kill() should kill
54 * only this specific window or the whole X11 client */
55 typedef enum { DONT_KILL_WINDOW = 0, KILL_WINDOW = 1, KILL_CLIENT = 2 } kill_window_t;
59 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
60 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
61 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
62 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
63 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
64 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
65 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
66 BIND_MODE_SWITCH = (1 << 8)
70 * Stores a rectangle, for example the size of a window, the child window etc.
71 * It needs to be packed so that the compiler will not add any padding bytes.
72 * (it is used in src/ewmh.c for example)
74 * Note that x and y can contain signed values in some cases (for example when
75 * used for the coordinates of a window, which can be set outside of the
76 * visible area, but not when specifying the position of a workspace for the
77 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
86 } __attribute__((packed));
89 * Stores the reserved pixels on each screen edge read from a
90 * _NET_WM_STRUT_PARTIAL.
101 * Stores a width/height pair, used as part of deco_render_params to check
102 * whether the rects width/height have changed.
105 struct width_height {
111 * Stores the parameters for rendering a window decoration. This structure is
112 * cached in every Con and no re-rendering will be done if the parameters have
113 * not changed (only the pixmaps will be copied).
116 struct deco_render_params {
117 struct Colortriple *color;
119 struct width_height con_rect;
120 struct width_height con_window_rect;
128 * Stores which workspace (by name) goes to which output.
131 struct Workspace_Assignment {
135 TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
138 struct Ignore_Event {
143 SLIST_ENTRY(Ignore_Event) ignore_events;
147 * Stores internal information about a startup sequence, like the workspace it
151 struct Startup_Sequence {
152 /** startup ID for this sequence, generated by libstartup-notification */
154 /** workspace on which this startup was initiated */
156 /** libstartup-notification context for this launch */
157 SnLauncherContext *context;
159 TAILQ_ENTRY(Startup_Sequence) sequences;
163 * Regular expression wrapper. It contains the pattern itself as a string (like
164 * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
165 * pcre_extra data returned by pcre_study().
167 * This makes it easier to have a useful logfile, including the matching or
168 * non-matching pattern.
177 /******************************************************************************
179 *****************************************************************************/
182 * Holds a keybinding, consisting of a keycode combined with modifiers and the
183 * command which is executed as soon as the key is pressed (see src/command.c)
187 /** Symbol the user specified in configfile, if any. This needs to be
188 * stored with the binding to be able to re-convert it into a keycode
189 * if the keyboard mapping changes (using Xmodmap for example) */
192 /** Only in use if symbol != NULL. Gets set to the value to which the
193 * symbol got translated when binding. Useful for unbinding and
194 * checking which binding was used when a key press event comes in.
196 * This is an array of number_keycodes size. */
197 xcb_keycode_t *translated_to;
199 uint32_t number_keycodes;
201 /** Keycode to bind */
204 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
207 /** Command, like in command mode */
210 TAILQ_ENTRY(Binding) bindings;
214 * Holds a command specified by either an:
217 * in the config (see src/config.c)
221 /** Command, like in command mode */
223 TAILQ_ENTRY(Autostart) autostarts;
224 TAILQ_ENTRY(Autostart) autostarts_always;
228 * Data structure for cached font information:
229 * - font id in X11 (load it once)
230 * - font height (multiple calls needed to get it)
234 /** The height of the font, built from font_ascent + font_descent */
236 /** The xcb-id for the font */
242 * An Output is a physical output on your graphics driver. Outputs which
243 * are currently in use have (output->active == true). Each output has a
244 * position and a mode. An output usually corresponds to one connected
245 * screen (except if you are running multiple screens in clone mode).
249 /** Output id, so that we can requery the output directly later */
250 xcb_randr_output_t id;
251 /** Name of the output */
254 /** Pointer to the Con which represents this output */
257 /** Whether the output is currently active (has a CRTC attached with a
261 /** Internal flags, necessary for querying RandR screens (happens in
267 /** x, y, width, height */
270 TAILQ_ENTRY(xoutput) outputs;
276 /** Holds the xcb_window_t (just an ID) for the leader window (logical
277 * parent for toolwindows and similar floating windows) */
279 xcb_window_t transient_for;
282 char *class_instance;
284 /** The name of the window as it will be passed to X11 (in UCS2 if the
285 * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
288 /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
289 * sets "buddy list"). Useful to match specific windows in assignments or
293 /** Flag to force re-rendering the decoration upon changes */
296 /** The name of the window as used in JSON (in UTF-8 if the application
297 * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
300 /** The length of the name in glyphs (not bytes) */
303 /** Whether the application used _NET_WM_NAME */
304 bool uses_net_wm_name;
306 /** Whether the application needs to receive WM_TAKE_FOCUS */
307 bool needs_take_focus;
309 /** Whether the window says it is a dock window */
310 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
312 /** Pixels the window reserves. left/right/top/bottom */
313 struct reservedpx reserved;
315 /** Pointers to the Assignments which were already ran for this Window
316 * (assignments run only once) */
317 uint32_t nr_assignments;
318 Assignment **ran_assignments;
323 struct regex *application;
325 struct regex *instance;
337 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
339 /* Where the window looking for a match should be inserted:
341 * M_HERE = the matched container will be replaced by the window
343 * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
344 * M_BELOW = the window will be inserted as a child of the matched container
348 enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
350 TAILQ_ENTRY(Match) matches;
354 * An Assignment makes specific windows go to a specific workspace/output or
355 * run a command for that window. With this mechanism, the user can -- for
356 * example -- make specific windows floating or assign his browser to workspace
357 * "www". Checking if a window is assigned works by comparing the Match data
358 * structure with the window (see match_matches_window()).
362 /** type of this assignment:
364 * A_COMMAND = run the specified command for the matching window
365 * A_TO_WORKSPACE = assign the matching window to the specified workspace
366 * A_TO_OUTPUT = assign the matching window to the specified output
368 * While the type is a bitmask, only one value can be set at a time. It is
369 * a bitmask to allow filtering for multiple types, for example in the
370 * assignment_for() function.
375 A_COMMAND = (1 << 0),
376 A_TO_WORKSPACE = (1 << 1),
377 A_TO_OUTPUT = (1 << 2)
380 /** the criteria to check if a window matches */
383 /** destination workspace/output/command, depending on the type */
390 TAILQ_ENTRY(Assignment) assignments;
403 orientation_t orientation;
407 struct Rect window_rect;
408 struct Rect deco_rect;
409 /** the geometry this window requested when getting mapped */
410 struct Rect geometry;
414 /** the workspace number, if this Con is of type CT_WORKSPACE and the
415 * workspace is not a named workspace (for named workspaces, num == -1) */
418 /* a sticky-group is an identifier which bundles several containers to a
419 * group. The contents are shared between all of them, that is they are
420 * displayed on whichever of the containers is currently visible */
423 /* user-definable mark to jump to this container later */
428 /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
429 * apply an aspect ratio to windows (think of MPlayer) */
430 int proportional_width;
431 int proportional_height;
432 /* the wanted size of the window, used in combination with size
433 * increments (see below). */
437 /* the x11 border pixel attribute */
440 /* minimum increment size specified for the window (in pixels) */
442 int height_increment;
444 struct Window *window;
446 /* Should this container be marked urgent? This gets set when the window
447 * inside this container (if any) sets the urgency hint, for example. */
450 /* ids/pixmap/graphics context for the frame window */
453 xcb_gcontext_t pm_gc;
454 bool pixmap_recreated;
456 /** Cache for the decoration rendering */
457 struct deco_render_params *deco_render_params;
459 /* Only workspace-containers can have floating clients */
460 TAILQ_HEAD(floating_head, Con) floating_head;
462 TAILQ_HEAD(nodes_head, Con) nodes_head;
463 TAILQ_HEAD(focus_head, Con) focus_head;
465 TAILQ_HEAD(swallow_head, Match) swallow_head;
467 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
468 enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2, L_DOCKAREA = 3, L_OUTPUT = 4 } layout;
469 border_style_t border_style;
470 /** floating? (= not in tiling layout) This cannot be simply a bool
471 * because we want to keep track of whether the status was set by the
472 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
473 * user. The user’s choice overwrites automatic mode, of course. The
474 * order of the values is important because we check with >=
475 * FLOATING_AUTO_ON if a client is floating. */
477 FLOATING_AUTO_OFF = 0,
478 FLOATING_USER_OFF = 1,
479 FLOATING_AUTO_ON = 2,
483 /** This counter contains the number of UnmapNotify events for this
484 * container (or, more precisely, for its ->frame) which should be ignored.
485 * UnmapNotify events need to be ignored when they are caused by i3 itself,
486 * for example when reparenting or when unmapping the window on a workspace
488 uint8_t ignore_unmap;
490 TAILQ_ENTRY(Con) nodes;
491 TAILQ_ENTRY(Con) focused;
492 TAILQ_ENTRY(Con) all_cons;
493 TAILQ_ENTRY(Con) floating_windows;
496 void(*on_remove_child)(Con *);