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