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