* vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
- * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
+ * © 2009-2012 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
+#ifndef I3_DATA_H
+#define I3_DATA_H
#define SN_API_NOT_YET_FROZEN 1
#include <libsn/sn-launcher.h>
#include <xcb/xcb_atom.h>
#include <stdbool.h>
#include <pcre.h>
+#include <sys/time.h>
+#include "libi3.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
+ * To get the big concept: There are helper structures like struct
+ * Workspace_Assignment. Every struct 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:
+ * The following things are all stored in a 'Con', from very high level (the
+ * biggest Cons) to very small (a single window):
*
- * TODO
+ * 1) X11 root window (as big as all your outputs combined)
+ * 2) output (like LVDS1)
+ * 3) content container, dockarea containers
+ * 4) workspaces
+ * 5) split containers
+ * ... (you can arbitrarily nest split containers)
+ * 6) X11 window containers
*
*/
*****************************************************************************/
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;
+typedef enum { BS_NORMAL = 0, BS_NONE = 1, BS_PIXEL = 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;
+/** 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) */
Rect con_deco_rect;
uint32_t background;
bool con_is_leaf;
+ orientation_t parent_orientation;
};
/**
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;
};
/**
* 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)
+ * command which is executed as soon as the key is pressed (see src/cfgparse.y)
*
*/
struct Binding {
+ /** 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;
+
/** 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) */
TAILQ_ENTRY(xoutput) outputs;
};
+/**
+ * A 'Window' is a type which contains an xcb_window_t and all the related
+ * information (hints like _NET_WM_NAME for that window).
+ *
+ */
struct Window {
xcb_window_t id;
char *class_class;
char *class_instance;
- /** 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 name of the window. */
+ i3String *name;
/** The WM_WINDOW_ROLE of this window (for example, the pidgin buddy window
* sets "buddy list"). Useful to match specific windows in assignments or
/** 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;
-
- /** The length of the name in glyphs (not bytes) */
- size_t name_len;
-
/** 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;
+ /** 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;
+
/** Whether the window says it is a dock window */
enum { W_NODOCK = 0, W_DOCK_TOP = 1, W_DOCK_BOTTOM = 2 } dock;
* (assignments run only once) */
uint32_t nr_assignments;
Assignment **ran_assignments;
+
+ /** Depth of the window */
+ uint16_t depth;
};
+/**
+ * A "match" is a data structure which acts like a mask or expression to match
+ * certain windows or not. For example, when using commands, you can specify a
+ * command like this: [title="*Firefox*"] kill. The title member of the match
+ * data structure will then be filled and i3 will check each window using
+ * match_matches_window() to find the windows affected by this command.
+ *
+ */
struct Match {
struct regex *title;
struct regex *application;
struct regex *instance;
struct regex *mark;
struct regex *role;
+ enum {
+ U_DONTCHECK = -1,
+ U_LATEST = 0,
+ U_OLDEST = 1
+ } urgent;
enum {
M_DONTCHECK = -1,
M_NODOCK = 0,
*/
enum { M_HERE = 0, M_ASSIGN_WS, M_BELOW } insert_where;
+ /* 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 -- 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()).
+ * example -- 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 {
TAILQ_ENTRY(Assignment) assignments;
};
+/**
+ * A 'Con' represents everything from the X11 root window down to a single X11 window.
+ *
+ */
struct Con {
bool mapped;
enum {
CT_WORKSPACE = 4,
CT_DOCKAREA = 5
} type;
- orientation_t orientation;
struct Con *parent;
struct Rect rect;
/* the x11 border pixel attribute */
int border_width;
+ int current_border_width;
/* minimum increment size specified for the window (in pixels) */
int width_increment;
* inside this container (if any) sets the urgency hint, for example. */
bool urgent;
+ /* timer used for disabling urgency */
+ struct ev_timer *urgency_timer;
+
/* ids/pixmap/graphics context for the frame window */
xcb_window_t frame;
xcb_pixmap_t pixmap;
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, L_DOCKAREA = 3, L_OUTPUT = 4 } layout;
+ /* 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. */
+ 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, 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
/** callbacks */
void(*on_remove_child)(Con *);
+
+ enum {
+ SCRATCHPAD_NONE = 0,
+ SCRATCHPAD_FRESH = 1,
+ 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
projects / i3 / i3 / blobdiff