X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=include%2Futil.h;h=cd88863c282a90b976bd9ba02fb6b4c3c58ef3ca;hb=c7ea8c42b679be191e843f653f5024846ce42fe9;hp=3ea2b3a75c519b8af8dcbac3c1825a614c64818e;hpb=982e453251e9c78c9ef443247e69f67060c90485;p=i3%2Fi3 diff --git a/include/util.h b/include/util.h index 3ea2b3a7..cd88863c 100644 --- a/include/util.h +++ b/include/util.h @@ -1,20 +1,21 @@ /* - * 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) * - * (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 - -#include "data.h" - #ifndef _UTIL_H #define _UTIL_H +#include + +#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) ? \ @@ -22,161 +23,111 @@ #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++) + 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) { \ + 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 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); +Rect rect_add(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 + * Updates *destination with new_value and returns true if it was changed or false + * if it was the same * */ -void slog(char *fmt, ...); +bool update_if_necessary(uint32_t *destination, const uint32_t new_value); /** - * Prints the message (see printf()) to stderr, then exits the program. + * 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 die(char *fmt, ...); - -/** - * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there - * is no more memory available) + * This function should be called after fork()ing. * - */ -void *smalloc(size_t size); - -/** - * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there - * is no more memory available) + * The first argument of the given argv vector will be overwritten with the + * executable name, so pass NULL. * - */ -void *scalloc(size_t size); - -/** - * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there - * is no more memory available) + * If the utility cannot be found in any of these locations, it exits with + * return code 2. * */ -char *sstrdup(const char *str); +void exec_i3_utility(char *name, char *argv[]); /** - * Inserts an element into the given keyvalue-table using the given key. + * Checks a generic cookie for errors and quits with the given message if + * there was an error. * */ -bool table_put(struct keyvalue_table_head *head, uint32_t key, void *value); +void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, + char *err_message); /** - * Removes the element from the given keyvalue-table with the given key and returns its value; + * 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. * */ -void *table_remove(struct keyvalue_table_head *head, uint32_t key); +char *resolve_tilde(const char *path); /** - * Returns the value of the element of the given keyvalue-table with the given key. + * Checks if the given path exists by calling stat(). * */ -void *table_get(struct keyvalue_table_head *head, uint32_t key); +bool path_exists(const char *path); -/** - * 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. - * - */ -void start_application(const char *command); /** - * Checks a generic cookie for errors and quits with the given message if there - * was an error. + * Returns the name of a temporary file with the specified prefix. * */ -void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message); +char *get_process_filename(const char *prefix); /** - * 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. + * Restart i3 in-place + * appends -a to argument list to disable autostart * */ -char *convert_utf8_to_ucs2(char *input, int *real_strlen); +void i3_restart(bool forget_layout); -/** - * Removes the given client from the container, either because it will be inserted into another - * one or because it was unmapped - * - */ -void remove_client_from_container(xcb_connection_t *conn, Client *client, Container *container); +#if defined(__OpenBSD__) || defined(__APPLE__) -/** - * Returns the client which comes next in focus stack (= was selected before) for - * the given container, optionally excluding the given client. - * - */ -Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude); - -/** - * 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) - * - */ -void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways); - -/** - * Called when the user switches to another mode or when the container is - * destroyed and thus needs to be cleaned up. - * - */ -void leave_stack_mode(xcb_connection_t *conn, Container *container); - -/** - * Switches the layout of the given container taking care of the necessary house-keeping - * - */ -void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode); - -/** - * Warps the pointer into the given client (in the middle of it, to be specific), therefore - * selecting it - * - */ -void warp_pointer_into(xcb_connection_t *conn, Client *client); - -/** - * Toggles fullscreen mode for the given client. It updates the data structures and - * reconfigures (= resizes/moves) the client and its frame to the full size of the - * screen. When leaving fullscreen, re-rendering the layout is forced. +/* + * Taken from FreeBSD + * Find the first occurrence of the byte string s in byte string l. * */ -void toggle_fullscreen(xcb_connection_t *conn, Client *client); +void *memmem(const void *l, size_t l_len, const void *s, size_t s_len); -/** - * Kills the given window using WM_DELETE_WINDOW or xcb_kill_window - * - */ -void kill_window(xcb_connection_t *conn, Client *window); +#endif #endif