X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=include%2Fdata.h;h=6cb6babc56d5ec0668a55799bde0a3885f2f98ea;hb=67ec2333ee659e4b8ce90e75b94a518a2dee81c0;hp=13acc063284669a54013fc7716d23fc883c0b8d8;hpb=70d28bc7afb013de718969371d3a3671de4a9bfc;p=i3%2Fi3 diff --git a/include/data.h b/include/data.h index 13acc063..6cb6babc 100644 --- a/include/data.h +++ b/include/data.h @@ -2,13 +2,12 @@ * 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 I3_DATA_H -#define I3_DATA_H +#pragma once #define SN_API_NOT_YET_FROZEN 1 #include @@ -48,37 +47,74 @@ 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 { NO_ORIENTATION = 0, HORIZ, VERT } orientation_t; -typedef enum { BS_NORMAL = 0, BS_NONE = 1, BS_PIXEL = 2 } border_style_t; +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() 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; + 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_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) }; +/** + * 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; + +/** + * 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. * It needs to be packed so that the compiler will not add any padding bytes. @@ -133,12 +169,12 @@ struct deco_render_params { struct width_height con_window_rect; Rect con_deco_rect; uint32_t background; + layout_t parent_layout; bool con_is_leaf; - orientation_t parent_orientation; }; /** - * Stores which workspace (by name) goes to which output. + * Stores which workspace (by name or number) goes to which output. * */ struct Workspace_Assignment { @@ -201,6 +237,10 @@ struct regex { * */ struct Binding { + /* 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; + /** If true, the binding should be executed upon a KeyRelease event, not a * KeyPress (the default). */ enum { @@ -215,6 +255,23 @@ struct Binding { 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; + + uint32_t number_keycodes; + + /** Keycode to bind */ + uint32_t keycode; + + /** Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, … */ + uint32_t mods; + /** 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) */ @@ -227,14 +284,6 @@ struct Binding { * 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; @@ -268,11 +317,6 @@ struct Autostart { 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) */ @@ -284,6 +328,12 @@ struct xoutput { 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; @@ -303,6 +353,11 @@ struct Window { 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; @@ -323,24 +378,24 @@ struct Window { /** 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; + /** 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; }; @@ -359,7 +414,8 @@ struct Match { struct regex *class; struct regex *instance; struct regex *mark; - struct regex *role; + struct regex *window_role; + xcb_atom_t window_type; enum { U_DONTCHECK = -1, U_LATEST = 0, @@ -373,8 +429,10 @@ struct Match { M_DOCK_BOTTOM = 3 } dock; xcb_window_t id; + enum { M_ANY = 0, + M_TILING, + M_FLOATING } floating; Con *con_id; - enum { M_ANY = 0, M_TILING, M_FLOATING } floating; /* Where the window looking for a match should be inserted: * @@ -385,20 +443,22 @@ struct Match { * (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()). * @@ -408,7 +468,7 @@ struct 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 + * 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 @@ -416,31 +476,53 @@ struct Assignment { * */ 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) } 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; }; +/** Fullscreen modes. Used by Con.fullscreen_mode. */ +typedef enum { CF_NONE = 0, + CF_OUTPUT = 1, + CF_GLOBAL = 2 } fullscreen_mode_t; + /** * A 'Con' represents everything from the X11 root window down to a single X11 window. * */ struct Con { bool mapped; + + /* 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; + + /* ids/pixmap/graphics context for the frame window */ + bool pixmap_recreated; + xcb_window_t frame; + xcb_pixmap_t pixmap; + xcb_gcontext_t pm_gc; + enum { CT_ROOT = 0, CT_OUTPUT = 1, @@ -449,6 +531,11 @@ struct Con { 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; struct Rect rect; @@ -459,10 +546,6 @@ struct Con { 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 */ @@ -470,13 +553,13 @@ struct Con { /* user-definable mark to jump to this container later */ char *mark; + /* 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; + /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */ + double aspect_ratio; /* the wanted size of the window, used in combination with size * increments (see below). */ int base_width; @@ -492,19 +575,9 @@ struct Con { 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; - /* 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; - xcb_gcontext_t pm_gc; - bool pixmap_recreated; - /** Cache for the decoration rendering */ struct deco_render_params *deco_render_params; @@ -516,7 +589,7 @@ struct Con { TAILQ_HEAD(swallow_head, Match) swallow_head; - enum { CF_NONE = 0, CF_OUTPUT = 1, CF_GLOBAL = 2 } fullscreen_mode; + fullscreen_mode_t fullscreen_mode; /* 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. @@ -531,15 +604,7 @@ struct Con { * 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; + 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 @@ -554,20 +619,13 @@ struct Con { 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 *); + void (*on_remove_child)(Con *); enum { /* Not a scratchpad window. */ @@ -588,5 +646,3 @@ struct Con { /* Depth of the container window */ uint16_t depth; }; - -#endif