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 #pragma once
12 
13 #include <stdbool.h>
14 #include <stdarg.h>
15 #include <stdio.h>
16 #include <xcb/xcb.h>
17 #include <xcb/xproto.h>
18 #include <xcb/xcb_keysyms.h>
19 
20 #if PANGO_SUPPORT
21 #include <pango/pango.h>
22 #endif
23 
28 typedef struct _i3String i3String;
29 
30 typedef struct Font i3Font;
31 
38 struct Font {
40  enum {
44  } type;
45 
47  int height;
48 
50  char *pattern;
51 
52  union {
53  struct {
55  xcb_font_t id;
56 
58  xcb_query_font_reply_t *info;
59 
61  xcb_charinfo_t *table;
62  } xcb;
63 
64 #if PANGO_SUPPORT
65 
66  PangoFontDescription *pango_desc;
67 #endif
68  } specific;
69 };
70 
71 /* Since this file also gets included by utilities which don’t use the i3 log
72  * infrastructure, we define a fallback. */
73 #if !defined(LOG)
74 void verboselog(char *fmt, ...)
75  __attribute__ ((format (printf, 1, 2)));
76 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
77 #endif
78 #if !defined(ELOG)
79 void errorlog(char *fmt, ...)
80  __attribute__ ((format (printf, 1, 2)));
81 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
82 #endif
83 #if !defined(DLOG)
84 void debuglog(char *fmt, ...)
85  __attribute__ ((format (printf, 1, 2)));
86 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
87 #endif
88 
100 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
101 
107 void *smalloc(size_t size);
108 
114 void *scalloc(size_t size);
115 
121 void *srealloc(void *ptr, size_t size);
122 
128 char *sstrdup(const char *str);
129 
135 int sasprintf(char **strp, const char *fmt, ...);
136 
142 i3String *i3string_from_utf8(const char *from_utf8);
143 
150 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
151 
157 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
158 
163 void i3string_free(i3String *str);
164 
170 #define I3STRING_FREE(str) \
171 do { \
172  if (str != NULL) { \
173  i3string_free(str); \
174  str = NULL; \
175  } \
176 } while (0)
177 
182 const char *i3string_as_utf8(i3String *str);
183 
188 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
189 
194 size_t i3string_get_num_bytes(i3String *str);
195 
200 size_t i3string_get_num_glyphs(i3String *str);
201 
207 int ipc_connect(const char *socket_path);
208 
217 int ipc_send_message(int sockfd, const uint32_t message_size,
218  const uint32_t message_type, const uint8_t *payload);
219 
231 int ipc_recv_message(int sockfd, uint32_t *message_type,
232  uint32_t *reply_length, uint8_t **reply);
233 
240 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
241 
256 uint32_t get_colorpixel(const char *hex) __attribute__((const));
257 
258 #if defined(__APPLE__)
259 
260 /*
261  * Taken from FreeBSD
262  * Returns a pointer to a new string which is a duplicate of the
263  * string, but only copies at most n characters.
264  *
265  */
266 char *strndup(const char *str, size_t n);
267 
268 #endif
269 
278 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
279 
287 uint32_t get_mod_mask_for(uint32_t keysym,
288  xcb_key_symbols_t *symbols,
289  xcb_get_modifier_mapping_reply_t *modmap_reply);
290 
296 i3Font load_font(const char *pattern, const bool fallback);
297 
302 void set_font(i3Font *font);
303 
308 void free_font(void);
309 
315 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
316 
324 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
325 
330 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
331 
340 void draw_text(i3String *text, xcb_drawable_t drawable,
341  xcb_gcontext_t gc, int x, int y, int max_width);
342 
347 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
348  xcb_gcontext_t gc, int x, int y, int max_width);
349 
355 int predict_text_width(i3String *text);
356 
361 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
362 
368 bool is_debug_build() __attribute__((const));
369 
374 char *get_process_filename(const char *prefix);
375 
383 char *get_exe_path(const char *argv0);
384 
391 int logical_px(const int logical);
struct reservedpx __attribute__
bool is_debug_build() __attribute__((const ))
Returns true if this version of i3 is a debug build (anything which is not a release version)...
const char * i3string_as_utf8(i3String *str)
Returns the UTF-8 encoded version of the i3String.
int logical_px(const int logical)
Convert a logical amount of pixels (e.g.
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
char * get_exe_path(const char *argv0)
This function returns the absolute path to the executable it is running in.
int predict_text_width(i3String *text)
Predict the text width in pixels for the given text.
void set_font(i3Font *font)
Defines the font to be used for the forthcoming calls.
size_t i3string_get_num_glyphs(i3String *str)
Returns the number of glyphs in an i3String.
char * get_process_filename(const char *prefix)
Returns the name of a temporary file with the specified prefix.
xcb_connection_t * conn
Definition: main.c:47
const xcb_char2b_t * i3string_as_ucs2(i3String *str)
Returns the UCS-2 encoded version of the i3String.
Data structure for cached font information:
Definition: libi3.h:38
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...
i3String * i3string_from_utf8(const char *from_utf8)
Build an i3String from an UTF-8 encoded string.
void free_font(void)
Frees the resources taken by the current font.
char * root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen)
Try to get the contents of the given atom (for example I3_SOCKET_PATH) from the X11 root window and r...
union Font::@22 specific
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...
int ipc_connect(const char *socket_path)
Connects to the i3 IPC socket and returns the file descriptor for the socket.
void errorlog(char *fmt,...)
Definition: log.c:295
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...
uint32_t get_colorpixel(const char *hex) __attribute__((const ))
Returns the colorpixel to use for the given hex color (think of HTML).
struct _i3String i3String
Opaque data structure for storing strings.
Definition: libi3.h:28
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 verboselog(char *fmt,...)
Definition: log.c:280
xcb_font_t id
The xcb-id for the font.
Definition: libi3.h:55
enum Font::@21 type
The type of font.
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().
char * pattern
The pattern/name used to load the font.
Definition: libi3.h:50
int height
The height of the font, built from font_ascent + font_descent.
Definition: libi3.h:47
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...
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...
xcb_visualtype_t * get_visualtype(xcb_screen_t *screen)
Returns the visual type associated with the given screen.
void i3string_free(i3String *str)
Free an i3String.
xcb_charinfo_t * table
Font table for this font (may be NULL)
Definition: libi3.h:61
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.
void debuglog(char *fmt,...)
Definition: log.c:315
void * scalloc(size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
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...
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...
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.
struct Font::@22::@23 xcb
xcb_query_font_reply_t * info
Font information gathered from the server.
Definition: libi3.h:58
uint32_t y
Definition: data.h:31
void * smalloc(size_t size)
Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there is no more memory a...
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.
void * srealloc(void *ptr, size_t size)
Safe-wrapper around realloc which exits if realloc returns NULL (meaning that there is no more memory...
size_t i3string_get_num_bytes(i3String *str)
Returns the number of bytes (UTF-8 encoded) in an i3String.
uint32_t x
Definition: data.h:30
i3String * i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs)
Build an i3String from an UCS-2 encoded string.
i3Font load_font(const char *pattern, const bool fallback)
Loads a font for usage, also getting its height.