libi3.h

Go to the documentation of this file.

/*
 * vim:ts=4:sw=4:expandtab
 *
 * i3 - an improved dynamic tiling window manager
 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
 *
 * libi3: contains functions which are used by i3 *and* accompanying tools such
 * as i3-msg, i3-config-wizard, …
 *
 */
#pragma once
 
#include <config.h>
 
#include <stdbool.h>
#include <stdarg.h>
#include <stdio.h>
#include <xcb/xcb.h>
#include <xcb/xproto.h>
#include <xcb/xcb_keysyms.h>
 
#include <pango/pango.h>
#include <cairo/cairo-xcb.h>
 
#define DEFAULT_DIR_MODE (S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
 
#define XCB_BUTTON_CLICK_LEFT XCB_BUTTON_INDEX_1
#define XCB_BUTTON_CLICK_MIDDLE XCB_BUTTON_INDEX_2
#define XCB_BUTTON_CLICK_RIGHT XCB_BUTTON_INDEX_3
#define XCB_BUTTON_SCROLL_UP XCB_BUTTON_INDEX_4
#define XCB_BUTTON_SCROLL_DOWN XCB_BUTTON_INDEX_5
/* xcb doesn't define constants for these. */
#define XCB_BUTTON_SCROLL_LEFT 6
#define XCB_BUTTON_SCROLL_RIGHT 7
 
extern xcb_connection_t *conn;
extern xcb_screen_t *root_screen;
 
typedef struct _i3String i3String;
 
typedef struct Font i3Font;
 
struct Font {
    enum {
        FONT_TYPE_NONE = 0,
        FONT_TYPE_XCB,
        FONT_TYPE_PANGO
    } type;
 
    int height;
 
    char *pattern;
 
    union {
        struct {
            xcb_font_t id;
 
            xcb_query_font_reply_t *info;
 
            xcb_charinfo_t *table;
        } xcb;
 
        PangoFontDescription *pango_desc;
    } specific;
};
 
/* Since this file also gets included by utilities which don’t use the i3 log
 * infrastructure, we define a fallback. */
#if !defined(LOG)
void verboselog(char *fmt, ...)
    __attribute__((format(printf, 1, 2)));
#define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
#endif
#if !defined(ELOG)
void errorlog(char *fmt, ...)
    __attribute__((format(printf, 1, 2)));
#define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
#endif
#if !defined(DLOG)
void debuglog(char *fmt, ...)
    __attribute__((format(printf, 1, 2)));
#define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, STRIPPED__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
#endif
 
char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
 
void *smalloc(size_t size);
 
void *scalloc(size_t num, size_t size);
 
void *srealloc(void *ptr, size_t size);
 
char *sstrdup(const char *str);
 
char *sstrndup(const char *str, size_t size);
 
int sasprintf(char **strp, const char *fmt, ...);
 
ssize_t writeall(int fd, const void *buf, size_t count);
 
ssize_t writeall_nonblock(int fd, const void *buf, size_t count);
 
ssize_t swrite(int fd, const void *buf, size_t count);
 
i3String *i3string_from_utf8(const char *from_utf8);
 
i3String *i3string_from_markup(const char *from_markup);
 
i3String *i3string_from_utf8_with_length(const char *from_utf8, ssize_t num_bytes);
 
i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
 
i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
 
i3String *i3string_copy(i3String *str);
 
void i3string_free(i3String *str);
 
#define I3STRING_FREE(str)      \
    do {                        \
        if (str != NULL) {      \
            i3string_free(str); \
            str = NULL;         \
        }                       \
    } while (0)
 
const char *i3string_as_utf8(i3String *str);
 
const xcb_char2b_t *i3string_as_ucs2(i3String *str);
 
size_t i3string_get_num_bytes(i3String *str);
 
bool i3string_is_markup(i3String *str);
 
void i3string_set_markup(i3String *str, bool pango_markup);
 
i3String *i3string_escape_markup(i3String *str);
 
size_t i3string_get_num_glyphs(i3String *str);
 
int ipc_connect(const char *socket_path);
 
int ipc_send_message(int sockfd, const uint32_t message_size,
                     const uint32_t message_type, const uint8_t *payload);
 
int ipc_recv_message(int sockfd, uint32_t *message_type,
                     uint32_t *reply_length, uint8_t **reply);
 
void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
 
#define HAS_G_UTF8_MAKE_VALID GLIB_CHECK_VERSION(2, 52, 0)
#if !HAS_G_UTF8_MAKE_VALID
gchar *g_utf8_make_valid(const gchar *str, gssize len);
#endif
 
uint32_t get_colorpixel(const char *hex) __attribute__((const));
 
#ifndef HAVE_strndup
 
char *strndup(const char *str, size_t n);
#endif
 
uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
 
uint32_t get_mod_mask_for(uint32_t keysym,
                          xcb_key_symbols_t *symbols,
                          xcb_get_modifier_mapping_reply_t *modmap_reply);
 
i3Font load_font(const char *pattern, const bool fallback);
 
void set_font(i3Font *font);
 
void free_font(void);
 
char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
 
xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
 
/* Represents a color split by color channel. */
typedef struct color_t {
    double red;
    double green;
    double blue;
    double alpha;
 
    /* The colorpixel we use for direct XCB calls. */
    uint32_t colorpixel;
} color_t;
 
#define COLOR_TRANSPARENT ((color_t){.red = 0.0, .green = 0.0, .blue = 0.0, .colorpixel = 0})
 
void set_font_colors(xcb_gcontext_t gc, color_t foreground, color_t background);
 
bool font_is_pango(void);
 
void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
               xcb_visualtype_t *visual, int x, int y, int max_width);
 
void draw_text_ascii(const char *text, xcb_drawable_t drawable,
                     xcb_gcontext_t gc, int x, int y, int max_width);
 
int predict_text_width(i3String *text);
 
xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
 
bool is_debug_build(void) __attribute__((const));
 
char *get_process_filename(const char *prefix);
 
char *get_exe_path(const char *argv0);
 
void init_dpi(void);
 
long get_dpi_value(void);
 
int logical_px(const int logical);
 
char *resolve_tilde(const char *path);
 
char *get_config_path(const char *override_configpath, bool use_system_paths);
 
#ifndef HAVE_mkdirp
 
int mkdirp(const char *path, mode_t mode);
#endif
 
typedef struct placeholder_t {
    /* The placeholder to be replaced, e.g., "%title". */
    char *name;
    /* The value this placeholder should be replaced with. */
    char *value;
} placeholder_t;
 
char *format_placeholders(char *format, placeholder_t *placeholders, int num);
 
/* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
 * and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
#define CAIRO_SURFACE_FLUSH(surface)  \
    do {                              \
        cairo_surface_flush(surface); \
        cairo_surface_flush(surface); \
    } while (0)
 
/* A wrapper grouping an XCB drawable and both a graphics context
 * and the corresponding cairo objects representing it. */
typedef struct surface_t {
    /* The drawable which is being represented. */
    xcb_drawable_t id;
 
    /* A classic XCB graphics context. */
    xcb_gcontext_t gc;
 
    xcb_visualtype_t *visual_type;
 
    int width;
    int height;
 
    /* A cairo surface representing the drawable. */
    cairo_surface_t *surface;
 
    /* The cairo object representing the drawable. In general,
     * this is what one should use for any drawing operation. */
    cairo_t *cr;
} surface_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);
 
void draw_util_surface_set_size(surface_t *surface, int width, int height);
 
void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface);
 
color_t draw_util_hex_to_color(const char *color);
 
void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
 
void draw_util_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h);
 
void draw_util_clear_surface(surface_t *surface, color_t color);
 
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);