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