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 /**
 121  * Stores which workspace (by name) goes to which output.
 122  *
 123  */
 124 struct Workspace_Assignment {
 125     char *name;
 126     char *output;
 127
 128     TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
 129 };
 130
 131 struct Ignore_Event {
 132     int sequence;
 133     int response_type;
 134     time_t added;
 135
 136     SLIST_ENTRY(Ignore_Event) ignore_events;
 137 };
 138
 139 /******************************************************************************
 140  * Major types
 141  *****************************************************************************/
 142
 143 /**
 144  * Holds a keybinding, consisting of a keycode combined with modifiers and the
 145  * command which is executed as soon as the key is pressed (see src/command.c)
 146  *
 147  */
 148 struct Binding {
 149     /** Symbol the user specified in configfile, if any. This needs to be
 150      * stored with the binding to be able to re-convert it into a keycode
 151      * if the keyboard mapping changes (using Xmodmap for example) */
 152     char *symbol;
 153
 154     /** Only in use if symbol != NULL. Gets set to the value to which the
 155      * symbol got translated when binding. Useful for unbinding and
 156      * checking which binding was used when a key press event comes in.
 157      *
 158      * This is an array of number_keycodes size. */
 159     xcb_keycode_t *translated_to;
 160
 161     uint32_t number_keycodes;
 162
 163     /** Keycode to bind */
 164     uint32_t keycode;
 165
 166     /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
 167     uint32_t mods;
 168
 169     /** Command, like in command mode */
 170     char *command;
 171
 172     TAILQ_ENTRY(Binding) bindings;
 173 };
 174
 175 /**
 176  * Holds a command specified by an exec-line in the config (see src/config.c)
 177  *
 178  */
 179 struct Autostart {
 180     /** Command, like in command mode */
 181     char *command;
 182     TAILQ_ENTRY(Autostart) autostarts;
 183 };
 184
 185 /**
 186  * Data structure for cached font information:
 187  * - font id in X11 (load it once)
 188  * - font height (multiple calls needed to get it)
 189  *
 190  */
 191 struct Font {
 192     /** The height of the font, built from font_ascent + font_descent */
 193     int height;
 194     /** The xcb-id for the font */
 195     xcb_font_t id;
 196 };
 197
 198
 199 /**
 200  * An Output is a physical output on your graphics driver. Outputs which
 201  * are currently in use have (output->active == true). Each output has a
 202  * position and a mode. An output usually corresponds to one connected
 203  * screen (except if you are running multiple screens in clone mode).
 204  *
 205  */
 206 struct xoutput {
 207     /** Output id, so that we can requery the output directly later */
 208     xcb_randr_output_t id;
 209     /** Name of the output */
 210     char *name;
 211
 212     /** Pointer to the Con which represents this output */
 213     Con *con;
 214
 215     /** Whether the output is currently active (has a CRTC attached with a
 216      * valid mode) */
 217     bool active;
 218
 219     /** Internal flags, necessary for querying RandR screens (happens in
 220      * two stages) */
 221     bool changed;
 222     bool to_be_disabled;
 223     bool primary;
 224
 225     /** x, y, width, height */
 226     Rect rect;
 227
 228 #if 0
 229     /** The bar window */
 230     xcb_window_t bar;
 231     xcb_gcontext_t bargc;
 232
 233     /** Contains all clients with _NET_WM_WINDOW_TYPE ==
 234      * _NET_WM_WINDOW_TYPE_DOCK */
 235     SLIST_HEAD(dock_clients_head, Client) dock_clients;
 236 #endif
 237
 238     TAILQ_ENTRY(xoutput) outputs;
 239 };
 240
 241 struct Window {
 242     xcb_window_t id;
 243
 244     /** Holds the xcb_window_t (just an ID) for the leader window (logical
 245      * parent for toolwindows and similar floating windows) */
 246     xcb_window_t leader;
 247     xcb_window_t transient_for;
 248
 249     char *class_class;
 250     char *class_instance;
 251
 252     /** The name of the window as it will be passed to X11 (in UCS2 if the
 253      * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
 254     char *name_x;
 255
 256     /** Flag to force re-rendering the decoration upon changes */
 257     bool name_x_changed;
 258
 259     /** The name of the window as used in JSON (in UTF-8 if the application
 260      * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
 261     char *name_json;
 262
 263     /** The length of the name in glyphs (not bytes) */
 264     int name_len;
 265
 266     /** Whether the application used _NET_WM_NAME */
 267     bool uses_net_wm_name;
 268
 269     /** Whether the application needs to receive WM_TAKE_FOCUS */
 270     bool needs_take_focus;
 271
 272     /** Whether the window says it is a dock window */
 273     enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
 274
 275     /** Pixels the window reserves. left/right/top/bottom */
 276     struct reservedpx reserved;
 277 };
 278
 279 struct Match {
 280     enum { M_WINDOW, M_CON } what;
 281
 282     char *title;
 283     int title_len;
 284     char *application;
 285     char *class;
 286     char *instance;
 287     char *mark;
 288     enum {
 289         M_DONTCHECK = -1,
 290         M_NODOCK = 0,
 291         M_DOCK_ANY = 1,
 292         M_DOCK_TOP = 2,
 293         M_DOCK_BOTTOM = 3
 294     } dock;
 295     xcb_window_t id;
 296     Con *con_id;
 297     enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
 298
 299     enum { M_GLOBAL = 0, M_OUTPUT, M_WORKSPACE } levels;
 300
 301     enum { M_USER = 0, M_RESTART } source;
 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 Con {
 321     bool mapped;
 322     enum {
 323         CT_ROOT = 0,
 324         CT_OUTPUT = 1,
 325         CT_CON = 2,
 326         CT_FLOATING_CON = 3,
 327         CT_WORKSPACE = 4,
 328         CT_DOCKAREA = 5
 329     } type;
 330     orientation_t orientation;
 331     struct Con *parent;
 332
 333     struct Rect rect;
 334     struct Rect window_rect;
 335     struct Rect deco_rect;
 336     /** the geometry this window requested when getting mapped */
 337     struct Rect geometry;
 338
 339     char *name;
 340
 341     /** the workspace number, if this Con is of type CT_WORKSPACE and the
 342      * workspace is not a named workspace (for named workspaces, num == -1) */
 343     int num;
 344
 345     /* a sticky-group is an identifier which bundles several containers to a
 346      * group. The contents are shared between all of them, that is they are
 347      * displayed on whichever of the containers is currently visible */
 348     char *sticky_group;
 349
 350     /* user-definable mark to jump to this container later */
 351     char *mark;
 352
 353     double percent;
 354
 355     /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
 356      * apply an aspect ratio to windows (think of MPlayer) */
 357     int proportional_width;
 358     int proportional_height;
 359     /* the wanted size of the window, used in combination with size
 360      * increments (see below). */
 361     int base_width;
 362     int base_height;
 363
 364     /* the x11 border pixel attribute */
 365     int border_width;
 366
 367     /* minimum increment size specified for the window (in pixels) */
 368     int width_increment;
 369     int height_increment;
 370
 371     struct Window *window;
 372
 373     /* Should this container be marked urgent? This gets set when the window
 374      * inside this container (if any) sets the urgency hint, for example. */
 375     bool urgent;
 376
 377     /* ids/pixmap/graphics context for the frame window */
 378     xcb_window_t frame;
 379     xcb_pixmap_t pixmap;
 380     xcb_gcontext_t pm_gc;
 381     bool pixmap_recreated;
 382
 383     /** Cache for the decoration rendering */
 384     struct deco_render_params *deco_render_params;
 385
 386     /* Only workspace-containers can have floating clients */
 387     TAILQ_HEAD(floating_head, Con) floating_head;
 388
 389     TAILQ_HEAD(nodes_head, Con) nodes_head;
 390     TAILQ_HEAD(focus_head, Con) focus_head;
 391
 392     TAILQ_HEAD(swallow_head, Match) swallow_head;
 393
 394     enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
 395     enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2, L_DOCKAREA = 3, L_OUTPUT = 4 } layout;
 396     border_style_t border_style;
 397     /** floating? (= not in tiling layout) This cannot be simply a bool
 398      * because we want to keep track of whether the status was set by the
 399      * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
 400      * user. The user’s choice overwrites automatic mode, of course. The
 401      * order of the values is important because we check with >=
 402      * FLOATING_AUTO_ON if a client is floating. */
 403     enum {
 404         FLOATING_AUTO_OFF = 0,
 405         FLOATING_USER_OFF = 1,
 406         FLOATING_AUTO_ON = 2,
 407         FLOATING_USER_ON = 3
 408     } floating;
 409
 410     /** This counter contains the number of UnmapNotify events for this
 411      * container (or, more precisely, for its ->frame) which should be ignored.
 412      * UnmapNotify events need to be ignored when they are caused by i3 itself,
 413      * for example when reparenting or when unmapping the window on a workspace
 414      * change. */
 415     uint8_t ignore_unmap;
 416
 417     TAILQ_ENTRY(Con) nodes;
 418     TAILQ_ENTRY(Con) focused;
 419     TAILQ_ENTRY(Con) all_cons;
 420     TAILQ_ENTRY(Con) floating_windows;
 421
 422     /** callbacks */
 423     void(*on_remove_child)(Con *);
 424 };
 425
 426 #endif