/*
- * vim:ts=8:expandtab
+ * vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
+ * © 2009-2010 Michael Stapelberg and contributors (see also: LICENSE)
*
- * (c) 2009 Michael Stapelberg and contributors
- *
- * See file LICENSE for license information.
+ * include/data.h: This file defines all data structures used by i3
*
*/
#include <xcb/xcb.h>
+#include <xcb/randr.h>
+#include <xcb/xcb_atom.h>
#include <stdbool.h>
#ifndef _DATA_H
#define _DATA_H
+#include "queue.h"
+
/*
- * This file defines all data structures used by i3
+ * To get the big concept: There are helper structures like struct Colorpixel
+ * or struct Stack_Window. Everything which is also defined as type (see
+ * forward definitions) is considered to be a major structure, thus important.
+ *
+ * Let’s start from the biggest to the smallest:
+ *
+ * TODO
*
*/
-#include "queue.h"
/* Forward definitions */
-typedef struct Cell Cell;
typedef struct Font i3Font;
-typedef struct Container Container;
-typedef struct Client Client;
typedef struct Binding Binding;
-typedef struct Workspace Workspace;
typedef struct Rect Rect;
-typedef struct Screen i3Screen;
+typedef struct xoutput Output;
+typedef struct Con Con;
+typedef struct Match Match;
+typedef struct Window i3Window;
+
-/* Helper types */
+/******************************************************************************
+ * Helper types
+ *****************************************************************************/
typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
+typedef enum { NO_ORIENTATION = 0, HORIZ, VERT } orientation_t;
enum {
- BIND_NONE = 0,
- BIND_MOD_1 = XCB_MOD_MASK_1,
- BIND_MOD_2 = XCB_MOD_MASK_2,
- BIND_MOD_3 = XCB_MOD_MASK_3,
- BIND_MOD_4 = XCB_MOD_MASK_4,
- BIND_MOD_5 = XCB_MOD_MASK_5,
- BIND_SHIFT = XCB_MOD_MASK_SHIFT,
- BIND_CONTROL = XCB_MOD_MASK_CONTROL,
- BIND_MODE_SWITCH = (1 << 8)
+ BIND_NONE = 0,
+ BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
+ BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
+ BIND_MOD1 = XCB_MOD_MASK_1, /* (1 << 3) */
+ BIND_MOD2 = XCB_MOD_MASK_2, /* (1 << 4) */
+ BIND_MOD3 = XCB_MOD_MASK_3, /* (1 << 5) */
+ BIND_MOD4 = XCB_MOD_MASK_4, /* (1 << 6) */
+ BIND_MOD5 = XCB_MOD_MASK_5, /* (1 << 7) */
+ BIND_MODE_SWITCH = (1 << 8)
};
+/**
+ * Stores a rectangle, for example the size of a window, the child window etc.
+ * It needs to be packed so that the compiler will not add any padding bytes.
+ * (it is used in src/ewmh.c for example)
+ *
+ * Note that x and y can contain signed values in some cases (for example when
+ * used for the coordinates of a window, which can be set outside of the
+ * visible area, but not when specifying the position of a workspace for the
+ * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
+ * typecasts.
+ *
+ */
struct Rect {
- uint32_t x, y;
- uint32_t width, height;
+ uint32_t x;
+ uint32_t y;
+ uint32_t width;
+ uint32_t height;
+} __attribute__((packed));
+
+/**
+ * Used for the cache of colorpixels.
+ *
+ */
+struct Colorpixel {
+ uint32_t pixel;
+ char *hex;
+ SLIST_ENTRY(Colorpixel) colorpixels;
};
-struct Workspace {
- /* x, y, width, height */
- Rect rect;
+struct Cached_Pixmap {
+ xcb_pixmap_t id;
- /* table dimensions */
- int cols;
- int rows;
+ /* We’re going to paint on it, so a graphics context will be needed */
+ xcb_gcontext_t gc;
- /* These are stored here just while this workspace is _not_ shown (see show_workspace()) */
- int current_row;
- int current_col;
+ /* The rect with which the pixmap was created */
+ Rect rect;
- Client *fullscreen_client;
+ /* The rect of the object to which this pixmap belongs. Necessary to
+ * find out when we need to re-create the pixmap. */
+ Rect *referred_rect;
- /* Contains all clients with _NET_WM_WINDOW_TYPE == _NET_WM_WINDOW_TYPE_DOCK */
- SLIST_HEAD(dock_clients_head, Client) dock_clients;
+ xcb_drawable_t referred_drawable;
+};
- /* Backpointer to the screen this workspace is on */
- i3Screen *screen;
+struct Ignore_Event {
+ int sequence;
+ time_t added;
- /* This is a two-dimensional dynamic array of Container-pointers. I’ve always wanted
- * to be a three-star programmer :) */
- Container ***table;
+ SLIST_ENTRY(Ignore_Event) ignore_events;
};
-/*
- * Defines a position in the table
+/******************************************************************************
+ * Major types
+ *****************************************************************************/
+
+/**
+ * Holds a keybinding, consisting of a keycode combined with modifiers and the
+ * command which is executed as soon as the key is pressed (see src/command.c)
*
*/
-struct Cell {
- int row;
- int column;
+struct Binding {
+ /** Symbol the user specified in configfile, if any. This needs to be
+ * stored with the binding to be able to re-convert it into a keycode
+ * if the keyboard mapping changes (using Xmodmap for example) */
+ char *symbol;
+
+ /** Only in use if symbol != NULL. Gets set to the value to which the
+ * symbol got translated when binding. Useful for unbinding and
+ * checking which binding was used when a key press event comes in.
+ *
+ * This is an array of number_keycodes size. */
+ xcb_keycode_t *translated_to;
+
+ uint32_t number_keycodes;
+
+ /** Keycode to bind */
+ uint32_t keycode;
+
+ /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
+ uint32_t mods;
+
+ /** Command, like in command mode */
+ char *command;
+
+ TAILQ_ENTRY(Binding) bindings;
};
-struct Binding {
- /* Keycode to bind */
- uint32_t keycode;
- /* Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
- uint32_t mods;
- /* Command, like in command mode */
- char *command;
-
- TAILQ_ENTRY(Binding) bindings;
+/**
+ * Holds a command specified by an exec-line in the config (see src/config.c)
+ *
+ */
+struct Autostart {
+ /** Command, like in command mode */
+ char *command;
+ TAILQ_ENTRY(Autostart) autostarts;
};
-/*
- * We need to save the height of a font because it is required for each drawing of
- * text but relatively hard to get. As soon as a new font needs to be loaded, a
- * Font-entry will be filled for later use.
+/**
+ * Data structure for cached font information:
+ * - font id in X11 (load it once)
+ * - font height (multiple calls needed to get it)
*
*/
struct Font {
- /* The name of the font, that is what the pattern resolves to */
- char *name;
- /* A copy of the pattern to build a cache */
- char *pattern;
- /* The height of the font, built from font_ascent + font_descent */
- int height;
- /* The xcb-id for the font */
- xcb_font_t id;
-
- TAILQ_ENTRY(Font) fonts;
+ /** The name of the font, that is what the pattern resolves to */
+ char *name;
+ /** A copy of the pattern to build a cache */
+ char *pattern;
+ /** The height of the font, built from font_ascent + font_descent */
+ int height;
+ /** The xcb-id for the font */
+ xcb_font_t id;
+
+ TAILQ_ENTRY(Font) fonts;
};
-/*
- * A client is X11-speak for a window.
+
+/**
+ * An Output is a physical output on your graphics driver. Outputs which
+ * are currently in use have (output->active == true). Each output has a
+ * position and a mode. An output usually corresponds to one connected
+ * screen (except if you are running multiple screens in clone mode).
*
*/
-struct Client {
- /* TODO: this is NOT final */
- Cell old_position; /* if you set a client to floating and set it back to managed,
- it does remember its old position and *tries* to get back there */
+struct xoutput {
+ /** Output id, so that we can requery the output directly later */
+ xcb_randr_output_t id;
+ /** Name of the output */
+ char *name;
- /* Backpointer. A client is inside a container */
- Container *container;
+ /** Whether the output is currently active (has a CRTC attached with a
+ * valid mode) */
+ bool active;
- /* x, y, width, height */
- Rect rect;
+ /** Internal flags, necessary for querying RandR screens (happens in
+ * two stages) */
+ bool changed;
+ bool to_be_disabled;
- /* Height which was determined by reading the _NET_WM_STRUT_PARTIAL top/bottom of the screen
- reservation */
- int desired_height;
+ /** x, y, width, height */
+ Rect rect;
- /* Name */
- char *name;
- int name_len;
+ /** The bar window */
+ xcb_window_t bar;
+ xcb_gcontext_t bargc;
- /* fullscreen is pretty obvious */
- bool fullscreen;
+ /** Contains all clients with _NET_WM_WINDOW_TYPE ==
+ * _NET_WM_WINDOW_TYPE_DOCK */
+ SLIST_HEAD(dock_clients_head, Client) dock_clients;
- enum { TITLEBAR_TOP = 0, TITLEBAR_LEFT, TITLEBAR_RIGHT, TITLEBAR_BOTTOM, TITLEBAR_OFF } titlebar_position;
+ TAILQ_ENTRY(xoutput) outputs;
+};
- /* If a client is set as a dock, it is placed at the very bottom of the screen and its
- requested size is used */
- bool dock;
+struct Window {
+ xcb_window_t id;
- /* After leaving fullscreen mode, a client needs to be reconfigured (configuration =
- setting X, Y, width and height). By setting the force_reconfigure flag, render_layout()
- will reconfigure the client. */
- bool force_reconfigure;
+ char *class_class;
+ char *class_instance;
- /* When reparenting a window, an unmap-notify is sent. As we delete windows when they’re
- unmapped, we need to ignore that one. Therefore, this flag is set when reparenting. */
- bool awaiting_useless_unmap;
+ /** The name of the window as it will be passed to X11 (in UCS2 if the
+ * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
+ char *name_x;
- /* XCB contexts */
- xcb_window_t frame; /* Our window: The frame around the client */
- xcb_gcontext_t titlegc; /* The titlebar’s graphic context inside the frame */
- xcb_window_t child; /* The client’s window */
+ /** The name of the window as used in JSON (in UTF-8 if the application
+ * supports _NET_WM_NAME, in COMPOUND_TEXT otherwise) */
+ char *name_json;
- /* The following entry provides the necessary list pointers to use Client with LIST_* macros */
- CIRCLEQ_ENTRY(Client) clients;
- SLIST_ENTRY(Client) dock_clients;
-};
+ /** The length of the name in glyphs (not bytes) */
+ int name_len;
-/*
- * A container is either in default or stacking mode. It sits inside the table.
- *
- */
-struct Container {
- /* Those are speaking for themselves: */
- Client *currently_focused;
- int colspan;
- int rowspan;
-
- /* Position of the container inside our table */
- int row;
- int col;
- /* Xinerama: X/Y of the container */
- int x;
- int y;
- /* Width/Height of the container. Changeable by the user */
- int width;
- int height;
- float width_factor;
- float height_factor;
-
- /* Backpointer to the workspace this container is in */
- Workspace *workspace;
-
- /* Ensure MODE_DEFAULT maps to 0 because we use calloc for initialization later */
- enum { MODE_DEFAULT = 0, MODE_STACK = 1 } mode;
- CIRCLEQ_HEAD(client_head, Client) clients;
+ /** Whether the application used _NET_WM_NAME */
+ bool uses_net_wm_name;
+
+ /** Whether the window says it is a dock window */
+ bool dock;
};
-struct Screen {
- /* Virtual screen number */
- int num;
+struct Match {
+ enum { M_WINDOW, M_CON } what;
- /* Current workspace selected on this virtual screen */
- int current_workspace;
+ char *title;
+ int title_len;
+ char *application;
+ char *class;
+ char *instance;
+ char *mark;
+ int dock;
+ xcb_window_t id;
+ Con *con_id;
+ enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
- /* x, y, width, height */
- Rect rect;
+ enum { M_GLOBAL = 0, M_OUTPUT, M_WORKSPACE } levels;
+
+ enum { M_USER = 0, M_RESTART } source;
+
+ /* wo das fenster eingefügt werden soll. bei here wird es direkt
+ * diesem Con zugewiesen, also layout saving. bei active ist es
+ * ein assignment, welches an der momentan fokussierten stelle einfügt */
+ enum { M_HERE = 0, M_ACTIVE } insert_where;
+
+ TAILQ_ENTRY(Match) matches;
+};
- TAILQ_ENTRY(Screen) screens;
+struct Con {
+ bool mapped;
+ enum { CT_ROOT = 0, CT_OUTPUT = 1, CT_CON = 2, CT_FLOATING_CON = 3, CT_WORKSPACE = 4 } type;
+ orientation_t orientation;
+ struct Con *parent;
+ /* parent before setting it to floating */
+ struct Con *old_parent;
+
+ struct Rect rect;
+ struct Rect window_rect;
+ struct Rect deco_rect;
+
+ char *name;
+
+ /* a sticky-group is an identifier which bundles several containers to a
+ * group. The contents are shared between all of them, that is they are
+ * displayed on whichever of the containers is currently visible */
+ char *sticky_group;
+
+ /* user-definable mark to jump to this container later */
+ char *mark;
+
+ double percent;
+
+ /* proportional width/height, calculated from WM_NORMAL_HINTS, used to
+ * apply an aspect ratio to windows (think of MPlayer) */
+ int proportional_width;
+ int proportional_height;
+ /* the wanted size of the window, used in combination with size
+ * increments (see below). */
+ int base_width;
+ int base_height;
+
+ /* minimum increment size specified for the window (in pixels) */
+ int width_increment;
+ int height_increment;
+
+ struct Window *window;
+
+ /* Should this container be marked urgent? This gets set when the window
+ * inside this container (if any) sets the urgency hint, for example. */
+ bool urgent;
+
+ /* ids/gc for the frame window */
+ xcb_window_t frame;
+ xcb_gcontext_t gc;
+
+ /* Only workspace-containers can have floating clients */
+ TAILQ_HEAD(floating_head, Con) floating_head;
+
+ TAILQ_HEAD(nodes_head, Con) nodes_head;
+ TAILQ_HEAD(focus_head, Con) focus_head;
+
+ TAILQ_HEAD(swallow_head, Match) swallow_head;
+
+ enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
+ enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2 } layout;
+ /** floating? (= not in tiling layout) This cannot be simply a bool
+ * because we want to keep track of whether the status was set by the
+ * application (by setting _NET_WM_WINDOW_TYPE appropriately) or by the
+ * user. The user’s choice overwrites automatic mode, of course. The
+ * order of the values is important because we check with >=
+ * FLOATING_AUTO_ON if a client is floating. */
+ enum {
+ FLOATING_AUTO_OFF = 0,
+ FLOATING_USER_OFF = 1,
+ FLOATING_AUTO_ON = 2,
+ FLOATING_USER_ON = 3
+ } floating;
+
+
+ TAILQ_ENTRY(Con) nodes;
+ TAILQ_ENTRY(Con) focused;
+ TAILQ_ENTRY(Con) all_cons;
+ TAILQ_ENTRY(Con) floating_windows;
};
#endif
projects / i3 / i3 / blobdiff