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