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