]> git.sur5r.net Git - i3/i3/blob - include/libi3.h
layout toggle: take any combination of layouts as arguments (#2649)
[i3/i3] / include / libi3.h
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009 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 #pragma once
12
13 #include <config.h>
14
15 #include <stdbool.h>
16 #include <stdarg.h>
17 #include <stdio.h>
18 #include <xcb/xcb.h>
19 #include <xcb/xproto.h>
20 #include <xcb/xcb_keysyms.h>
21
22 #include <pango/pango.h>
23 #include <cairo/cairo-xcb.h>
24
25 #define DEFAULT_DIR_MODE (S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
26
27 /**
28  * XCB connection and root screen
29  *
30  */
31 extern xcb_connection_t *conn;
32 extern xcb_screen_t *root_screen;
33
34 /**
35  * Opaque data structure for storing strings.
36  *
37  */
38 typedef struct _i3String i3String;
39
40 typedef struct Font i3Font;
41
42 /**
43  * Data structure for cached font information:
44  * - font id in X11 (load it once)
45  * - font height (multiple calls needed to get it)
46  *
47  */
48 struct Font {
49     /** The type of font */
50     enum {
51         FONT_TYPE_NONE = 0,
52         FONT_TYPE_XCB,
53         FONT_TYPE_PANGO
54     } type;
55
56     /** The height of the font, built from font_ascent + font_descent */
57     int height;
58
59     /** The pattern/name used to load the font. */
60     char *pattern;
61
62     union {
63         struct {
64             /** The xcb-id for the font */
65             xcb_font_t id;
66
67             /** Font information gathered from the server */
68             xcb_query_font_reply_t *info;
69
70             /** Font table for this font (may be NULL) */
71             xcb_charinfo_t *table;
72         } xcb;
73
74         /** The pango font description */
75         PangoFontDescription *pango_desc;
76     } specific;
77 };
78
79 /* Since this file also gets included by utilities which don’t use the i3 log
80  * infrastructure, we define a fallback. */
81 #if !defined(LOG)
82 void verboselog(char *fmt, ...)
83     __attribute__((format(printf, 1, 2)));
84 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
85 #endif
86 #if !defined(ELOG)
87 void errorlog(char *fmt, ...)
88     __attribute__((format(printf, 1, 2)));
89 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
90 #endif
91 #if !defined(DLOG)
92 void debuglog(char *fmt, ...)
93     __attribute__((format(printf, 1, 2)));
94 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, STRIPPED__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
95 #endif
96
97 /**
98  * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
99  * the X11 root window and return NULL if it doesn’t work.
100  *
101  * If the provided XCB connection is NULL, a new connection will be
102  * established.
103  *
104  * The memory for the contents is dynamically allocated and has to be
105  * free()d by the caller.
106  *
107  */
108 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
109
110 /**
111  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
112  * there is no more memory available)
113  *
114  */
115 void *smalloc(size_t size);
116
117 /**
118  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
119  * there is no more memory available)
120  *
121  */
122 void *scalloc(size_t num, size_t size);
123
124 /**
125  * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
126  * that there is no more memory available).
127  *
128  */
129 void *srealloc(void *ptr, size_t size);
130
131 /**
132  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
133  * there is no more memory available)
134  *
135  */
136 char *sstrdup(const char *str);
137
138 /**
139  * Safe-wrapper around strndup which exits if strndup returns NULL (meaning that
140  * there is no more memory available)
141  *
142  */
143 char *sstrndup(const char *str, size_t size);
144
145 /**
146  * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
147  * there is no more memory available)
148  *
149  */
150 int sasprintf(char **strp, const char *fmt, ...);
151
152 /**
153  * Wrapper around correct write which returns -1 (meaning that
154  * write failed) or count (meaning that all bytes were written)
155  *
156  */
157 ssize_t writeall(int fd, const void *buf, size_t count);
158
159 /**
160  * Safe-wrapper around writeall which exits if it returns -1 (meaning that
161  * write failed)
162  *
163  */
164 ssize_t swrite(int fd, const void *buf, size_t count);
165
166 /**
167  * Build an i3String from an UTF-8 encoded string.
168  * Returns the newly-allocated i3String.
169  *
170  */
171 i3String *i3string_from_utf8(const char *from_utf8);
172
173 /**
174  * Build an i3String from an UTF-8 encoded string in Pango markup.
175  *
176  */
177 i3String *i3string_from_markup(const char *from_markup);
178
179 /**
180  * Build an i3String from an UTF-8 encoded string with fixed length.
181  * To be used when no proper NUL-terminaison is available.
182  * Returns the newly-allocated i3String.
183  *
184  */
185 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
186
187 /**
188  * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
189  * length.
190  *
191  */
192 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
193
194 /**
195  * Build an i3String from an UCS-2 encoded string.
196  * Returns the newly-allocated i3String.
197  *
198  */
199 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
200
201 /**
202  * Copies the given i3string.
203  * Note that this will not free the source string.
204  */
205 i3String *i3string_copy(i3String *str);
206
207 /**
208  * Free an i3String.
209  *
210  */
211 void i3string_free(i3String *str);
212
213 /**
214  * Securely i3string_free by setting the pointer to NULL
215  * to prevent accidentally using freed memory.
216  *
217  */
218 #define I3STRING_FREE(str)      \
219     do {                        \
220         if (str != NULL) {      \
221             i3string_free(str); \
222             str = NULL;         \
223         }                       \
224     } while (0)
225
226 /**
227  * Returns the UTF-8 encoded version of the i3String.
228  *
229  */
230 const char *i3string_as_utf8(i3String *str);
231
232 /**
233  * Returns the UCS-2 encoded version of the i3String.
234  *
235  */
236 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
237
238 /**
239  * Returns the number of bytes (UTF-8 encoded) in an i3String.
240  *
241  */
242 size_t i3string_get_num_bytes(i3String *str);
243
244 /**
245  * Whether the given i3String is in Pango markup.
246  */
247 bool i3string_is_markup(i3String *str);
248
249 /**
250  * Set whether the i3String should use Pango markup.
251  */
252 void i3string_set_markup(i3String *str, bool pango_markup);
253
254 /**
255  * Escape pango markup characters in the given string.
256  */
257 i3String *i3string_escape_markup(i3String *str);
258
259 /**
260  * Returns the number of glyphs in an i3String.
261  *
262  */
263 size_t i3string_get_num_glyphs(i3String *str);
264
265 /**
266  * Connects to the i3 IPC socket and returns the file descriptor for the
267  * socket. die()s if anything goes wrong.
268  *
269  */
270 int ipc_connect(const char *socket_path);
271
272 /**
273  * Formats a message (payload) of the given size and type and sends it to i3 via
274  * the given socket file descriptor.
275  *
276  * Returns -1 when write() fails, errno will remain.
277  * Returns 0 on success.
278  *
279  */
280 int ipc_send_message(int sockfd, const uint32_t message_size,
281                      const uint32_t message_type, const uint8_t *payload);
282
283 /**
284  * Reads a message from the given socket file descriptor and stores its length
285  * (reply_length) as well as a pointer to its contents (reply).
286  *
287  * Returns -1 when read() fails, errno will remain.
288  * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
289  * message type, EOF instead of a message). Additionally, the error will be
290  * printed to stderr.
291  * Returns 0 on success.
292  *
293  */
294 int ipc_recv_message(int sockfd, uint32_t *message_type,
295                      uint32_t *reply_length, uint8_t **reply);
296
297 /**
298  * Generates a configure_notify event and sends it to the given window
299  * Applications need this to think they’ve configured themselves correctly.
300  * The truth is, however, that we will manage them.
301  *
302  */
303 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
304
305 /**
306  * Returns the colorpixel to use for the given hex color (think of HTML). Only
307  * works for true-color (vast majority of cases) at the moment, avoiding a
308  * roundtrip to X11.
309  *
310  * The hex_color has to start with #, for example #FF00FF.
311  *
312  * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
313  * This has to be done by the caller.
314  *
315  * NOTE that this function may in the future rely on a global xcb_connection_t
316  * variable called 'conn' to be present.
317  *
318  */
319 uint32_t get_colorpixel(const char *hex) __attribute__((const));
320
321 #if defined(__APPLE__)
322
323 /*
324  * Taken from FreeBSD
325  * Returns a pointer to a new string which is a duplicate of the
326  * string, but only copies at most n characters.
327  *
328  */
329 char *strndup(const char *str, size_t n);
330
331 #endif
332
333 /**
334  * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
335  * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
336  *
337  * This function initiates one round-trip. Use get_mod_mask_for() directly if
338  * you already have the modifier mapping and key symbols.
339  *
340  */
341 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
342
343 /**
344  * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
345  * example for XCB_NUM_LOCK (usually configured to mod2).
346  *
347  * This function does not initiate any round-trips.
348  *
349  */
350 uint32_t get_mod_mask_for(uint32_t keysym,
351                           xcb_key_symbols_t *symbols,
352                           xcb_get_modifier_mapping_reply_t *modmap_reply);
353
354 /**
355  * Loads a font for usage, also getting its height. If fallback is true,
356  * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any
357  * font was previously loaded, it will be freed.
358  *
359  */
360 i3Font load_font(const char *pattern, const bool fallback);
361
362 /**
363  * Defines the font to be used for the forthcoming calls.
364  *
365  */
366 void set_font(i3Font *font);
367
368 /**
369  * Frees the resources taken by the current font. If no font was previously
370  * loaded, it simply returns.
371  *
372  */
373 void free_font(void);
374
375 /**
376  * Converts the given string to UTF-8 from UCS-2 big endian. The return value
377  * must be freed after use.
378  *
379  */
380 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
381
382 /**
383  * Converts the given string to UCS-2 big endian for use with
384  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
385  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
386  * returned. It has to be freed when done.
387  *
388  */
389 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
390
391 /* Represents a color split by color channel. */
392 typedef struct color_t {
393     double red;
394     double green;
395     double blue;
396     double alpha;
397
398     /* The colorpixel we use for direct XCB calls. */
399     uint32_t colorpixel;
400 } color_t;
401
402 #define COLOR_TRANSPARENT ((color_t){.red = 0.0, .green = 0.0, .blue = 0.0, .colorpixel = 0})
403
404 /**
405  * Defines the colors to be used for the forthcoming draw_text calls.
406  *
407  */
408 void set_font_colors(xcb_gcontext_t gc, color_t foreground, color_t background);
409
410 /**
411  * Returns true if and only if the current font is a pango font.
412  *
413  */
414 bool font_is_pango(void);
415
416 /**
417  * Draws text onto the specified X drawable (normally a pixmap) at the
418  * specified coordinates (from the top left corner of the leftmost, uppermost
419  * glyph) and using the provided gc.
420  *
421  * Text must be specified as an i3String.
422  *
423  */
424 void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
425                xcb_visualtype_t *visual, int x, int y, int max_width);
426
427 /**
428  * ASCII version of draw_text to print static strings.
429  *
430  */
431 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
432                      xcb_gcontext_t gc, int x, int y, int max_width);
433
434 /**
435  * Predict the text width in pixels for the given text. Text must be
436  * specified as an i3String.
437  *
438  */
439 int predict_text_width(i3String *text);
440
441 /**
442  * Returns the visual type associated with the given screen.
443  *
444  */
445 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
446
447 /**
448  * Returns true if this version of i3 is a debug build (anything which is not a
449  * release version), based on the git version number.
450  *
451  */
452 bool is_debug_build() __attribute__((const));
453
454 /**
455  * Returns the name of a temporary file with the specified prefix.
456  *
457  */
458 char *get_process_filename(const char *prefix);
459
460 /**
461  * This function returns the absolute path to the executable it is running in.
462  *
463  * The implementation follows http://stackoverflow.com/a/933996/712014
464  *
465  * Returned value must be freed by the caller.
466  */
467 char *get_exe_path(const char *argv0);
468
469 /**
470  * Initialize the DPI setting.
471  * This will use the 'Xft.dpi' X resource if available and fall back to
472  * guessing the correct value otherwise.
473  */
474 void init_dpi(void);
475
476 /**
477  * This function returns the value of the DPI setting.
478  *
479  */
480 long get_dpi_value(void);
481
482 /**
483  * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
484  * screen) to a corresponding amount of physical pixels on a standard or retina
485  * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
486  *
487  */
488 int logical_px(const int logical);
489
490 /**
491  * This function resolves ~ in pathnames.
492  * It may resolve wildcards in the first part of the path, but if no match
493  * or multiple matches are found, it just returns a copy of path as given.
494  *
495  */
496 char *resolve_tilde(const char *path);
497
498 /**
499  * Get the path of the first configuration file found. If override_configpath
500  * is specified, that path is returned and saved for further calls. Otherwise,
501  * checks the home directory first, then the system directory first, always
502  * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
503  * $XDG_CONFIG_DIRS)
504  *
505  */
506 char *get_config_path(const char *override_configpath, bool use_system_paths);
507
508 #if !defined(__sun)
509 /**
510  * Emulates mkdir -p (creates any missing folders)
511  *
512  */
513 int mkdirp(const char *path, mode_t mode);
514 #endif
515
516 /** Helper structure for usage in format_placeholders(). */
517 typedef struct placeholder_t {
518     /* The placeholder to be replaced, e.g., "%title". */
519     char *name;
520     /* The value this placeholder should be replaced with. */
521     char *value;
522 } placeholder_t;
523
524 /**
525  * Replaces occurrences of the defined placeholders in the format string.
526  *
527  */
528 char *format_placeholders(char *format, placeholder_t *placeholders, int num);
529
530 /* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
531  * and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
532 #define CAIRO_SURFACE_FLUSH(surface)  \
533     do {                              \
534         cairo_surface_flush(surface); \
535         cairo_surface_flush(surface); \
536     } while (0)
537
538 /* A wrapper grouping an XCB drawable and both a graphics context
539  * and the corresponding cairo objects representing it. */
540 typedef struct surface_t {
541     /* The drawable which is being represented. */
542     xcb_drawable_t id;
543
544     /* A classic XCB graphics context. */
545     xcb_gcontext_t gc;
546
547     xcb_visualtype_t *visual_type;
548
549     int width;
550     int height;
551
552     /* A cairo surface representing the drawable. */
553     cairo_surface_t *surface;
554
555     /* The cairo object representing the drawable. In general,
556      * this is what one should use for any drawing operation. */
557     cairo_t *cr;
558 } surface_t;
559
560 /**
561  * Initialize the surface to represent the given drawable.
562  *
563  */
564 void draw_util_surface_init(xcb_connection_t *conn, surface_t *surface, xcb_drawable_t drawable,
565                             xcb_visualtype_t *visual, int width, int height);
566
567 /**
568  * Resize the surface to the given size.
569  *
570  */
571 void draw_util_surface_set_size(surface_t *surface, int width, int height);
572
573 /**
574  * Destroys the surface.
575  *
576  */
577 void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface);
578
579 /**
580  * Parses the given color in hex format to an internal color representation.
581  * Note that the input must begin with a hash sign, e.g., "#3fbc59".
582  *
583  */
584 color_t draw_util_hex_to_color(const char *color);
585
586 /**
587  * Draw the given text using libi3.
588  * This function also marks the surface dirty which is needed if other means of
589  * drawing are used. This will be the case when using XCB to draw text.
590  *
591  */
592 void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
593
594 /**
595  * Draws a filled rectangle.
596  * This function is a convenience wrapper and takes care of flushing the
597  * surface as well as restoring the cairo state.
598  *
599  */
600 void draw_util_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h);
601
602 /**
603  * Clears a surface with the given color.
604  *
605  */
606 void draw_util_clear_surface(surface_t *surface, color_t color);
607
608 /**
609  * Copies a surface onto another surface.
610  *
611  */
612 void draw_util_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y,
613                             double dest_x, double dest_y, double width, double height);