X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=include%2Flibi3.h;h=3a1258273b912847ccc429adafbaba28b86cbd82;hb=42515308e72e4ea6f6b49508c1ba286263dded64;hp=7547845b9bf2245a97242badd9bcd6d7c9ff8e7f;hpb=cd2a1267c8de435219d3808a71b7a09288ad3585;p=i3%2Fi3 diff --git a/include/libi3.h b/include/libi3.h index 7547845b..3a125827 100644 --- a/include/libi3.h +++ b/include/libi3.h @@ -2,14 +2,13 @@ * vim:ts=4:sw=4:expandtab * * i3 - an improved dynamic tiling window manager - * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE) + * © 2009-2013 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, … * */ -#ifndef I3_LIBI3_H -#define I3_LIBI3_H +#pragma once #include #include @@ -47,6 +46,9 @@ struct Font { /** The height of the font, built from font_ascent + font_descent */ int height; + /** The pattern/name used to load the font. */ + char *pattern; + union { struct { /** The xcb-id for the font */ @@ -69,23 +71,33 @@ struct Font { /* 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, ...); +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, ...); +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, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__) +#endif /** * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from * the X11 root window and return NULL if it doesn’t work. * + * If the provided XCB connection is NULL, a new connection will be + * established. + * * The memory for the contents is dynamically allocated and has to be * free()d by the caller. * */ -char *root_atom_contents(const char *atomname); +char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen); /** * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that @@ -122,6 +134,20 @@ char *sstrdup(const char *str); */ int sasprintf(char **strp, const char *fmt, ...); +/** + * Wrapper around correct write which returns -1 (meaning that + * write failed) or count (meaning that all bytes were written) + * + */ +ssize_t writeall(int fd, const void *buf, size_t count); + +/** + * Safe-wrapper around writeall which exits if it returns -1 (meaning that + * write failed) + * + */ +ssize_t swrite(int fd, const void *buf, size_t count); + /** * Build an i3String from an UTF-8 encoded string. * Returns the newly-allocated i3String. @@ -129,6 +155,12 @@ int sasprintf(char **strp, const char *fmt, ...); */ i3String *i3string_from_utf8(const char *from_utf8); +/** + * Build an i3String from an UTF-8 encoded string in Pango markup. + * + */ +i3String *i3string_from_markup(const char *from_markup); + /** * Build an i3String from an UTF-8 encoded string with fixed length. * To be used when no proper NUL-terminaison is available. @@ -137,6 +169,13 @@ i3String *i3string_from_utf8(const char *from_utf8); */ i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes); +/** + * Build an i3String from an UTF-8 encoded string in Pango markup with fixed + * length. + * + */ +i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes); + /** * Build an i3String from an UCS-2 encoded string. * Returns the newly-allocated i3String. @@ -144,6 +183,12 @@ i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes */ i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs); +/** + * Copies the given i3string. + * Note that this will not free the source string. + */ +i3String *i3string_copy(i3String *str); + /** * Free an i3String. * @@ -155,13 +200,13 @@ void i3string_free(i3String *str); * to prevent accidentally using freed memory. * */ -#define I3STRING_FREE(str) \ -do { \ - if (str != NULL) { \ - i3string_free(str); \ - str = NULL; \ - } \ -} while (0) +#define I3STRING_FREE(str) \ + do { \ + if (str != NULL) { \ + i3string_free(str); \ + str = NULL; \ + } \ + } while (0) /** * Returns the UTF-8 encoded version of the i3String. @@ -181,6 +226,16 @@ const xcb_char2b_t *i3string_as_ucs2(i3String *str); */ size_t i3string_get_num_bytes(i3String *str); +/** + * Whether the given i3String is in Pango markup. + */ +bool i3string_is_markup(i3String *str); + +/** + * Set whether the i3String should use Pango markup. + */ +void i3string_set_markup(i3String *str, bool is_markup); + /** * Returns the number of glyphs in an i3String. * @@ -202,8 +257,8 @@ int ipc_connect(const char *socket_path); * Returns 0 on success. * */ -int ipc_send_message(int sockfd, uint32_t message_size, - uint32_t message_type, const uint8_t *payload); +int ipc_send_message(int sockfd, const uint32_t message_size, + const uint32_t message_type, const uint8_t *payload); /** * Reads a message from the given socket file descriptor and stores its length @@ -216,7 +271,7 @@ int ipc_send_message(int sockfd, uint32_t message_size, * Returns 0 on success. * */ -int ipc_recv_message(int sockfd, uint32_t message_type, +int ipc_recv_message(int sockfd, uint32_t *message_type, uint32_t *reply_length, uint8_t **reply); /** @@ -273,12 +328,13 @@ 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); + xcb_key_symbols_t *symbols, + xcb_get_modifier_mapping_reply_t *modmap_reply); /** * Loads a font for usage, also getting its height. If fallback is true, - * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. + * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any + * font was previously loaded, it will be freed. * */ i3Font load_font(const char *pattern, const bool fallback); @@ -290,7 +346,8 @@ i3Font load_font(const char *pattern, const bool fallback); void set_font(i3Font *font); /** - * Frees the resources taken by the current font. + * Frees the resources taken by the current font. If no font was previously + * loaded, it simply returns. * */ void free_font(void); @@ -326,14 +383,14 @@ void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background * */ void draw_text(i3String *text, xcb_drawable_t drawable, - xcb_gcontext_t gc, int x, int y, int max_width); + xcb_gcontext_t gc, int x, int y, int max_width); /** * ASCII version of draw_text to print static strings. * */ void draw_text_ascii(const char *text, xcb_drawable_t drawable, - xcb_gcontext_t gc, int x, int y, int max_width); + xcb_gcontext_t gc, int x, int y, int max_width); /** * Predict the text width in pixels for the given text. Text must be @@ -355,4 +412,25 @@ xcb_visualtype_t *get_visualtype(xcb_screen_t *screen); */ bool is_debug_build() __attribute__((const)); -#endif +/** + * Returns the name of a temporary file with the specified prefix. + * + */ +char *get_process_filename(const char *prefix); + +/** + * This function returns the absolute path to the executable it is running in. + * + * The implementation follows http://stackoverflow.com/a/933996/712014 + * + * Returned value must be freed by the caller. + */ +char *get_exe_path(const char *argv0); + +/** + * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI + * screen) to a corresponding amount of physical pixels on a standard or retina + * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen. + * + */ +int logical_px(const int logical);