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-2011 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 _LIBI3_H
12 #define _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 
50  union {
51  struct {
53  xcb_font_t id;
54 
56  xcb_query_font_reply_t *info;
57 
59  xcb_charinfo_t *table;
60  } xcb;
61 
62 #if PANGO_SUPPORT
63 
64  PangoFontDescription *pango_desc;
65 #endif
66  } specific;
67 };
68 
69 /* Since this file also gets included by utilities which don’t use the i3 log
70  * infrastructure, we define a fallback. */
71 #if !defined(LOG)
72 void verboselog(char *fmt, ...);
73 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
74 #endif
75 #if !defined(ELOG)
76 void errorlog(char *fmt, ...);
77 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
78 #endif
79 
88 char *root_atom_contents(const char *atomname);
89 
95 void *smalloc(size_t size);
96 
102 void *scalloc(size_t size);
103 
109 void *srealloc(void *ptr, size_t size);
110 
116 char *sstrdup(const char *str);
117 
123 int sasprintf(char **strp, const char *fmt, ...);
124 
130 i3String *i3string_from_utf8(const char *from_utf8);
131 
138 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
139 
145 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
146 
151 void i3string_free(i3String *str);
152 
158 #define I3STRING_FREE(str) \
159 do { \
160  if (str != NULL) { \
161  i3string_free(str); \
162  str = NULL; \
163  } \
164 } while (0)
165 
170 const char *i3string_as_utf8(i3String *str);
171 
176 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
177 
182 size_t i3string_get_num_bytes(i3String *str);
183 
188 size_t i3string_get_num_glyphs(i3String *str);
189 
195 int ipc_connect(const char *socket_path);
196 
205 int ipc_send_message(int sockfd, uint32_t message_size,
206  uint32_t message_type, const uint8_t *payload);
207 
219 int ipc_recv_message(int sockfd, uint32_t message_type,
220  uint32_t *reply_length, uint8_t **reply);
221 
228 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
229 
244 uint32_t get_colorpixel(const char *hex) __attribute__((const));
245 
246 #if defined(__APPLE__)
247 
248 /*
249  * Taken from FreeBSD
250  * Returns a pointer to a new string which is a duplicate of the
251  * string, but only copies at most n characters.
252  *
253  */
254 char *strndup(const char *str, size_t n);
255 
256 #endif
257 
266 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
267 
275 uint32_t get_mod_mask_for(uint32_t keysym,
276  xcb_key_symbols_t *symbols,
277  xcb_get_modifier_mapping_reply_t *modmap_reply);
278 
284 i3Font load_font(const char *pattern, const bool fallback);
285 
290 void set_font(i3Font *font);
291 
296 void free_font(void);
297 
303 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
304 
312 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
313 
318 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
319 
328 void draw_text(i3String *text, xcb_drawable_t drawable,
329  xcb_gcontext_t gc, int x, int y, int max_width);
330 
335 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
336  xcb_gcontext_t gc, int x, int y, int max_width);
337 
343 int predict_text_width(i3String *text);
344 
349 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
350 
356 bool is_debug_build() __attribute__((const));
357 
358 #endif