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     xcb_font_t font;
 123 };
 124
 125 /**
 126  * Stores which workspace (by name) goes to which output.
 127  *
 128  */
 129 struct Workspace_Assignment {
 130     char *name;
 131     char *output;
 132
 133     TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
 134 };
 135
 136 struct Ignore_Event {
 137     int sequence;
 138     int response_type;
 139     time_t added;
 140
 141     SLIST_ENTRY(Ignore_Event) ignore_events;
 142 };
 143
 144 /**
 145  * Stores internal information about a startup sequence, like the workspace it
 146  * was initiated on.
 147  *
 148  */
 149 struct Startup_Sequence {
 150     /** startup ID for this sequence, generated by libstartup-notification */
 151     char *id;
 152     /** workspace on which this startup was initiated */
 153     char *workspace;
 154     /** libstartup-notification context for this launch */
 155     SnLauncherContext *context;
 156
 157     TAILQ_ENTRY(Startup_Sequence) sequences;
 158 };
 159
 160 /**
 161  * Regular expression wrapper. It contains the pattern itself as a string (like
 162  * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
 163  * pcre_extra data returned by pcre_study().
 164  *
 165  * This makes it easier to have a useful logfile, including the matching or
 166  * non-matching pattern.
 167  *
 168  */
 169 struct regex {
 170     char *pattern;
 171     pcre *regex;
 172     pcre_extra *extra;
 173 };
 174
 175 /******************************************************************************
 176  * Major types
 177  *****************************************************************************/
 178
 179 /**
 180  * Holds a keybinding, consisting of a keycode combined with modifiers and the
 181  * command which is executed as soon as the key is pressed (see src/command.c)
 182  *
 183  */
 184 struct Binding {
 185     /** Symbol the user specified in configfile, if any. This needs to be
 186      * stored with the binding to be able to re-convert it into a keycode
 187      * if the keyboard mapping changes (using Xmodmap for example) */
 188     char *symbol;
 189
 190     /** Only in use if symbol != NULL. Gets set to the value to which the
 191      * symbol got translated when binding. Useful for unbinding and
 192      * checking which binding was used when a key press event comes in.
 193      *
 194      * This is an array of number_keycodes size. */
 195     xcb_keycode_t *translated_to;
 196
 197     uint32_t number_keycodes;
 198
 199     /** Keycode to bind */
 200     uint32_t keycode;
 201
 202     /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
 203     uint32_t mods;
 204
 205     /** Command, like in command mode */
 206     char *command;
 207
 208     TAILQ_ENTRY(Binding) bindings;
 209 };
 210
 211 /**
 212  * Holds a command specified by either an:
 213  * - exec-line
 214  * - exec_always-line
 215  * in the config (see src/config.c)
 216  *
 217  */
 218 struct Autostart {
 219     /** Command, like in command mode */
 220     char *command;
 221     /** no_startup_id flag for start_application(). Determines whether a
 222      * startup notification context/ID should be created. */
 223     bool no_startup_id;
 224     TAILQ_ENTRY(Autostart) autostarts;
 225     TAILQ_ENTRY(Autostart) autostarts_always;
 226 };
 227
 228 /**
 229  * An Output is a physical output on your graphics driver. Outputs which
 230  * are currently in use have (output->active == true). Each output has a
 231  * position and a mode. An output usually corresponds to one connected
 232  * screen (except if you are running multiple screens in clone mode).
 233  *
 234  */
 235 struct xoutput {
 236     /** Output id, so that we can requery the output directly later */
 237     xcb_randr_output_t id;
 238     /** Name of the output */
 239     char *name;
 240
 241     /** Pointer to the Con which represents this output */
 242     Con *con;
 243
 244     /** Whether the output is currently active (has a CRTC attached with a
 245      * valid mode) */
 246     bool active;
 247
 248     /** Internal flags, necessary for querying RandR screens (happens in
 249      * two stages) */
 250     bool changed;
 251     bool to_be_disabled;
 252     bool primary;
 253
 254     /** x, y, width, height */
 255     Rect rect;
 256
 257     TAILQ_ENTRY(xoutput) outputs;
 258 };
 259
 260 struct Window {
 261     xcb_window_t id;
 262
 263     /** Holds the xcb_window_t (just an ID) for the leader window (logical
 264      * parent for toolwindows and similar floating windows) */
 265     xcb_window_t leader;
 266     xcb_window_t transient_for;
 267
 268     char *class_class;
 269     char *class_instance;
 270
 271     /** The name of the window as it will be passed to X11 (in UCS2 if the
 272      * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
 273     char *name_x;
 274
 275     /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
 276      * sets "buddy list"). Useful to match specific windows in assignments or
 277      * for_window. */
 278     char *role;
 279
 280     /** Flag to force re-rendering the decoration upon changes */
 281     bool name_x_changed;
 282
 283     /** The name of the window as used in JSON (in UTF-8 if the application
 284      * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
 285     char *name_json;
 286
 287     /** The length of the name in glyphs (not bytes) */
 288     size_t name_len;
 289
 290     /** Whether the application used _NET_WM_NAME */
 291     bool uses_net_wm_name;
 292
 293     /** Whether the application needs to receive WM_TAKE_FOCUS */
 294     bool needs_take_focus;
 295
 296     /** Whether the window says it is a dock window */
 297     enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
 298
 299     /** Pixels the window reserves. left/right/top/bottom */
 300     struct reservedpx reserved;
 301
 302     /** Pointers to the Assignments which were already ran for this Window
 303      * (assignments run only once) */
 304     uint32_t nr_assignments;
 305     Assignment **ran_assignments;
 306 };
 307
 308 struct Match {
 309     struct regex *title;
 310     struct regex *application;
 311     struct regex *class;
 312     struct regex *instance;
 313     struct regex *mark;
 314     struct regex *role;
 315     enum {
 316         M_DONTCHECK = -1,
 317         M_NODOCK = 0,
 318         M_DOCK_ANY = 1,
 319         M_DOCK_TOP = 2,
 320         M_DOCK_BOTTOM = 3
 321     } dock;
 322     xcb_window_t id;
 323     Con *con_id;
 324     enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
 325
 326     /* Where the window looking for a match should be inserted:
 327      *
 328      * M_HERE   = the matched container will be replaced by the window
 329      *            (layout saving)
 330      * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
 331      * M_BELOW  = the window will be inserted as a child of the matched container
 332      *            (dockareas)
 333      *
 334      */
 335     enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
 336
 337     TAILQ_ENTRY(Match) matches;
 338 };
 339
 340 /**
 341  * An Assignment makes specific windows go to a specific workspace/output or
 342  * run a command for that window. With this mechanism, the user can -- for
 343  * example -- make specific windows floating or assign his browser to workspace
 344  * "www". Checking if a window is assigned works by comparing the Match data
 345  * structure with the window (see match_matches_window()).
 346  *
 347  */
 348 struct Assignment {
 349     /** type of this assignment:
 350      *
 351      * A_COMMAND = run the specified command for the matching window
 352      * A_TO_WORKSPACE = assign the matching window to the specified workspace
 353      * A_TO_OUTPUT = assign the matching window to the specified output
 354      *
 355      * While the type is a bitmask, only one value can be set at a time. It is
 356      * a bitmask to allow filtering for multiple types, for example in the
 357      * assignment_for() function.
 358      *
 359      */
 360     enum {
 361         A_ANY          = 0,
 362         A_COMMAND      = (1 << 0),
 363         A_TO_WORKSPACE = (1 << 1),
 364         A_TO_OUTPUT    = (1 << 2)
 365     } type;
 366
 367     /** the criteria to check if a window matches */
 368     Match match;
 369
 370     /** destination workspace/output/command, depending on the type */
 371     union {
 372         char *command;
 373         char *workspace;
 374         char *output;
 375     } dest;
 376
 377     TAILQ_ENTRY(Assignment) assignments;
 378 };
 379
 380 struct Con {
 381     bool mapped;
 382     enum {
 383         CT_ROOT = 0,
 384         CT_OUTPUT = 1,
 385         CT_CON = 2,
 386         CT_FLOATING_CON = 3,
 387         CT_WORKSPACE = 4,
 388         CT_DOCKAREA = 5
 389     } type;
 390     orientation_t orientation;
 391     struct Con *parent;
 392
 393     struct Rect rect;
 394     struct Rect window_rect;
 395     struct Rect deco_rect;
 396     /** the geometry this window requested when getting mapped */
 397     struct Rect geometry;
 398
 399     char *name;
 400
 401     /** the workspace number, if this Con is of type CT_WORKSPACE and the
 402      * workspace is not a named workspace (for named workspaces, num == -1) */
 403     int num;
 404
 405     /* a sticky-group is an identifier which bundles several containers to a
 406      * group. The contents are shared between all of them, that is they are
 407      * displayed on whichever of the containers is currently visible */
 408     char *sticky_group;
 409
 410     /* user-definable mark to jump to this container later */
 411     char *mark;
 412
 413     double percent;
 414
 415     /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
 416      * apply an aspect ratio to windows (think of MPlayer) */
 417     int proportional_width;
 418     int proportional_height;
 419     /* the wanted size of the window, used in combination with size
 420      * increments (see below). */
 421     int base_width;
 422     int base_height;
 423
 424     /* the x11 border pixel attribute */
 425     int border_width;
 426
 427     /* minimum increment size specified for the window (in pixels) */
 428     int width_increment;
 429     int height_increment;
 430
 431     struct Window *window;
 432
 433     /* Should this container be marked urgent? This gets set when the window
 434      * inside this container (if any) sets the urgency hint, for example. */
 435     bool urgent;
 436
 437     /* ids/pixmap/graphics context for the frame window */
 438     xcb_window_t frame;
 439     xcb_pixmap_t pixmap;
 440     xcb_gcontext_t pm_gc;
 441     bool pixmap_recreated;
 442
 443     /** Cache for the decoration rendering */
 444     struct deco_render_params *deco_render_params;
 445
 446     /* Only workspace-containers can have floating clients */
 447     TAILQ_HEAD(floating_head, Con) floating_head;
 448
 449     TAILQ_HEAD(nodes_head, Con) nodes_head;
 450     TAILQ_HEAD(focus_head, Con) focus_head;
 451
 452     TAILQ_HEAD(swallow_head, Match) swallow_head;
 453
 454     enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
 455     enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2, L_DOCKAREA = 3, L_OUTPUT = 4 } layout;
 456     border_style_t border_style;
 457     /** floating? (= not in tiling layout) This cannot be simply a bool
 458      * because we want to keep track of whether the status was set by the
 459      * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
 460      * user. The user’s choice overwrites automatic mode, of course. The
 461      * order of the values is important because we check with >=
 462      * FLOATING_AUTO_ON if a client is floating. */
 463     enum {
 464         FLOATING_AUTO_OFF = 0,
 465         FLOATING_USER_OFF = 1,
 466         FLOATING_AUTO_ON = 2,
 467         FLOATING_USER_ON = 3
 468     } floating;
 469
 470     /** This counter contains the number of UnmapNotify events for this
 471      * container (or, more precisely, for its ->frame) which should be ignored.
 472      * UnmapNotify events need to be ignored when they are caused by i3 itself,
 473      * for example when reparenting or when unmapping the window on a workspace
 474      * change. */
 475     uint8_t ignore_unmap;
 476
 477     TAILQ_ENTRY(Con) nodes;
 478     TAILQ_ENTRY(Con) focused;
 479     TAILQ_ENTRY(Con) all_cons;
 480     TAILQ_ENTRY(Con) floating_windows;
 481
 482     /** callbacks */
 483     void(*on_remove_child)(Con *);
 484 };
 485
 486 #endif