src/types.h

   1 /* Copyright (c) 2012, Bastien Dejean
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  * 1. Redistributions of source code must retain the above copyright notice, this
   8  *    list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright notice,
  10  *    this list of conditions and the following disclaimer in the documentation
  11  *    and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  17  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  20  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #ifndef BSPWM_TYPES_H
  26 #define BSPWM_TYPES_H
  27 #include <stdbool.h>
  28 #include <xcb/xcb.h>
  29 #include <xcb/xcb_icccm.h>
  30 #include <xcb/randr.h>
  31 #include <xcb/xcb_event.h>
  32 #include "helpers.h"
  33
  34 #define MISSING_VALUE        "N/A"
  35 #define MAX_WM_STATES        4
  36
  37 typedef enum {
  38         TYPE_HORIZONTAL,
  39         TYPE_VERTICAL
  40 } split_type_t;
  41
  42 typedef enum {
  43         MODE_AUTOMATIC,
  44         MODE_MANUAL
  45 } split_mode_t;
  46
  47 typedef enum {
  48         SCHEME_LONGEST_SIDE,
  49         SCHEME_ALTERNATE,
  50         SCHEME_SPIRAL
  51 } automatic_scheme_t;
  52
  53 typedef enum {
  54         STATE_TILED,
  55         STATE_PSEUDO_TILED,
  56         STATE_FLOATING,
  57         STATE_FULLSCREEN
  58 } client_state_t;
  59
  60 typedef enum {
  61         WM_FLAG_MODAL = 1 << 0,
  62         WM_FLAG_STICKY = 1 << 1,
  63         WM_FLAG_MAXIMIZED_VERT = 1 << 2,
  64         WM_FLAG_MAXIMIZED_HORZ = 1 << 3,
  65         WM_FLAG_SHADED = 1 << 4,
  66         WM_FLAG_SKIP_TASKBAR = 1 << 5,
  67         WM_FLAG_SKIP_PAGER = 1 << 6,
  68         WM_FLAG_HIDDEN = 1 << 7,
  69         WM_FLAG_FULLSCREEN = 1 << 8,
  70         WM_FLAG_ABOVE = 1 << 9,
  71         WM_FLAG_BELOW = 1 << 10,
  72         WM_FLAG_DEMANDS_ATTENTION = 1 << 11,
  73 } wm_flags_t;
  74
  75 typedef enum {
  76         LAYER_BELOW,
  77         LAYER_NORMAL,
  78         LAYER_ABOVE
  79 } stack_layer_t;
  80
  81 typedef enum {
  82         OPTION_NONE,
  83         OPTION_TRUE,
  84         OPTION_FALSE
  85 } option_bool_t;
  86
  87 typedef enum {
  88         ALTER_TOGGLE,
  89         ALTER_SET
  90 } alter_state_t;
  91
  92 typedef enum {
  93         CYCLE_NEXT,
  94         CYCLE_PREV
  95 } cycle_dir_t;
  96
  97 typedef enum {
  98         CIRCULATE_FORWARD,
  99         CIRCULATE_BACKWARD
 100 } circulate_dir_t;
 101
 102 typedef enum {
 103         HISTORY_OLDER,
 104         HISTORY_NEWER
 105 } history_dir_t;
 106
 107 typedef enum {
 108         DIR_NORTH,
 109         DIR_WEST,
 110         DIR_SOUTH,
 111         DIR_EAST
 112 } direction_t;
 113
 114 typedef enum {
 115         HANDLE_LEFT = 1 << 0,
 116         HANDLE_TOP = 1 << 1,
 117         HANDLE_RIGHT = 1 << 2,
 118         HANDLE_BOTTOM = 1 << 3,
 119         HANDLE_TOP_LEFT = HANDLE_TOP | HANDLE_LEFT,
 120         HANDLE_TOP_RIGHT = HANDLE_TOP | HANDLE_RIGHT,
 121         HANDLE_BOTTOM_RIGHT = HANDLE_BOTTOM | HANDLE_RIGHT,
 122         HANDLE_BOTTOM_LEFT = HANDLE_BOTTOM | HANDLE_LEFT
 123 } resize_handle_t;
 124
 125 typedef enum {
 126         ACTION_NONE,
 127         ACTION_FOCUS,
 128         ACTION_MOVE,
 129         ACTION_RESIZE_SIDE,
 130         ACTION_RESIZE_CORNER
 131 } pointer_action_t;
 132
 133 typedef enum {
 134         LAYOUT_TILED,
 135         LAYOUT_MONOCLE
 136 } layout_t;
 137
 138 typedef enum {
 139         FLIP_HORIZONTAL,
 140         FLIP_VERTICAL
 141 } flip_t;
 142
 143 typedef enum {
 144         FIRST_CHILD,
 145         SECOND_CHILD
 146 } child_polarity_t;
 147
 148 typedef enum {
 149         TIGHTNESS_LOW,
 150         TIGHTNESS_HIGH,
 151 } tightness_t;
 152
 153 typedef enum {
 154         AREA_BIGGEST,
 155         AREA_SMALLEST,
 156 } area_peak_t;
 157
 158 typedef enum {
 159         STATE_TRANSITION_ENTER = 1 << 0,
 160         STATE_TRANSITION_EXIT = 1 << 1,
 161 } state_transition_t;
 162
 163 typedef struct {
 164         option_bool_t automatic;
 165         option_bool_t focused;
 166         option_bool_t active;
 167         option_bool_t local;
 168         option_bool_t leaf;
 169         option_bool_t window;
 170         option_bool_t tiled;
 171         option_bool_t pseudo_tiled;
 172         option_bool_t floating;
 173         option_bool_t fullscreen;
 174         option_bool_t hidden;
 175         option_bool_t sticky;
 176         option_bool_t private;
 177         option_bool_t locked;
 178         option_bool_t marked;
 179         option_bool_t urgent;
 180         option_bool_t same_class;
 181         option_bool_t descendant_of;
 182         option_bool_t ancestor_of;
 183         option_bool_t below;
 184         option_bool_t normal;
 185         option_bool_t above;
 186         option_bool_t horizontal;
 187         option_bool_t vertical;
 188 } node_select_t;
 189
 190 typedef struct {
 191         option_bool_t occupied;
 192         option_bool_t focused;
 193         option_bool_t active;
 194         option_bool_t urgent;
 195         option_bool_t local;
 196         option_bool_t tiled;
 197         option_bool_t monocle;
 198         option_bool_t user_tiled;
 199         option_bool_t user_monocle;
 200 } desktop_select_t;
 201
 202 typedef struct {
 203         option_bool_t occupied;
 204         option_bool_t focused;
 205 } monitor_select_t;
 206
 207 typedef struct icccm_props_t icccm_props_t;
 208 struct icccm_props_t {
 209         bool take_focus;
 210         bool input_hint;
 211         bool delete_window;
 212 };
 213
 214 typedef struct {
 215         char class_name[MAXLEN];
 216         char instance_name[MAXLEN];
 217         char name[MAXLEN];
 218         unsigned int border_width;
 219         bool urgent;
 220         bool shown;
 221         client_state_t state;
 222         client_state_t last_state;
 223         stack_layer_t layer;
 224         stack_layer_t last_layer;
 225         xcb_rectangle_t floating_rectangle;
 226         xcb_rectangle_t tiled_rectangle;
 227         xcb_size_hints_t size_hints;
 228         icccm_props_t icccm_props;
 229         wm_flags_t wm_flags;
 230 } client_t;
 231
 232 typedef struct presel_t presel_t;
 233 struct presel_t {
 234         double split_ratio;
 235         direction_t split_dir;
 236         xcb_window_t feedback;
 237 };
 238
 239 typedef struct constraints_t constraints_t;
 240 struct constraints_t {
 241         uint16_t min_width;
 242         uint16_t min_height;
 243 };
 244
 245 typedef struct node_t node_t;
 246 struct node_t {
 247         uint32_t id;
 248         split_type_t split_type;
 249         double split_ratio;
 250         presel_t *presel;
 251         xcb_rectangle_t rectangle;
 252         constraints_t constraints;
 253         bool vacant;
 254         bool hidden;
 255         bool sticky;
 256         bool private;
 257         bool locked;
 258         bool marked;
 259         node_t *first_child;
 260         node_t *second_child;
 261         node_t *parent;
 262         client_t *client;
 263 };
 264
 265 typedef struct padding_t padding_t;
 266 struct padding_t {
 267         int top;
 268         int right;
 269         int bottom;
 270         int left;
 271 };
 272
 273 typedef struct desktop_t desktop_t;
 274 struct desktop_t {
 275         char name[SMALEN];
 276         uint32_t id;
 277         layout_t layout;
 278         layout_t user_layout;
 279         node_t *root;
 280         node_t *focus;
 281         desktop_t *prev;
 282         desktop_t *next;
 283         padding_t padding;
 284         int window_gap;
 285         unsigned int border_width;
 286 };
 287
 288 typedef struct monitor_t monitor_t;
 289 struct monitor_t {
 290         char name[SMALEN];
 291         uint32_t id;
 292         xcb_randr_output_t randr_id;
 293         xcb_window_t root;
 294         bool wired;
 295         padding_t padding;
 296         unsigned int sticky_count;
 297         int window_gap;
 298         unsigned int border_width;
 299         xcb_rectangle_t rectangle;
 300         desktop_t *desk;
 301         desktop_t *desk_head;
 302         desktop_t *desk_tail;
 303         monitor_t *prev;
 304         monitor_t *next;
 305 };
 306
 307 typedef struct {
 308         monitor_t *monitor;
 309         desktop_t *desktop;
 310         node_t *node;
 311 } coordinates_t;
 312
 313 typedef struct history_t history_t;
 314 struct history_t {
 315         coordinates_t loc;
 316         bool latest;
 317         history_t *prev;
 318         history_t *next;
 319 };
 320
 321 typedef struct stacking_list_t stacking_list_t;
 322 struct stacking_list_t {
 323         node_t *node;
 324         stacking_list_t *prev;
 325         stacking_list_t *next;
 326 };
 327
 328 typedef struct event_queue_t event_queue_t;
 329 struct event_queue_t {
 330         xcb_generic_event_t event;
 331         event_queue_t *prev;
 332         event_queue_t *next;
 333 };
 334
 335 typedef struct subscriber_list_t subscriber_list_t;
 336 struct subscriber_list_t {
 337         FILE *stream;
 338         char* fifo_path;
 339         int field;
 340         int count;
 341         subscriber_list_t *prev;
 342         subscriber_list_t *next;
 343 };
 344
 345 typedef struct rule_t rule_t;
 346 struct rule_t {
 347         char class_name[MAXLEN];
 348         char instance_name[MAXLEN];
 349         char name[MAXLEN];
 350         char effect[MAXLEN];
 351         bool one_shot;
 352         rule_t *prev;
 353         rule_t *next;
 354 };
 355
 356 typedef struct {
 357         char class_name[MAXLEN];
 358         char instance_name[MAXLEN];
 359         char name[MAXLEN];
 360         char monitor_desc[MAXLEN];
 361         char desktop_desc[MAXLEN];
 362         char node_desc[MAXLEN];
 363         direction_t *split_dir;
 364         double split_ratio;
 365         stack_layer_t *layer;
 366         client_state_t *state;
 367         bool hidden;
 368         bool sticky;
 369         bool private;
 370         bool locked;
 371         bool marked;
 372         bool center;
 373         bool follow;
 374         bool manage;
 375         bool focus;
 376         bool border;
 377         xcb_rectangle_t *rect;
 378 } rule_consequence_t;
 379
 380 typedef struct pending_rule_t pending_rule_t;
 381 struct pending_rule_t {
 382         int fd;
 383         xcb_window_t win;
 384         rule_consequence_t *csq;
 385         event_queue_t *event_head;
 386         event_queue_t *event_tail;
 387         pending_rule_t *prev;
 388         pending_rule_t *next;
 389 };
 390
 391 #endif