*
* i3 - an improved dynamic tiling window manager
*
- * © 2009 Michael Stapelberg and contributors
+ * © 2009-2010 Michael Stapelberg and contributors
*
* See file LICENSE for license information.
*
*
*/
#include <xcb/xcb.h>
+#include <xcb/randr.h>
#include <xcb/xcb_atom.h>
#include <stdbool.h>
#include "queue.h"
/*
- * 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.
+ * 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:
- * - An i3Screen is a virtual screen (Xinerama). This can be a single one, though two monitors
- * might be connected, if you’re running clone mode. There can also be multiple of them.
*
- * - Each i3Screen contains Workspaces. The concept is known from various other window managers.
- * Basically, a workspace is a specific set of windows, usually grouped thematically (irc,
- * www, work, …). You can switch between these.
- *
- * - Each Workspace has a table, which is our layout abstraction. You manage your windows
- * by moving them around in your table. It grows as necessary.
- *
- * - Each cell of the table has a container, which can be in default or stacking mode. In default
- * mode, each client is given equally much space in the container. In stacking mode, only one
- * client is shown at a time, but all the titlebars are rendered at the top.
- *
- * - Inside the container are clients, which is X11-speak for a window.
+ * TODO
*
*/
/* 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
*****************************************************************************/
typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
+typedef enum { HORIZ, VERT, NO_ORIENTATION } orientation_t;
enum {
BIND_NONE = 0,
BIND_MODE_SWITCH = (1 << 8)
};
-struct Rect {
- uint32_t x, y;
- uint32_t width, height;
-};
-
-/*
- * Defines a position in the table
+/**
+ * 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 Cell {
- int row;
- int column;
-};
+struct Rect {
+ 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;
};
-/*
- * Contains data for the windows needed to draw the titlebars on in stacking mode
- *
- */
-struct Stack_Window {
- xcb_window_t window;
+struct Cached_Pixmap {
+ xcb_pixmap_t id;
+
+ /* We’re going to paint on it, so a graphics context will be needed */
xcb_gcontext_t gc;
+
+ /* The rect with which the pixmap was created */
Rect rect;
- /* Backpointer to the container this stack window is in */
- Container *container;
+ /* 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;
- SLIST_ENTRY(Stack_Window) stack_windows;
+ xcb_drawable_t referred_drawable;
};
struct Ignore_Event {
SLIST_ENTRY(Ignore_Event) ignore_events;
};
-/*
- * Emulates the behaviour of tables of libxcb-wm, which in libxcb 0.3.4 suddenly vanished.
+/**
+ * Emulates the behaviour of tables of libxcb-wm, which in libxcb 0.3.4
+ * suddenly vanished.
*
*/
struct keyvalue_element {
uint32_t key;
void *value;
-
TAILQ_ENTRY(keyvalue_element) elements;
};
-typedef struct {
- enum xcb_atom_fast_tag_t tag;
- union {
- xcb_get_window_attributes_cookie_t cookie;
- uint8_t override_redirect;
- } u;
-} window_attributes_t;
-
/******************************************************************************
* Major types
*****************************************************************************/
-/*
- * The concept of Workspaces is known from various other window managers. Basically,
- * a workspace is a specific set of windows, usually grouped thematically (irc,
- * www, work, …). You can switch between these.
+/**
+ * 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 Workspace {
- /* Number of this workspace, starting from 0 */
- int num;
-
- /* x, y, width, height */
- Rect rect;
-
- /* table dimensions */
- int cols;
- int rows;
-
- /* These are stored here only while this workspace is _not_ shown (see show_workspace()) */
- int current_row;
- int current_col;
-
- /* Should clients on this workspace be automatically floating? */
- bool auto_float;
- /* Are the floating clients on this workspace currently hidden? */
- bool floating_hidden;
-
- Client *fullscreen_client;
-
- /* The focus stack contains the clients in the correct order of focus so that
- the focus can be reverted correctly when a client is closed */
- SLIST_HEAD(focus_stack_head, Client) focus_stack;
-
- /* This tail queue contains the floating clients in order of when they were first
- * set to floating (new floating clients are just appended) */
- TAILQ_HEAD(floating_clients_head, Client) floating_clients;
-
- /* Backpointer to the screen this workspace is on */
- i3Screen *screen;
+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;
- /* This is a two-dimensional dynamic array of Container-pointers. I’ve always wanted
- * to be a three-star programmer :) */
- Container ***table;
+ /** 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;
- /* width_factor and height_factor contain the amount of space (percentage) a column/row
- has of all the space which is available for resized windows. This ensures that
- non-resized windows (newly opened, for example) have the same size as always */
- float *width_factor;
- float *height_factor;
-};
+ uint32_t number_keycodes;
-/*
- * 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 Binding {
- /* Keycode to bind */
+ /** Keycode to bind */
uint32_t keycode;
- /* Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
+
+ /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
uint32_t mods;
- /* Command, like in command mode */
+
+ /** 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 */
+ /** Command, like in command mode */
char *command;
TAILQ_ENTRY(Autostart) autostarts;
};
-/*
+/**
* Holds an assignment for a given window class/title to a specific workspace
* (see src/config.c)
*
*/
struct Assignment {
char *windowclass_title;
- /* floating is true if this was an assignment to the special workspace "~".
- * Matching clients will be put into floating mode automatically. */
- bool floating;
+ /** floating is true if this was an assignment to the special
+ * workspace "~". Matching clients will be put into floating mode
+ * automatically. */
+ enum {
+ ASSIGN_FLOATING_NO, /* don’t float, but put on a workspace */
+ ASSIGN_FLOATING_ONLY, /* float, but don’t assign on a workspace */
+ ASSIGN_FLOATING /* float and put on a workspace */
+ } floating;
+
+ /** The number of the workspace to assign to. */
int workspace;
TAILQ_ENTRY(Assignment) assignments;
};
-/*
+/**
* 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 */
+ /** The name of the font, that is what the pattern resolves to */
char *name;
- /* A copy of the pattern to build a cache */
+ /** A copy of the pattern to build a cache */
char *pattern;
- /* The height of the font, built from font_ascent + font_descent */
+ /** The height of the font, built from font_ascent + font_descent */
int height;
- /* The xcb-id for the font */
+ /** 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 {
- /* initialized will be set to true if the client was fully initialized by
- * manage_window() and all functions can be used normally */
- bool initialized;
+struct xoutput {
+ /** Output id, so that we can requery the output directly later */
+ xcb_randr_output_t id;
+ /** Name of the output */
+ char *name;
- /* 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 */
- Cell old_position;
+ /** Whether the output is currently active (has a CRTC attached with a
+ * valid mode) */
+ bool active;
- /* Backpointer. A client is inside a container */
- Container *container;
- /* Because dock clients don’t have a container, we have this workspace-backpointer */
- Workspace *workspace;
+ /** Internal flags, necessary for querying RandR screens (happens in
+ * two stages) */
+ bool changed;
+ bool to_be_disabled;
- /* x, y, width, height of the frame */
+ /** x, y, width, height */
Rect rect;
- /* Position in floating mode and in tiling mode are saved separately */
- Rect floating_rect;
- /* x, y, width, height of the child (relative to its frame) */
- Rect child_rect;
- /* contains the size calculated from the hints set by the window or 0 if the client
- did not send any hints */
- int proportional_height;
- int proportional_width;
+ /** The bar window */
+ xcb_window_t bar;
+ xcb_gcontext_t bargc;
- /* Height which was determined by reading the _NET_WM_STRUT_PARTIAL top/bottom of the screen
- reservation */
- int desired_height;
+ /** Contains all clients with _NET_WM_WINDOW_TYPE ==
+ * _NET_WM_WINDOW_TYPE_DOCK */
+ SLIST_HEAD(dock_clients_head, Client) dock_clients;
- /* Name (= window title) */
- char *name;
- /* name_len stores the real string length (glyphs) of the window title if the client uses
- _NET_WM_NAME. Otherwise, it is set to -1 to indicate that name should be just passed
- to X as 8-bit string and therefore will not be rendered correctly. This behaviour is
- to support legacy applications which do not set _NET_WM_NAME */
- int name_len;
- /* This will be set to true as soon as the first _NET_WM_NAME comes in. If set to true,
- legacy window names are ignored. */
- bool uses_net_wm_name;
-
- /* Holds the WM_CLASS, useful for matching the client in commands */
- char *window_class;
-
- /* fullscreen is pretty obvious */
- bool fullscreen;
-
- /* 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 WM_CLASS to tools for example) 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;
-
- /* Ensure TITLEBAR_TOP maps to 0 because we use calloc for initialization later */
- enum { TITLEBAR_TOP = 0, TITLEBAR_LEFT, TITLEBAR_RIGHT, TITLEBAR_BOTTOM, TITLEBAR_OFF } titlebar_position;
-
- /* 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;
-
- /* 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;
-
- /* 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;
-
- /* 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 following entry provides the necessary list pointers to use Client with LIST_* macros */
- CIRCLEQ_ENTRY(Client) clients;
- SLIST_ENTRY(Client) dock_clients;
- SLIST_ENTRY(Client) focus_clients;
- TAILQ_ENTRY(Client) floating_clients;
+ TAILQ_ENTRY(xoutput) outputs;
};
-/*
- * A container is either in default or stacking mode. It sits inside each cell of 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;
+struct Window {
+ xcb_window_t id;
+
+ char *class_class;
+ char *class_instance;
- /* When in stacking mode, we draw the titlebars of each client onto a separate window */
- struct Stack_Window stack_win;
+ /** The name of the window as it will be passod to X11 (in UCS2 if the
+ * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
+ char *name_x;
- /* Backpointer to the workspace this container is in */
- Workspace *workspace;
+ /** 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;
- /* Ensure MODE_DEFAULT maps to 0 because we use calloc for initialization later */
- enum { MODE_DEFAULT = 0, MODE_STACK } mode;
- CIRCLEQ_HEAD(client_head, Client) clients;
+ /** The length of the name in glyphs (not bytes) */
+ int name_len;
+
+ /** Whether the application used _NET_WM_NAME */
+ bool uses_net_wm_name;
};
-/*
- * This is a virtual screen (Xinerama). This can be a single one, though two monitors
- * might be connected, if you’re running clone mode. There can also be multiple of them.
- *
- */
-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;
+ xcb_window_t id;
+ bool floating;
- /* x, y, width, height */
- Rect rect;
+ enum { M_GLOBAL, M_OUTPUT, M_WORKSPACE } levels;
- /* The bar window */
- xcb_window_t bar;
- xcb_gcontext_t bargc;
+ enum { M_USER, 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, M_ACTIVE } insert_where;
+
+ TAILQ_ENTRY(Match) matches;
+};
+
+struct Con {
+ bool mapped;
+ enum { CT_ROOT = 0, CT_OUTPUT = 1, CT_CON = 2, CT_FLOATING_CON = 3 } 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;
+
+ double percent;
+
+ struct Window *window;
+
+ /* 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;
- /* Contains all clients with _NET_WM_WINDOW_TYPE == _NET_WM_WINDOW_TYPE_DOCK */
- SLIST_HEAD(dock_clients_head, Client) dock_clients;
- TAILQ_ENTRY(Screen) screens;
+ TAILQ_ENTRY(Con) nodes;
+ TAILQ_ENTRY(Con) focused;
+ TAILQ_ENTRY(Con) all_cons;
+ TAILQ_ENTRY(Con) floating_windows;
};
#endif
projects / i3 / i3 / blobdiff