/*
- * vim:ts=8:expandtab
+ * vim:ts=4:sw=4:expandtab
*
* i3 - an improved dynamic tiling window manager
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
*
- * (c) 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>
+#pragma once
+
+#include <config.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 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 FREE(pointer) do { \
- if (pointer != NULL) { \
- free(pointer); \
- pointer = NULL; \
- } \
-} \
-while (0)
-
-/** ##__VA_ARGS__ means: leave out __VA_ARGS__ completely if it is empty, that
- is, delete the preceding comma */
-#define LOG(fmt, ...) slog("%s:%s:%d - " fmt, __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
-
-TAILQ_HEAD(keyvalue_table_head, keyvalue_element);
-extern struct keyvalue_table_head by_parent;
-extern struct keyvalue_table_head by_child;
+#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; \
+ }
+
+#define FREE(pointer) \
+ do { \
+ free(pointer); \
+ pointer = NULL; \
+ } while (0)
+
+#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);
/**
- * Logs the given message to stdout while prefixing the current time to it.
- * This is to be called by LOG() which includes filename/linenumber
+ * Returns true if the name consists of only digits.
*
*/
-void slog(char *fmt, ...);
+__attribute__((pure)) bool name_is_digits(const char *name);
/**
- * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
- * there is no more memory available)
+ * 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.
*
*/
-void *smalloc(size_t size);
+bool layout_from_name(const char *layout_str, layout_t *out);
/**
- * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
- * there is no more memory available)
+ * Parses the workspace name as a number. Returns -1 if the workspace should be
+ * interpreted as a "named workspace".
*
*/
-void *scalloc(size_t size);
+long ws_name_to_number(const char *name);
/**
- * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
- * there is no more memory available)
+ * Updates *destination with new_value and returns true if it was changed or false
+ * if it was the same
*
*/
-char *sstrdup(const char *str);
+bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
/**
- * Inserts an element into the given keyvalue-table using the given key.
+ * 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).
*
- */
-bool table_put(struct keyvalue_table_head *head, uint32_t key, void *value);
-
-/**
- * Removes the element from the given keyvalue-table with the given key and
- * returns its value;
+ * This function should be called after fork()ing.
*
- */
-void *table_remove(struct keyvalue_table_head *head, uint32_t key);
-
-/**
- * Returns the value of the element of the given keyvalue-table with the given
- * key.
+ * The first argument of the given argv vector will be overwritten with the
+ * executable name, so pass NULL.
+ *
+ * If the utility cannot be found in any of these locations, it exits with
+ * return code 2.
*
*/
-void *table_get(struct keyvalue_table_head *head, uint32_t key);
+void exec_i3_utility(char *name, char *argv[]);
/**
- * 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 shell is determined by looking for the SHELL environment variable. If
- * it does not exist, /bin/sh is used.
+ * Checks if the given path exists by calling stat().
*
*/
-void start_application(const char *command);
+bool path_exists(const char *path);
/**
- * Checks a generic cookie for errors and quits with the given message if
- * there was an error.
+ * Restart i3 in-place
+ * appends -a to argument list to disable autostart
*
*/
-void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
- char *err_message);
+void i3_restart(bool forget_layout);
-/**
- * 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.
+#if defined(__OpenBSD__) || defined(__APPLE__)
+
+/*
+ * Taken from FreeBSD
+ * Find the first occurrence of the byte string s in byte string l.
*
*/
-char *convert_utf8_to_ucs2(char *input, int *real_strlen);
+void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
+
+#endif
/**
- * Returns the client which comes next in focus stack (= was selected before) for
- * the given container, optionally excluding the given client.
+ * 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.
*
*/
-Client *get_last_focused_client(xcb_connection_t *conn, Container *container,
- Client *exclude);
+char *pango_escape_markup(char *input);
/**
- * Sets the given client as focused by updating the data structures correctly,
- * updating the X input focus and finally re-decorating both windows (to
- * signalize the user the new focus situation)
+ * Starts an i3-nagbar instance with the given parameters. Takes care of
+ * handling SIGCHLD and killing i3-nagbar when i3 exits.
+ *
+ * The resulting PID will be stored in *nagbar_pid and can be used with
+ * kill_nagbar() to kill the bar later on.
*
*/
-void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways);
+void start_nagbar(pid_t *nagbar_pid, char *argv[]);
/**
- * Called when the user switches to another mode or when the container is
- * destroyed and thus needs to be cleaned up.
+ * Kills the i3-nagbar process, if *nagbar_pid != -1.
+ *
+ * If wait_for_it is set (restarting i3), this function will waitpid(),
+ * otherwise, ev is assumed to handle it (reloading).
*
*/
-void leave_stack_mode(xcb_connection_t *conn, Container *container);
+void kill_nagbar(pid_t *nagbar_pid, bool wait_for_it);
/**
- * Switches the layout of the given container taking care of the necessary
- * house-keeping
- *
+ * 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.
*/
-void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode);
+bool parse_long(const char *str, long *out, int base);
/**
- * Gets the first matching client for the given window class/window title.
- * If the paramater specific is set to a specific client, only this one
- * will be checked.
+ * 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.
*
*/
-Client *get_matching_client(xcb_connection_t *conn,
- const char *window_classtitle, Client *specific);
-
-#endif
+ssize_t slurp(const char *path, char **buf);
projects / i3 / i3 / blobdiff