git.sur5r.net Git - i3/i3/blob - include/data.h

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * include/data.h: This file defines all data structures used by i3
  11  *
  12  */
  13 #include <xcb/xcb.h>
  14 #include <xcb/xcb_atom.h>
  15 #include <stdbool.h>
  16
  17 #ifndef _DATA_H
  18 #define _DATA_H
  19 #include "queue.h"
  20
  21 /*
  22  * To get the big concept: There are helper structures like struct Colorpixel
  23  * or struct Stack_Window. Everything which is also defined as type (see
  24  * forward definitions) is considered to be a major structure, thus important.
  25  *
  26  * Let’s start from the biggest to the smallest:
  27  *
  28  * - An i3Screen is a virtual screen (Xinerama). This can be a single one,
  29  *   though two monitors might be connected, if you’re running clone
  30  *   mode. There can also be multiple of them.
  31  *
  32  * - Each i3Screen contains Workspaces. The concept is known from various
  33  *   other window managers.  Basically, a workspace is a specific set of
  34  *   windows, usually grouped thematically (irc, www, work, …). You can switch
  35  *   between these.
  36  *
  37  * - Each Workspace has a table, which is our layout abstraction. You manage
  38  *   your windows by moving them around in your table. It grows as necessary.
  39  *
  40  * - Each cell of the table has a container, which can be in default or
  41  *   stacking mode. In default mode, each client is given equally much space
  42  *   in the container. In stacking mode, only one client is shown at a time,
  43  *   but all the titlebars are rendered at the top.
  44  *
  45  * - Inside the container are clients, which is X11-speak for a window.
  46  *
  47  */
  48
  49 /* Forward definitions */
  50 typedef struct Cell Cell;
  51 typedef struct Font i3Font;
  52 typedef struct Container Container;
  53 typedef struct Client Client;
  54 typedef struct Binding Binding;
  55 typedef struct Workspace Workspace;
  56 typedef struct Rect Rect;
  57 typedef struct Screen i3Screen;
  58
  59 /******************************************************************************
  60  * Helper types
  61  *****************************************************************************/
  62 typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
  63
  64 enum {
  65         BIND_NONE = 0,
  66         BIND_SHIFT = XCB_MOD_MASK_SHIFT,        /* (1 << 0) */
  67         BIND_CONTROL = XCB_MOD_MASK_CONTROL,    /* (1 << 2) */
  68         BIND_MOD1 = XCB_MOD_MASK_1,             /* (1 << 3) */
  69         BIND_MOD2 = XCB_MOD_MASK_2,             /* (1 << 4) */
  70         BIND_MOD3 = XCB_MOD_MASK_3,             /* (1 << 5) */
  71         BIND_MOD4 = XCB_MOD_MASK_4,             /* (1 << 6) */
  72         BIND_MOD5 = XCB_MOD_MASK_5,             /* (1 << 7) */
  73         BIND_MODE_SWITCH = (1 << 8)
  74 };
  75
  76 /**
  77  * Stores a rectangle, for example the size of a window, the child window etc.
  78  *
  79  */
  80 struct Rect {
  81         uint32_t x, y;
  82         uint32_t width, height;
  83 };
  84
  85 /**
  86  * Defines a position in the table
  87  *
  88  */
  89 struct Cell {
  90         int row;
  91         int column;
  92 };
  93
  94 /**
  95  * Used for the cache of colorpixels.
  96  *
  97  */
  98 struct Colorpixel {
  99         uint32_t pixel;
 100         char *hex;
 101         SLIST_ENTRY(Colorpixel) colorpixels;
 102 };
 103
 104 struct Cached_Pixmap {
 105         xcb_pixmap_t id;
 106
 107         /* We’re going to paint on it, so a graphics context will be needed */
 108         xcb_gcontext_t gc;
 109
 110         /* The rect with which the pixmap was created */
 111         Rect rect;
 112
 113         /* The rect of the object to which this pixmap belongs. Necessary to
 114          * find out when we need to re-create the pixmap. */
 115         Rect *referred_rect;
 116
 117         xcb_drawable_t referred_drawable;
 118 };
 119
 120 /**
 121  * Contains data for the windows needed to draw the titlebars on in stacking
 122  * mode
 123  *
 124  */
 125 struct Stack_Window {
 126         xcb_window_t window;
 127         struct Cached_Pixmap pixmap;
 128         Rect rect;
 129
 130         /** Backpointer to the container this stack window is in */
 131         Container *container;
 132
 133         SLIST_ENTRY(Stack_Window) stack_windows;
 134 };
 135
 136 struct Ignore_Event {
 137         int sequence;
 138         time_t added;
 139
 140         SLIST_ENTRY(Ignore_Event) ignore_events;
 141 };
 142
 143 /**
 144  * Emulates the behaviour of tables of libxcb-wm, which in libxcb 0.3.4
 145  * suddenly vanished.
 146  *
 147  */
 148 struct keyvalue_element {
 149         uint32_t key;
 150         void *value;
 151         TAILQ_ENTRY(keyvalue_element) elements;
 152 };
 153
 154 /******************************************************************************
 155  * Major types
 156  *****************************************************************************/
 157
 158 /**
 159  * The concept of Workspaces is known from various other window
 160  * managers. Basically, a workspace is a specific set of windows, usually
 161  * grouped thematically (irc, www, work, …). You can switch between these.
 162  *
 163  */
 164 struct Workspace {
 165         /** Number of this workspace, starting from 0 */
 166         int num;
 167
 168         /** Name of the workspace (in UCS-2) */
 169         char *name;
 170
 171         /** Length of the workspace’s name (in glyphs) */
 172         int name_len;
 173
 174         /** Width of the workspace’s name (in pixels) rendered in config.font */
 175         int text_width;
 176
 177         /** x, y, width, height */
 178         Rect rect;
 179
 180         /** table dimensions */
 181         int cols;
 182         /** table dimensions */
 183         int rows;
 184
 185         /** These are stored here only while this workspace is _not_ shown
 186          * (see show_workspace()) */
 187         int current_row;
 188         /** These are stored here only while this workspace is _not_ shown
 189          * (see show_workspace()) */
 190         int current_col;
 191
 192         /** Should clients on this workspace be automatically floating? */
 193         bool auto_float;
 194         /** Are the floating clients on this workspace currently hidden? */
 195         bool floating_hidden;
 196
 197         /** the client who is started in fullscreen mode on this workspace,
 198          * NULL if there is none */
 199         Client *fullscreen_client;
 200
 201         /** The focus stack contains the clients in the correct order of focus
 202            so that the focus can be reverted correctly when a client is
 203            closed */
 204         SLIST_HEAD(focus_stack_head, Client) focus_stack;
 205
 206         /** This tail queue contains the floating clients in order of when
 207          * they were first set to floating (new floating clients are just
 208          * appended) */
 209         TAILQ_HEAD(floating_clients_head, Client) floating_clients;
 210
 211         /** Backpointer to the screen this workspace is on */
 212         i3Screen *screen;
 213
 214         /** This is a two-dimensional dynamic array of
 215          * Container-pointers. I’ve always wanted to be a three-star
 216          * programmer :) */
 217         Container ***table;
 218
 219         /** width_factor and height_factor contain the amount of space
 220          * (percentage) a column/row has of all the space which is available
 221          * for resized windows. This ensures that non-resized windows (newly
 222          * opened, for example) have the same size as always */
 223         float *width_factor;
 224         float *height_factor;
 225 };
 226
 227 /**
 228  * Holds a keybinding, consisting of a keycode combined with modifiers and the
 229  * command which is executed as soon as the key is pressed (see src/command.c)
 230  *
 231  */
 232 struct Binding {
 233         /** Keycode to bind */
 234         uint32_t keycode;
 235         /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
 236         uint32_t mods;
 237         /** Command, like in command mode */
 238         char *command;
 239         TAILQ_ENTRY(Binding) bindings;
 240 };
 241
 242 /**
 243  * Holds a command specified by an exec-line in the config (see src/config.c)
 244  *
 245  */
 246 struct Autostart {
 247         /** Command, like in command mode */
 248         char *command;
 249         TAILQ_ENTRY(Autostart) autostarts;
 250 };
 251
 252 /**
 253  * Holds an assignment for a given window class/title to a specific workspace
 254  * (see src/config.c)
 255  *
 256  */
 257 struct Assignment {
 258         char *windowclass_title;
 259         /** floating is true if this was an assignment to the special
 260          * workspace "~".  Matching clients will be put into floating mode
 261          * automatically. */
 262         enum {
 263                 ASSIGN_FLOATING_NO,   /* don’t float, but put on a workspace */
 264                 ASSIGN_FLOATING_ONLY, /* float, but don’t assign on a workspace */
 265                 ASSIGN_FLOATING       /* float and put on a workspace */
 266         } floating;
 267
 268         /** The number of the workspace to assign to. */
 269         int workspace;
 270         TAILQ_ENTRY(Assignment) assignments;
 271 };
 272
 273 /**
 274  * Data structure for cached font information:
 275  * - font id in X11 (load it once)
 276  * - font height (multiple calls needed to get it)
 277  *
 278  */
 279 struct Font {
 280         /** The name of the font, that is what the pattern resolves to */
 281         char *name;
 282         /** A copy of the pattern to build a cache */
 283         char *pattern;
 284         /** The height of the font, built from font_ascent + font_descent */
 285         int height;
 286         /** The xcb-id for the font */
 287         xcb_font_t id;
 288
 289         TAILQ_ENTRY(Font) fonts;
 290 };
 291
 292 /**
 293  * A client is X11-speak for a window.
 294  *
 295  */
 296 struct Client {
 297         /** initialized will be set to true if the client was fully
 298          * initialized by manage_window() and all functions can be used
 299          * normally */
 300         bool initialized;
 301
 302         /** if you set a client to floating and set it back to managed, it
 303          * does remember its old position and *tries* to get back there */
 304         Cell old_position;
 305
 306         /** Backpointer. A client is inside a container */
 307         Container *container;
 308         /** Because dock clients don’t have a container, we have this
 309          * workspace-backpointer */
 310         Workspace *workspace;
 311
 312         /** x, y, width, height of the frame */
 313         Rect rect;
 314         /** Position in floating mode and in tiling mode are saved
 315          * separately */
 316         Rect floating_rect;
 317         /** x, y, width, height of the child (relative to its frame) */
 318         Rect child_rect;
 319
 320         /** contains the size calculated from the hints set by the window or 0
 321          * if the client did not send any hints */
 322         int proportional_height;
 323         int proportional_width;
 324
 325         /** Height which was determined by reading the _NET_WM_STRUT_PARTIAL
 326          * top/bottom of the screen reservation */
 327         int desired_height;
 328
 329         /** Name (= window title) */
 330         char *name;
 331         /** name_len stores the real string length (glyphs) of the window
 332          * title if the client uses _NET_WM_NAME. Otherwise, it is set to -1
 333          * to indicate that name should be just passed to X as 8-bit string
 334          * and therefore will not be rendered correctly. This behaviour is to
 335          * support legacy applications which do not set _NET_WM_NAME */
 336         int name_len;
 337         /** This will be set to true as soon as the first _NET_WM_NAME comes
 338          * in. If set to true, legacy window names are ignored. */
 339         bool uses_net_wm_name;
 340
 341         /** Holds the WM_CLASS, useful for matching the client in commands */
 342         char *window_class;
 343
 344         /** Holds the xcb_window_t (just an ID) for the leader window (logical
 345          * parent for toolwindows and similar floating windows) */
 346         xcb_window_t leader;
 347
 348         /** fullscreen is pretty obvious */
 349         bool fullscreen;
 350
 351         /** floating? (= not in tiling layout) This cannot be simply a bool
 352          * because we want to keep track of whether the status was set by the
 353          * application (by setting WM_CLASS to tools for example) or by the
 354          * user. The user’s choice overwrites automatic mode, of course. The
 355          * order of the values is important because we check with >=
 356          * FLOATING_AUTO_ON if a client is floating. */
 357         enum { FLOATING_AUTO_OFF = 0, FLOATING_USER_OFF = 1, FLOATING_AUTO_ON = 2, FLOATING_USER_ON = 3 } floating;
 358
 359         /** Ensure TITLEBAR_TOP maps to 0 because we use calloc for
 360          * initialization later */
 361         enum { TITLEBAR_TOP = 0, TITLEBAR_LEFT, TITLEBAR_RIGHT, TITLEBAR_BOTTOM, TITLEBAR_OFF } titlebar_position;
 362
 363         /** Contains a bool specifying whether this window should not be drawn
 364          * with the usual decorations */
 365         bool borderless;
 366
 367         /** If a client is set as a dock, it is placed at the very bottom of
 368          * the screen and its requested size is used */
 369         bool dock;
 370
 371         /* After leaving fullscreen mode, a client needs to be reconfigured
 372          * (configuration = setting X, Y, width and height). By setting the
 373          * force_reconfigure flag, render_layout() will reconfigure the
 374          * client. */
 375         bool force_reconfigure;
 376
 377         /* When reparenting a window, an unmap-notify is sent. As we delete
 378          * windows when they’re unmapped, we need to ignore that
 379          * one. Therefore, this flag is set when reparenting. */
 380         bool awaiting_useless_unmap;
 381
 382         /* XCB contexts */
 383         xcb_window_t frame;             /**< Our window: The frame around the
 384                                          * client */
 385         xcb_gcontext_t titlegc;         /**< The titlebar’s graphic context
 386                                          * inside the frame */
 387         xcb_window_t child;             /**< The client’s window */
 388
 389         /** The following entry provides the necessary list pointers to use
 390          * Client with LIST_* macros */
 391         CIRCLEQ_ENTRY(Client) clients;
 392         SLIST_ENTRY(Client) dock_clients;
 393         SLIST_ENTRY(Client) focus_clients;
 394         TAILQ_ENTRY(Client) floating_clients;
 395 };
 396
 397 /**
 398  * A container is either in default or stacking mode. It sits inside each cell
 399  * of the table.
 400  *
 401  */
 402 struct Container {
 403         /* Those are speaking for themselves: */
 404         Client *currently_focused;
 405         int colspan;
 406         int rowspan;
 407
 408         /* Position of the container inside our table */
 409         int row;
 410         int col;
 411         /* Xinerama: X/Y of the container */
 412         int x;
 413         int y;
 414         /* Width/Height of the container. Changeable by the user */
 415         int width;
 416         int height;
 417
 418         /* When in stacking mode, we draw the titlebars of each client onto a
 419          * separate window */
 420         struct Stack_Window stack_win;
 421
 422         /* Backpointer to the workspace this container is in */
 423         Workspace *workspace;
 424
 425         /* Ensure MODE_DEFAULT maps to 0 because we use calloc for
 426          * initialization later */
 427         enum { MODE_DEFAULT = 0, MODE_STACK } mode;
 428         CIRCLEQ_HEAD(client_head, Client) clients;
 429 };
 430
 431 /**
 432  * This is a virtual screen (Xinerama). This can be a single one, though two
 433  * monitors might be connected, if you’re running clone mode. There can also
 434  * be multiple of them.
 435  *
 436  */
 437 struct Screen {
 438         /** Virtual screen number */
 439         int num;
 440
 441         /** Current workspace selected on this virtual screen */
 442         int current_workspace;
 443
 444         /** x, y, width, height */
 445         Rect rect;
 446
 447         /** The bar window */
 448         xcb_window_t bar;
 449         xcb_gcontext_t bargc;
 450
 451         /** Contains all clients with _NET_WM_WINDOW_TYPE ==
 452          * _NET_WM_WINDOW_TYPE_DOCK */
 453         SLIST_HEAD(dock_clients_head, Client) dock_clients;
 454
 455         TAILQ_ENTRY(Screen) screens;
 456 };
 457
 458 #endif