git.sur5r.net Git - i3/i3/blob - include/data.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * include/data.h: This file defines all data structures used by i3
   8  *
   9  */
  10 #include <xcb/randr.h>
  11 #include <xcb/xcb_atom.h>
  12 #include <stdbool.h>
  13
  14 #ifndef _DATA_H
  15 #define _DATA_H
  16 #include "queue.h"
  17
  18 /*
  19  * To get the big concept: There are helper structures like struct Colorpixel
  20  * or struct Stack_Window. Everything which is also defined as type (see
  21  * forward definitions) is considered to be a major structure, thus important.
  22  *
  23  * Let’s start from the biggest to the smallest:
  24  *
  25  * TODO
  26  *
  27  */
  28
  29 /* Forward definitions */
  30 typedef struct Font i3Font;
  31 typedef struct Binding Binding;
  32 typedef struct Rect Rect;
  33 typedef struct xoutput Output;
  34 typedef struct Con Con;
  35 typedef struct Match Match;
  36 typedef struct Assignment Assignment;
  37 typedef struct Window i3Window;
  38
  39
  40 /******************************************************************************
  41  * Helper types
  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;
  46
  47 /** parameter to specify whether tree_close() and x_window_kill() should kill
  48  * only this specific window or the whole X11 client */
  49 typedef enum { DONT_KILL_WINDOW = 0, KILL_WINDOW = 1, KILL_CLIENT = 2 } kill_window_t;
  50
  51 enum {
  52     BIND_NONE = 0,
  53     BIND_SHIFT = XCB_MOD_MASK_SHIFT,        /* (1 << 0) */
  54     BIND_CONTROL = XCB_MOD_MASK_CONTROL,    /* (1 << 2) */
  55     BIND_MOD1 = XCB_MOD_MASK_1,             /* (1 << 3) */
  56     BIND_MOD2 = XCB_MOD_MASK_2,             /* (1 << 4) */
  57     BIND_MOD3 = XCB_MOD_MASK_3,             /* (1 << 5) */
  58     BIND_MOD4 = XCB_MOD_MASK_4,             /* (1 << 6) */
  59     BIND_MOD5 = XCB_MOD_MASK_5,             /* (1 << 7) */
  60     BIND_MODE_SWITCH = (1 << 8)
  61 };
  62
  63 /**
  64  * Stores a rectangle, for example the size of a window, the child window etc.
  65  * It needs to be packed so that the compiler will not add any padding bytes.
  66  * (it is used in src/ewmh.c for example)
  67  *
  68  * Note that x and y can contain signed values in some cases (for example when
  69  * used for the coordinates of a window, which can be set outside of the
  70  * visible area, but not when specifying the position of a workspace for the
  71  * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
  72  * typecasts.
  73  *
  74  */
  75 struct Rect {
  76     uint32_t x;
  77     uint32_t y;
  78     uint32_t width;
  79     uint32_t height;
  80 } __attribute__((packed));
  81
  82 /**
  83  * Stores the reserved pixels on each screen edge read from a
  84  * _NET_WM_STRUT_PARTIAL.
  85  *
  86  */
  87 struct reservedpx {
  88     uint32_t left;
  89     uint32_t right;
  90     uint32_t top;
  91     uint32_t bottom;
  92 };
  93
  94 /**
  95  * Stores a width/height pair, used as part of deco_render_params to check
  96  * whether the rects width/height have changed.
  97  *
  98  */
  99 struct width_height {
 100     uint32_t w;
 101     uint32_t h;
 102 };
 103
 104 /**
 105  * Stores the parameters for rendering a window decoration. This structure is
 106  * cached in every Con and no re-rendering will be done if the parameters have
 107  * not changed (only the pixmaps will be copied).
 108  *
 109  */
 110 struct deco_render_params {
 111     struct Colortriple *color;
 112     int border_style;
 113     struct width_height con_rect;
 114     struct width_height con_window_rect;
 115     Rect con_deco_rect;
 116     uint32_t background;
 117     bool con_is_leaf;
 118     xcb_font_t font;
 119 };
 120
 121 /**
 122  * Stores which workspace (by name) goes to which output.
 123  *
 124  */
 125 struct Workspace_Assignment {
 126     char *name;
 127     char *output;
 128
 129     TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
 130 };
 131
 132 struct Ignore_Event {
 133     int sequence;
 134     int response_type;
 135     time_t added;
 136
 137     SLIST_ENTRY(Ignore_Event) ignore_events;
 138 };
 139
 140 /******************************************************************************
 141  * Major types
 142  *****************************************************************************/
 143
 144 /**
 145  * Holds a keybinding, consisting of a keycode combined with modifiers and the
 146  * command which is executed as soon as the key is pressed (see src/command.c)
 147  *
 148  */
 149 struct Binding {
 150     /** Symbol the user specified in configfile, if any. This needs to be
 151      * stored with the binding to be able to re-convert it into a keycode
 152      * if the keyboard mapping changes (using Xmodmap for example) */
 153     char *symbol;
 154
 155     /** Only in use if symbol != NULL. Gets set to the value to which the
 156      * symbol got translated when binding. Useful for unbinding and
 157      * checking which binding was used when a key press event comes in.
 158      *
 159      * This is an array of number_keycodes size. */
 160     xcb_keycode_t *translated_to;
 161
 162     uint32_t number_keycodes;
 163
 164     /** Keycode to bind */
 165     uint32_t keycode;
 166
 167     /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
 168     uint32_t mods;
 169
 170     /** Command, like in command mode */
 171     char *command;
 172
 173     TAILQ_ENTRY(Binding) bindings;
 174 };
 175
 176 /**
 177  * Holds a command specified by either an:
 178  * - exec-line
 179  * - exec_always-line
 180  * in the config (see src/config.c)
 181  *
 182  */
 183 struct Autostart {
 184     /** Command, like in command mode */
 185     char *command;
 186     TAILQ_ENTRY(Autostart) autostarts;
 187     TAILQ_ENTRY(Autostart) autostarts_always;
 188 };
 189
 190 /**
 191  * Data structure for cached font information:
 192  * - font id in X11 (load it once)
 193  * - font height (multiple calls needed to get it)
 194  *
 195  */
 196 struct Font {
 197     /** The height of the font, built from font_ascent + font_descent */
 198     int height;
 199     /** The xcb-id for the font */
 200     xcb_font_t id;
 201 };
 202
 203
 204 /**
 205  * An Output is a physical output on your graphics driver. Outputs which
 206  * are currently in use have (output->active == true). Each output has a
 207  * position and a mode. An output usually corresponds to one connected
 208  * screen (except if you are running multiple screens in clone mode).
 209  *
 210  */
 211 struct xoutput {
 212     /** Output id, so that we can requery the output directly later */
 213     xcb_randr_output_t id;
 214     /** Name of the output */
 215     char *name;
 216
 217     /** Pointer to the Con which represents this output */
 218     Con *con;
 219
 220     /** Whether the output is currently active (has a CRTC attached with a
 221      * valid mode) */
 222     bool active;
 223
 224     /** Internal flags, necessary for querying RandR screens (happens in
 225      * two stages) */
 226     bool changed;
 227     bool to_be_disabled;
 228     bool primary;
 229
 230     /** x, y, width, height */
 231     Rect rect;
 232
 233     TAILQ_ENTRY(xoutput) outputs;
 234 };
 235
 236 struct Window {
 237     xcb_window_t id;
 238
 239     /** Holds the xcb_window_t (just an ID) for the leader window (logical
 240      * parent for toolwindows and similar floating windows) */
 241     xcb_window_t leader;
 242     xcb_window_t transient_for;
 243
 244     char *class_class;
 245     char *class_instance;
 246
 247     /** The name of the window as it will be passed to X11 (in UCS2 if the
 248      * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
 249     char *name_x;
 250
 251     /** Flag to force re-rendering the decoration upon changes */
 252     bool name_x_changed;
 253
 254     /** The name of the window as used in JSON (in UTF-8 if the application
 255      * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
 256     char *name_json;
 257
 258     /** The length of the name in glyphs (not bytes) */
 259     int name_len;
 260
 261     /** Whether the application used _NET_WM_NAME */
 262     bool uses_net_wm_name;
 263
 264     /** Whether the application needs to receive WM_TAKE_FOCUS */
 265     bool needs_take_focus;
 266
 267     /** Whether the window says it is a dock window */
 268     enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
 269
 270     /** Pixels the window reserves. left/right/top/bottom */
 271     struct reservedpx reserved;
 272
 273     /** Pointers to the Assignments which were already ran for this Window
 274      * (assignments run only once) */
 275     uint32_t nr_assignments;
 276     Assignment **ran_assignments;
 277 };
 278
 279 struct Match {
 280     char *title;
 281     int title_len;
 282     char *application;
 283     char *class;
 284     char *instance;
 285     char *mark;
 286     enum {
 287         M_DONTCHECK = -1,
 288         M_NODOCK = 0,
 289         M_DOCK_ANY = 1,
 290         M_DOCK_TOP = 2,
 291         M_DOCK_BOTTOM = 3
 292     } dock;
 293     xcb_window_t id;
 294     Con *con_id;
 295     enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
 296
 297     /* Where the window looking for a match should be inserted:
 298      *
 299      * M_HERE   = the matched container will be replaced by the window
 300      *            (layout saving)
 301      * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
 302      * M_BELOW  = the window will be inserted as a child of the matched container
 303      *            (dockareas)
 304      *
 305      */
 306     enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
 307
 308     TAILQ_ENTRY(Match) matches;
 309 };
 310
 311 /**
 312  * An Assignment makes specific windows go to a specific workspace/output or
 313  * run a command for that window. With this mechanism, the user can -- for
 314  * example -- make specific windows floating or assign his browser to workspace
 315  * "www". Checking if a window is assigned works by comparing the Match data
 316  * structure with the window (see match_matches_window()).
 317  *
 318  */
 319 struct Assignment {
 320     /** type of this assignment:
 321      *
 322      * A_COMMAND = run the specified command for the matching window
 323      * A_TO_WORKSPACE = assign the matching window to the specified workspace
 324      * A_TO_OUTPUT = assign the matching window to the specified output
 325      *
 326      * While the type is a bitmask, only one value can be set at a time. It is
 327      * a bitmask to allow filtering for multiple types, for example in the
 328      * assignment_for() function.
 329      *
 330      */
 331     enum {
 332         A_ANY          = 0,
 333         A_COMMAND      = (1 << 0),
 334         A_TO_WORKSPACE = (1 << 1),
 335         A_TO_OUTPUT    = (1 << 2)
 336     } type;
 337
 338     /** the criteria to check if a window matches */
 339     Match match;
 340
 341     /** destination workspace/output/command, depending on the type */
 342     union {
 343         char *command;
 344         char *workspace;
 345         char *output;
 346     } dest;
 347
 348     TAILQ_ENTRY(Assignment) assignments;
 349 };
 350
 351 struct Con {
 352     bool mapped;
 353     enum {
 354         CT_ROOT = 0,
 355         CT_OUTPUT = 1,
 356         CT_CON = 2,
 357         CT_FLOATING_CON = 3,
 358         CT_WORKSPACE = 4,
 359         CT_DOCKAREA = 5
 360     } type;
 361     orientation_t orientation;
 362     struct Con *parent;
 363
 364     struct Rect rect;
 365     struct Rect window_rect;
 366     struct Rect deco_rect;
 367     /** the geometry this window requested when getting mapped */
 368     struct Rect geometry;
 369
 370     char *name;
 371
 372     /** the workspace number, if this Con is of type CT_WORKSPACE and the
 373      * workspace is not a named workspace (for named workspaces, num == -1) */
 374     int num;
 375
 376     /* a sticky-group is an identifier which bundles several containers to a
 377      * group. The contents are shared between all of them, that is they are
 378      * displayed on whichever of the containers is currently visible */
 379     char *sticky_group;
 380
 381     /* user-definable mark to jump to this container later */
 382     char *mark;
 383
 384     double percent;
 385
 386     /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
 387      * apply an aspect ratio to windows (think of MPlayer) */
 388     int proportional_width;
 389     int proportional_height;
 390     /* the wanted size of the window, used in combination with size
 391      * increments (see below). */
 392     int base_width;
 393     int base_height;
 394
 395     /* the x11 border pixel attribute */
 396     int border_width;
 397
 398     /* minimum increment size specified for the window (in pixels) */
 399     int width_increment;
 400     int height_increment;
 401
 402     struct Window *window;
 403
 404     /* Should this container be marked urgent? This gets set when the window
 405      * inside this container (if any) sets the urgency hint, for example. */
 406     bool urgent;
 407
 408     /* ids/pixmap/graphics context for the frame window */
 409     xcb_window_t frame;
 410     xcb_pixmap_t pixmap;
 411     xcb_gcontext_t pm_gc;
 412     bool pixmap_recreated;
 413
 414     /** Cache for the decoration rendering */
 415     struct deco_render_params *deco_render_params;
 416
 417     /* Only workspace-containers can have floating clients */
 418     TAILQ_HEAD(floating_head, Con) floating_head;
 419
 420     TAILQ_HEAD(nodes_head, Con) nodes_head;
 421     TAILQ_HEAD(focus_head, Con) focus_head;
 422
 423     TAILQ_HEAD(swallow_head, Match) swallow_head;
 424
 425     enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
 426     enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2, L_DOCKAREA = 3, L_OUTPUT = 4 } layout;
 427     border_style_t border_style;
 428     /** floating? (= not in tiling layout) This cannot be simply a bool
 429      * because we want to keep track of whether the status was set by the
 430      * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
 431      * user. The user’s choice overwrites automatic mode, of course. The
 432      * order of the values is important because we check with >=
 433      * FLOATING_AUTO_ON if a client is floating. */
 434     enum {
 435         FLOATING_AUTO_OFF = 0,
 436         FLOATING_USER_OFF = 1,
 437         FLOATING_AUTO_ON = 2,
 438         FLOATING_USER_ON = 3
 439     } floating;
 440
 441     /** This counter contains the number of UnmapNotify events for this
 442      * container (or, more precisely, for its ->frame) which should be ignored.
 443      * UnmapNotify events need to be ignored when they are caused by i3 itself,
 444      * for example when reparenting or when unmapping the window on a workspace
 445      * change. */
 446     uint8_t ignore_unmap;
 447
 448     TAILQ_ENTRY(Con) nodes;
 449     TAILQ_ENTRY(Con) focused;
 450     TAILQ_ENTRY(Con) all_cons;
 451     TAILQ_ENTRY(Con) floating_windows;
 452
 453     /** callbacks */
 454     void(*on_remove_child)(Con *);
 455 };
 456
 457 #endif