git.sur5r.net Git - i3/i3/blob - libi3/string.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * string.c: Define an i3String type to automagically handle UTF-8/UCS-2
   8  *           conversions. Some font backends need UCS-2 (X core fonts),
   9  *           others want UTF-8 (Pango).
  10  *
  11  */
  12
  13 #include <stdlib.h>
  14 #include <string.h>
  15
  16 #if PANGO_SUPPORT
  17 #include <glib.h>
  18 #endif
  19
  20 #include "libi3.h"
  21
  22 struct _i3String {
  23     char *utf8;
  24     xcb_char2b_t *ucs2;
  25     size_t num_glyphs;
  26     size_t num_bytes;
  27     bool is_markup;
  28 };
  29
  30 /*
  31  * Build an i3String from an UTF-8 encoded string.
  32  * Returns the newly-allocated i3String.
  33  *
  34  */
  35 i3String *i3string_from_utf8(const char *from_utf8) {
  36     i3String *str = scalloc(sizeof(i3String));
  37
  38     /* Get the text */
  39     str->utf8 = sstrdup(from_utf8);
  40
  41     /* Compute and store the length */
  42     str->num_bytes = strlen(str->utf8);
  43
  44     return str;
  45 }
  46
  47 /*
  48  * Build an i3String from an UTF-8 encoded string in Pango markup.
  49  *
  50  */
  51 i3String *i3string_from_markup(const char *from_markup) {
  52     i3String *str = i3string_from_utf8(from_markup);
  53
  54     /* Set the markup flag */
  55     str->is_markup = true;
  56
  57     return str;
  58 }
  59
  60 /*
  61  * Build an i3String from an UTF-8 encoded string with fixed length.
  62  * To be used when no proper NUL-terminaison is available.
  63  * Returns the newly-allocated i3String.
  64  *
  65  */
  66 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes) {
  67     i3String *str = scalloc(sizeof(i3String));
  68
  69     /* Copy the actual text to our i3String */
  70     str->utf8 = scalloc(sizeof(char) * (num_bytes + 1));
  71     strncpy(str->utf8, from_utf8, num_bytes);
  72     str->utf8[num_bytes] = '\0';
  73
  74     /* Store the length */
  75     str->num_bytes = num_bytes;
  76
  77     return str;
  78 }
  79
  80 /*
  81  * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
  82  * length.
  83  *
  84  */
  85 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes) {
  86     i3String *str = i3string_from_utf8_with_length(from_markup, num_bytes);
  87
  88     /* set the markup flag */
  89     str->is_markup = true;
  90
  91     return str;
  92 }
  93
  94 /*
  95  * Build an i3String from an UCS-2 encoded string.
  96  * Returns the newly-allocated i3String.
  97  *
  98  */
  99 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs) {
 100     i3String *str = scalloc(sizeof(i3String));
 101
 102     /* Copy the actual text to our i3String */
 103     size_t num_bytes = num_glyphs * sizeof(xcb_char2b_t);
 104     str->ucs2 = scalloc(num_bytes);
 105     memcpy(str->ucs2, from_ucs2, num_bytes);
 106
 107     /* Store the length */
 108     str->num_glyphs = num_glyphs;
 109
 110     str->utf8 = NULL;
 111     str->num_bytes = 0;
 112
 113     return str;
 114 }
 115
 116 /**
 117  * Copies the given i3string.
 118  * Note that this will not free the source string.
 119  */
 120 i3String *i3string_copy(i3String *str) {
 121     i3String *copy = i3string_from_utf8(i3string_as_utf8(str));
 122     copy->is_markup = str->is_markup;
 123     return copy;
 124 }
 125
 126 /*
 127  * Free an i3String.
 128  *
 129  */
 130 void i3string_free(i3String *str) {
 131     if (str == NULL)
 132         return;
 133     free(str->utf8);
 134     free(str->ucs2);
 135     free(str);
 136 }
 137
 138 static void i3string_ensure_utf8(i3String *str) {
 139     if (str->utf8 != NULL)
 140         return;
 141     if ((str->utf8 = convert_ucs2_to_utf8(str->ucs2, str->num_glyphs)) != NULL)
 142         str->num_bytes = strlen(str->utf8);
 143 }
 144
 145 static void i3string_ensure_ucs2(i3String *str) {
 146     if (str->ucs2 != NULL)
 147         return;
 148     str->ucs2 = convert_utf8_to_ucs2(str->utf8, &str->num_glyphs);
 149 }
 150
 151 /*
 152  * Returns the UTF-8 encoded version of the i3String.
 153  *
 154  */
 155 const char *i3string_as_utf8(i3String *str) {
 156     i3string_ensure_utf8(str);
 157     return str->utf8;
 158 }
 159
 160 /*
 161  * Returns the UCS-2 encoded version of the i3String.
 162  *
 163  */
 164 const xcb_char2b_t *i3string_as_ucs2(i3String *str) {
 165     i3string_ensure_ucs2(str);
 166     return str->ucs2;
 167 }
 168
 169 /*
 170  * Returns the number of bytes (UTF-8 encoded) in an i3String.
 171  *
 172  */
 173 size_t i3string_get_num_bytes(i3String *str) {
 174     i3string_ensure_utf8(str);
 175     return str->num_bytes;
 176 }
 177
 178 /*
 179  * Whether the given i3String is in Pango markup.
 180  */
 181 bool i3string_is_markup(i3String *str) {
 182     return str->is_markup;
 183 }
 184
 185 /*
 186  * Set whether the i3String should use Pango markup.
 187  */
 188 void i3string_set_markup(i3String *str, bool is_markup) {
 189     str->is_markup = is_markup;
 190 }
 191
 192 /*
 193  * Escape pango markup characters in the given string.
 194  */
 195 i3String *i3string_escape_markup(i3String *str) {
 196 #if PANGO_SUPPORT
 197     const char *text = i3string_as_utf8(str);
 198     return i3string_from_utf8(g_markup_escape_text(text, -1));
 199 #else
 200     return str;
 201 #endif
 202 }
 203
 204 /*
 205  * Returns the number of glyphs in an i3String.
 206  *
 207  */
 208 size_t i3string_get_num_glyphs(i3String *str) {
 209     i3string_ensure_ucs2(str);
 210     return str->num_glyphs;
 211 }