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