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