]> git.sur5r.net Git - i3/i3/blobdiff - include/util.h
Merge branch 'release-4.16.1'
[i3/i3] / include / util.h
index ac21b870ecc9c6f0fa1e4601f5d16c73e7c64ae2..d08ac69df9cc4205dfcc791b7d8b76f77baa943e 100644 (file)
@@ -2,7 +2,7 @@
  * vim:ts=4:sw=4:expandtab
  *
  * i3 - an improved dynamic tiling window manager
- * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
  *
  * util.c: Utility functions, which can be useful everywhere within i3 (see
  *         also libi3).
  */
 #pragma once
 
+#include <config.h>
+
 #include <err.h>
 
 #include "data.h"
 
 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
-#define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
-#define STARTS_WITH(string, needle) (strncasecmp(string, needle, strlen(needle)) == 0)
-#define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? \
-                                                CIRCLEQ_NEXT(elm, field) : NULL)
-#define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? \
-                                                CIRCLEQ_PREV(elm, field) : NULL)
-#define FOR_TABLE(workspace) \
-                        for (int cols = 0; cols < (workspace)->cols; cols++) \
-                                for (int rows = 0; rows < (workspace)->rows; rows++)
-
-#define NODES_FOREACH(head) \
-    for (Con *child = (Con*)-1; (child == (Con*)-1) && ((child = 0), true);) \
-        TAILQ_FOREACH(child, &((head)->nodes_head), nodes)
-
-#define NODES_FOREACH_REVERSE(head) \
-    for (Con *child = (Con*)-1; (child == (Con*)-1) && ((child = 0), true);) \
-        TAILQ_FOREACH_REVERSE(child, &((head)->nodes_head), nodes_head, nodes)
+#define exit_if_null(pointer, ...) \
+    {                              \
+        if (pointer == NULL)       \
+            die(__VA_ARGS__);      \
+    }
+#define STARTS_WITH(string, needle) (strncasecmp((string), (needle), strlen((needle))) == 0)
+#define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_NEXT(elm, field) : NULL)
+#define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? CIRCLEQ_PREV(elm, field) : NULL)
+
+#define NODES_FOREACH(head)                                                    \
+    for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
+    TAILQ_FOREACH(child, &((head)->nodes_head), nodes)
+
+#define NODES_FOREACH_REVERSE(head)                                            \
+    for (Con *child = (Con *)-1; (child == (Con *)-1) && ((child = 0), true);) \
+    TAILQ_FOREACH_REVERSE(child, &((head)->nodes_head), nodes_head, nodes)
 
 /* greps the ->nodes of the given head and returns the first node that matches the given condition */
 #define GREP_FIRST(dest, head, condition) \
-    NODES_FOREACH(head) { \
-        if (!(condition)) \
-            continue; \
-        \
-        (dest) = child; \
-        break; \
+    NODES_FOREACH(head) {                 \
+        if (!(condition))                 \
+            continue;                     \
+                                          \
+        (dest) = child;                   \
+        break;                            \
     }
 
-#define FREE(pointer) do { \
-        if (pointer != NULL) { \
-                free(pointer); \
-                pointer = NULL; \
-        } \
-} \
-while (0)
+#define FREE(pointer)   \
+    do {                \
+        free(pointer);  \
+        pointer = NULL; \
+    } while (0)
+
+#define CALL(obj, member, ...) obj->member(obj, ##__VA_ARGS__)
 
-#define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
+#define SWAP(first, second, type) \
+    do {                          \
+        type tmp_SWAP = first;    \
+        first = second;           \
+        second = tmp_SWAP;        \
+    } while (0)
 
 int min(int a, int b);
 int max(int a, int b);
 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
 Rect rect_add(Rect a, Rect b);
+Rect rect_sub(Rect a, Rect b);
 
 /**
  * Returns true if the name consists of only digits.
@@ -64,6 +71,14 @@ Rect rect_add(Rect a, Rect b);
  */
 __attribute__((pure)) bool name_is_digits(const char *name);
 
+/**
+ * Set 'out' to the layout_t value for the given layout. The function
+ * returns true on success or false if the passed string is not a valid
+ * layout name.
+ *
+ */
+bool layout_from_name(const char *layout_str, layout_t *out);
+
 /**
  * Parses the workspace name as a number. Returns -1 if the workspace should be
  * interpreted as a "named workspace".
@@ -95,22 +110,6 @@ bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
  */
 void exec_i3_utility(char *name, char *argv[]);
 
-/**
- * Checks a generic cookie for errors and quits with the given message if
- * there was an error.
- *
- */
-void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
-                 char *err_message);
-
-/**
- * This function resolves ~ in pathnames.
- * It may resolve wildcards in the first part of the path, but if no match
- * or multiple matches are found, it just returns a copy of path as given.
- *
- */
-char *resolve_tilde(const char *path);
-
 /**
  * Checks if the given path exists by calling stat().
  *
@@ -126,7 +125,7 @@ void i3_restart(bool forget_layout);
 
 #if defined(__OpenBSD__) || defined(__APPLE__)
 
-/*
+/**
  * Taken from FreeBSD
  * Find the first occurrence of the byte string s in byte string l.
  *
@@ -135,6 +134,13 @@ void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 
 #endif
 
+/**
+ * Escapes the given string if a pango font is currently used.
+ * If the string has to be escaped, the input string will be free'd.
+ *
+ */
+char *pango_escape_markup(char *input);
+
 /**
  * Starts an i3-nagbar instance with the given parameters. Takes care of
  * handling SIGCHLD and killing i3-nagbar when i3 exits.
@@ -153,3 +159,24 @@ void start_nagbar(pid_t *nagbar_pid, char *argv[]);
  *
  */
 void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);
+
+/**
+ * Converts a string into a long using strtol().
+ * This is a convenience wrapper checking the parsing result. It returns true
+ * if the number could be parsed.
+ */
+bool parse_long(const char *str, long *out, int base);
+
+/**
+ * Slurp reads path in its entirety into buf, returning the length of the file
+ * or -1 if the file could not be read. buf is set to a buffer of appropriate
+ * size, or NULL if -1 is returned.
+ *
+ */
+ssize_t slurp(const char *path, char **buf);
+
+/**
+ * Convert a direction to its corresponding orientation.
+ *
+ */
+orientation_t orientation_from_direction(direction_t direction);