* vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
- * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
*
* include/data.h: This file defines all data structures used by i3
*
*/
-#ifndef _DATA_H
-#define _DATA_H
+#pragma once
+
+#include "libi3.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>
#include <sys/time.h>
-#include "libi3.h"
#include "queue.h"
/*
typedef struct Match Match;
typedef struct Assignment Assignment;
typedef struct Window i3Window;
-
+typedef struct mark_t mark_t;
/******************************************************************************
* Helper types
*****************************************************************************/
-typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_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
+typedef enum { D_LEFT,
+ D_RIGHT,
+ D_UP,
+ D_DOWN } direction_t;
+typedef enum { NO_ORIENTATION = 0,
+ HORIZ,
+ VERT } orientation_t;
+typedef enum { BS_NORMAL = 0,
+ BS_NONE = 1,
+ BS_PIXEL = 2 } border_style_t;
+
+/** parameter to specify whether tree_close_internal() 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;
+typedef enum { DONT_KILL_WINDOW = 0,
+ KILL_WINDOW = 1,
+ KILL_CLIENT = 2 } kill_window_t;
/** describes if the window is adjacent to the output (physical screen) edges. */
typedef enum { ADJ_NONE = 0,
ADJ_LEFT_SCREEN_EDGE = (1 << 0),
ADJ_RIGHT_SCREEN_EDGE = (1 << 1),
ADJ_UPPER_SCREEN_EDGE = (1 << 2),
- ADJ_LOWER_SCREEN_EDGE = (1 << 4)} adjacent_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)
-};
+ ADJ_LOWER_SCREEN_EDGE = (1 << 4) } adjacent_t;
+
+typedef enum { HEBM_NONE = ADJ_NONE,
+ HEBM_VERTICAL = ADJ_LEFT_SCREEN_EDGE | ADJ_RIGHT_SCREEN_EDGE,
+ HEBM_HORIZONTAL = ADJ_UPPER_SCREEN_EDGE | ADJ_LOWER_SCREEN_EDGE,
+ HEBM_BOTH = HEBM_VERTICAL | HEBM_HORIZONTAL,
+ HEBM_SMART = (1 << 5) } hide_edge_borders_mode_t;
+
+typedef enum { MM_REPLACE,
+ MM_ADD } mark_mode_t;
+
+/**
+ * Container layouts. See Con::layout.
+ */
+typedef enum {
+ L_DEFAULT = 0,
+ L_STACKED = 1,
+ L_TABBED = 2,
+ L_DOCKAREA = 3,
+ L_OUTPUT = 4,
+ L_SPLITV = 5,
+ L_SPLITH = 6
+} layout_t;
+
+/**
+ * Binding input types. See Binding::input_type.
+ */
+typedef enum {
+ B_KEYBOARD = 0,
+ B_MOUSE = 1
+} input_type_t;
+
+/**
+ * Bitmask for matching XCB_XKB_GROUP_1 to XCB_XKB_GROUP_4.
+ */
+typedef enum {
+ I3_XKB_GROUP_MASK_ANY = 0,
+ I3_XKB_GROUP_MASK_1 = (1 << 0),
+ I3_XKB_GROUP_MASK_2 = (1 << 1),
+ I3_XKB_GROUP_MASK_3 = (1 << 2),
+ I3_XKB_GROUP_MASK_4 = (1 << 3)
+} i3_xkb_group_mask_t;
+
+/**
+ * The lower 16 bits contain a xcb_key_but_mask_t, the higher 16 bits contain
+ * an i3_xkb_group_mask_t. This type is necessary for the fallback logic to
+ * work when handling XKB groups (see ticket #1775) and makes the code which
+ * locates keybindings upon KeyPress/KeyRelease events simpler.
+ */
+typedef uint32_t i3_event_state_mask_t;
+
+/**
+ * Mouse pointer warping modes.
+ */
+typedef enum {
+ POINTER_WARPING_OUTPUT = 0,
+ POINTER_WARPING_NONE = 1
+} warping_t;
/**
* Stores a rectangle, for example the size of a window, the child window etc.
struct width_height con_rect;
struct width_height con_window_rect;
Rect con_deco_rect;
- uint32_t background;
+ color_t background;
+ layout_t parent_layout;
bool con_is_leaf;
};
/**
- * Stores which workspace (by name) goes to which output.
+ * Stores which workspace (by name or number) goes to which output.
*
*/
struct Workspace_Assignment {
char *name;
char *output;
- TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
+ TAILQ_ENTRY(Workspace_Assignment)
+ ws_assignments;
};
struct Ignore_Event {
int response_type;
time_t added;
- SLIST_ENTRY(Ignore_Event) ignore_events;
+ SLIST_ENTRY(Ignore_Event)
+ ignore_events;
};
/**
char *workspace;
/** libstartup-notification context for this launch */
SnLauncherContext *context;
+ /** time at which this sequence should be deleted (after it was marked as
+ * completed) */
+ time_t delete_at;
- TAILQ_ENTRY(Startup_Sequence) sequences;
+ TAILQ_ENTRY(Startup_Sequence)
+ sequences;
};
/**
pcre_extra *extra;
};
+/**
+ * Stores a resolved keycode (from a keysym), including the modifier mask. Will
+ * be passed to xcb_grab_key().
+ *
+ */
+struct Binding_Keycode {
+ xcb_keycode_t keycode;
+ i3_event_state_mask_t modifiers;
+
+ TAILQ_ENTRY(Binding_Keycode)
+ keycodes;
+};
+
/******************************************************************************
* 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/cfgparse.y)
+ * command which is executed as soon as the key is pressed (see
+ * src/config_parser.c)
*
*/
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;
+ /* The type of input this binding is for. (Mouse bindings are not yet
+ * implemented. All bindings are currently assumed to be keyboard bindings.) */
+ input_type_t input_type;
- /** 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;
+ /** If true, the binding should be executed upon a KeyRelease event, not a
+ * KeyPress (the default). */
+ enum {
+ /* This binding will only be executed upon KeyPress events */
+ B_UPON_KEYPRESS = 0,
+ /* This binding will be executed either upon a KeyRelease event, or… */
+ B_UPON_KEYRELEASE = 1,
+ /* …upon a KeyRelease event, even if the modifiers don’t match. This
+ * state is triggered from get_binding() when the corresponding
+ * KeyPress (!) happens, so that users can release the modifier keys
+ * before releasing the actual key. */
+ B_UPON_KEYRELEASE_IGNORE_MODS = 2,
+ } release;
+
+ /** If this is true for a mouse binding, the binding should be executed
+ * when the button is pressed over the window border. */
+ bool border;
+
+ /** If this is true for a mouse binding, the binding should be executed
+ * when the button is pressed over any part of the window, not just the
+ * title bar (default). */
+ bool whole_window;
+
+ /** If this is true for a mouse binding, the binding should only be
+ * executed if the button press was not on the titlebar. */
+ bool exclude_titlebar;
/** Keycode to bind */
uint32_t keycode;
- /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */
- uint32_t mods;
+ /** Bitmask which is applied against event->state for KeyPress and
+ * KeyRelease events to determine whether this binding applies to the
+ * current state. */
+ i3_event_state_mask_t event_state_mask;
+
+ /** 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. Contains keycodes which generate the
+ * specified symbol. Useful for unbinding and checking which binding was
+ * used when a key press event comes in. */
+ TAILQ_HEAD(keycodes_head, Binding_Keycode)
+ keycodes_head;
/** Command, like in command mode */
char *command;
- TAILQ_ENTRY(Binding) bindings;
+ TAILQ_ENTRY(Binding)
+ bindings;
};
/**
/** 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;
+
+ TAILQ_ENTRY(Autostart)
+ autostarts;
+
+ TAILQ_ENTRY(Autostart)
+ autostarts_always;
};
/**
struct xoutput {
/** Output id, so that we can requery the output directly later */
xcb_randr_output_t id;
- /** Name of the output */
- char *name;
-
- /** Pointer to the Con which represents this output */
- Con *con;
/** Whether the output is currently active (has a CRTC attached with a
* valid mode) */
bool to_be_disabled;
bool primary;
+ /** Name of the output */
+ char *name;
+
+ /** Pointer to the Con which represents this output */
+ Con *con;
+
/** x, y, width, height */
Rect rect;
- TAILQ_ENTRY(xoutput) outputs;
+ TAILQ_ENTRY(xoutput)
+ outputs;
};
/**
xcb_window_t leader;
xcb_window_t transient_for;
+ /** Pointers to the Assignments which were already ran for this Window
+ * (assignments run only once) */
+ uint32_t nr_assignments;
+ Assignment **ran_assignments;
+
char *class_class;
char *class_instance;
/** Whether the application needs to receive WM_TAKE_FOCUS */
bool needs_take_focus;
- /** When this window was marked urgent. 0 means not urgent */
- struct timeval urgent;
-
/** Whether this window accepts focus. We store this inverted so that the
* default will be 'accepts focus'. */
bool doesnt_accept_focus;
+ /** The _NET_WM_WINDOW_TYPE for this window. */
+ xcb_atom_t window_type;
+
+ /** The _NET_WM_DESKTOP for this window. */
+ uint32_t wm_desktop;
+
/** Whether the window says it is a dock window */
- enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
+ enum { W_NODOCK = 0,
+ W_DOCK_TOP = 1,
+ W_DOCK_BOTTOM = 2 } dock;
+
+ /** When this window was marked urgent. 0 means not urgent */
+ struct timeval urgent;
/** 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;
-
/** Depth of the window */
uint16_t depth;
+
+ /* 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;
+
+ /* Minimum size specified for the window. */
+ int min_width;
+ int min_height;
+
+ /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */
+ double aspect_ratio;
};
/**
*
*/
struct Match {
+ /* Set if a criterion was specified incorrectly. */
+ char *error;
+
struct regex *title;
struct regex *application;
struct regex *class;
struct regex *instance;
struct regex *mark;
- struct regex *role;
+ struct regex *window_role;
+ struct regex *workspace;
+ xcb_atom_t window_type;
enum {
U_DONTCHECK = -1,
U_LATEST = 0,
M_DOCK_BOTTOM = 3
} dock;
xcb_window_t id;
+ enum { WM_ANY = 0,
+ WM_TILING,
+ WM_FLOATING } window_mode;
Con *con_id;
- enum { M_ANY = 0, M_TILING, M_FLOATING } floating;
/* Where the window looking for a match should be inserted:
*
* (dockareas)
*
*/
- enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
+ enum { M_HERE = 0,
+ M_ASSIGN_WS,
+ M_BELOW } insert_where;
+
+ TAILQ_ENTRY(Match)
+ matches;
/* Whether this match was generated when restarting i3 inplace.
* Leads to not setting focus when managing a new window, because the old
* focus stack should be restored. */
bool restart_mode;
-
- TAILQ_ENTRY(Match) matches;
};
/**
* 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 -- assign his browser to workspace "www". Checking if a window is
+ * example -- assign their browser to workspace "www". Checking if a window is
* assigned works by comparing the Match data structure with the window (see
* match_matches_window()).
*
*
* 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
+ * A_NO_FOCUS = don't focus matched window when it is managed
*
* 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
*
*/
enum {
- A_ANY = 0,
- A_COMMAND = (1 << 0),
+ A_ANY = 0,
+ A_COMMAND = (1 << 0),
A_TO_WORKSPACE = (1 << 1),
- A_TO_OUTPUT = (1 << 2)
+ A_NO_FOCUS = (1 << 2),
+ A_TO_WORKSPACE_NUMBER = (1 << 3)
} type;
/** the criteria to check if a window matches */
Match match;
- /** destination workspace/output/command, depending on the type */
+ /** destination workspace/command, depending on the type */
union {
char *command;
char *workspace;
- char *output;
} dest;
- TAILQ_ENTRY(Assignment) assignments;
+ TAILQ_ENTRY(Assignment)
+ assignments;
+};
+
+/** Fullscreen modes. Used by Con.fullscreen_mode. */
+typedef enum { CF_NONE = 0,
+ CF_OUTPUT = 1,
+ CF_GLOBAL = 2 } fullscreen_mode_t;
+
+struct mark_t {
+ char *name;
+
+ TAILQ_ENTRY(mark_t)
+ marks;
};
/**
*/
struct Con {
bool mapped;
- /** whether this is a split container or not */
- bool split;
+
+ /* 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;
+
+ /** 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;
+
+ /* The surface used for the frame window. */
+ surface_t frame;
+ surface_t frame_buffer;
+ bool pixmap_recreated;
+
enum {
CT_ROOT = 0,
CT_OUTPUT = 1,
CT_WORKSPACE = 4,
CT_DOCKAREA = 5
} type;
+
+ /** 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;
+
struct Con *parent;
+ /* The position and size for this con. These coordinates are absolute. Note
+ * that the rect of a container does not include the decoration. */
struct Rect rect;
+ /* The position and size of the actual client window. These coordinates are
+ * relative to the container's rect. */
struct Rect window_rect;
+ /* The position and size of the container's decoration. These coordinates
+ * are relative to the container's parent's 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;
+ /** The format with which the window's name should be displayed. */
+ char *title_format;
/* 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;
+ /* user-definable marks to jump to this container later */
+ TAILQ_HEAD(marks_head, mark_t)
+ marks_head;
+ /* cached to decide whether a redraw is needed */
+ bool mark_changed;
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;
+ int current_border_width;
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/pixmap/graphics context for the frame window */
- xcb_window_t frame;
- xcb_pixmap_t pixmap;
- xcb_gcontext_t pm_gc;
- bool pixmap_recreated;
+ /* timer used for disabling urgency */
+ struct ev_timer *urgency_timer;
/** 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(floating_head, Con)
+ floating_head;
- TAILQ_HEAD(nodes_head, Con) nodes_head;
- TAILQ_HEAD(focus_head, Con) focus_head;
+ TAILQ_HEAD(nodes_head, Con)
+ nodes_head;
- TAILQ_HEAD(swallow_head, Match) swallow_head;
+ TAILQ_HEAD(focus_head, Con)
+ focus_head;
- enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode;
- enum {
- L_DEFAULT = 0,
- L_STACKED = 1,
- L_TABBED = 2,
- L_DOCKAREA = 3,
- L_OUTPUT = 4,
- L_SPLITV = 5,
- L_SPLITH = 6
- } layout, last_split_layout;
+ TAILQ_HEAD(swallow_head, Match)
+ swallow_head;
+
+ fullscreen_mode_t fullscreen_mode;
+
+ /* Whether this window should stick to the glass. This corresponds to
+ * the _NET_WM_STATE_STICKY atom and will only be respected if the
+ * window is floating. */
+ bool sticky;
+
+ /* layout is the layout of this container: one of split[v|h], stacked or
+ * tabbed. Special containers in the tree (above workspaces) have special
+ * layouts like dockarea or output.
+ *
+ * last_split_layout is one of splitv or splith to support the old "layout
+ * default" command which by now should be "layout splitv" or "layout
+ * splith" explicitly.
+ *
+ * workspace_layout is only for type == CT_WORKSPACE cons. When you change
+ * the layout of a workspace without any children, i3 cannot just set the
+ * layout (because workspaces need to be splitv/splith to allow focus
+ * parent and opening new containers). Instead, it stores the requested
+ * layout in workspace_layout and creates a new split container with that
+ * layout whenever a new container is attached to the workspace. */
+ layout_t layout, last_split_layout, workspace_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
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) nodes;
- TAILQ_ENTRY(Con) focused;
- TAILQ_ENTRY(Con) all_cons;
- TAILQ_ENTRY(Con) floating_windows;
+ TAILQ_ENTRY(Con)
+ floating_windows;
/** callbacks */
- void(*on_remove_child)(Con *);
+ void (*on_remove_child)(Con *);
enum {
+ /* Not a scratchpad window. */
SCRATCHPAD_NONE = 0,
+
+ /* Just moved to scratchpad, not resized by the user yet.
+ * Window will be auto-centered and sized appropriately. */
SCRATCHPAD_FRESH = 1,
+
+ /* The user changed position/size of the scratchpad window. */
SCRATCHPAD_CHANGED = 2
} scratchpad_state;
/* The ID of this container before restarting. Necessary to correctly
* interpret back-references in the JSON (such as the focus stack). */
int old_id;
-};
-#endif
+ /* Depth of the container window */
+ uint16_t depth;
+
+ /* The colormap for this con if a custom one is used. */
+ xcb_colormap_t colormap;
+};
projects / i3 / i3 / blobdiff