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 = 2 } 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 * Stores the reserved pixels on each screen edge read from a
80 * _NET_WM_STRUT_PARTIAL.
91 * Used for the cache of colorpixels.
97 SLIST_ENTRY(Colorpixel) colorpixels;
100 struct Cached_Pixmap {
103 /* We’re going to paint on it, so a graphics context will be needed */
106 /* The rect with which the pixmap was created */
109 /* The rect of the object to which this pixmap belongs. Necessary to
110 * find out when we need to re-create the pixmap. */
113 xcb_drawable_t referred_drawable;
116 struct Ignore_Event {
120 SLIST_ENTRY(Ignore_Event) ignore_events;
123 /******************************************************************************
125 *****************************************************************************/
128 * Holds a keybinding, consisting of a keycode combined with modifiers and the
129 * command which is executed as soon as the key is pressed (see src/command.c)
133 /** Symbol the user specified in configfile, if any. This needs to be
134 * stored with the binding to be able to re-convert it into a keycode
135 * if the keyboard mapping changes (using Xmodmap for example) */
138 /** Only in use if symbol != NULL. Gets set to the value to which the
139 * symbol got translated when binding. Useful for unbinding and
140 * checking which binding was used when a key press event comes in.
142 * This is an array of number_keycodes size. */
143 xcb_keycode_t *translated_to;
145 uint32_t number_keycodes;
147 /** Keycode to bind */
150 /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
153 /** Command, like in command mode */
156 TAILQ_ENTRY(Binding) bindings;
160 * Holds a command specified by an exec-line in the config (see src/config.c)
164 /** Command, like in command mode */
166 TAILQ_ENTRY(Autostart) autostarts;
170 * Data structure for cached font information:
171 * - font id in X11 (load it once)
172 * - font height (multiple calls needed to get it)
176 /** The height of the font, built from font_ascent + font_descent */
178 /** The xcb-id for the font */
184 * An Output is a physical output on your graphics driver. Outputs which
185 * are currently in use have (output->active == true). Each output has a
186 * position and a mode. An output usually corresponds to one connected
187 * screen (except if you are running multiple screens in clone mode).
191 /** Output id, so that we can requery the output directly later */
192 xcb_randr_output_t id;
193 /** Name of the output */
196 /** Pointer to the Con which represents this output */
199 /** Whether the output is currently active (has a CRTC attached with a
203 /** Internal flags, necessary for querying RandR screens (happens in
209 /** x, y, width, height */
213 /** The bar window */
215 xcb_gcontext_t bargc;
217 /** Contains all clients with _NET_WM_WINDOW_TYPE ==
218 * _NET_WM_WINDOW_TYPE_DOCK */
219 SLIST_HEAD(dock_clients_head, Client) dock_clients;
222 TAILQ_ENTRY(xoutput) outputs;
228 /** Holds the xcb_window_t (just an ID) for the leader window (logical
229 * parent for toolwindows and similar floating windows) */
231 xcb_window_t transient_for;
234 char *class_instance;
236 /** The name of the window as it will be passed to X11 (in UCS2 if the
237 * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
240 /** The name of the window as used in JSON (in UTF-8 if the application
241 * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
244 /** The length of the name in glyphs (not bytes) */
247 /** Whether the application used _NET_WM_NAME */
248 bool uses_net_wm_name;
250 /** Whether the window says it is a dock window */
251 enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
253 /** Pixels the window reserves. left/right/top/bottom */
254 struct reservedpx reserved;
258 enum { M_WINDOW, M_CON } what;
275 enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
277 enum { M_GLOBAL = 0, M_OUTPUT, M_WORKSPACE } levels;
279 enum { M_USER = 0, M_RESTART } source;
281 /* Where the window looking for a match should be inserted:
283 * M_HERE = the matched container will be replaced by the window
285 * M_ACTIVE = the window will be inserted next to the currently focused
286 * container below the matched container
288 * M_BELOW = the window will be inserted as a child of the matched container
292 enum { M_HERE = 0, M_ACTIVE, M_BELOW } insert_where;
294 TAILQ_ENTRY(Match) matches;
307 orientation_t orientation;
311 struct Rect window_rect;
312 struct Rect deco_rect;
313 /** the geometry this window requested when getting mapped */
314 struct Rect geometry;
318 /** the workspace number, if this Con is of type CT_WORKSPACE and the
319 * workspace is not a named workspace (for named workspaces, num == -1) */
322 /* a sticky-group is an identifier which bundles several containers to a
323 * group. The contents are shared between all of them, that is they are
324 * displayed on whichever of the containers is currently visible */
327 /* user-definable mark to jump to this container later */
332 /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
333 * apply an aspect ratio to windows (think of MPlayer) */
334 int proportional_width;
335 int proportional_height;
336 /* the wanted size of the window, used in combination with size
337 * increments (see below). */
341 /* the x11 border pixel attribute */
344 /* minimum increment size specified for the window (in pixels) */
346 int height_increment;
348 struct Window *window;
350 /* Should this container be marked urgent? This gets set when the window
351 * inside this container (if any) sets the urgency hint, for example. */
354 /* ids/gc for the frame window */
358 /* Only workspace-containers can have floating clients */
359 TAILQ_HEAD(floating_head, Con) floating_head;
361 TAILQ_HEAD(nodes_head, Con) nodes_head;
362 TAILQ_HEAD(focus_head, Con) focus_head;
364 TAILQ_HEAD(swallow_head, Match) swallow_head;
366 enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
367 enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2, L_DOCKAREA = 3, L_OUTPUT = 4 } layout;
368 border_style_t border_style;
369 /** floating? (= not in tiling layout) This cannot be simply a bool
370 * because we want to keep track of whether the status was set by the
371 * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
372 * user. The user’s choice overwrites automatic mode, of course. The
373 * order of the values is important because we check with >=
374 * FLOATING_AUTO_ON if a client is floating. */
376 FLOATING_AUTO_OFF = 0,
377 FLOATING_USER_OFF = 1,
378 FLOATING_AUTO_ON = 2,
382 /** This counter contains the number of UnmapNotify events for this
383 * container (or, more precisely, for its ->frame) which should be ignored.
384 * UnmapNotify events need to be ignored when they are caused by i3 itself,
385 * for example when reparenting or when unmapping the window on a workspace
387 uint8_t ignore_unmap;
389 TAILQ_ENTRY(Con) nodes;
390 TAILQ_ENTRY(Con) focused;
391 TAILQ_ENTRY(Con) all_cons;
392 TAILQ_ENTRY(Con) floating_windows;
395 void(*on_remove_child)(Con *);