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