src/helpers.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_HELPERS_H
  26 #define BSPWM_HELPERS_H
  27
  28 #include <xcb/xcb.h>
  29 #include <stdarg.h>
  30 #include <stdio.h>
  31 #include <stdbool.h>
  32 #include <stdint.h>
  33 #include <float.h>
  34
  35 #define LENGTH(x)         (sizeof(x) / sizeof(*x))
  36 #define MAX(A, B)         ((A) > (B) ? (A) : (B))
  37 #define MIN(A, B)         ((A) < (B) ? (A) : (B))
  38
  39 #define IS_TILED(c)       (c->state == STATE_TILED || c->state == STATE_PSEUDO_TILED)
  40 #define IS_FLOATING(c)    (c->state == STATE_FLOATING)
  41 #define IS_FULLSCREEN(c)  (c->state == STATE_FULLSCREEN)
  42 #define IS_RECEPTACLE(n)  (is_leaf(n) && n->client == NULL)
  43
  44 #define IS_SINGLE_MONOCLE(d) (single_monocle && tiled_count(d->root, true) <= 1)
  45 #define IS_MONOCLE(d)     (d->layout == LAYOUT_MONOCLE || IS_SINGLE_MONOCLE(d))
  46 #define ACTUAL_LAYOUT(d)  (IS_MONOCLE(d) ? LAYOUT_MONOCLE : d->layout)
  47
  48 #define BOOL_STR(A)       ((A) ? "true" : "false")
  49 #define ON_OFF_STR(A)     ((A) ? "on" : "off")
  50 #define LAYOUT_STR(A)     ((A) == LAYOUT_TILED ? "tiled" : "monocle")
  51 #define LAYOUT_CHR(A)     ((A) == LAYOUT_TILED ? 'T' : 'M')
  52 #define CHILD_POL_STR(A)  ((A) == FIRST_CHILD ? "first_child" : "second_child")
  53 #define AUTO_SCM_STR(A)   ((A) == SCHEME_LONGEST_SIDE ? "longest_side" : ((A) == SCHEME_ALTERNATE ? "alternate" : "spiral"))
  54 #define TIGHTNESS_STR(A)  ((A) == TIGHTNESS_HIGH ? "high" : "low")
  55 #define SPLIT_TYPE_STR(A) ((A) == TYPE_HORIZONTAL ? "horizontal" : "vertical")
  56 #define SPLIT_MODE_STR(A) ((A) == MODE_AUTOMATIC ? "automatic" : "manual")
  57 #define SPLIT_DIR_STR(A)  ((A) == DIR_NORTH ? "north" : ((A) == DIR_WEST ? "west" : ((A) == DIR_SOUTH ? "south" : "east")))
  58 #define STATE_STR(A)      ((A) == STATE_TILED ? "tiled" : ((A) == STATE_FLOATING ? "floating" : ((A) == STATE_FULLSCREEN ? "fullscreen" : "pseudo_tiled")))
  59 #define STATE_CHR(A)      ((A) == STATE_TILED ? 'T' : ((A) == STATE_FLOATING ? 'F' : ((A) == STATE_FULLSCREEN ? '=' : 'P')))
  60 #define LAYER_STR(A)      ((A) == LAYER_BELOW ? "below" : ((A) == LAYER_NORMAL ? "normal" : "above"))
  61
  62 #define XCB_CONFIG_WINDOW_X_Y               (XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y)
  63 #define XCB_CONFIG_WINDOW_WIDTH_HEIGHT      (XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT)
  64 #define XCB_CONFIG_WINDOW_X_Y_WIDTH_HEIGHT  (XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT)
  65
  66 #define MAXLEN    256
  67 #define SMALEN     32
  68 #define INIT_CAP    8
  69
  70 #define cleaned_mask(m)   (m & ~(num_lock | scroll_lock | caps_lock))
  71 #define streq(s1, s2)     (strcmp((s1), (s2)) == 0)
  72 #define unsigned_subtract(a, b)  \
  73         do {                         \
  74                 if (b > a) {             \
  75                         a = 0;               \
  76                 } else {                 \
  77                         a -= b;              \
  78                 }                        \
  79         } while (false)
  80
  81
  82 void warn(char *fmt, ...);
  83 void err(char *fmt, ...);
  84 char *read_string(const char *file_path, size_t *tlen);
  85 char *copy_string(char *str, size_t len);
  86 char *mktempfifo(const char *template);
  87 int asprintf(char **buf, const char *fmt, ...);
  88 int vasprintf(char **buf, const char *fmt, va_list args);
  89 uint32_t get_color_pixel(const char *color);
  90 bool is_hex_color(const char *color);
  91
  92 #endif