]> git.sur5r.net Git - i3/i3/blobdiff - include/data.h
Argument for 'kill' for killing a specific window (now default) or the whole client...
[i3/i3] / include / data.h
index c034d1151d607b70672de0f9c64bc95b9eb4c0fb..1165da990388ce4856f4f8e7dcad1addfec2fd9e 100644 (file)
@@ -1,16 +1,12 @@
 /*
- * 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-2010 Michael Stapelberg and contributors (see also: LICENSE)
  *
  * include/data.h: This file defines all data structures used by i3
  *
  */
-#include <xcb/xcb.h>
 #include <xcb/randr.h>
 #include <xcb/xcb_atom.h>
 #include <stdbool.h>
@@ -44,18 +40,23 @@ 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)
 };
 
 /**
@@ -71,54 +72,57 @@ enum {
  *
  */
 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 Cached_Pixmap {
-        xcb_pixmap_t id;
-
-        /* We’re going to paint on it, so a graphics context will be needed */
-        xcb_gcontext_t gc;
-
-        /* The rect with which the pixmap was created */
-        Rect rect;
-
-        /* 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;
-
-        xcb_drawable_t referred_drawable;
+struct reservedpx {
+    uint32_t left;
+    uint32_t right;
+    uint32_t top;
+    uint32_t bottom;
 };
 
-struct Ignore_Event {
-        int sequence;
-        time_t added;
-
-        SLIST_ENTRY(Ignore_Event) ignore_events;
+/**
+ * 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;
 };
 
 /**
- * Emulates the behaviour of tables of libxcb-wm, which in libxcb 0.3.4
- * suddenly vanished.
+ * 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 keyvalue_element {
-        uint32_t key;
-        void *value;
-        TAILQ_ENTRY(keyvalue_element) elements;
+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;
+};
+
+struct Ignore_Event {
+    int sequence;
+    int response_type;
+    time_t added;
+
+    SLIST_ENTRY(Ignore_Event) ignore_events;
 };
 
 /******************************************************************************
@@ -131,30 +135,30 @@ struct keyvalue_element {
  *
  */
 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;
 };
 
 /**
@@ -162,30 +166,9 @@ struct Binding {
  *
  */
 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;
+    /** Command, like in command mode */
+    char *command;
+    TAILQ_ENTRY(Autostart) autostarts;
 };
 
 /**
@@ -195,16 +178,10 @@ struct Assignment {
  *
  */
 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;
+    /** The height of the font, built from font_ascent + font_descent */
+    int height;
+    /** The xcb-id for the font */
+    xcb_font_t id;
 };
 
 
@@ -216,38 +193,76 @@ struct Font {
  *
  */
 struct xoutput {
-        /** Output id, so that we can requery the output directly later */
-        xcb_randr_output_t id;
-        /** Name of the output */
-        char *name;
+    /** 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;
+    /** Pointer to the Con which represents this output */
+    Con *con;
 
-        /** Internal flags, necessary for querying RandR screens (happens in
-         * two stages) */
-        bool changed;
-        bool to_be_disabled;
+    /** Whether the output is currently active (has a CRTC attached with a
+     * valid mode) */
+    bool active;
 
-        /** x, y, width, height */
-        Rect rect;
+    /** Internal flags, necessary for querying RandR screens (happens in
+     * two stages) */
+    bool changed;
+    bool to_be_disabled;
+    bool primary;
 
-        /** The bar window */
-        xcb_window_t bar;
-        xcb_gcontext_t bargc;
+    /** x, y, width, height */
+    Rect rect;
 
-        /** Contains all clients with _NET_WM_WINDOW_TYPE ==
-         * _NET_WM_WINDOW_TYPE_DOCK */
-        SLIST_HEAD(dock_clients_head, Client) dock_clients;
+#if 0
+    /** The bar window */
+    xcb_window_t bar;
+    xcb_gcontext_t bargc;
 
-        TAILQ_ENTRY(xoutput) outputs;
+    /** Contains all clients with _NET_WM_WINDOW_TYPE ==
+     * _NET_WM_WINDOW_TYPE_DOCK */
+    SLIST_HEAD(dock_clients_head, Client) dock_clients;
+#endif
+
+    TAILQ_ENTRY(xoutput) outputs;
 };
 
 struct Window {
     xcb_window_t id;
 
-    const char *class;
+    /** 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 passed to X11 (in UCS2 if the
+     * application supports _NET_WM_NAME, in COMPOUND_TEXT otherwise). */
+    char *name_x;
+
+    /** 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) */
+    int 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;
+
+    /** 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;
 };
 
 struct Match {
@@ -258,42 +273,104 @@ struct Match {
     char *application;
     char *class;
     char *instance;
+    char *mark;
+    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;
 
-    enum { M_GLOBAL, M_OUTPUT, M_WORKSPACE } levels;
+    enum { M_GLOBAL = 0, M_OUTPUT, M_WORKSPACE } levels;
 
-    enum { M_USER, M_RESTART } source;
+    enum { M_USER = 0, M_RESTART } source;
 
-    /* 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;
+    char *target_ws;
+
+    /* 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;
+    TAILQ_ENTRY(Match) 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;
@@ -304,7 +381,8 @@ struct Con {
     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
@@ -318,11 +396,20 @@ 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 *);
 };
 
 #endif