2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2010 Michael Stapelberg and contributors (see also: LICENSE)
7 * include/data.h: This file defines all data structures used by i3
11 #include <xcb/randr.h>
12 #include <xcb/xcb_atom.h>
20 * To get the big concept: There are helper structures like struct Colorpixel
21 * or struct Stack_Window. Everything which is also defined as type (see
22 * forward definitions) is considered to be a major structure, thus important.
24 * Let’s start from the biggest to the smallest:
30 /* Forward definitions */
31 typedef struct Font i3Font;
32 typedef struct Binding Binding;
33 typedef struct Rect Rect;
34 typedef struct xoutput Output;
35 typedef struct Con Con;
36 typedef struct Match Match;
37 typedef struct Window i3Window;
40 /******************************************************************************
42 *****************************************************************************/
43 typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
44 typedef enum { NO_ORIENTATION = 0, HORIZ, VERT } orientation_t;
48 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
49 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
50 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
51 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
52 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
53 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
54 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
55 BIND_MODE_SWITCH = (1 << 8)
59 * Stores a rectangle, for example the size of a window, the child window etc.
60 * It needs to be packed so that the compiler will not add any padding bytes.
61 * (it is used in src/ewmh.c for example)
63 * Note that x and y can contain signed values in some cases (for example when
64 * used for the coordinates of a window, which can be set outside of the
65 * visible area, but not when specifying the position of a workspace for the
66 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
75 } __attribute__((packed));
78 * Used for the cache of colorpixels.
84 SLIST_ENTRY(Colorpixel) colorpixels;
87 struct Cached_Pixmap {
90 /* We’re going to paint on it, so a graphics context will be needed */
93 /* The rect with which the pixmap was created */
96 /* The rect of the object to which this pixmap belongs. Necessary to
97 * find out when we need to re-create the pixmap. */
100 xcb_drawable_t referred_drawable;
103 struct Ignore_Event {
107 SLIST_ENTRY(Ignore_Event) ignore_events;
110 /******************************************************************************
112 *****************************************************************************/
115 * Holds a keybinding, consisting of a keycode combined with modifiers and the
116 * command which is executed as soon as the key is pressed (see src/command.c)
120 /** Symbol the user specified in configfile, if any. This needs to be
121 * stored with the binding to be able to re-convert it into a keycode
122 * if the keyboard mapping changes (using Xmodmap for example) */
125 /** Only in use if symbol != NULL. Gets set to the value to which the
126 * symbol got translated when binding. Useful for unbinding and
127 * checking which binding was used when a key press event comes in.
129 * This is an array of number_keycodes size. */
130 xcb_keycode_t *translated_to;
132 uint32_t number_keycodes;
134 /** Keycode to bind */
137 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
140 /** Command, like in command mode */
143 TAILQ_ENTRY(Binding) bindings;
147 * Holds a command specified by an exec-line in the config (see src/config.c)
151 /** Command, like in command mode */
153 TAILQ_ENTRY(Autostart) autostarts;
157 * Data structure for cached font information:
158 * - font id in X11 (load it once)
159 * - font height (multiple calls needed to get it)
163 /** The name of the font, that is what the pattern resolves to */
165 /** A copy of the pattern to build a cache */
167 /** The height of the font, built from font_ascent + font_descent */
169 /** The xcb-id for the font */
172 TAILQ_ENTRY(Font) fonts;
177 * An Output is a physical output on your graphics driver. Outputs which
178 * are currently in use have (output->active == true). Each output has a
179 * position and a mode. An output usually corresponds to one connected
180 * screen (except if you are running multiple screens in clone mode).
184 /** Output id, so that we can requery the output directly later */
185 xcb_randr_output_t id;
186 /** Name of the output */
189 /** Whether the output is currently active (has a CRTC attached with a
193 /** Internal flags, necessary for querying RandR screens (happens in
198 /** x, y, width, height */
201 /** The bar window */
203 xcb_gcontext_t bargc;
205 /** Contains all clients with _NET_WM_WINDOW_TYPE ==
206 * _NET_WM_WINDOW_TYPE_DOCK */
207 SLIST_HEAD(dock_clients_head, Client) dock_clients;
209 TAILQ_ENTRY(xoutput) outputs;
216 char *class_instance;
218 /** The name of the window as it will be passed to X11 (in UCS2 if the
219 * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
222 /** The name of the window as used in JSON (in UTF-8 if the application
223 * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
226 /** The length of the name in glyphs (not bytes) */
229 /** Whether the application used _NET_WM_NAME */
230 bool uses_net_wm_name;
232 /** Whether the window says it is a dock window */
237 enum { M_WINDOW, M_CON } what;
248 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
250 enum { M_GLOBAL = 0, M_OUTPUT, M_WORKSPACE } levels;
252 enum { M_USER = 0, M_RESTART } source;
254 /* wo das fenster eingefügt werden soll. bei here wird es direkt
255 * diesem Con zugewiesen, also layout saving. bei active ist es
256 * ein assignment, welches an der momentan fokussierten stelle einfügt */
257 enum { M_HERE = 0, M_ACTIVE } insert_where;
259 TAILQ_ENTRY(Match) matches;
264 enum { CT_ROOT = 0, CT_OUTPUT = 1, CT_CON = 2, CT_FLOATING_CON = 3, CT_WORKSPACE = 4 } type;
265 orientation_t orientation;
267 /* parent before setting it to floating */
268 struct Con *old_parent;
271 struct Rect window_rect;
272 struct Rect deco_rect;
276 /* user-definable mark to jump to this container later */
281 struct Window *window;
283 /* Should this container be marked urgent? This gets set when the window
284 * inside this container (if any) sets the urgency hint, for example. */
287 /* ids/gc for the frame window */
291 /* Only workspace-containers can have floating clients */
292 TAILQ_HEAD(floating_head, Con) floating_head;
294 TAILQ_HEAD(nodes_head, Con) nodes_head;
295 TAILQ_HEAD(focus_head, Con) focus_head;
297 TAILQ_HEAD(swallow_head, Match) swallow_head;
299 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
300 enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2 } layout;
301 /** floating? (= not in tiling layout) This cannot be simply a bool
302 * because we want to keep track of whether the status was set by the
303 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
304 * user. The user’s choice overwrites automatic mode, of course. The
305 * order of the values is important because we check with >=
306 * FLOATING_AUTO_ON if a client is floating. */
308 FLOATING_AUTO_OFF = 0,
309 FLOATING_USER_OFF = 1,
310 FLOATING_AUTO_ON = 2,
315 TAILQ_ENTRY(Con) nodes;
316 TAILQ_ENTRY(Con) focused;
317 TAILQ_ENTRY(Con) all_cons;
318 TAILQ_ENTRY(Con) floating_windows;