i3
libi3.h
Go to the documentation of this file.
1/*
2 * vim:ts=4:sw=4:expandtab
3 *
4 * i3 - an improved 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 <sys/stat.h>
19#include <xcb/xcb.h>
20#include <xcb/xproto.h>
21#include <xcb/xcb_keysyms.h>
22
23#include <pango/pango.h>
24#include <cairo/cairo-xcb.h>
25
26#define DEFAULT_DIR_MODE (S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
27
29#define XCB_BUTTON_CLICK_LEFT XCB_BUTTON_INDEX_1
30#define XCB_BUTTON_CLICK_MIDDLE XCB_BUTTON_INDEX_2
31#define XCB_BUTTON_CLICK_RIGHT XCB_BUTTON_INDEX_3
32#define XCB_BUTTON_SCROLL_UP XCB_BUTTON_INDEX_4
33#define XCB_BUTTON_SCROLL_DOWN XCB_BUTTON_INDEX_5
34/* xcb doesn't define constants for these. */
35#define XCB_BUTTON_SCROLL_LEFT 6
36#define XCB_BUTTON_SCROLL_RIGHT 7
37
42extern xcb_connection_t *conn;
43extern xcb_screen_t *root_screen;
44
49typedef struct _i3String i3String;
50
51typedef struct Font i3Font;
52
59struct Font {
61 enum {
66
68 int height;
69
71 char *pattern;
72
73 union {
74 struct {
76 xcb_font_t id;
77
79 xcb_query_font_reply_t *info;
80
82 xcb_charinfo_t *table;
83 } xcb;
84
86 PangoFontDescription *pango_desc;
88};
89
90/* Since this file also gets included by utilities which don’t use the i3 log
91 * infrastructure, we define a fallback. */
92#if !defined(LOG)
93void verboselog(char *fmt, ...)
94 __attribute__((format(printf, 1, 2)));
95#define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
96#endif
97#if !defined(ELOG)
98void errorlog(char *fmt, ...)
99 __attribute__((format(printf, 1, 2)));
100#define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
101#endif
102#if !defined(DLOG)
103void debuglog(char *fmt, ...)
104 __attribute__((format(printf, 1, 2)));
105#define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
106#endif
107
119char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
120
126void *smalloc(size_t size);
127
133void *scalloc(size_t num, size_t size);
134
140void *srealloc(void *ptr, size_t size);
141
147char *sstrdup(const char *str);
148
154char *sstrndup(const char *str, size_t size);
155
161int sasprintf(char **strp, const char *fmt, ...);
162
168ssize_t writeall(int fd, const void *buf, size_t count);
169
176ssize_t writeall_nonblock(int fd, const void *buf, size_t count);
177
183ssize_t swrite(int fd, const void *buf, size_t count);
184
189int strcasecmp_nullable(const char *a, const char *b);
190
196i3String *i3string_from_utf8(const char *from_utf8);
197
202i3String *i3string_from_markup(const char *from_markup);
203
210i3String *i3string_from_utf8_with_length(const char *from_utf8, ssize_t num_bytes);
211
217i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
218
224i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
225
231
237
243#define I3STRING_FREE(str) \
244 do { \
245 if (str != NULL) { \
246 i3string_free(str); \
247 str = NULL; \
248 } \
249 } while (0)
250
255const char *i3string_as_utf8(i3String *str);
256
261const xcb_char2b_t *i3string_as_ucs2(i3String *str);
262
268
273
277void i3string_set_markup(i3String *str, bool pango_markup);
278
283
289
295int ipc_connect(const char *socket_path);
296
301int ipc_connect_impl(const char *socket_path);
302
311int ipc_send_message(int sockfd, const uint32_t message_size,
312 const uint32_t message_type, const uint8_t *payload);
313
325int ipc_recv_message(int sockfd, uint32_t *message_type,
326 uint32_t *reply_length, uint8_t **reply);
327
334void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
335
336#define HAS_G_UTF8_MAKE_VALID GLIB_CHECK_VERSION(2, 52, 0)
337#if !HAS_G_UTF8_MAKE_VALID
338gchar *g_utf8_make_valid(const gchar *str, gssize len);
339#endif
340
355uint32_t get_colorpixel(const char *hex) __attribute__((const));
356
357#ifndef HAVE_STRNDUP
364char *strndup(const char *str, size_t n);
365#endif
366
375uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
376
384uint32_t get_mod_mask_for(uint32_t keysym,
385 xcb_key_symbols_t *symbols,
386 xcb_get_modifier_mapping_reply_t *modmap_reply);
387
394i3Font load_font(const char *pattern, const bool fallback);
395
400void set_font(i3Font *font);
401
407void free_font(void);
408
414char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
415
423xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
424
425/* Represents a color split by color channel. */
426typedef struct color_t {
427 double red;
428 double green;
429 double blue;
430 double alpha;
431
432 /* The colorpixel we use for direct XCB calls. */
433 uint32_t colorpixel;
435
436#define COLOR_TRANSPARENT ((color_t){.red = 0.0, .green = 0.0, .blue = 0.0, .colorpixel = 0})
437
442void set_font_colors(xcb_gcontext_t gc, color_t foreground, color_t background);
443
448bool font_is_pango(void);
449
460void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
461 cairo_surface_t *surface, int x, int y, int max_width);
462
469
474xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
475
481bool is_debug_build(void) __attribute__((const));
482
487char *get_process_filename(const char *prefix);
488
496char *get_exe_path(const char *argv0);
497
503void init_dpi(void);
504
509long get_dpi_value(void);
510
517int logical_px(const int logical);
518
525char *resolve_tilde(const char *path);
526
535char *get_config_path(const char *override_configpath, bool use_system_paths);
536
537#ifndef HAVE_MKDIRP
542int mkdirp(const char *path, mode_t mode);
543#endif
544
546typedef struct placeholder_t {
547 /* The placeholder to be replaced, e.g., "%title". */
548 const char *name;
549 /* The value this placeholder should be replaced with. */
550 const char *value;
552
557char *format_placeholders(char *format, placeholder_t *placeholders, int num);
558
559/* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
560 * and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
561#define CAIRO_SURFACE_FLUSH(surface) \
562 do { \
563 cairo_surface_flush(surface); \
564 cairo_surface_flush(surface); \
565 } while (0)
566
567/* A wrapper grouping an XCB drawable and both a graphics context
568 * and the corresponding cairo objects representing it. */
569typedef struct surface_t {
570 /* The drawable which is being represented. */
571 xcb_drawable_t id;
572
573 /* A classic XCB graphics context. */
574 xcb_gcontext_t gc;
576
577 int width;
579
580 /* A cairo surface representing the drawable. */
581 cairo_surface_t *surface;
582
583 /* The cairo object representing the drawable. In general,
584 * this is what one should use for any drawing operation. */
585 cairo_t *cr;
587
592void draw_util_surface_init(xcb_connection_t *conn, surface_t *surface, xcb_drawable_t drawable,
593 xcb_visualtype_t *visual, int width, int height);
594
599void draw_util_surface_set_size(surface_t *surface, int width, int height);
600
605void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface);
606
613
620void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
621
625void draw_util_image(cairo_surface_t *image, surface_t *surface, int x, int y, int width, int height);
626
633void draw_util_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h);
634
640
645void draw_util_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y,
646 double dest_x, double dest_y, double width, double height);
647
654void set_nonblock(int sockfd);
655
664int create_socket(const char *filename, char **out_socketpath);
665
670bool path_exists(const char *path);
671
675void set_screenshot_as_wallpaper(xcb_connection_t *conn, xcb_screen_t *screen);
676
683bool is_background_set(xcb_connection_t *conn, xcb_screen_t *screen);
684
689bool boolstr(const char *str);
690
695uint16_t get_visual_depth(xcb_visualid_t visual_id);
#define y(x,...)
Definition commands.c:18
__attribute__((pure))
Definition util.c:67
xcb_visualid_t visual_id
void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc, cairo_surface_t *surface, int x, int y, int max_width)
Draws text onto the specified X drawable (normally a pixmap) at the specified coordinates (from the t...
void draw_util_surface_init(xcb_connection_t *conn, surface_t *surface, xcb_drawable_t drawable, xcb_visualtype_t *visual, int width, int height)
Initialize the surface to represent the given drawable.
struct _i3String i3String
Opaque data structure for storing strings.
Definition libi3.h:49
void draw_util_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y, double dest_x, double dest_y, double width, double height)
Copies a surface onto another surface.
void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width)
Draw the given text using libi3.
int logical_px(const int logical)
Convert a logical amount of pixels (e.g.
char * resolve_tilde(const char *path)
This function resolves ~ in pathnames.
ssize_t writeall_nonblock(int fd, const void *buf, size_t count)
Like writeall, but instead of retrying upon EAGAIN (returned when a write would block),...
void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface)
Destroys the surface.
uint32_t get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols, xcb_get_modifier_mapping_reply_t *modmap_reply)
Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for example for XCB_NUM_LOCK (usu...
xcb_connection_t * conn
XCB connection and root screen.
Definition main.c:54
ssize_t writeall(int fd, const void *buf, size_t count)
Wrapper around correct write which returns -1 (meaning that write failed) or count (meaning that all ...
void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width)
Generates a configure_notify event and sends it to the given window Applications need this to think t...
void set_screenshot_as_wallpaper(xcb_connection_t *conn, xcb_screen_t *screen)
Grab a screenshot of the screen's root window and set it as the wallpaper.
struct surface_t surface_t
int strcasecmp_nullable(const char *a, const char *b)
Like strcasecmp but considers the case where either string is NULL.
char * strndup(const char *str, size_t n)
Taken from FreeBSD Returns a pointer to a new string which is a duplicate of the string,...
int create_socket(const char *filename, char **out_socketpath)
Creates the UNIX domain socket at the given path, sets it to non-blocking mode, bind()s and listen()s...
ssize_t swrite(int fd, const void *buf, size_t count)
Safe-wrapper around writeall which exits if it returns -1 (meaning that write failed)
void set_nonblock(int sockfd)
Puts the given socket file descriptor into non-blocking mode or dies if setting O_NONBLOCK failed.
i3String * i3string_copy(i3String *str)
Copies the given i3string.
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
char * format_placeholders(char *format, placeholder_t *placeholders, int num)
Replaces occurrences of the defined placeholders in the format string.
void i3string_free(i3String *str)
Free an i3String.
i3String * i3string_from_utf8_with_length(const char *from_utf8, ssize_t num_bytes)
Build an i3String from an UTF-8 encoded string with fixed length.
size_t i3string_get_num_glyphs(i3String *str)
Returns the number of glyphs in an i3String.
const char * i3string_as_utf8(i3String *str)
Returns the UTF-8 encoded version of the i3String.
char * get_exe_path(const char *argv0)
This function returns the absolute path to the executable it is running in.
int ipc_recv_message(int sockfd, uint32_t *message_type, uint32_t *reply_length, uint8_t **reply)
Reads a message from the given socket file descriptor and stores its length (reply_length) as well as...
uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols)
All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol,...
void * scalloc(size_t num, size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
color_t draw_util_hex_to_color(const char *color)
Parses the given color in hex format to an internal color representation.
char * get_config_path(const char *override_configpath, bool use_system_paths)
Get the path of the first configuration file found.
char * convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs)
Converts the given string to UTF-8 from UCS-2 big endian.
long get_dpi_value(void)
This function returns the value of the DPI setting.
bool path_exists(const char *path)
Checks if the given path exists by calling stat().
xcb_screen_t * root_screen
Definition main.c:66
i3String * i3string_escape_markup(i3String *str)
Escape pango markup characters in the given string.
const xcb_char2b_t * i3string_as_ucs2(i3String *str)
Returns the UCS-2 encoded version of the i3String.
int sasprintf(char **strp, const char *fmt,...)
Safe-wrapper around asprintf which exits if it returns -1 (meaning that there is no more memory avail...
size_t i3string_get_num_bytes(i3String *str)
Returns the number of bytes (UTF-8 encoded) in an i3String.
char * sstrndup(const char *str, size_t size)
Safe-wrapper around strndup which exits if strndup returns NULL (meaning that there is no more memory...
i3String * i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs)
Build an i3String from an UCS-2 encoded string.
xcb_char2b_t * convert_utf8_to_ucs2(char *input, size_t *real_strlen)
Converts the given string to UCS-2 big endian for use with xcb_image_text_16().
void * srealloc(void *ptr, size_t size)
Safe-wrapper around realloc which exits if realloc returns NULL (meaning that there is no more memory...
i3String * i3string_from_markup_with_length(const char *from_markup, size_t num_bytes)
Build an i3String from an UTF-8 encoded string in Pango markup with fixed length.
bool boolstr(const char *str)
Reports whether str represents the enabled state (1, yes, true, …).
void i3string_set_markup(i3String *str, bool pango_markup)
Set whether the i3String should use Pango markup.
void draw_util_image(cairo_surface_t *image, surface_t *surface, int x, int y, int width, int height)
Draw the given image using libi3.
struct color_t color_t
gchar * g_utf8_make_valid(const gchar *str, gssize len)
struct placeholder_t placeholder_t
Helper structure for usage in format_placeholders().
char * root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen)
Try to get the contents of the given atom (for example I3_SOCKET_PATH) from the X11 root window and r...
uint32_t get_colorpixel(const char *hex) __attribute__((const))
Returns the colorpixel to use for the given hex color (think of HTML).
bool i3string_is_markup(i3String *str)
Whether the given i3String is in Pango markup.
char * get_process_filename(const char *prefix)
Returns the name of a temporary file with the specified prefix.
int mkdirp(const char *path, mode_t mode)
Emulates mkdir -p (creates any missing folders)
int ipc_connect(const char *socket_path)
Connects to the i3 IPC socket and returns the file descriptor for the socket.
int ipc_send_message(int sockfd, const uint32_t message_size, const uint32_t message_type, const uint8_t *payload)
Formats a message (payload) of the given size and type and sends it to i3 via the given socket file d...
void errorlog(char *fmt,...) __attribute__((format(printf
void set_font(i3Font *font)
Defines the font to be used for the forthcoming calls.
void debuglog(char *fmt,...) __attribute__((format(printf
void draw_util_surface_set_size(surface_t *surface, int width, int height)
Resize the surface to the given size.
i3Font load_font(const char *pattern, const bool fallback)
Loads a font for usage, also getting its height.
bool is_background_set(xcb_connection_t *conn, xcb_screen_t *screen)
Test whether the screen's root window has a background set.
bool is_debug_build(void) __attribute__((const))
Returns true if this version of i3 is a debug build (anything which is not a release version),...
void draw_util_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h)
Draws a filled rectangle.
uint16_t get_visual_depth(xcb_visualid_t visual_id)
Get depth of visual specified by visualid.
i3String * i3string_from_utf8(const char *from_utf8)
Build an i3String from an UTF-8 encoded string.
void init_dpi(void)
Initialize the DPI setting.
void set_font_colors(xcb_gcontext_t gc, color_t foreground, color_t background)
Defines the colors to be used for the forthcoming draw_text calls.
void verboselog(char *fmt,...) __attribute__((format(printf
int predict_text_width(i3String *text)
Predict the text width in pixels for the given text.
void draw_util_clear_surface(surface_t *surface, color_t color)
Clears a surface with the given color.
void free_font(void)
Frees the resources taken by the current font.
xcb_visualtype_t * get_visualtype(xcb_screen_t *screen)
Returns the visual type associated with the given screen.
i3String * i3string_from_markup(const char *from_markup)
Build an i3String from an UTF-8 encoded string in Pango markup.
bool font_is_pango(void)
Returns true if and only if the current font is a pango font.
int ipc_connect_impl(const char *socket_path)
Connects to the socket at the given path with no fallback paths.
void * smalloc(size_t size)
Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there is no more memory a...
Data structure for cached font information:
Definition libi3.h:59
xcb_charinfo_t * table
Font table for this font (may be NULL)
Definition libi3.h:82
char * pattern
The pattern/name used to load the font.
Definition libi3.h:71
xcb_font_t id
The xcb-id for the font.
Definition libi3.h:76
union Font::@22 specific
xcb_query_font_reply_t * info
Font information gathered from the server.
Definition libi3.h:79
enum Font::@21 type
The type of font.
PangoFontDescription * pango_desc
The pango font description.
Definition libi3.h:86
int height
The height of the font, built from font_ascent + font_descent.
Definition libi3.h:68
struct Font::@22::@23 xcb
@ FONT_TYPE_XCB
Definition libi3.h:63
@ FONT_TYPE_NONE
Definition libi3.h:62
@ FONT_TYPE_PANGO
Definition libi3.h:64
double red
Definition libi3.h:427
double blue
Definition libi3.h:429
double green
Definition libi3.h:428
uint32_t colorpixel
Definition libi3.h:433
double alpha
Definition libi3.h:430
Helper structure for usage in format_placeholders().
Definition libi3.h:546
const char * value
Definition libi3.h:550
const char * name
Definition libi3.h:548
int height
Definition libi3.h:578
cairo_surface_t * surface
Definition libi3.h:581
xcb_gcontext_t gc
Definition libi3.h:574
int width
Definition libi3.h:577
bool owns_gc
Definition libi3.h:575
cairo_t * cr
Definition libi3.h:585
xcb_drawable_t id
Definition libi3.h:571