2009-02-13 20:33:31 -05:00
|
|
|
|
/*
|
|
|
|
|
* vim:ts=8:expandtab
|
|
|
|
|
*
|
|
|
|
|
* i3 - an improved dynamic tiling window manager
|
|
|
|
|
*
|
|
|
|
|
* (c) 2009 Michael Stapelberg and contributors
|
|
|
|
|
*
|
|
|
|
|
* See file LICENSE for license information.
|
|
|
|
|
*
|
2009-02-24 08:18:08 -05:00
|
|
|
|
* include/data.h: This file defines all data structures used by i3
|
|
|
|
|
*
|
2009-02-13 20:33:31 -05:00
|
|
|
|
*/
|
2009-02-07 22:04:35 -05:00
|
|
|
|
#include <xcb/xcb.h>
|
2009-02-14 02:38:07 -05:00
|
|
|
|
#include <stdbool.h>
|
2009-02-07 22:04:35 -05:00
|
|
|
|
|
|
|
|
|
#ifndef _DATA_H
|
|
|
|
|
#define _DATA_H
|
2009-02-24 08:18:08 -05:00
|
|
|
|
#include "queue.h"
|
|
|
|
|
|
2009-02-06 11:49:45 -05:00
|
|
|
|
/*
|
2009-02-24 08:18:08 -05:00
|
|
|
|
* To get the big concept: There are helper structures like struct Colorpixel or
|
|
|
|
|
* struct Stack_Window. Everything 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:
|
|
|
|
|
* - 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.
|
|
|
|
|
*
|
|
|
|
|
* - Each i3Screen 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.
|
|
|
|
|
*
|
|
|
|
|
* - Each Workspace has a table, which is our layout abstraction. You manage your windows
|
|
|
|
|
* by moving them around in your table. It grows as necessary.
|
|
|
|
|
*
|
|
|
|
|
* - Each cell of the table has a container, which can be in default or stacking mode. In default
|
|
|
|
|
* mode, each client is given equally much space in the container. In stacking mode, only one
|
|
|
|
|
* client is shown at a time, but all the titlebars are rendered at the top.
|
|
|
|
|
*
|
|
|
|
|
* - Inside the container are clients, which is X11-speak for a window.
|
2009-02-06 11:49:45 -05:00
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
|
2009-02-07 20:39:56 -05:00
|
|
|
|
/* Forward definitions */
|
|
|
|
|
typedef struct Cell Cell;
|
2009-02-09 23:50:35 -05:00
|
|
|
|
typedef struct Font i3Font;
|
2009-02-07 20:39:56 -05:00
|
|
|
|
typedef struct Container Container;
|
|
|
|
|
typedef struct Client Client;
|
2009-02-10 14:49:47 -05:00
|
|
|
|
typedef struct Binding Binding;
|
2009-02-12 23:16:47 -05:00
|
|
|
|
typedef struct Workspace Workspace;
|
2009-02-14 19:58:09 -05:00
|
|
|
|
typedef struct Rect Rect;
|
|
|
|
|
typedef struct Screen i3Screen;
|
2009-02-07 20:39:56 -05:00
|
|
|
|
|
2009-02-24 08:18:08 -05:00
|
|
|
|
/******************************************************************************
|
|
|
|
|
* Helper types
|
|
|
|
|
*****************************************************************************/
|
2009-02-07 20:39:56 -05:00
|
|
|
|
typedef enum { D_LEFT, D_RIGHT, D_UP, D_DOWN } direction_t;
|
2009-02-10 14:49:47 -05:00
|
|
|
|
|
|
|
|
|
enum {
|
2009-02-13 20:33:31 -05:00
|
|
|
|
BIND_NONE = 0,
|
2009-02-24 08:18:08 -05:00
|
|
|
|
BIND_SHIFT = XCB_MOD_MASK_SHIFT, /* (1 << 0) */
|
|
|
|
|
BIND_CONTROL = XCB_MOD_MASK_CONTROL, /* (1 << 2) */
|
2009-02-24 18:50:30 -05:00
|
|
|
|
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) */
|
2009-02-13 20:33:31 -05:00
|
|
|
|
BIND_MODE_SWITCH = (1 << 8)
|
2009-02-10 14:49:47 -05:00
|
|
|
|
};
|
|
|
|
|
|
2009-02-14 19:58:09 -05:00
|
|
|
|
struct Rect {
|
|
|
|
|
uint32_t x, y;
|
|
|
|
|
uint32_t width, height;
|
|
|
|
|
};
|
|
|
|
|
|
2009-02-24 08:18:08 -05:00
|
|
|
|
/*
|
|
|
|
|
* Defines a position in the table
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
struct Cell {
|
|
|
|
|
int row;
|
|
|
|
|
int column;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Used for the cache of colorpixels.
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
struct Colorpixel {
|
|
|
|
|
uint32_t pixel;
|
|
|
|
|
|
|
|
|
|
char *hex;
|
|
|
|
|
|
|
|
|
|
SLIST_ENTRY(Colorpixel) colorpixels;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Contains data for the windows needed to draw the titlebars on in stacking mode
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
struct Stack_Window {
|
|
|
|
|
xcb_window_t window;
|
|
|
|
|
xcb_gcontext_t gc;
|
2009-03-04 15:49:29 -05:00
|
|
|
|
Rect rect;
|
2009-02-24 08:18:08 -05:00
|
|
|
|
|
|
|
|
|
/* Backpointer to the container this stack window is in */
|
|
|
|
|
Container *container;
|
|
|
|
|
|
|
|
|
|
SLIST_ENTRY(Stack_Window) stack_windows;
|
|
|
|
|
};
|
|
|
|
|
|
2009-03-09 19:51:15 -04:00
|
|
|
|
struct Ignore_Event {
|
|
|
|
|
int sequence;
|
|
|
|
|
time_t added;
|
|
|
|
|
|
|
|
|
|
SLIST_ENTRY(Ignore_Event) ignore_events;
|
|
|
|
|
};
|
2009-02-24 08:18:08 -05:00
|
|
|
|
|
|
|
|
|
/******************************************************************************
|
|
|
|
|
* Major types
|
|
|
|
|
*****************************************************************************/
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* The concept of Workspaces 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.
|
|
|
|
|
*
|
|
|
|
|
*/
|
2009-02-12 23:16:47 -05:00
|
|
|
|
struct Workspace {
|
2009-03-04 02:59:03 -05:00
|
|
|
|
/* Number of this workspace, starting from 0 */
|
|
|
|
|
int num;
|
|
|
|
|
|
2009-02-14 19:58:09 -05:00
|
|
|
|
/* x, y, width, height */
|
|
|
|
|
Rect rect;
|
2009-02-13 20:33:31 -05:00
|
|
|
|
|
|
|
|
|
/* table dimensions */
|
|
|
|
|
int cols;
|
|
|
|
|
int rows;
|
|
|
|
|
|
2009-03-01 16:00:54 -05:00
|
|
|
|
/* These are stored here only while this workspace is _not_ shown (see show_workspace()) */
|
2009-02-13 20:33:31 -05:00
|
|
|
|
int current_row;
|
|
|
|
|
int current_col;
|
|
|
|
|
|
2009-02-14 02:38:07 -05:00
|
|
|
|
Client *fullscreen_client;
|
|
|
|
|
|
2009-03-04 19:20:13 -05:00
|
|
|
|
/* The focus stack contains the clients in the correct order of focus so that
|
|
|
|
|
the focus can be reverted correctly when a client is closed */
|
|
|
|
|
SLIST_HEAD(focus_stack_head, Client) focus_stack;
|
|
|
|
|
|
2009-02-14 19:58:09 -05:00
|
|
|
|
/* Backpointer to the screen this workspace is on */
|
|
|
|
|
i3Screen *screen;
|
|
|
|
|
|
2009-02-13 20:33:31 -05:00
|
|
|
|
/* This is a two-dimensional dynamic array of Container-pointers. I’ve always wanted
|
|
|
|
|
* to be a three-star programmer :) */
|
|
|
|
|
Container ***table;
|
2009-02-07 22:04:35 -05:00
|
|
|
|
};
|
2009-02-07 20:39:56 -05:00
|
|
|
|
|
2009-02-06 12:23:37 -05:00
|
|
|
|
/*
|
2009-02-24 08:18:08 -05:00
|
|
|
|
* 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)
|
2009-02-06 12:23:37 -05:00
|
|
|
|
*
|
|
|
|
|
*/
|
2009-02-10 14:49:47 -05:00
|
|
|
|
struct Binding {
|
2009-02-13 20:33:31 -05:00
|
|
|
|
/* 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;
|
2009-02-10 14:49:47 -05:00
|
|
|
|
};
|
|
|
|
|
|
2009-02-06 12:23:37 -05:00
|
|
|
|
/*
|
2009-03-01 16:00:54 -05:00
|
|
|
|
* Data structure for cached font information:
|
|
|
|
|
* - font id in X11 (load it once)
|
|
|
|
|
* - font height (multiple calls needed to get it)
|
2009-02-06 12:23:37 -05:00
|
|
|
|
*
|
|
|
|
|
*/
|
2009-02-07 20:39:56 -05:00
|
|
|
|
struct Font {
|
2009-02-13 20:33:31 -05:00
|
|
|
|
/* 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;
|
2009-02-14 20:40:03 -05:00
|
|
|
|
|
|
|
|
|
TAILQ_ENTRY(Font) fonts;
|
2009-02-07 20:39:56 -05:00
|
|
|
|
};
|
2009-02-06 12:23:37 -05:00
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* A client is X11-speak for a window.
|
|
|
|
|
*
|
|
|
|
|
*/
|
2009-02-07 20:39:56 -05:00
|
|
|
|
struct Client {
|
2009-02-24 08:18:08 -05:00
|
|
|
|
/* if you set a client to floating and set it back to managed, it does remember its old
|
|
|
|
|
position and *tries* to get back there */
|
|
|
|
|
Cell old_position;
|
2009-02-06 19:38:51 -05:00
|
|
|
|
|
2009-02-13 20:33:31 -05:00
|
|
|
|
/* Backpointer. A client is inside a container */
|
|
|
|
|
Container *container;
|
2009-03-10 15:56:25 -04:00
|
|
|
|
/* Because dock clients don’t have a container, we have this workspace-backpointer */
|
|
|
|
|
Workspace *workspace;
|
2009-02-07 20:39:56 -05:00
|
|
|
|
|
2009-03-02 19:14:11 -05:00
|
|
|
|
/* x, y, width, height of the frame */
|
2009-02-14 19:58:09 -05:00
|
|
|
|
Rect rect;
|
2009-03-02 19:14:11 -05:00
|
|
|
|
/* x, y, width, height of the child (relative to its frame) */
|
|
|
|
|
Rect child_rect;
|
2009-02-06 19:38:51 -05:00
|
|
|
|
|
2009-03-06 00:06:19 -05:00
|
|
|
|
/* contains the size calculated from the hints set by the window or 0 if the client
|
|
|
|
|
did not send any hints */
|
|
|
|
|
int proportional_height;
|
|
|
|
|
int proportional_width;
|
|
|
|
|
|
2009-02-22 18:18:13 -05:00
|
|
|
|
/* Height which was determined by reading the _NET_WM_STRUT_PARTIAL top/bottom of the screen
|
|
|
|
|
reservation */
|
|
|
|
|
int desired_height;
|
|
|
|
|
|
2009-03-07 18:49:11 -05:00
|
|
|
|
/* Name (= window title) */
|
2009-02-13 20:33:31 -05:00
|
|
|
|
char *name;
|
2009-03-11 16:31:54 -04:00
|
|
|
|
/* name_len stores the real string length (glyphs) of the window title if the client uses
|
|
|
|
|
_NET_WM_NAME. Otherwise, it is set to -1 to indicate that name should be just passed
|
|
|
|
|
to X as 8-bit string and therefore will not be rendered correctly. This behaviour is
|
|
|
|
|
to support legacy applications which do not set _NET_WM_NAME */
|
2009-03-09 01:26:32 -04:00
|
|
|
|
int name_len;
|
2009-03-12 11:44:44 -04:00
|
|
|
|
/* This will be set to true as soon as the first _NET_WM_NAME comes in. If set to true,
|
|
|
|
|
legacy window names are ignored. */
|
|
|
|
|
bool uses_net_wm_name;
|
2009-02-11 12:54:20 -05:00
|
|
|
|
|
2009-02-14 02:38:07 -05:00
|
|
|
|
/* fullscreen is pretty obvious */
|
|
|
|
|
bool fullscreen;
|
|
|
|
|
|
2009-03-01 16:00:54 -05:00
|
|
|
|
/* Ensure TITLEBAR_TOP maps to 0 because we use calloc for initialization later */
|
2009-02-22 18:18:13 -05:00
|
|
|
|
enum { TITLEBAR_TOP = 0, TITLEBAR_LEFT, TITLEBAR_RIGHT, TITLEBAR_BOTTOM, TITLEBAR_OFF } titlebar_position;
|
|
|
|
|
|
|
|
|
|
/* 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;
|
|
|
|
|
|
2009-02-14 02:38:07 -05:00
|
|
|
|
/* 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 client. */
|
|
|
|
|
bool force_reconfigure;
|
|
|
|
|
|
2009-02-14 13:55:18 -05:00
|
|
|
|
/* When reparenting a window, an unmap-notify is sent. As we delete windows when they’re
|
|
|
|
|
unmapped, we need to ignore that one. Therefore, this flag is set when reparenting. */
|
|
|
|
|
bool awaiting_useless_unmap;
|
|
|
|
|
|
2009-02-13 20:33:31 -05:00
|
|
|
|
/* XCB contexts */
|
2009-02-24 08:18:08 -05:00
|
|
|
|
xcb_window_t frame; /* Our window: The frame around the client */
|
|
|
|
|
xcb_gcontext_t titlegc; /* The titlebar’s graphic context inside the frame */
|
|
|
|
|
xcb_window_t child; /* The client’s window */
|
|
|
|
|
|
2009-02-13 20:33:31 -05:00
|
|
|
|
/* The following entry provides the necessary list pointers to use Client with LIST_* macros */
|
|
|
|
|
CIRCLEQ_ENTRY(Client) clients;
|
2009-02-22 18:18:13 -05:00
|
|
|
|
SLIST_ENTRY(Client) dock_clients;
|
2009-03-04 19:20:13 -05:00
|
|
|
|
SLIST_ENTRY(Client) focus_clients;
|
2009-02-07 20:39:56 -05:00
|
|
|
|
};
|
2009-02-06 22:27:22 -05:00
|
|
|
|
|
2009-02-23 18:30:04 -05:00
|
|
|
|
/*
|
2009-02-24 08:18:08 -05:00
|
|
|
|
* A container is either in default or stacking mode. It sits inside each cell of the table.
|
2009-02-06 22:27:22 -05:00
|
|
|
|
*
|
|
|
|
|
*/
|
2009-02-07 20:39:56 -05:00
|
|
|
|
struct Container {
|
2009-02-13 20:33:31 -05:00
|
|
|
|
/* Those are speaking for themselves: */
|
|
|
|
|
Client *currently_focused;
|
|
|
|
|
int colspan;
|
|
|
|
|
int rowspan;
|
|
|
|
|
|
|
|
|
|
/* Position of the container inside our table */
|
|
|
|
|
int row;
|
|
|
|
|
int col;
|
|
|
|
|
/* Xinerama: X/Y of the container */
|
|
|
|
|
int x;
|
|
|
|
|
int y;
|
|
|
|
|
/* Width/Height of the container. Changeable by the user */
|
|
|
|
|
int width;
|
|
|
|
|
int height;
|
2009-03-01 16:00:54 -05:00
|
|
|
|
/* width_factor and height_factor contain the amount of space (percentage) a window
|
|
|
|
|
has of all the space which is available for resized windows. This ensures that
|
|
|
|
|
non-resized windows (newly opened, for example) have the same size as always */
|
2009-02-15 21:28:07 -05:00
|
|
|
|
float width_factor;
|
|
|
|
|
float height_factor;
|
2009-02-13 20:33:31 -05:00
|
|
|
|
|
2009-02-23 18:30:04 -05:00
|
|
|
|
/* When in stacking mode, we draw the titlebars of each client onto a separate window */
|
|
|
|
|
struct Stack_Window stack_win;
|
|
|
|
|
|
2009-02-14 02:38:07 -05:00
|
|
|
|
/* Backpointer to the workspace this container is in */
|
|
|
|
|
Workspace *workspace;
|
|
|
|
|
|
2009-02-13 20:33:31 -05:00
|
|
|
|
/* Ensure MODE_DEFAULT maps to 0 because we use calloc for initialization later */
|
2009-03-01 16:00:54 -05:00
|
|
|
|
enum { MODE_DEFAULT = 0, MODE_STACK } mode;
|
2009-02-13 20:33:31 -05:00
|
|
|
|
CIRCLEQ_HEAD(client_head, Client) clients;
|
2009-02-07 20:39:56 -05:00
|
|
|
|
};
|
2009-02-07 22:04:35 -05:00
|
|
|
|
|
2009-02-24 08:18:08 -05:00
|
|
|
|
/*
|
|
|
|
|
* 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.
|
|
|
|
|
*
|
|
|
|
|
*/
|
2009-02-14 19:58:09 -05:00
|
|
|
|
struct Screen {
|
|
|
|
|
/* Virtual screen number */
|
|
|
|
|
int num;
|
|
|
|
|
|
|
|
|
|
/* Current workspace selected on this virtual screen */
|
|
|
|
|
int current_workspace;
|
|
|
|
|
|
|
|
|
|
/* x, y, width, height */
|
|
|
|
|
Rect rect;
|
|
|
|
|
|
2009-03-04 06:09:43 -05:00
|
|
|
|
/* The bar window */
|
|
|
|
|
xcb_window_t bar;
|
|
|
|
|
xcb_gcontext_t bargc;
|
|
|
|
|
|
2009-04-11 08:29:15 -04:00
|
|
|
|
/* Contains all clients with _NET_WM_WINDOW_TYPE == _NET_WM_WINDOW_TYPE_DOCK */
|
|
|
|
|
SLIST_HEAD(dock_clients_head, Client) dock_clients;
|
|
|
|
|
|
2009-02-14 19:58:09 -05:00
|
|
|
|
TAILQ_ENTRY(Screen) screens;
|
|
|
|
|
};
|
|
|
|
|
|
2009-02-07 22:04:35 -05:00
|
|
|
|
#endif
|