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  __attribute__ ((format (printf, 1, 2)));
77 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
78 #endif
79 #if !defined(ELOG)
80 void errorlog(char *fmt, ...)
81  __attribute__ ((format (printf, 1, 2)));
82 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
83 #endif
84 #if !defined(DLOG)
85 void debuglog(char *fmt, ...)
86  __attribute__ ((format (printf, 1, 2)));
87 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
88 #endif
89 
101 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
102 
108 void *smalloc(size_t size);
109 
115 void *scalloc(size_t size);
116 
122 void *srealloc(void *ptr, size_t size);
123 
129 char *sstrdup(const char *str);
130 
136 int sasprintf(char **strp, const char *fmt, ...);
137 
143 i3String *i3string_from_utf8(const char *from_utf8);
144 
151 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
152 
158 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
159 
164 void i3string_free(i3String *str);
165 
171 #define I3STRING_FREE(str) \
172 do { \
173  if (str != NULL) { \
174  i3string_free(str); \
175  str = NULL; \
176  } \
177 } while (0)
178 
183 const char *i3string_as_utf8(i3String *str);
184 
189 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
190 
195 size_t i3string_get_num_bytes(i3String *str);
196 
201 size_t i3string_get_num_glyphs(i3String *str);
202 
208 int ipc_connect(const char *socket_path);
209 
218 int ipc_send_message(int sockfd, const uint32_t message_size,
219  const uint32_t message_type, const uint8_t *payload);
220 
232 int ipc_recv_message(int sockfd, uint32_t *message_type,
233  uint32_t *reply_length, uint8_t **reply);
234 
241 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
242 
257 uint32_t get_colorpixel(const char *hex) __attribute__((const));
258 
259 #if defined(__APPLE__)
260 
261 /*
262  * Taken from FreeBSD
263  * Returns a pointer to a new string which is a duplicate of the
264  * string, but only copies at most n characters.
265  *
266  */
267 char *strndup(const char *str, size_t n);
268 
269 #endif
270 
279 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
280 
288 uint32_t get_mod_mask_for(uint32_t keysym,
289  xcb_key_symbols_t *symbols,
290  xcb_get_modifier_mapping_reply_t *modmap_reply);
291 
297 i3Font load_font(const char *pattern, const bool fallback);
298 
303 void set_font(i3Font *font);
304 
309 void free_font(void);
310 
316 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
317 
325 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
326 
331 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
332 
341 void draw_text(i3String *text, xcb_drawable_t drawable,
342  xcb_gcontext_t gc, int x, int y, int max_width);
343 
348 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
349  xcb_gcontext_t gc, int x, int y, int max_width);
350 
356 int predict_text_width(i3String *text);
357 
362 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
363 
369 bool is_debug_build() __attribute__((const));
370 
375 char *get_process_filename(const char *prefix);
376 
384 char *get_exe_path(const char *argv0);
385 
386 #endif