]> git.lizzy.rs Git - bspwm.git/blobdiff - types.h
Mention the default reference
[bspwm.git] / types.h
diff --git a/types.h b/types.h
index 4baa35d11dcc0909376032da5bfec11239662e21..2f8a568802533199648a9aacd0b8fdca55d70a24 100644 (file)
--- a/types.h
+++ b/types.h
-#ifndef _TYPES_H
-#define _TYPES_H
-
+/* Copyright (c) 2012, Bastien Dejean
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef BSPWM_TYPES_H
+#define BSPWM_TYPES_H
 #include <stdbool.h>
 #include <xcb/xcb.h>
+#include <xcb/xcb_icccm.h>
 #include <xcb/randr.h>
 #include <xcb/xcb_event.h>
 #include "helpers.h"
 
-#define DEFAULT_DESK_NAME    "Desktop"
-#define DEFAULT_MON_NAME     "Monitor"
 #define MISSING_VALUE        "N/A"
+#define MAX_WM_STATES        4
 
 typedef enum {
-    TYPE_HORIZONTAL,
-    TYPE_VERTICAL
+       TYPE_HORIZONTAL,
+       TYPE_VERTICAL
 } split_type_t;
 
 typedef enum {
-    MODE_AUTOMATIC,
-    MODE_MANUAL
+       MODE_AUTOMATIC,
+       MODE_MANUAL
 } split_mode_t;
 
 typedef enum {
-    LAYOUT_TILED,
-    LAYOUT_MONOCLE
-} layout_t;
+       STATE_TILED,
+       STATE_PSEUDO_TILED,
+       STATE_FLOATING,
+       STATE_FULLSCREEN
+} client_state_t;
 
 typedef enum {
-    MOVE_PULL,
-    MOVE_PUSH
-} fence_move_t;
+       WM_FLAG_MODAL = 1 << 0,
+       WM_FLAG_STICKY = 1 << 1,
+       WM_FLAG_MAXIMIZED_VERT = 1 << 2,
+       WM_FLAG_MAXIMIZED_HORZ = 1 << 3,
+       WM_FLAG_SHADED = 1 << 4,
+       WM_FLAG_SKIP_TASKBAR = 1 << 5,
+       WM_FLAG_SKIP_PAGER = 1 << 6,
+       WM_FLAG_HIDDEN = 1 << 7,
+       WM_FLAG_FULLSCREEN = 1 << 8,
+       WM_FLAG_ABOVE = 1 << 9,
+       WM_FLAG_BELOW = 1 << 10,
+       WM_FLAG_DEMANDS_ATTENTION = 1 << 11,
+} wm_flags_t;
 
 typedef enum {
-    CHANGE_INCREASE,
-    CHANGE_DECREASE
-} value_change_t;
+       LAYER_BELOW,
+       LAYER_NORMAL,
+       LAYER_ABOVE
+} stack_layer_t;
 
 typedef enum {
-    CLIENT_TYPE_ALL,
-    CLIENT_TYPE_FLOATING,
-    CLIENT_TYPE_TILED
-} client_type_t;
+       OPTION_NONE,
+       OPTION_TRUE,
+       OPTION_FALSE
+} option_bool_t;
 
 typedef enum {
-    CLIENT_CLASS_ALL,
-    CLIENT_CLASS_EQUAL,
-    CLIENT_CLASS_DIFFER
-} client_class_t;
+       ALTER_TOGGLE,
+       ALTER_SET
+} alter_state_t;
 
 typedef enum {
-    CLIENT_MODE_ALL,
-    CLIENT_MODE_AUTOMATIC,
-    CLIENT_MODE_MANUAL
-} client_mode_t;
+       CYCLE_NEXT,
+       CYCLE_PREV
+} cycle_dir_t;
 
 typedef enum {
-    CLIENT_URGENCY_ALL,
-    CLIENT_URGENCY_ON,
-    CLIENT_URGENCY_OFF
-} client_urgency_t;
-
-typedef struct {
-    client_type_t type;
-    client_class_t class;
-    client_mode_t mode;
-    client_urgency_t urgency;
-} client_select_t;
+       CIRCULATE_FORWARD,
+       CIRCULATE_BACKWARD
+} circulate_dir_t;
 
 typedef enum {
-    ALTER_NONE,
-    ALTER_TOGGLE,
-    ALTER_SET
-} state_alter_t;
+       HISTORY_OLDER,
+       HISTORY_NEWER
+} history_dir_t;
 
 typedef enum {
-    DESKTOP_STATUS_ALL,
-    DESKTOP_STATUS_FREE,
-    DESKTOP_STATUS_OCCUPIED
-} desktop_status_t;
+       DIR_NORTH,
+       DIR_WEST,
+       DIR_SOUTH,
+       DIR_EAST
+} direction_t;
 
 typedef enum {
-    DESKTOP_URGENCY_ALL,
-    DESKTOP_URGENCY_ON,
-    DESKTOP_URGENCY_OFF
-} desktop_urgency_t;
-
-typedef struct {
-    desktop_status_t status;
-    desktop_urgency_t urgency;
-} desktop_select_t;
+       HANDLE_LEFT = 1 << 0,
+       HANDLE_TOP = 1 << 1,
+       HANDLE_RIGHT = 1 << 2,
+       HANDLE_BOTTOM = 1 << 3,
+       HANDLE_TOP_LEFT = HANDLE_TOP | HANDLE_LEFT,
+       HANDLE_TOP_RIGHT = HANDLE_TOP | HANDLE_RIGHT,
+       HANDLE_BOTTOM_RIGHT = HANDLE_BOTTOM | HANDLE_RIGHT,
+       HANDLE_BOTTOM_LEFT = HANDLE_BOTTOM | HANDLE_LEFT
+} resize_handle_t;
 
 typedef enum {
-    CYCLE_NEXT,
-    CYCLE_PREV
-} cycle_dir_t;
+       ACTION_FOCUS,
+       ACTION_MOVE,
+       ACTION_RESIZE_SIDE,
+       ACTION_RESIZE_CORNER
+} pointer_action_t;
 
 typedef enum {
-    CIRCULATE_FORWARD,
-    CIRCULATE_BACKWARD
-} circulate_dir_t;
+       LAYOUT_TILED,
+       LAYOUT_MONOCLE
+} layout_t;
 
 typedef enum {
-    FLIP_HORIZONTAL,
-    FLIP_VERTICAL
+       FLIP_HORIZONTAL,
+       FLIP_VERTICAL
 } flip_t;
 
 typedef enum {
-    DIR_RIGHT,
-    DIR_DOWN,
-    DIR_LEFT,
-    DIR_UP
-} direction_t;
+       FIRST_CHILD,
+       SECOND_CHILD
+} child_polarity_t;
 
-typedef enum {
-    CORNER_TOP_LEFT,
-    CORNER_TOP_RIGHT,
-    CORNER_BOTTOM_RIGHT,
-    CORNER_BOTTOM_LEFT
-} corner_t;
+typedef struct {
+       option_bool_t automatic;
+       option_bool_t focused;
+       option_bool_t local;
+       option_bool_t leaf;
+       option_bool_t window;
+       option_bool_t tiled;
+       option_bool_t pseudo_tiled;
+       option_bool_t floating;
+       option_bool_t fullscreen;
+       option_bool_t hidden;
+       option_bool_t sticky;
+       option_bool_t private;
+       option_bool_t locked;
+       option_bool_t urgent;
+       option_bool_t same_class;
+       option_bool_t below;
+       option_bool_t normal;
+       option_bool_t above;
+} node_select_t;
 
-typedef enum {
-    SIDE_LEFT,
-    SIDE_TOP,
-    SIDE_RIGHT,
-    SIDE_BOTTOM
-} side_t;
+typedef struct {
+       option_bool_t occupied;
+       option_bool_t focused;
+       option_bool_t urgent;
+       option_bool_t local;
+} desktop_select_t;
 
-typedef enum {
-    ACTION_NONE,
-    ACTION_FOCUS,
-    ACTION_MOVE,
-    ACTION_RESIZE_SIDE,
-    ACTION_RESIZE_CORNER
-} pointer_action_t;
+typedef struct {
+       option_bool_t occupied;
+       option_bool_t focused;
+} monitor_select_t;
+
+typedef struct icccm_props_t icccm_props_t;
+struct icccm_props_t {
+       bool take_focus;
+       bool input_hint;
+};
 
 typedef struct {
-    xcb_window_t window;
-    char class_name[MAXLEN];
-    unsigned int border_width;
-    bool floating;
-    bool transient;    /* transient window are always floating */
-    bool fullscreen;
-    bool locked;       /* protects window from being closed */
-    bool urgent;
-    bool icccm_focus;  /* send an event to request input focus */
-    xcb_rectangle_t floating_rectangle;
-    xcb_rectangle_t tiled_rectangle;
+       char class_name[3 * SMALEN / 2];
+       char instance_name[3 * SMALEN / 2];
+       unsigned int border_width;
+       bool urgent;
+       bool shown;
+       client_state_t state;
+       client_state_t last_state;
+       stack_layer_t layer;
+       stack_layer_t last_layer;
+       xcb_rectangle_t floating_rectangle;
+       xcb_rectangle_t tiled_rectangle;
+       xcb_size_hints_t size_hints;
+       icccm_props_t icccm_props;
+       wm_flags_t wm_flags;
 } client_t;
 
+typedef struct presel_t presel_t;
+struct presel_t {
+       double split_ratio;
+       direction_t split_dir;
+       xcb_window_t feedback;
+};
+
 typedef struct node_t node_t;
 struct node_t {
-    split_type_t split_type;
-    double split_ratio;
-    split_mode_t split_mode;
-    direction_t split_dir;
-    int birth_rotation;
-    xcb_rectangle_t rectangle;
-    bool vacant;          /* vacant nodes only hold floating clients */
-    node_t *first_child;
-    node_t *second_child;
-    node_t *parent;
-    client_t *client;     /* NULL except for leaves */
+       uint32_t id;
+       split_type_t split_type;
+       double split_ratio;
+       int birth_rotation;
+       presel_t *presel;
+       xcb_rectangle_t rectangle;
+       bool vacant;
+       bool hidden;
+       bool sticky;
+       bool private;
+       bool locked;
+       node_t *first_child;
+       node_t *second_child;
+       node_t *parent;
+       client_t *client;
 };
 
-typedef struct node_list_t node_list_t;
-struct node_list_t {
-    node_t *node;
-    bool latest;          /* used for z-ordering tiled windows */
-    node_list_t *prev;
-    node_list_t *next;
+typedef struct padding_t padding_t;
+struct padding_t {
+       int top;
+       int right;
+       int bottom;
+       int left;
 };
 
-typedef struct {
-    node_list_t *head;
-    node_list_t *tail;
-} focus_history_t;
-
 typedef struct desktop_t desktop_t;
 struct desktop_t {
-    char name[MAXLEN];
-    layout_t layout;
-    node_t *root;
-    node_t *focus;
-    focus_history_t *history;
-    desktop_t *prev;
-    desktop_t *next;
+       char name[SMALEN];
+       uint32_t id;
+       layout_t layout;
+       node_t *root;
+       node_t *focus;
+       desktop_t *prev;
+       desktop_t *next;
+       padding_t padding;
+       int window_gap;
+       unsigned int border_width;
 };
 
 typedef struct monitor_t monitor_t;
 struct monitor_t {
-    char name[MAXLEN];
-    xcb_randr_output_t id;
-    xcb_rectangle_t rectangle;
-    bool wired;
-    int top_padding;
-    int right_padding;
-    int bottom_padding;
-    int left_padding;
-    desktop_t *desk;
-    desktop_t *last_desk;
-    desktop_t *desk_head;
-    desktop_t *desk_tail;
-    monitor_t *prev;
-    monitor_t *next;
+       char name[SMALEN];
+       uint32_t id;
+       xcb_randr_output_t randr_id;
+       xcb_window_t root;
+       bool wired;
+       padding_t padding;
+       unsigned int sticky_count;
+       int window_gap;
+       unsigned int border_width;
+       xcb_rectangle_t rectangle;
+       desktop_t *desk;
+       desktop_t *desk_head;
+       desktop_t *desk_tail;
+       monitor_t *prev;
+       monitor_t *next;
 };
 
 typedef struct {
-    monitor_t *monitor;
-    desktop_t *desktop;
-    node_t *node;
+       monitor_t *monitor;
+       desktop_t *desktop;
+       node_t *node;
 } coordinates_t;
 
-typedef struct {
-    char name[MAXLEN];
-} rule_cause_t;
+typedef struct history_t history_t;
+struct history_t {
+       coordinates_t loc;
+       bool latest;
+       history_t *prev;
+       history_t *next;
+};
 
-typedef struct {
-    bool floating;
-    bool follow;
-    bool focus;
-    char desc[MAXLEN];
-} rule_effect_t;
+typedef struct stacking_list_t stacking_list_t;
+struct stacking_list_t {
+       node_t *node;
+       stacking_list_t *prev;
+       stacking_list_t *next;
+};
+
+typedef struct subscriber_list_t subscriber_list_t;
+struct subscriber_list_t {
+       int fd;
+       FILE *stream;
+       int field;
+       subscriber_list_t *prev;
+       subscriber_list_t *next;
+};
 
 typedef struct rule_t rule_t;
 struct rule_t {
-    unsigned int uid;
-    rule_cause_t cause;
-    rule_effect_t effect;
-    rule_t *prev;
-    rule_t *next;
+       char class_name[MAXLEN];
+       char instance_name[MAXLEN];
+       char effect[MAXLEN];
+       bool one_shot;
+       rule_t *prev;
+       rule_t *next;
 };
 
 typedef struct {
-    xcb_point_t position;
-    pointer_action_t action;
-    xcb_rectangle_t rectangle;
-    node_t *vertical_fence;
-    node_t *horizontal_fence;
-    monitor_t *monitor;
-    desktop_t *desktop;
-    node_t *node;
-    client_t *client;
-    xcb_window_t window;
-    bool is_tiled;
-    double vertical_ratio;
-    double horizontal_ratio;
-    corner_t corner;
-    side_t side;
-} pointer_state_t;
-
-typedef struct {
-    node_t *fence;
-    unsigned int distance;
-} fence_distance_t;
-
-node_t *make_node(void);
-monitor_t *make_monitor(xcb_rectangle_t *);
-monitor_t *find_monitor(char *);
-monitor_t *get_monitor_by_id(xcb_randr_output_t);
-monitor_t *add_monitor(xcb_rectangle_t *);
-void remove_monitor(monitor_t *);
-void merge_monitors(monitor_t *, monitor_t *);
-desktop_t *make_desktop(const char *);
-void insert_desktop(monitor_t *, desktop_t *);
-void add_desktop(monitor_t *, desktop_t *);
-void empty_desktop(desktop_t *);
-void unlink_desktop(monitor_t *, desktop_t *);
-void remove_desktop(monitor_t *, desktop_t *);
-void transfer_desktop(monitor_t *, monitor_t *, desktop_t *);
-rule_t *make_rule(void);
-pointer_state_t *make_pointer_state(void);
-client_t *make_client(xcb_window_t);
-focus_history_t *make_focus_history(void);
-node_list_t *make_node_list(void);
-void history_add(focus_history_t *, node_t *);
-void history_remove(focus_history_t *, node_t *);
-void empty_history(focus_history_t *);
-node_t *history_get(focus_history_t *, int);
-node_t *history_last(focus_history_t *, node_t *, client_select_t);
-int history_rank(focus_history_t *, node_t *);
+       char class_name[3 * SMALEN / 2];
+       char instance_name[3 * SMALEN / 2];
+       char monitor_desc[MAXLEN];
+       char desktop_desc[MAXLEN];
+       char node_desc[MAXLEN];
+       char split_dir[SMALEN];
+       double split_ratio;
+       stack_layer_t *layer;
+       client_state_t *state;
+       bool hidden;
+       bool sticky;
+       bool private;
+       bool locked;
+       bool center;
+       bool follow;
+       bool manage;
+       bool focus;
+       bool border;
+} rule_consequence_t;
+
+typedef struct pending_rule_t pending_rule_t;
+struct pending_rule_t {
+       int fd;
+       xcb_window_t win;
+       rule_consequence_t *csq;
+       pending_rule_t *prev;
+       pending_rule_t *next;
+};
 
 #endif