]> git.sur5r.net Git - i3/i3/blobdiff - include/data.h
Bugfix: Ignore enter_notify when warping pointer (makes "goto" work correctly)
[i3/i3] / include / data.h
index 386e49cced9249ae62dbe9dea37564a8335325b9..3618dfb8560f938f3f234c2174c6e89459ecdc57 100644 (file)
@@ -3,7 +3,7 @@
  *
  * i3 - an improved dynamic tiling window manager
  *
- * © 2009 Michael Stapelberg and contributors
+ * © 2009-2010 Michael Stapelberg and contributors
  *
  * See file LICENSE for license information.
  *
@@ -11,6 +11,7 @@
  *
  */
 #include <xcb/xcb.h>
+#include <xcb/randr.h>
 #include <xcb/xcb_atom.h>
 #include <stdbool.h>
 
  *
  * Let’s start from the biggest to the smallest:
  *
- * - An i3Screen is a virtual screen (Xinerama). This can be a single one,
- *   though two monitors might be connected, if you’re running clone
- *   mode. There can also be multiple of them.
+ * - An Output is a physical output on your graphics driver. Outputs which
+ *   are currently in use have (output->active == true). Each output has a
+ *   position and a mode. An output usually corresponds to one connected
+ *   screen (except if you are running multiple screens in clone mode).
  *
- * - Each i3Screen contains Workspaces. The concept is known from various
+ * - Each Output contains Workspaces. The concept is known from various
  *   other window managers.  Basically, a workspace is a specific set of
  *   windows, usually grouped thematically (irc, www, work, …). You can switch
  *   between these.
@@ -54,7 +56,7 @@ typedef struct Client Client;
 typedef struct Binding Binding;
 typedef struct Workspace Workspace;
 typedef struct Rect Rect;
-typedef struct Screen i3Screen;
+typedef struct xoutput Output;
 
 /******************************************************************************
  * Helper types
@@ -74,13 +76,23 @@ enum {
 };
 
 /**
- * FIXME: needs to be documented
+ * 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.
+ * (it is used in src/ewmh.c for example)
+ *
+ * Note that x and y can contain signed values in some cases (for example when
+ * used for the coordinates of a window, which can be set outside of the
+ * visible area, but not when specifying the position of a workspace for the
+ * _NET_WM_WORKAREA hint). Not declaring x/y as int32_t saves us a lot of
+ * typecasts.
  *
  */
 struct Rect {
-        uint32_t x, y;
-        uint32_t width, height;
-};
+        uint32_t x;
+        uint32_t y;
+        uint32_t width;
+        uint32_t height;
+} __attribute__((packed));
 
 /**
  * Defines a position in the table
@@ -101,6 +113,22 @@ struct Colorpixel {
         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;
+};
+
 /**
  * Contains data for the windows needed to draw the titlebars on in stacking
  * mode
@@ -108,7 +136,7 @@ struct Colorpixel {
  */
 struct Stack_Window {
         xcb_window_t window;
-        xcb_gcontext_t gc;
+        struct Cached_Pixmap pixmap;
         Rect rect;
 
         /** Backpointer to the container this stack window is in */
@@ -135,18 +163,6 @@ struct keyvalue_element {
         TAILQ_ENTRY(keyvalue_element) elements;
 };
 
-/**
- * FIXME: needs documentation.
- *
- */
-typedef struct {
-        enum xcb_atom_fast_tag_t tag;
-        union {
-                xcb_get_window_attributes_cookie_t cookie;
-                uint8_t override_redirect;
-        } u;
-} window_attributes_t;
-
 /******************************************************************************
  * Major types
  *****************************************************************************/
@@ -161,6 +177,18 @@ struct Workspace {
         /** Number of this workspace, starting from 0 */
         int num;
 
+        /** Name of the workspace (in UTF-8) */
+        char *utf8_name;
+
+        /** Name of the workspace (in UCS-2) */
+        char *name;
+
+        /** Length of the workspace’s name (in glyphs) */
+        int name_len;
+
+        /** Width of the workspace’s name (in pixels) rendered in config.font */
+        int text_width;
+
         /** x, y, width, height */
         Rect rect;
 
@@ -181,6 +209,12 @@ struct Workspace {
         /** Are the floating clients on this workspace currently hidden? */
         bool floating_hidden;
 
+        /** The name of the RandR output this screen should be on */
+        char *preferred_output;
+
+        /** True if any client on this workspace has its urgent flag set */
+        bool urgent;
+
         /** the client who is started in fullscreen mode on this workspace,
          * NULL if there is none */
         Client *fullscreen_client;
@@ -195,8 +229,8 @@ struct Workspace {
          * appended) */
         TAILQ_HEAD(floating_clients_head, Client) floating_clients;
 
-        /** Backpointer to the screen this workspace is on */
-        i3Screen *screen;
+        /** Backpointer to the output this workspace is on */
+        Output *output;
 
         /** This is a two-dimensional dynamic array of
          * Container-pointers. I’ve always wanted to be a three-star
@@ -209,6 +243,8 @@ struct Workspace {
          * opened, for example) have the same size as always */
         float *width_factor;
         float *height_factor;
+
+        TAILQ_ENTRY(Workspace) workspaces;
 };
 
 /**
@@ -217,12 +253,29 @@ struct Workspace {
  *
  */
 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;
+
+        /** 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;
+
         /** 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;
+
         TAILQ_ENTRY(Binding) bindings;
 };
 
@@ -246,8 +299,13 @@ struct Assignment {
         /** floating is true if this was an assignment to the special
          * workspace "~".  Matching clients will be put into floating mode
          * automatically. */
-        bool floating;
-        /** FIXME: needs documentation */
+        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;
 };
@@ -304,6 +362,17 @@ struct Client {
         int proportional_height;
         int proportional_width;
 
+        int base_height;
+        int base_width;
+
+        /** The amount of pixels which X will draw around the client. */
+        int border_width;
+
+        /** contains the minimum increment size as specified for the window
+         * (in pixels). */
+        int width_increment;
+        int height_increment;
+
         /** Height which was determined by reading the _NET_WM_STRUT_PARTIAL
          * top/bottom of the screen reservation */
         int desired_height;
@@ -320,8 +389,17 @@ struct Client {
          * in. If set to true, legacy window names are ignored. */
         bool uses_net_wm_name;
 
-        /** Holds the WM_CLASS, useful for matching the client in commands */
-        char *window_class;
+        /** Holds the WM_CLASS (which consists of two strings, the instance
+         * and the class), useful for matching the client in commands */
+        char *window_class_instance;
+        char *window_class_class;
+
+        /** Holds the client’s mark, for vim-like jumping */
+        char *mark;
+
+        /** Holds the xcb_window_t (just an ID) for the leader window (logical
+         * parent for toolwindows and similar floating windows) */
+        xcb_window_t leader;
 
         /** fullscreen is pretty obvious */
         bool fullscreen;
@@ -338,10 +416,17 @@ struct Client {
          * initialization later */
         enum { TITLEBAR_TOP = 0, TITLEBAR_LEFT, TITLEBAR_RIGHT, TITLEBAR_BOTTOM, TITLEBAR_OFF } titlebar_position;
 
+        /** Contains a bool specifying whether this window should not be drawn
+         * with the usual decorations */
+        bool borderless;
+
         /** If a client is set as a dock, it is placed at the very bottom of
          * the screen and its requested size is used */
         bool dock;
 
+        /** True if the client set the urgency flag in its WM_HINTS property */
+        bool urgent;
+
         /* After leaving fullscreen mode, a client needs to be reconfigured
          * (configuration = setting X, Y, width and height). By setting the
          * force_reconfigure flag, render_layout() will reconfigure the
@@ -369,8 +454,8 @@ struct Client {
 };
 
 /**
- * A container is either in default or stacking mode. It sits inside each cell
- * of the table.
+ * A container is either in default, stacking or tabbed mode. There is one for
+ * each cell of the table.
  *
  */
 struct Container {
@@ -398,22 +483,43 @@ struct Container {
 
         /* Ensure MODE_DEFAULT maps to 0 because we use calloc for
          * initialization later */
-        enum { MODE_DEFAULT = 0, MODE_STACK } mode;
+        enum { MODE_DEFAULT = 0, MODE_STACK, MODE_TABBED } mode;
+
+        /* When in stacking, one can either have unlimited windows inside the
+         * container or set a limit for the rows or columns the stack window
+         * should display to use the screen more efficiently. */
+        enum { STACK_LIMIT_NONE = 0, STACK_LIMIT_COLS, STACK_LIMIT_ROWS } stack_limit;
+
+        /* The number of columns or rows to limit to, see stack_limit */
+        int stack_limit_value;
+
         CIRCLEQ_HEAD(client_head, Client) clients;
 };
 
 /**
- * This is a virtual screen (Xinerama). This can be a single one, though two
- * monitors might be connected, if you’re running clone mode. There can also
- * be multiple of them.
+ * An Output is a physical output on your graphics driver. Outputs which
+ * are currently in use have (output->active == true). Each output has a
+ * position and a mode. An output usually corresponds to one connected
+ * screen (except if you are running multiple screens in clone mode).
  *
  */
-struct Screen {
-        /** Virtual screen number */
-        int num;
+struct xoutput {
+        /** 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;
+
+        /** Internal flags, necessary for querying RandR screens (happens in
+         * two stages) */
+        bool changed;
+        bool to_be_disabled;
 
         /** Current workspace selected on this virtual screen */
-        int current_workspace;
+        Workspace *current_workspace;
 
         /** x, y, width, height */
         Rect rect;
@@ -426,7 +532,7 @@ struct Screen {
          * _NET_WM_WINDOW_TYPE_DOCK */
         SLIST_HEAD(dock_clients_head, Client) dock_clients;
 
-        TAILQ_ENTRY(Screen) screens;
+        TAILQ_ENTRY(xoutput) outputs;
 };
 
 #endif