data.h

Go to the documentation of this file.

/*
 * vim:ts=4:sw=4:expandtab
 *
 * i3 - an improved dynamic tiling window manager
 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
 *
 * include/data.h: This file defines all data structures used by i3
 *
 */
#pragma once
 
#define PCRE2_CODE_UNIT_WIDTH 8
 
#define SN_API_NOT_YET_FROZEN 1
#include <libsn/sn-launcher.h>
 
#include <xcb/randr.h>
#include <pcre2.h>
#include <sys/time.h>
#include <cairo/cairo.h>
 
#include "queue.h"
 
/*
 * 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.
 *
 * The following things are all stored in a 'Con', from very high level (the
 * biggest Cons) to very small (a single window):
 *
 * 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
 *
 */
 
/* Forward definitions */
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;
typedef struct gaps_t gaps_t;
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 { BEFORE,
               AFTER } position_t;
typedef enum {
    BS_NONE = 0,
    BS_PIXEL = 1,
    BS_NORMAL = 2,
} border_style_t;

typedef enum { DONT_KILL_WINDOW = 0,
               KILL_WINDOW = 1,
               KILL_CLIENT = 2 } kill_window_t;

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;
 
typedef enum { SMART_BORDERS_OFF,
               SMART_BORDERS_ON,
               SMART_BORDERS_NO_GAPS } smart_borders_t;
 
typedef enum { SMART_GAPS_OFF,
               SMART_GAPS_ON,
               SMART_GAPS_INVERSE_OUTER } smart_gaps_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),
               HEBM_SMART_NO_GAPS = (1 << 6) } hide_edge_borders_mode_t;
 
typedef enum { MM_REPLACE,
               MM_ADD } mark_mode_t;

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;

typedef enum {
    B_KEYBOARD = 0,
    B_MOUSE = 1
} input_type_t;

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;

typedef uint32_t i3_event_state_mask_t;

typedef enum {
    POINTER_WARPING_OUTPUT = 0,
    POINTER_WARPING_NONE = 1
} warping_t;
 
struct gaps_t {
    int inner;
    int top;
    int right;
    int bottom;
    int left;
};
 
typedef enum {
    GAPS_INNER = (1 << 0),
    GAPS_TOP = (1 << 1),
    GAPS_RIGHT = (1 << 2),
    GAPS_BOTTOM = (1 << 3),
    GAPS_LEFT = (1 << 4),
    GAPS_VERTICAL = (GAPS_TOP | GAPS_BOTTOM),
    GAPS_HORIZONTAL = (GAPS_RIGHT | GAPS_LEFT),
    GAPS_OUTER = (GAPS_VERTICAL | GAPS_HORIZONTAL),
} gaps_mask_t;

typedef enum {
    FOCUS_WRAPPING_OFF = 0,
    FOCUS_WRAPPING_ON = 1,
    FOCUS_WRAPPING_FORCE = 2,
    FOCUS_WRAPPING_WORKSPACE = 3
} focus_wrapping_t;

typedef enum {
    QUBE_DOM0 = 0,
    QUBE_RED = 1,
    QUBE_ORANGE = 2,
    QUBE_YELLOW = 3,
    QUBE_GREEN = 4,
    QUBE_GRAY = 5,
    QUBE_BLUE = 6,
    QUBE_PURPLE = 7,
    QUBE_BLACK = 8,
} qube_label_t;
 
#define QUBE_NUM_LABELS 9
 

struct Rect {
    uint32_t x;
    uint32_t y;
    uint32_t width;
    uint32_t height;
};

struct reservedpx {
    uint32_t left;
    uint32_t right;
    uint32_t top;
    uint32_t bottom;
};

struct width_height {
    uint32_t w;
    uint32_t h;
};

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;
    color_t background;
    layout_t parent_layout;
    bool con_is_leaf;
};

struct Workspace_Assignment {
    char *name;
    char *output;
    gaps_t gaps;
    gaps_mask_t gaps_mask;
 
    TAILQ_ENTRY(Workspace_Assignment) ws_assignments;
};
 
struct Ignore_Event {
    int sequence;
    int response_type;
    time_t added;
 
    SLIST_ENTRY(Ignore_Event) ignore_events;
};

struct Startup_Sequence {
    char *id;
    char *workspace;
    SnLauncherContext *context;
    time_t delete_at;
 
    TAILQ_ENTRY(Startup_Sequence) sequences;
};

struct regex {
    char *pattern;
    pcre2_code *regex;
};

struct Binding_Keycode {
    xcb_keycode_t keycode;
    i3_event_state_mask_t modifiers;
    TAILQ_ENTRY(Binding_Keycode) keycodes;
};
 
/******************************************************************************
 * Major types
 *****************************************************************************/

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;

    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;

    bool border;

    bool whole_window;

    bool exclude_titlebar;

    uint32_t keycode;

    i3_event_state_mask_t event_state_mask;

    char *symbol;

    TAILQ_HEAD(keycodes_head, Binding_Keycode) keycodes_head;

    char *command;
 
    TAILQ_ENTRY(Binding) bindings;
};

struct Autostart {
    char *command;
    bool no_startup_id;
    TAILQ_ENTRY(Autostart) autostarts;
    TAILQ_ENTRY(Autostart) autostarts_always;
};
 
struct output_name {
    char *name;
    SLIST_ENTRY(output_name) names;
};

struct xoutput {
    xcb_randr_output_t id;

    bool active;

    bool changed;
    bool to_be_disabled;
    bool primary;

    SLIST_HEAD(names_head, output_name) names_head;

    Con *con;

    Rect rect;
 
    TAILQ_ENTRY(xoutput) outputs;
};

struct Window {
    xcb_window_t id;

    xcb_window_t leader;
    xcb_window_t transient_for;

    uint32_t nr_assignments;
    Assignment **ran_assignments;
 
    char *class_class;
    char *class_instance;

    i3String *name;

    i3String *qubes_vmname;

    int qubes_label;

    char *role;

    char *machine;

    bool name_x_changed;

    bool uses_net_wm_name;

    bool needs_take_focus;

    bool doesnt_accept_focus;

    xcb_atom_t window_type;

    uint32_t wm_desktop;

    enum { W_NODOCK = 0,
           W_DOCK_TOP = 1,
           W_DOCK_BOTTOM = 2 } dock;

    struct timeval urgent;

    struct reservedpx reserved;

    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;
 
    /* Maximum size specified for the window. */
    int max_width;
    int max_height;
 
    /* aspect ratio from WM_NORMAL_HINTS (MPlayer uses this for example) */
    double min_aspect_ratio;
    double max_aspect_ratio;

    cairo_surface_t *icon;

    bool shaped;
    bool input_shaped;
 
    /* Time when the window became managed. Used to determine whether a window
     * should be swallowed after initial management. */
    time_t managed_since;
 
    /* The window has been swallowed. */
    bool swallowed;
};

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 *window_role;
    struct regex *workspace;
    struct regex *machine;
    xcb_atom_t window_type;
    enum {
        U_DONTCHECK = -1,
        U_LATEST = 0,
        U_OLDEST = 1
    } urgent;
    enum {
        M_DONTCHECK = -1,
        M_NODOCK = 0,
        M_DOCK_ANY = 1,
        M_DOCK_TOP = 2,
        M_DOCK_BOTTOM = 3
    } dock;
    xcb_window_t id;
    enum { WM_ANY = 0,
           WM_TILING_AUTO,
           WM_TILING_USER,
           WM_TILING,
           WM_FLOATING_AUTO,
           WM_FLOATING_USER,
           WM_FLOATING } window_mode;
    Con *con_id;
    bool match_all_windows;
 
    /* 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;
 
    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;
};

struct Assignment {
    enum {
        A_ANY = 0,
        A_COMMAND = (1 << 0),
        A_TO_WORKSPACE = (1 << 1),
        A_NO_FOCUS = (1 << 2),
        A_TO_WORKSPACE_NUMBER = (1 << 3),
        A_TO_OUTPUT = (1 << 4)
    } type;

    Match match;

    union {
        char *command;
        char *workspace;
        char *output;
    } dest;
 
    TAILQ_ENTRY(Assignment) assignments;
};

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;
 
    /* 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;

    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_CON = 2,
        CT_FLOATING_CON = 3,
        CT_WORKSPACE = 4,
        CT_DOCKAREA = 5
    } type;

    int num;

    gaps_t gaps;
 
    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;
    struct Rect geometry;
 
    char *name;

    char *title_format;

    int window_icon_padding;
 
    /* 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 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;
 
    /* the x11 border pixel attribute */
    int border_width;
    int current_border_width;
 
    struct Window *window;
 
    /* timer used for disabling urgency */
    struct ev_timer *urgency_timer;

    struct deco_render_params *deco_render_params;
 
    /* 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;
 
    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;
    /* When the border style of a con changes because of motif hints, we don't
     * want to set more decoration that the user wants. The user's preference is determined by these:
     * 1. For new tiling windows, as set by `default_border`
     * 2. For new floating windows, as set by `default_floating_border`
     * 3. For all windows that the user runs the `border` command, whatever is
     * the result of that command for that window. */
    border_style_t max_user_border_style;

    enum {
        FLOATING_AUTO_OFF = 0,
        FLOATING_USER_OFF = 1,
        FLOATING_AUTO_ON = 2,
        FLOATING_USER_ON = 3
    } floating;
 
    TAILQ_ENTRY(Con) nodes;
    TAILQ_ENTRY(Con) focused;
    TAILQ_ENTRY(Con) all_cons;
    TAILQ_ENTRY(Con) floating_windows;

    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;
 
    /* Depth of the container window */
    uint16_t depth;
 
    /* The colormap for this con if a custom one is used. */
    xcb_colormap_t colormap;
};