]> git.sur5r.net Git - i3/i3/blobdiff - include/util.h
Merge branch 'master' into next
[i3/i3] / include / util.h
index 46a156558973685b363a4ae1e64ce73d6a6944eb..cd88863c282a90b976bd9ba02fb6b4c3c58ef3ca 100644 (file)
@@ -1,21 +1,20 @@
 /*
- * vim:ts=8:expandtab
+ * 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 file LICENSE for license information.
+ * util.c: Utility functions, which can be useful everywhere within i3 (see
+ *         also libi3).
  *
  */
-#include <xcb/xcb.h>
+#ifndef _UTIL_H
+#define _UTIL_H
+
 #include <err.h>
 
 #include "data.h"
 
-#ifndef _UTIL_H
-#define _UTIL_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 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)
+
+/* 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; \
+    }
+
 #define FREE(pointer) do { \
         if (pointer != NULL) { \
                 free(pointer); \
@@ -34,6 +52,8 @@
 } \
 while (0)
 
+#define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
+
 int min(int a, int b);
 int max(int a, int b);
 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
@@ -47,44 +67,21 @@ Rect rect_add(Rect a, Rect b);
 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
 
 /**
- * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
- * there is no more memory available)
+ * exec()s an i3 utility, for example the config file migration script or
+ * i3-nagbar. This function first searches $PATH for the given utility named,
+ * then falls back to the dirname() of the i3 executable path and then falls
+ * back to the dirname() of the target of /proc/self/exe (on linux).
  *
- */
-void *smalloc(size_t size);
-
-/**
- * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
- * there is no more memory available)
- *
- */
-void *scalloc(size_t size);
-
-/**
- * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
- * that there is no more memory available).
- *
- */
-void *srealloc(void *ptr, size_t size);
-
-/**
- * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
- * there is no more memory available)
+ * This function should be called after fork()ing.
  *
- */
-char *sstrdup(const char *str);
-
-/**
- * Starts the given application by passing it through a shell. We use double
- * fork to avoid zombie processes. As the started application’s parent exits
- * (immediately), the application is reparented to init (process-id 1), which
- * correctly handles childs, so we don’t have to do it :-).
+ * The first argument of the given argv vector will be overwritten with the
+ * executable name, so pass NULL.
  *
- * The shell is determined by looking for the SHELL environment variable. If
- * it does not exist, /bin/sh is used.
+ * If the utility cannot be found in any of these locations, it exits with
+ * return code 2.
  *
  */
-void start_application(const char *command);
+void exec_i3_utility(char *name, char *argv[]);
 
 /**
  * Checks a generic cookie for errors and quits with the given message if
@@ -95,15 +92,6 @@ void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
                  char *err_message);
 
 /**
- * Converts the given string to UCS-2 big endian for use with
- * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen, a
- * buffer containing the UCS-2 encoded string (16 bit per glyph) is
- * returned. It has to be freed when done.
- *
- */
-char *convert_utf8_to_ucs2(char *input, int *real_strlen);
-
-/*
  * 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.
@@ -111,17 +99,35 @@ char *convert_utf8_to_ucs2(char *input, int *real_strlen);
  */
 char *resolve_tilde(const char *path);
 
-/*
+/**
  * Checks if the given path exists by calling stat().
  *
  */
 bool path_exists(const char *path);
 
-/*
+
+/**
+ * Returns the name of a temporary file with the specified prefix.
+ *
+ */
+char *get_process_filename(const char *prefix);
+
+/**
  * Restart i3 in-place
  * appends -a to argument list to disable autostart
  *
  */
-void i3_restart();
+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.
+ *
+ */
+void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
+
+#endif
 
 #endif