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;
45 typedef enum { BS_NORMAL = 0, BS_NONE = 1, BS_1PIXEL = 3 } border_style_t;
49 BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
50 BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
51 BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
52 BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
53 BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
54 BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
55 BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
56 BIND_MODE_SWITCH = (1 << 8)
60 * Stores a rectangle, for example the size of a window, the child window etc.
61 * It needs to be packed so that the compiler will not add any padding bytes.
62 * (it is used in src/ewmh.c for example)
64 * Note that x and y can contain signed values in some cases (for example when
65 * used for the coordinates of a window, which can be set outside of the
66 * visible area, but not when specifying the position of a workspace for the
67 * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
76 } __attribute__((packed));
79 * Used for the cache of colorpixels.
85 SLIST_ENTRY(Colorpixel) colorpixels;
88 struct Cached_Pixmap {
91 /* We’re going to paint on it, so a graphics context will be needed */
94 /* The rect with which the pixmap was created */
97 /* The rect of the object to which this pixmap belongs. Necessary to
98 * find out when we need to re-create the pixmap. */
101 xcb_drawable_t referred_drawable;
104 struct Ignore_Event {
108 SLIST_ENTRY(Ignore_Event) ignore_events;
111 /******************************************************************************
113 *****************************************************************************/
116 * Holds a keybinding, consisting of a keycode combined with modifiers and the
117 * command which is executed as soon as the key is pressed (see src/command.c)
121 /** Symbol the user specified in configfile, if any. This needs to be
122 * stored with the binding to be able to re-convert it into a keycode
123 * if the keyboard mapping changes (using Xmodmap for example) */
126 /** Only in use if symbol != NULL. Gets set to the value to which the
127 * symbol got translated when binding. Useful for unbinding and
128 * checking which binding was used when a key press event comes in.
130 * This is an array of number_keycodes size. */
131 xcb_keycode_t *translated_to;
133 uint32_t number_keycodes;
135 /** Keycode to bind */
138 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
141 /** Command, like in command mode */
144 TAILQ_ENTRY(Binding) bindings;
148 * Holds a command specified by an exec-line in the config (see src/config.c)
152 /** Command, like in command mode */
154 TAILQ_ENTRY(Autostart) autostarts;
158 * Data structure for cached font information:
159 * - font id in X11 (load it once)
160 * - font height (multiple calls needed to get it)
164 /** The name of the font, that is what the pattern resolves to */
166 /** A copy of the pattern to build a cache */
168 /** The height of the font, built from font_ascent + font_descent */
170 /** The xcb-id for the font */
173 TAILQ_ENTRY(Font) fonts;
178 * An Output is a physical output on your graphics driver. Outputs which
179 * are currently in use have (output->active == true). Each output has a
180 * position and a mode. An output usually corresponds to one connected
181 * screen (except if you are running multiple screens in clone mode).
185 /** Output id, so that we can requery the output directly later */
186 xcb_randr_output_t id;
187 /** Name of the output */
190 /** Pointer to the Con which represents this output */
193 /** Whether the output is currently active (has a CRTC attached with a
197 /** Internal flags, necessary for querying RandR screens (happens in
202 /** x, y, width, height */
205 /** The bar window */
207 xcb_gcontext_t bargc;
209 /** Contains all clients with _NET_WM_WINDOW_TYPE ==
210 * _NET_WM_WINDOW_TYPE_DOCK */
211 SLIST_HEAD(dock_clients_head, Client) dock_clients;
213 TAILQ_ENTRY(xoutput) outputs;
219 /** Holds the xcb_window_t (just an ID) for the leader window (logical
220 * parent for toolwindows and similar floating windows) */
222 xcb_window_t transient_for;
225 char *class_instance;
227 /** The name of the window as it will be passed to X11 (in UCS2 if the
228 * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
231 /** The name of the window as used in JSON (in UTF-8 if the application
232 * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
235 /** The length of the name in glyphs (not bytes) */
238 /** Whether the application used _NET_WM_NAME */
239 bool uses_net_wm_name;
241 /** Whether the window says it is a dock window */
246 enum { M_WINDOW, M_CON } what;
257 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
259 enum { M_GLOBAL = 0, M_OUTPUT, M_WORKSPACE } levels;
261 enum { M_USER = 0, M_RESTART } source;
263 /* wo das fenster eingefügt werden soll. bei here wird es direkt
264 * diesem Con zugewiesen, also layout saving. bei active ist es
265 * ein assignment, welches an der momentan fokussierten stelle einfügt */
266 enum { M_HERE = 0, M_ACTIVE } insert_where;
268 TAILQ_ENTRY(Match) matches;
273 enum { CT_ROOT = 0, CT_OUTPUT = 1, CT_CON = 2, CT_FLOATING_CON = 3, CT_WORKSPACE = 4 } type;
274 orientation_t orientation;
276 /* parent before setting it to floating */
277 struct Con *old_parent;
280 struct Rect window_rect;
281 struct Rect deco_rect;
285 /** the workspace number, if this Con is of type CT_WORKSPACE and the
286 * workspace is not a named workspace (for named workspaces, num == -1) */
289 /* a sticky-group is an identifier which bundles several containers to a
290 * group. The contents are shared between all of them, that is they are
291 * displayed on whichever of the containers is currently visible */
294 /* user-definable mark to jump to this container later */
299 /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
300 * apply an aspect ratio to windows (think of MPlayer) */
301 int proportional_width;
302 int proportional_height;
303 /* the wanted size of the window, used in combination with size
304 * increments (see below). */
308 /* the x11 border pixel attribute */
311 /* minimum increment size specified for the window (in pixels) */
313 int height_increment;
315 struct Window *window;
317 /* Should this container be marked urgent? This gets set when the window
318 * inside this container (if any) sets the urgency hint, for example. */
321 /* ids/gc for the frame window */
325 /* Only workspace-containers can have floating clients */
326 TAILQ_HEAD(floating_head, Con) floating_head;
328 TAILQ_HEAD(nodes_head, Con) nodes_head;
329 TAILQ_HEAD(focus_head, Con) focus_head;
331 TAILQ_HEAD(swallow_head, Match) swallow_head;
333 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
334 enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2 } layout;
335 border_style_t border_style;
336 /** floating? (= not in tiling layout) This cannot be simply a bool
337 * because we want to keep track of whether the status was set by the
338 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
339 * user. The user’s choice overwrites automatic mode, of course. The
340 * order of the values is important because we check with >=
341 * FLOATING_AUTO_ON if a client is floating. */
343 FLOATING_AUTO_OFF = 0,
344 FLOATING_USER_OFF = 1,
345 FLOATING_AUTO_ON = 2,
349 /** This counter contains the number of UnmapNotify events for this
350 * container (or, more precisely, for its ->frame) which should be ignored.
351 * UnmapNotify events need to be ignored when they are caused by i3 itself,
352 * for example when reparenting or when unmapping the window on a workspace
354 uint8_t ignore_unmap;
356 TAILQ_ENTRY(Con) nodes;
357 TAILQ_ENTRY(Con) focused;
358 TAILQ_ENTRY(Con) all_cons;
359 TAILQ_ENTRY(Con) floating_windows;