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