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/xcb.h>
  11 #include <xcb/randr.h>
  12 #include <xcb/xcb_atom.h>
  13 #include <stdbool.h>
  14
  15 #ifndef _DATA_H
  16 #define _DATA_H
  17 #include "queue.h"
  18
  19 /*
  20  * To get the big concept: There are helper structures like struct Colorpixel
  21  * or struct Stack_Window. Everything which is also defined as type (see
  22  * forward definitions) is considered to be a major structure, thus important.
  23  *
  24  * Let’s start from the biggest to the smallest:
  25  *
  26  * TODO
  27  *
  28  */
  29
  30 /* Forward definitions */
  31 typedef struct Font i3Font;
  32 typedef struct Binding Binding;
  33 typedef struct Rect Rect;
  34 typedef struct xoutput Output;
  35 typedef struct Con Con;
  36 typedef struct Match Match;
  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
  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  * Used for the cache of colorpixels.
  79  *
  80  */
  81 struct Colorpixel {
  82     uint32_t pixel;
  83     char *hex;
  84     SLIST_ENTRY(Colorpixel) colorpixels;
  85 };
  86
  87 struct Cached_Pixmap {
  88     xcb_pixmap_t id;
  89
  90     /* We’re going to paint on it, so a graphics context will be needed */
  91     xcb_gcontext_t gc;
  92
  93     /* The rect with which the pixmap was created */
  94     Rect rect;
  95
  96     /* The rect of the object to which this pixmap belongs. Necessary to
  97      * find out when we need to re-create the pixmap. */
  98     Rect *referred_rect;
  99
 100     xcb_drawable_t referred_drawable;
 101 };
 102
 103 struct Ignore_Event {
 104     int sequence;
 105     time_t added;
 106
 107     SLIST_ENTRY(Ignore_Event) ignore_events;
 108 };
 109
 110 /******************************************************************************
 111  * Major types
 112  *****************************************************************************/
 113
 114 /**
 115  * Holds a keybinding, consisting of a keycode combined with modifiers and the
 116  * command which is executed as soon as the key is pressed (see src/command.c)
 117  *
 118  */
 119 struct Binding {
 120     /** Symbol the user specified in configfile, if any. This needs to be
 121      * stored with the binding to be able to re-convert it into a keycode
 122      * if the keyboard mapping changes (using Xmodmap for example) */
 123     char *symbol;
 124
 125     /** Only in use if symbol != NULL. Gets set to the value to which the
 126      * symbol got translated when binding. Useful for unbinding and
 127      * checking which binding was used when a key press event comes in.
 128      *
 129      * This is an array of number_keycodes size. */
 130     xcb_keycode_t *translated_to;
 131
 132     uint32_t number_keycodes;
 133
 134     /** Keycode to bind */
 135     uint32_t keycode;
 136
 137     /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
 138     uint32_t mods;
 139
 140     /** Command, like in command mode */
 141     char *command;
 142
 143     TAILQ_ENTRY(Binding) bindings;
 144 };
 145
 146 /**
 147  * Holds a command specified by an exec-line in the config (see src/config.c)
 148  *
 149  */
 150 struct Autostart {
 151     /** Command, like in command mode */
 152     char *command;
 153     TAILQ_ENTRY(Autostart) autostarts;
 154 };
 155
 156 /**
 157  * Data structure for cached font information:
 158  * - font id in X11 (load it once)
 159  * - font height (multiple calls needed to get it)
 160  *
 161  */
 162 struct Font {
 163     /** The name of the font, that is what the pattern resolves to */
 164     char *name;
 165     /** A copy of the pattern to build a cache */
 166     char *pattern;
 167     /** The height of the font, built from font_ascent + font_descent */
 168     int height;
 169     /** The xcb-id for the font */
 170     xcb_font_t id;
 171
 172     TAILQ_ENTRY(Font) fonts;
 173 };
 174
 175
 176 /**
 177  * An Output is a physical output on your graphics driver. Outputs which
 178  * are currently in use have (output->active == true). Each output has a
 179  * position and a mode. An output usually corresponds to one connected
 180  * screen (except if you are running multiple screens in clone mode).
 181  *
 182  */
 183 struct xoutput {
 184     /** Output id, so that we can requery the output directly later */
 185     xcb_randr_output_t id;
 186     /** Name of the output */
 187     char *name;
 188
 189     /** Whether the output is currently active (has a CRTC attached with a
 190      * valid mode) */
 191     bool active;
 192
 193     /** Internal flags, necessary for querying RandR screens (happens in
 194      * two stages) */
 195     bool changed;
 196     bool to_be_disabled;
 197
 198     /** x, y, width, height */
 199     Rect rect;
 200
 201     /** The bar window */
 202     xcb_window_t bar;
 203     xcb_gcontext_t bargc;
 204
 205     /** Contains all clients with _NET_WM_WINDOW_TYPE ==
 206      * _NET_WM_WINDOW_TYPE_DOCK */
 207     SLIST_HEAD(dock_clients_head, Client) dock_clients;
 208
 209     TAILQ_ENTRY(xoutput) outputs;
 210 };
 211
 212 struct Window {
 213     xcb_window_t id;
 214
 215     /** Holds the xcb_window_t (just an ID) for the leader window (logical
 216      * parent for toolwindows and similar floating windows) */
 217     xcb_window_t leader;
 218     xcb_window_t transient_for;
 219
 220     char *class_class;
 221     char *class_instance;
 222
 223     /** The name of the window as it will be passed to X11 (in UCS2 if the
 224      * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
 225     char *name_x;
 226
 227     /** The name of the window as used in JSON (in UTF-8 if the application
 228      * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
 229     char *name_json;
 230
 231     /** The length of the name in glyphs (not bytes) */
 232     int name_len;
 233
 234     /** Whether the application used _NET_WM_NAME */
 235     bool uses_net_wm_name;
 236
 237     /** Whether the window says it is a dock window */
 238     bool dock;
 239 };
 240
 241 struct Match {
 242     enum { M_WINDOW, M_CON } what;
 243
 244     char *title;
 245     int title_len;
 246     char *application;
 247     char *class;
 248     char *instance;
 249     char *mark;
 250     int dock;
 251     xcb_window_t id;
 252     Con *con_id;
 253     enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
 254
 255     enum { M_GLOBAL = 0, M_OUTPUT, M_WORKSPACE } levels;
 256
 257     enum { M_USER = 0, M_RESTART } source;
 258
 259     /* wo das fenster eingefügt werden soll. bei here wird es direkt
 260      * diesem Con zugewiesen, also layout saving. bei active ist es
 261      * ein assignment, welches an der momentan fokussierten stelle einfügt */
 262     enum { M_HERE = 0, M_ACTIVE } insert_where;
 263
 264     TAILQ_ENTRY(Match) matches;
 265 };
 266
 267 struct Con {
 268     bool mapped;
 269     enum { CT_ROOT = 0, CT_OUTPUT = 1, CT_CON = 2, CT_FLOATING_CON = 3, CT_WORKSPACE = 4 } type;
 270     orientation_t orientation;
 271     struct Con *parent;
 272     /* parent before setting it to floating */
 273     struct Con *old_parent;
 274
 275     struct Rect rect;
 276     struct Rect window_rect;
 277     struct Rect deco_rect;
 278
 279     char *name;
 280
 281     /* a sticky-group is an identifier which bundles several containers to a
 282      * group. The contents are shared between all of them, that is they are
 283      * displayed on whichever of the containers is currently visible */
 284     char *sticky_group;
 285
 286     /* user-definable mark to jump to this container later */
 287     char *mark;
 288
 289     double percent;
 290
 291     /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
 292      * apply an aspect ratio to windows (think of MPlayer) */
 293     int proportional_width;
 294     int proportional_height;
 295     /* the wanted size of the window, used in combination with size
 296      * increments (see below). */
 297     int base_width;
 298     int base_height;
 299
 300     /* minimum increment size specified for the window (in pixels) */
 301     int width_increment;
 302     int height_increment;
 303
 304     struct Window *window;
 305
 306     /* Should this container be marked urgent? This gets set when the window
 307      * inside this container (if any) sets the urgency hint, for example. */
 308     bool urgent;
 309
 310     /* ids/gc for the frame window */
 311     xcb_window_t frame;
 312     xcb_gcontext_t gc;
 313
 314     /* Only workspace-containers can have floating clients */
 315     TAILQ_HEAD(floating_head, Con) floating_head;
 316
 317     TAILQ_HEAD(nodes_head, Con) nodes_head;
 318     TAILQ_HEAD(focus_head, Con) focus_head;
 319
 320     TAILQ_HEAD(swallow_head, Match) swallow_head;
 321
 322     enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
 323     enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2 } layout;
 324     enum { BS_NORMAL = 0, BS_NONE = 1, BS_1PIXEL = 3 } border_style;
 325     /** floating? (= not in tiling layout) This cannot be simply a bool
 326      * because we want to keep track of whether the status was set by the
 327      * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
 328      * user. The user’s choice overwrites automatic mode, of course. The
 329      * order of the values is important because we check with >=
 330      * FLOATING_AUTO_ON if a client is floating. */
 331     enum {
 332         FLOATING_AUTO_OFF = 0,
 333         FLOATING_USER_OFF = 1,
 334         FLOATING_AUTO_ON = 2,
 335         FLOATING_USER_ON = 3
 336     } floating;
 337
 338
 339     TAILQ_ENTRY(Con) nodes;
 340     TAILQ_ENTRY(Con) focused;
 341     TAILQ_ENTRY(Con) all_cons;
 342     TAILQ_ENTRY(Con) floating_windows;
 343 };
 344
 345 #endif