/*
- * vim:ts=8:expandtab
+ * vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
- *
- * © 2009-2010 Michael Stapelberg and contributors
- *
- * See file LICENSE for license information.
+ * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
*
* include/data.h: This file defines all data structures used by i3
*
*/
-#include <xcb/xcb.h>
+#ifndef _DATA_H
+#define _DATA_H
+
+#define SN_API_NOT_YET_FROZEN 1
+#include <libsn/sn-launcher.h>
+
#include <xcb/randr.h>
#include <xcb/xcb_atom.h>
#include <stdbool.h>
+#include <pcre.h>
-#ifndef _DATA_H
-#define _DATA_H
#include "queue.h"
/*
*/
/* Forward definitions */
-typedef struct Font i3Font;
typedef struct Binding Binding;
typedef struct Rect Rect;
typedef struct xoutput Output;
typedef struct Con Con;
typedef struct Match Match;
+typedef struct Assignment Assignment;
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;
+typedef enum { NO_ORIENTATION = 0, HORIZ, VERT } orientation_t;
+typedef enum { BS_NORMAL = 0, BS_NONE = 1, BS_1PIXEL = 2 } border_style_t;
+
+/** parameter to specify whether tree_close() and x_window_kill() should kill
+ * only this specific window or the whole X11 client */
+typedef enum { DONT_KILL_WINDOW = 0, KILL_WINDOW = 1, KILL_CLIENT = 2 } kill_window_t;
enum {
- 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)
+ 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)
};
/**
*
*/
struct Rect {
- uint32_t x;
- uint32_t y;
- uint32_t width;
- uint32_t height;
+ uint32_t x;
+ uint32_t y;
+ uint32_t width;
+ uint32_t height;
} __attribute__((packed));
/**
- * Used for the cache of colorpixels.
+ * Stores the reserved pixels on each screen edge read from a
+ * _NET_WM_STRUT_PARTIAL.
*
*/
-struct Colorpixel {
- uint32_t pixel;
- char *hex;
- SLIST_ENTRY(Colorpixel) colorpixels;
+struct reservedpx {
+ uint32_t left;
+ uint32_t right;
+ uint32_t top;
+ uint32_t bottom;
};
-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;
+/**
+ * Stores a width/height pair, used as part of deco_render_params to check
+ * whether the rects width/height have changed.
+ *
+ */
+struct width_height {
+ uint32_t w;
+ uint32_t h;
+};
- /* The rect with which the pixmap was created */
- Rect rect;
+/**
+ * Stores the parameters for rendering a window decoration. This structure is
+ * cached in every Con and no re-rendering will be done if the parameters have
+ * not changed (only the pixmaps will be copied).
+ *
+ */
+struct deco_render_params {
+ struct Colortriple *color;
+ int border_style;
+ struct width_height con_rect;
+ struct width_height con_window_rect;
+ Rect con_deco_rect;
+ uint32_t background;
+ bool con_is_leaf;
+ xcb_font_t font;
+};
- /* 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;
+/**
+ * Stores which workspace (by name) goes to which output.
+ *
+ */
+struct Workspace_Assignment {
+ char *name;
+ char *output;
- xcb_drawable_t referred_drawable;
+ TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
};
struct Ignore_Event {
- int sequence;
- time_t added;
+ int sequence;
+ int response_type;
+ time_t added;
- SLIST_ENTRY(Ignore_Event) ignore_events;
+ SLIST_ENTRY(Ignore_Event) ignore_events;
};
/**
- * Emulates the behaviour of tables of libxcb-wm, which in libxcb 0.3.4
- * suddenly vanished.
+ * Stores internal information about a startup sequence, like the workspace it
+ * was initiated on.
+ *
+ */
+struct Startup_Sequence {
+ /** startup ID for this sequence, generated by libstartup-notification */
+ char *id;
+ /** workspace on which this startup was initiated */
+ char *workspace;
+ /** libstartup-notification context for this launch */
+ SnLauncherContext *context;
+
+ TAILQ_ENTRY(Startup_Sequence) sequences;
+};
+
+/**
+ * Regular expression wrapper. It contains the pattern itself as a string (like
+ * ^foo[0-9]$) as well as a pointer to the compiled PCRE expression and the
+ * pcre_extra data returned by pcre_study().
+ *
+ * This makes it easier to have a useful logfile, including the matching or
+ * non-matching pattern.
*
*/
-struct keyvalue_element {
- uint32_t key;
- void *value;
- TAILQ_ENTRY(keyvalue_element) elements;
+struct regex {
+ char *pattern;
+ pcre *regex;
+ pcre_extra *extra;
};
/******************************************************************************
*
*/
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;
+ /** 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;
+ /** 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;
+ uint32_t number_keycodes;
- /** Keycode to bind */
- uint32_t keycode;
+ /** Keycode to bind */
+ uint32_t keycode;
- /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
- uint32_t mods;
+ /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
+ uint32_t mods;
- /** Command, like in command mode */
- char *command;
+ /** Command, like in command mode */
+ char *command;
- TAILQ_ENTRY(Binding) bindings;
+ TAILQ_ENTRY(Binding) bindings;
};
/**
- * Holds a command specified by an exec-line in the config (see src/config.c)
+ * Holds a command specified by either an:
+ * - exec-line
+ * - exec_always-line
+ * in the config (see src/config.c)
*
*/
struct Autostart {
- /** 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. */
- 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 */
- 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;
+ /** Command, like in command mode */
+ char *command;
+ /** no_startup_id flag for start_application(). Determines whether a
+ * startup notification context/ID should be created. */
+ bool no_startup_id;
+ TAILQ_ENTRY(Autostart) autostarts;
+ TAILQ_ENTRY(Autostart) autostarts_always;
};
-
/**
* An Output is a physical output on your graphics driver. Outputs which
* are currently in use have (output->active == true). Each output has a
*
*/
struct xoutput {
- /** Output id, so that we can requery the output directly later */
- xcb_randr_output_t id;
- /** Name of the output */
- char *name;
-
- /** Whether the output is currently active (has a CRTC attached with a
- * valid mode) */
- bool active;
+ /** Output id, so that we can requery the output directly later */
+ xcb_randr_output_t id;
+ /** Name of the output */
+ char *name;
- /** Internal flags, necessary for querying RandR screens (happens in
- * two stages) */
- bool changed;
- bool to_be_disabled;
+ /** Pointer to the Con which represents this output */
+ Con *con;
- /** x, y, width, height */
- Rect rect;
+ /** Whether the output is currently active (has a CRTC attached with a
+ * valid mode) */
+ bool active;
- /** The bar window */
- xcb_window_t bar;
- xcb_gcontext_t bargc;
+ /** Internal flags, necessary for querying RandR screens (happens in
+ * two stages) */
+ bool changed;
+ bool to_be_disabled;
+ bool primary;
- /** Contains all clients with _NET_WM_WINDOW_TYPE ==
- * _NET_WM_WINDOW_TYPE_DOCK */
- SLIST_HEAD(dock_clients_head, Client) dock_clients;
+ /** x, y, width, height */
+ Rect rect;
- TAILQ_ENTRY(xoutput) outputs;
+ TAILQ_ENTRY(xoutput) outputs;
};
struct Window {
xcb_window_t id;
+ /** Holds the xcb_window_t (just an ID) for the leader window (logical
+ * parent for toolwindows and similar floating windows) */
+ xcb_window_t leader;
+ xcb_window_t transient_for;
+
char *class_class;
char *class_instance;
- /** The name of the window as it will be passod to X11 (in UCS2 if the
+ /** 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;
+ /** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
+ * sets "buddy list"). Useful to match specific windows in assignments or
+ * for_window. */
+ char *role;
+
+ /** Flag to force re-rendering the decoration upon changes */
+ bool name_x_changed;
+
/** 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;
/** Whether the application used _NET_WM_NAME */
bool uses_net_wm_name;
+
+ /** Whether the application needs to receive WM_TAKE_FOCUS */
+ bool needs_take_focus;
+
+ /** Whether this window accepts focus. We store this inverted so that the
+ * default will be 'accepts focus'. */
+ bool doesnt_accept_focus;
+
+ /** Whether the window says it is a dock window */
+ enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
+
+ /** Pixels the window reserves. left/right/top/bottom */
+ struct reservedpx reserved;
+
+ /** Pointers to the Assignments which were already ran for this Window
+ * (assignments run only once) */
+ uint32_t nr_assignments;
+ Assignment **ran_assignments;
};
struct Match {
- enum { M_WINDOW, M_CON } what;
-
- char *title;
- int title_len;
- char *application;
- char *class;
- char *instance;
+ struct regex *title;
+ struct regex *application;
+ struct regex *class;
+ struct regex *instance;
+ struct regex *mark;
+ struct regex *role;
+ enum {
+ M_DONTCHECK = -1,
+ M_NODOCK = 0,
+ M_DOCK_ANY = 1,
+ M_DOCK_TOP = 2,
+ M_DOCK_BOTTOM = 3
+ } dock;
xcb_window_t id;
- bool floating;
+ Con *con_id;
+ enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
+
+ /* Where the window looking for a match should be inserted:
+ *
+ * M_HERE = the matched container will be replaced by the window
+ * (layout saving)
+ * M_ASSIGN_WS = the matched container will be inserted in the target_ws.
+ * M_BELOW = the window will be inserted as a child of the matched container
+ * (dockareas)
+ *
+ */
+ enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
- enum { M_GLOBAL, M_OUTPUT, M_WORKSPACE } levels;
+ TAILQ_ENTRY(Match) matches;
+};
- enum { M_USER, M_RESTART } source;
+/**
+ * An Assignment makes specific windows go to a specific workspace/output or
+ * run a command for that window. With this mechanism, the user can -- for
+ * example -- make specific windows floating or assign his browser to workspace
+ * "www". Checking if a window is assigned works by comparing the Match data
+ * structure with the window (see match_matches_window()).
+ *
+ */
+struct Assignment {
+ /** type of this assignment:
+ *
+ * A_COMMAND = run the specified command for the matching window
+ * A_TO_WORKSPACE = assign the matching window to the specified workspace
+ * A_TO_OUTPUT = assign the matching window to the specified output
+ *
+ * While the type is a bitmask, only one value can be set at a time. It is
+ * a bitmask to allow filtering for multiple types, for example in the
+ * assignment_for() function.
+ *
+ */
+ enum {
+ A_ANY = 0,
+ A_COMMAND = (1 << 0),
+ A_TO_WORKSPACE = (1 << 1),
+ A_TO_OUTPUT = (1 << 2)
+ } type;
- /* 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;
+ /** the criteria to check if a window matches */
+ Match match;
- TAILQ_ENTRY(Match) matches;
+ /** destination workspace/output/command, depending on the type */
+ union {
+ char *command;
+ char *workspace;
+ char *output;
+ } dest;
+
+ TAILQ_ENTRY(Assignment) assignments;
};
struct Con {
bool mapped;
- enum { CT_ROOT = 0, CT_OUTPUT = 1, CT_CON = 2, CT_FLOATING_CON = 3 } type;
+ enum {
+ CT_ROOT = 0,
+ CT_OUTPUT = 1,
+ CT_CON = 2,
+ CT_FLOATING_CON = 3,
+ CT_WORKSPACE = 4,
+ CT_DOCKAREA = 5
+ } 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;
+ /** the geometry this window requested when getting mapped */
+ struct Rect geometry;
char *name;
+ /** the workspace number, if this Con is of type CT_WORKSPACE and the
+ * workspace is not a named workspace (for named workspaces, num == -1) */
+ int num;
+
+ /* 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;
+
+ /* the x11 border pixel attribute */
+ int border_width;
+
+ /* minimum increment size specified for the window (in pixels) */
+ int width_increment;
+ int height_increment;
+
struct Window *window;
- /* ids/gc for the frame 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/pixmap/graphics context for the frame window */
xcb_window_t frame;
- xcb_gcontext_t gc;
+ xcb_pixmap_t pixmap;
+ xcb_gcontext_t pm_gc;
+ bool pixmap_recreated;
+
+ /** Cache for the decoration rendering */
+ struct deco_render_params *deco_render_params;
/* Only workspace-containers can have floating clients */
TAILQ_HEAD(floating_head, Con) floating_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;
+ enum { L_DEFAULT = 0, L_STACKED = 1, L_TABBED = 2, L_DOCKAREA = 3, L_OUTPUT = 4 } layout;
+ border_style_t border_style;
/** 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
FLOATING_USER_ON = 3
} floating;
+ /** This counter contains the number of UnmapNotify events for this
+ * container (or, more precisely, for its ->frame) which should be ignored.
+ * UnmapNotify events need to be ignored when they are caused by i3 itself,
+ * for example when reparenting or when unmapping the window on a workspace
+ * change. */
+ uint8_t ignore_unmap;
TAILQ_ENTRY(Con) nodes;
TAILQ_ENTRY(Con) focused;
TAILQ_ENTRY(Con) all_cons;
TAILQ_ENTRY(Con) floating_windows;
+
+ /** callbacks */
+ void(*on_remove_child)(Con *);
};
#endif
projects / i3 / i3 / blobdiff