Mention the default reference

[bspwm.git] / helpers.h

diff --git a/helpers.h b/helpers.h
index d9fe1daf07f1fe34b27b254b69219443d8df3cfe..b8d481c3e6f170c75f7ae978b6d2b45ffe118871 100644 (file)
--- a/helpers.h
+++ b/helpers.h
@@ -1,33 +1,82 @@
-#ifndef _HELPERS_H
-#define _HELPERS_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_HELPERS_H
+#define BSPWM_HELPERS_H
 
 #include <xcb/xcb.h>
 #include <stdarg.h>
 #include <stdio.h>
+#include <stdbool.h>
 #include <stdint.h>
 
 #define LENGTH(x)         (sizeof(x) / sizeof(*x))
 #define MAX(A, B)         ((A) > (B) ? (A) : (B))
 #define MIN(A, B)         ((A) < (B) ? (A) : (B))
-#define BOOLSTR(A)        ((A) ? "true" : "false")
 
-#define XCB_CONFIG_WINDOW_X_Y_WIDTH_HEIGHT XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT
-#define XCB_CONFIG_WINDOW_X_Y XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
-#define MAXLEN 256
+#define IS_TILED(c)       (c->state == STATE_TILED || c->state == STATE_PSEUDO_TILED)
+#define IS_FLOATING(c)    (c->state == STATE_FLOATING)
+#define IS_FULLSCREEN(c)  (c->state == STATE_FULLSCREEN)
+#define IS_RECEPTACLE(n)  (is_leaf(n) && n->client == NULL)
 
-#define REMLEN(x)         (BUFSIZ - strlen(x) - 1)
+#define BOOL_STR(A)       ((A) ? "true" : "false")
+#define ON_OFF_STR(A)     ((A) ? "on" : "off")
+#define LAYOUT_STR(A)     ((A) == LAYOUT_TILED ? "tiled" : "monocle")
+#define LAYOUT_CHR(A)     ((A) == LAYOUT_TILED ? 'T' : 'M')
+#define CHILD_POL_STR(A)  ((A) == FIRST_CHILD ? "first_child" : "second_child")
+#define SPLIT_TYPE_STR(A) ((A) == TYPE_HORIZONTAL ? "horizontal" : "vertical")
+#define SPLIT_MODE_STR(A) ((A) == MODE_AUTOMATIC ? "automatic" : "manual")
+#define SPLIT_DIR_STR(A)  ((A) == DIR_NORTH ? "north" : ((A) == DIR_WEST ? "west" : ((A) == DIR_SOUTH ? "south" : "east")))
+#define STATE_STR(A)      ((A) == STATE_TILED ? "tiled" : ((A) == STATE_FLOATING ? "floating" : ((A) == STATE_FULLSCREEN ? "fullscreen" : "pseudo_tiled")))
+#define STATE_CHR(A)      ((A) == STATE_TILED ? 'T' : ((A) == STATE_FLOATING ? 'F' : ((A) == STATE_FULLSCREEN ? '=' : 'P')))
+#define LAYER_STR(A)      ((A) == LAYER_BELOW ? "below" : ((A) == LAYER_NORMAL ? "normal" : "above"))
+
+#define XCB_CONFIG_WINDOW_X_Y               (XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y)
+#define XCB_CONFIG_WINDOW_WIDTH_HEIGHT      (XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT)
+#define XCB_CONFIG_WINDOW_X_Y_WIDTH_HEIGHT  (XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT)
+
+#define MAXLEN    256
+#define SMALEN     32
+#define INIT_CAP    8
+
+#define cleaned_mask(m)   (m & ~(num_lock | scroll_lock | caps_lock))
+#define streq(s1, s2)     (strcmp((s1), (s2)) == 0)
+#define unsigned_subtract(a, b)  \
+       do {                         \
+               if (b > a) {             \
+                       a = 0;               \
+               } else {                 \
+                       a -= b;              \
+               }                        \
+       } while (false)
 
-#ifdef DEBUG
-#  define PUTS(x)         puts(x)
-#  define PRINTF(x,...)   printf(x, __VA_ARGS__)
-#else
-#  define PUTS(x)         ((void)0)
-#  define PRINTF(x,...)   ((void)0)
-#endif
 
-void warn(char *, ...);
-__attribute__((noreturn))
-void err(char *, ...);
-uint32_t get_color(char *);
+void warn(char *fmt, ...);
+void err(char *fmt, ...);
+char *read_string(const char *file_path, size_t *tlen);
+char *copy_string(char *str, size_t len);
+uint32_t get_color_pixel(const char *color);
+bool is_hex_color(const char *color);
 
 #endif