4 * i3 - an improved dynamic tiling window manager
6 * © 2009 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * include/data.h: This file defines all data structures used by i3
14 #include <xcb/xcb_atom.h>
22 * To get the big concept: There are helper structures like struct Colorpixel
23 * or struct Stack_Window. Everything which is also defined as type (see
24 * forward definitions) is considered to be a major structure, thus important.
26 * Let’s start from the biggest to the smallest:
28 * - An i3Screen is a virtual screen (Xinerama). This can be a single one,
29 * though two monitors might be connected, if you’re running clone
30 * mode. There can also be multiple of them.
32 * - Each i3Screen contains Workspaces. The concept is known from various
33 * other window managers. Basically, a workspace is a specific set of
34 * windows, usually grouped thematically (irc, www, work, …). You can switch
37 * - Each Workspace has a table, which is our layout abstraction. You manage
38 * your windows by moving them around in your table. It grows as necessary.
40 * - Each cell of the table has a container, which can be in default or
41 * stacking mode. In default mode, each client is given equally much space
42 * in the container. In stacking mode, only one client is shown at a time,
43 * but all the titlebars are rendered at the top.
45 * - Inside the container are clients, which is X11-speak for a window.
49 /* Forward definitions */
50 typedef struct Cell Cell;
51 typedef struct Font i3Font;
52 typedef struct Container Container;
53 typedef struct Client Client;
54 typedef struct Binding Binding;
55 typedef struct Workspace Workspace;
56 typedef struct Rect Rect;
57 typedef struct Screen i3Screen;
59 /******************************************************************************
61 *****************************************************************************/
62 typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
66 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
67 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
68 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
69 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
70 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
71 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
72 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
73 BIND_MODE_SWITCH = (1 << 8)
77 * Stores a rectangle, for example the size of a window, the child window etc.
82 uint32_t width, height;
86 * Defines a position in the table
95 * Used for the cache of colorpixels.
101 SLIST_ENTRY(Colorpixel) colorpixels;
104 struct Cached_Pixmap {
107 /* We’re going to paint on it, so a graphics context will be needed */
110 /* The rect with which the pixmap was created */
113 /* The rect of the object to which this pixmap belongs. Necessary to
114 * find out when we need to re-create the pixmap. */
117 xcb_drawable_t referred_drawable;
121 * Contains data for the windows needed to draw the titlebars on in stacking
125 struct Stack_Window {
127 struct Cached_Pixmap pixmap;
130 /** Backpointer to the container this stack window is in */
131 Container *container;
133 SLIST_ENTRY(Stack_Window) stack_windows;
136 struct Ignore_Event {
140 SLIST_ENTRY(Ignore_Event) ignore_events;
144 * Emulates the behaviour of tables of libxcb-wm, which in libxcb 0.3.4
148 struct keyvalue_element {
151 TAILQ_ENTRY(keyvalue_element) elements;
154 /******************************************************************************
156 *****************************************************************************/
159 * The concept of Workspaces is known from various other window
160 * managers. Basically, a workspace is a specific set of windows, usually
161 * grouped thematically (irc, www, work, …). You can switch between these.
165 /** Number of this workspace, starting from 0 */
168 /** Name of the workspace (in UCS-2) */
171 /** Length of the workspace’s name (in glyphs) */
174 /** Width of the workspace’s name (in pixels) rendered in config.font */
177 /** x, y, width, height */
180 /** table dimensions */
182 /** table dimensions */
185 /** These are stored here only while this workspace is _not_ shown
186 * (see show_workspace()) */
188 /** These are stored here only while this workspace is _not_ shown
189 * (see show_workspace()) */
192 /** Should clients on this workspace be automatically floating? */
194 /** Are the floating clients on this workspace currently hidden? */
195 bool floating_hidden;
197 /** A <screen> specifier on which this workspace would like to be (if
198 * the screen is available). screen := <number> | <position> */
199 char *preferred_screen;
201 /** Temporary flag needed for re-querying xinerama screens */
204 /** True if any client on this workspace has its urgent flag set */
207 /** the client who is started in fullscreen mode on this workspace,
208 * NULL if there is none */
209 Client *fullscreen_client;
211 /** The focus stack contains the clients in the correct order of focus
212 so that the focus can be reverted correctly when a client is
214 SLIST_HEAD(focus_stack_head, Client) focus_stack;
216 /** This tail queue contains the floating clients in order of when
217 * they were first set to floating (new floating clients are just
219 TAILQ_HEAD(floating_clients_head, Client) floating_clients;
221 /** Backpointer to the screen this workspace is on */
224 /** This is a two-dimensional dynamic array of
225 * Container-pointers. I’ve always wanted to be a three-star
229 /** width_factor and height_factor contain the amount of space
230 * (percentage) a column/row has of all the space which is available
231 * for resized windows. This ensures that non-resized windows (newly
232 * opened, for example) have the same size as always */
234 float *height_factor;
238 * Holds a keybinding, consisting of a keycode combined with modifiers and the
239 * command which is executed as soon as the key is pressed (see src/command.c)
243 /** Symbol the user specified in configfile, if any. This needs to be
244 * stored with the binding to be able to re-convert it into a keycode
245 * if the keyboard mapping changes (using Xmodmap for example) */
248 /** Only in use if symbol != NULL. Gets set to the value to which the
249 * symbol got translated when binding. Useful for unbinding and
250 * checking which binding was used when a key press event comes in.
252 * This is an array of number_keycodes size. */
253 xcb_keycode_t *translated_to;
255 uint32_t number_keycodes;
257 /** Keycode to bind */
260 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
263 /** Command, like in command mode */
266 TAILQ_ENTRY(Binding) bindings;
270 * Holds a command specified by an exec-line in the config (see src/config.c)
274 /** Command, like in command mode */
276 TAILQ_ENTRY(Autostart) autostarts;
280 * Holds an assignment for a given window class/title to a specific workspace
285 char *windowclass_title;
286 /** floating is true if this was an assignment to the special
287 * workspace "~". Matching clients will be put into floating mode
290 ASSIGN_FLOATING_NO, /* don’t float, but put on a workspace */
291 ASSIGN_FLOATING_ONLY, /* float, but don’t assign on a workspace */
292 ASSIGN_FLOATING /* float and put on a workspace */
295 /** The number of the workspace to assign to. */
297 TAILQ_ENTRY(Assignment) assignments;
301 * Data structure for cached font information:
302 * - font id in X11 (load it once)
303 * - font height (multiple calls needed to get it)
307 /** The name of the font, that is what the pattern resolves to */
309 /** A copy of the pattern to build a cache */
311 /** The height of the font, built from font_ascent + font_descent */
313 /** The xcb-id for the font */
316 TAILQ_ENTRY(Font) fonts;
320 * A client is X11-speak for a window.
324 /** initialized will be set to true if the client was fully
325 * initialized by manage_window() and all functions can be used
329 /** if you set a client to floating and set it back to managed, it
330 * does remember its old position and *tries* to get back there */
333 /** Backpointer. A client is inside a container */
334 Container *container;
335 /** Because dock clients don’t have a container, we have this
336 * workspace-backpointer */
337 Workspace *workspace;
339 /** x, y, width, height of the frame */
341 /** Position in floating mode and in tiling mode are saved
344 /** x, y, width, height of the child (relative to its frame) */
347 /** contains the size calculated from the hints set by the window or 0
348 * if the client did not send any hints */
349 int proportional_height;
350 int proportional_width;
355 /** contains the minimum increment size as specified for the window
358 int height_increment;
360 /** Height which was determined by reading the _NET_WM_STRUT_PARTIAL
361 * top/bottom of the screen reservation */
364 /** Name (= window title) */
366 /** name_len stores the real string length (glyphs) of the window
367 * title if the client uses _NET_WM_NAME. Otherwise, it is set to -1
368 * to indicate that name should be just passed to X as 8-bit string
369 * and therefore will not be rendered correctly. This behaviour is to
370 * support legacy applications which do not set _NET_WM_NAME */
372 /** This will be set to true as soon as the first _NET_WM_NAME comes
373 * in. If set to true, legacy window names are ignored. */
374 bool uses_net_wm_name;
376 /** Holds the WM_CLASS, useful for matching the client in commands */
379 /** Holds the client’s mark, for vim-like jumping */
382 /** Holds the xcb_window_t (just an ID) for the leader window (logical
383 * parent for toolwindows and similar floating windows) */
386 /** fullscreen is pretty obvious */
389 /** floating? (= not in tiling layout) This cannot be simply a bool
390 * because we want to keep track of whether the status was set by the
391 * application (by setting WM_CLASS to tools for example) or by the
392 * user. The user’s choice overwrites automatic mode, of course. The
393 * order of the values is important because we check with >=
394 * FLOATING_AUTO_ON if a client is floating. */
395 enum { FLOATING_AUTO_OFF = 0, FLOATING_USER_OFF = 1, FLOATING_AUTO_ON = 2, FLOATING_USER_ON = 3 } floating;
397 /** Ensure TITLEBAR_TOP maps to 0 because we use calloc for
398 * initialization later */
399 enum { TITLEBAR_TOP = 0, TITLEBAR_LEFT, TITLEBAR_RIGHT, TITLEBAR_BOTTOM, TITLEBAR_OFF } titlebar_position;
401 /** Contains a bool specifying whether this window should not be drawn
402 * with the usual decorations */
405 /** If a client is set as a dock, it is placed at the very bottom of
406 * the screen and its requested size is used */
409 /** True if the client set the urgency flag in its WM_HINTS property */
412 /* After leaving fullscreen mode, a client needs to be reconfigured
413 * (configuration = setting X, Y, width and height). By setting the
414 * force_reconfigure flag, render_layout() will reconfigure the
416 bool force_reconfigure;
418 /* When reparenting a window, an unmap-notify is sent. As we delete
419 * windows when they’re unmapped, we need to ignore that
420 * one. Therefore, this flag is set when reparenting. */
421 bool awaiting_useless_unmap;
424 xcb_window_t frame; /**< Our window: The frame around the
426 xcb_gcontext_t titlegc; /**< The titlebar’s graphic context
427 * inside the frame */
428 xcb_window_t child; /**< The client’s window */
430 /** The following entry provides the necessary list pointers to use
431 * Client with LIST_* macros */
432 CIRCLEQ_ENTRY(Client) clients;
433 SLIST_ENTRY(Client) dock_clients;
434 SLIST_ENTRY(Client) focus_clients;
435 TAILQ_ENTRY(Client) floating_clients;
439 * A container is either in default or stacking mode. It sits inside each cell
444 /* Those are speaking for themselves: */
445 Client *currently_focused;
449 /* Position of the container inside our table */
452 /* Xinerama: X/Y of the container */
455 /* Width/Height of the container. Changeable by the user */
459 /* When in stacking mode, we draw the titlebars of each client onto a
461 struct Stack_Window stack_win;
463 /* Backpointer to the workspace this container is in */
464 Workspace *workspace;
466 /* Ensure MODE_DEFAULT maps to 0 because we use calloc for
467 * initialization later */
468 enum { MODE_DEFAULT = 0, MODE_STACK, MODE_TABBED } mode;
469 CIRCLEQ_HEAD(client_head, Client) clients;
473 * This is a virtual screen (Xinerama). This can be a single one, though two
474 * monitors might be connected, if you’re running clone mode. There can also
475 * be multiple of them.
479 /** Virtual screen number */
482 /** Current workspace selected on this virtual screen */
483 int current_workspace;
485 /** x, y, width, height */
488 /** The bar window */
490 xcb_gcontext_t bargc;
492 /** Contains all clients with _NET_WM_WINDOW_TYPE ==
493 * _NET_WM_WINDOW_TYPE_DOCK */
494 SLIST_HEAD(dock_clients_head, Client) dock_clients;
496 TAILQ_ENTRY(Screen) screens;