git.sur5r.net Git - i3/i3/blob - include/libi3.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * libi3: contains functions which are used by i3 *and* accompanying tools such
   8  * as i3-msg, i3-config-wizard, …
   9  *
  10  */
  11 #ifndef _LIBI3_H
  12 #define _LIBI3_H
  13
  14 #include <stdbool.h>
  15 #include <stdarg.h>
  16 #include <stdio.h>
  17 #include <xcb/xcb.h>
  18 #include <xcb/xproto.h>
  19 #include <xcb/xcb_keysyms.h>
  20
  21 typedef struct Font i3Font;
  22
  23 /**
  24  * Data structure for cached font information:
  25  * - font id in X11 (load it once)
  26  * - font height (multiple calls needed to get it)
  27  *
  28  */
  29 struct Font {
  30     /** The height of the font, built from font_ascent + font_descent */
  31     int height;
  32     /** The xcb-id for the font */
  33     xcb_font_t id;
  34 };
  35
  36 /* Since this file also gets included by utilities which don’t use the i3 log
  37  * infrastructure, we define a fallback. */
  38 #if !defined(ELOG)
  39 #define ELOG(fmt, ...) fprintf(stderr, "ERROR: " fmt, ##__VA_ARGS__)
  40 #endif
  41
  42 /**
  43  * Try to get the socket path from X11 and return NULL if it doesn’t work.
  44  *
  45  * The memory for the socket path is dynamically allocated and has to be
  46  * free()d by the caller.
  47  *
  48  */
  49 char *socket_path_from_x11();
  50
  51 /**
  52  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
  53  * there is no more memory available)
  54  *
  55  */
  56 void *smalloc(size_t size);
  57
  58 /**
  59  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
  60  * there is no more memory available)
  61  *
  62  */
  63 void *scalloc(size_t size);
  64
  65 /**
  66  * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
  67  * that there is no more memory available).
  68  *
  69  */
  70 void *srealloc(void *ptr, size_t size);
  71
  72 /**
  73  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
  74  * there is no more memory available)
  75  *
  76  */
  77 char *sstrdup(const char *str);
  78
  79 /**
  80  * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
  81  * there is no more memory available)
  82  *
  83  */
  84 int sasprintf(char **strp, const char *fmt, ...);
  85
  86 /**
  87  * Connects to the i3 IPC socket and returns the file descriptor for the
  88  * socket. die()s if anything goes wrong.
  89  *
  90  */
  91 int ipc_connect(const char *socket_path);
  92
  93 /**
  94  * Formats a message (payload) of the given size and type and sends it to i3 via
  95  * the given socket file descriptor.
  96  *
  97  * Returns -1 when write() fails, errno will remain.
  98  * Returns 0 on success.
  99  *
 100  */
 101 int ipc_send_message(int sockfd, uint32_t message_size,
 102                      uint32_t message_type, const uint8_t *payload);
 103
 104 /**
 105  * Reads a message from the given socket file descriptor and stores its length
 106  * (reply_length) as well as a pointer to its contents (reply).
 107  *
 108  * Returns -1 when read() fails, errno will remain.
 109  * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
 110  * message type, EOF instead of a message). Additionally, the error will be
 111  * printed to stderr.
 112  * Returns 0 on success.
 113  *
 114  */
 115 int ipc_recv_message(int sockfd, uint32_t message_type,
 116                      uint32_t *reply_length, uint8_t **reply);
 117
 118 /**
 119  * Generates a configure_notify event and sends it to the given window
 120  * Applications need this to think they’ve configured themselves correctly.
 121  * The truth is, however, that we will manage them.
 122  *
 123  */
 124 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
 125
 126 /**
 127  * Returns the colorpixel to use for the given hex color (think of HTML). Only
 128  * works for true-color (vast majority of cases) at the moment, avoiding a
 129  * roundtrip to X11.
 130  *
 131  * The hex_color has to start with #, for example #FF00FF.
 132  *
 133  * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
 134  * This has to be done by the caller.
 135  *
 136  * NOTE that this function may in the future rely on a global xcb_connection_t
 137  * variable called 'conn' to be present.
 138  *
 139  */
 140 uint32_t get_colorpixel(const char *hex) __attribute__((const));
 141
 142 #if defined(__APPLE__)
 143
 144 /*
 145  * Taken from FreeBSD
 146  * Returns a pointer to a new string which is a duplicate of the
 147  * string, but only copies at most n characters.
 148  *
 149  */
 150 char *strndup(const char *str, size_t n);
 151
 152 #endif
 153
 154 /**
 155  * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
 156  * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
 157  *
 158  * This function initiates one round-trip. Use get_mod_mask_for() directly if
 159  * you already have the modifier mapping and key symbols.
 160  *
 161  */
 162 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
 163
 164 /**
 165  * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
 166  * example for XCB_NUM_LOCK (usually configured to mod2).
 167  *
 168  * This function does not initiate any round-trips.
 169  *
 170  */
 171 uint32_t get_mod_mask_for(uint32_t keysym,
 172                            xcb_key_symbols_t *symbols,
 173                            xcb_get_modifier_mapping_reply_t *modmap_reply);
 174
 175 /**
 176  * Loads a font for usage, also getting its height. If fallback is true,
 177  * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting.
 178  *
 179  */
 180 i3Font load_font(const char *pattern, bool fallback);
 181
 182 #endif