i3
libi3.h
Go to the documentation of this file.
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009-2013 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 #ifndef I3_LIBI3_H
12 #define I3_LIBI3_H
13 
14 #include <stdbool.h>
15 #include <stdarg.h>
16 #include <stdio.h>
17 #include <xcb/xcb.h>
18 #include <xcb/xproto.h>
19 #include <xcb/xcb_keysyms.h>
20 
21 #if PANGO_SUPPORT
22 #include <pango/pango.h>
23 #endif
24 
29 typedef struct _i3String i3String;
30 
31 typedef struct Font i3Font;
32 
39 struct Font {
41  enum {
45  } type;
46 
48  int height;
49 
51  char *pattern;
52 
53  union {
54  struct {
56  xcb_font_t id;
57 
59  xcb_query_font_reply_t *info;
60 
62  xcb_charinfo_t *table;
63  } xcb;
64 
65 #if PANGO_SUPPORT
66 
67  PangoFontDescription *pango_desc;
68 #endif
69  } specific;
70 };
71 
72 /* Since this file also gets included by utilities which don’t use the i3 log
73  * infrastructure, we define a fallback. */
74 #if !defined(LOG)
75 void verboselog(char *fmt, ...);
76 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
77 #endif
78 #if !defined(ELOG)
79 void errorlog(char *fmt, ...);
80 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
81 #endif
82 
91 char *root_atom_contents(const char *atomname);
92 
98 void *smalloc(size_t size);
99 
105 void *scalloc(size_t size);
106 
112 void *srealloc(void *ptr, size_t size);
113 
119 char *sstrdup(const char *str);
120 
126 int sasprintf(char **strp, const char *fmt, ...);
127 
133 i3String *i3string_from_utf8(const char *from_utf8);
134 
141 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
142 
148 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
149 
154 void i3string_free(i3String *str);
155 
161 #define I3STRING_FREE(str) \
162 do { \
163  if (str != NULL) { \
164  i3string_free(str); \
165  str = NULL; \
166  } \
167 } while (0)
168 
173 const char *i3string_as_utf8(i3String *str);
174 
179 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
180 
185 size_t i3string_get_num_bytes(i3String *str);
186 
191 size_t i3string_get_num_glyphs(i3String *str);
192 
198 int ipc_connect(const char *socket_path);
199 
208 int ipc_send_message(int sockfd, const uint32_t message_size,
209  const uint32_t message_type, const uint8_t *payload);
210 
222 int ipc_recv_message(int sockfd, uint32_t *message_type,
223  uint32_t *reply_length, uint8_t **reply);
224 
231 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
232 
247 uint32_t get_colorpixel(const char *hex) __attribute__((const));
248 
249 #if defined(__APPLE__)
250 
251 /*
252  * Taken from FreeBSD
253  * Returns a pointer to a new string which is a duplicate of the
254  * string, but only copies at most n characters.
255  *
256  */
257 char *strndup(const char *str, size_t n);
258 
259 #endif
260 
269 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
270 
278 uint32_t get_mod_mask_for(uint32_t keysym,
279  xcb_key_symbols_t *symbols,
280  xcb_get_modifier_mapping_reply_t *modmap_reply);
281 
287 i3Font load_font(const char *pattern, const bool fallback);
288 
293 void set_font(i3Font *font);
294 
299 void free_font(void);
300 
306 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
307 
315 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
316 
321 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
322 
331 void draw_text(i3String *text, xcb_drawable_t drawable,
332  xcb_gcontext_t gc, int x, int y, int max_width);
333 
338 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
339  xcb_gcontext_t gc, int x, int y, int max_width);
340 
346 int predict_text_width(i3String *text);
347 
352 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
353 
359 bool is_debug_build() __attribute__((const));
360 
365 char *get_process_filename(const char *prefix);
366 
373 const char *get_exe_path(const char *argv0);
374 
375 #endif
struct Font::@23::@24 xcb
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...
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...
i3String * i3string_from_utf8(const char *from_utf8)
Build an i3String from an UTF-8 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 errorlog(char *fmt,...)
Definition: log.c:289
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...
struct _i3String i3String
Opaque data structure for storing strings.
Definition: libi3.h:29
void draw_text_ascii(const char *text, xcb_drawable_t drawable, xcb_gcontext_t gc, int x, int y, int max_width)
ASCII version of draw_text to print static strings.
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
int ipc_connect(const char *socket_path)
Connects to the i3 IPC socket and returns the file descriptor for the socket.
void * scalloc(size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
const char * i3string_as_utf8(i3String *str)
Returns the UTF-8 encoded version of the i3String.
xcb_visualtype_t * get_visualtype(xcb_screen_t *screen)
Returns the visual type associated with the given screen.
xcb_connection_t * conn
Definition: main.c:42
uint32_t get_colorpixel(const char *hex) __attribute__((const ))
Returns the colorpixel to use for the given hex color (think of HTML).
xcb_query_font_reply_t * info
Font information gathered from the server.
Definition: libi3.h:59
char * pattern
The pattern/name used to load the font.
Definition: libi3.h:51
char * root_atom_contents(const char *atomname)
Try to get the contents of the given atom (for example I3_SOCKET_PATH) from the X11 root window and r...
union Font::@23 specific
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.
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...
xcb_charinfo_t * table
Font table for this font (may be NULL)
Definition: libi3.h:62
uint32_t x
Definition: data.h:30
enum Font::@22 type
The type of font.
void * smalloc(size_t size)
Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there is no more memory a...
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...
i3Font load_font(const char *pattern, const bool fallback)
Loads a font for usage, also getting its height.
const char * get_exe_path(const char *argv0)
This function returns the absolute path to the executable it is running in.
i3String * i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs)
Build an i3String from an UCS-2 encoded string.
void free_font(void)
Frees the resources taken by the current font.
void * srealloc(void *ptr, size_t size)
Safe-wrapper around realloc which exits if realloc returns NULL (meaning that there is no more memory...
xcb_font_t id
The xcb-id for the font.
Definition: libi3.h:56
char * get_process_filename(const char *prefix)
Returns the name of a temporary file with the specified prefix.
size_t i3string_get_num_bytes(i3String *str)
Returns the number of bytes (UTF-8 encoded) in an i3String.
uint32_t y
Definition: data.h:31
i3String * i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes)
Build an i3String from an UTF-8 encoded string with fixed length.
void i3string_free(i3String *str)
Free an i3String.
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 draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc, int x, int y, int max_width)
Draws text onto the specified X drawable (normally a pixmap) at the specified coordinates (from the t...
bool is_debug_build() __attribute__((const ))
Returns true if this version of i3 is a debug build (anything which is not a release version)...
void verboselog(char *fmt,...)
Definition: log.c:274
size_t i3string_get_num_glyphs(i3String *str)
Returns the number of glyphs in an i3String.
void set_font(i3Font *font)
Defines the font to be used for the forthcoming calls.
struct reservedpx __attribute__
int height
The height of the font, built from font_ascent + font_descent.
Definition: libi3.h:48
const xcb_char2b_t * i3string_as_ucs2(i3String *str)
Returns the UCS-2 encoded version of the i3String.
int predict_text_width(i3String *text)
Predict the text width in pixels for the given text.
Data structure for cached font information:
Definition: libi3.h:39
void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background)
Defines the colors to be used for the forthcoming draw_text calls.