chiark / gitweb /
util: when unescaping C escape sequences support C++11 \u and \U unicode literals
[elogind.git] / src / shared / utf8.c
index 6e5ba9abf4ad115b9fcc2d3e78fbef6e65664815..800884ffee99c77b36c6c16f35015a70442409fa 100644 (file)
@@ -52,7 +52,7 @@
 #include "utf8.h"
 #include "util.h"
 
-static inline bool is_unicode_valid(uint32_t ch) {
+bool unichar_is_valid(uint32_t ch) {
 
         if (ch >= 0x110000) /* End of unicode space */
                 return false;
@@ -66,7 +66,7 @@ static inline bool is_unicode_valid(uint32_t ch) {
         return true;
 }
 
-static bool is_unicode_control(uint32_t ch) {
+static bool unichar_is_control(uint32_t ch) {
 
         /*
           0 to ' '-1 is the C0 range.
@@ -80,8 +80,11 @@ static bool is_unicode_control(uint32_t ch) {
 
 /* count of characters used to encode one unicode char */
 static int utf8_encoded_expected_len(const char *str) {
-        unsigned char c = (unsigned char)str[0];
+        unsigned char c;
 
+        assert(str);
+
+        c = (unsigned char) str[0];
         if (c < 0x80)
                 return 1;
         if ((c & 0xe0) == 0xc0)
@@ -94,16 +97,18 @@ static int utf8_encoded_expected_len(const char *str) {
                 return 5;
         if ((c & 0xfe) == 0xfc)
                 return 6;
+
         return 0;
 }
 
 /* decode one unicode char */
 int utf8_encoded_to_unichar(const char *str) {
-        int unichar;
-        int len;
-        int i;
+        int unichar, len, i;
+
+        assert(str);
 
         len = utf8_encoded_expected_len(str);
+
         switch (len) {
         case 1:
                 return (int)str[0];
@@ -123,12 +128,12 @@ int utf8_encoded_to_unichar(const char *str) {
                 unichar = (int)str[0] & 0x01;
                 break;
         default:
-                return -1;
+                return -EINVAL;
         }
 
         for (i = 1; i < len; i++) {
                 if (((int)str[i] & 0xc0) != 0x80)
-                        return -1;
+                        return -EINVAL;
                 unichar <<= 6;
                 unichar |= (int)str[i] & 0x3f;
         }
@@ -136,16 +141,23 @@ int utf8_encoded_to_unichar(const char *str) {
         return unichar;
 }
 
-bool utf8_is_printable(const char* str, size_t length) {
-        const uint8_t *p;
+bool utf8_is_printable_newline(const char* str, size_t length, bool newline) {
+        const char *p;
 
         assert(str);
 
-        for (p = (const uint8_t*) str; length;) {
-                int encoded_len = utf8_encoded_valid_unichar((const char *)p);
-                int val = utf8_encoded_to_unichar((const char*)p);
+        for (p = str; length;) {
+                int encoded_len, val;
 
-                if (encoded_len < 0 || val < 0 || is_unicode_control(val))
+                encoded_len = utf8_encoded_valid_unichar(p);
+                if (encoded_len < 0 ||
+                    (size_t) encoded_len > length)
+                        return false;
+
+                val = utf8_encoded_to_unichar(p);
+                if (val < 0 ||
+                    unichar_is_control(val) ||
+                    (!newline && val == '\n'))
                         return false;
 
                 length -= encoded_len;
@@ -164,7 +176,6 @@ const char *utf8_is_valid(const char *str) {
                 int len;
 
                 len = utf8_encoded_valid_unichar((const char *)p);
-
                 if (len < 0)
                         return NULL;
 
@@ -174,6 +185,72 @@ const char *utf8_is_valid(const char *str) {
         return str;
 }
 
+char *utf8_escape_invalid(const char *str) {
+        char *p, *s;
+
+        assert(str);
+
+        p = s = malloc(strlen(str) * 4 + 1);
+        if (!p)
+                return NULL;
+
+        while (*str) {
+                int len;
+
+                len = utf8_encoded_valid_unichar(str);
+                if (len > 0) {
+                        s = mempcpy(s, str, len);
+                        str += len;
+                } else {
+                        s = stpcpy(s, UTF8_REPLACEMENT_CHARACTER);
+                        str += 1;
+                }
+        }
+
+        *s = '\0';
+
+        return p;
+}
+
+char *utf8_escape_non_printable(const char *str) {
+        char *p, *s;
+
+        assert(str);
+
+        p = s = malloc(strlen(str) * 4 + 1);
+        if (!p)
+                return NULL;
+
+        while (*str) {
+                int len;
+
+                len = utf8_encoded_valid_unichar(str);
+                if (len > 0) {
+                        if (utf8_is_printable(str, len)) {
+                                s = mempcpy(s, str, len);
+                                str += len;
+                        } else {
+                                while (len > 0) {
+                                        *(s++) = '\\';
+                                        *(s++) = 'x';
+                                        *(s++) = hexchar((int) *str >> 4);
+                                        *(s++) = hexchar((int) *str);
+
+                                        str += 1;
+                                        len --;
+                                }
+                        }
+                } else {
+                        s = stpcpy(s, UTF8_REPLACEMENT_CHARACTER);
+                        str += 1;
+                }
+        }
+
+        *s = '\0';
+
+        return p;
+}
+
 char *ascii_is_valid(const char *str) {
         const char *p;
 
@@ -186,44 +263,98 @@ char *ascii_is_valid(const char *str) {
         return (char*) str;
 }
 
+/**
+ * utf8_encode_unichar() - Encode single UCS-4 character as UTF-8
+ * @out_utf8: output buffer of at least 4 bytes or NULL
+ * @g: UCS-4 character to encode
+ *
+ * This encodes a single UCS-4 character as UTF-8 and writes it into @out_utf8.
+ * The length of the character is returned. It is not zero-terminated! If the
+ * output buffer is NULL, only the length is returned.
+ *
+ * Returns: The length in bytes that the UTF-8 representation does or would
+ *          occupy.
+ */
+size_t utf8_encode_unichar(char *out_utf8, uint32_t g) {
+
+        if (g < (1 << 7)) {
+                if (out_utf8)
+                        out_utf8[0] = g & 0x7f;
+                return 1;
+        } else if (g < (1 << 11)) {
+                if (out_utf8) {
+                        out_utf8[0] = 0xc0 | ((g >> 6) & 0x1f);
+                        out_utf8[1] = 0x80 | (g & 0x3f);
+                }
+                return 2;
+        } else if (g < (1 << 16)) {
+                if (out_utf8) {
+                        out_utf8[0] = 0xe0 | ((g >> 12) & 0x0f);
+                        out_utf8[1] = 0x80 | ((g >> 6) & 0x3f);
+                        out_utf8[2] = 0x80 | (g & 0x3f);
+                }
+                return 3;
+        } else if (g < (1 << 21)) {
+                if (out_utf8) {
+                        out_utf8[0] = 0xf0 | ((g >> 18) & 0x07);
+                        out_utf8[1] = 0x80 | ((g >> 12) & 0x3f);
+                        out_utf8[2] = 0x80 | ((g >> 6) & 0x3f);
+                        out_utf8[3] = 0x80 | (g & 0x3f);
+                }
+                return 4;
+        }
+
+        return 0;
+}
+
 char *utf16_to_utf8(const void *s, size_t length) {
-        char *r;
         const uint8_t *f;
-        uint8_t *t;
+        char *r, *t;
 
-        r = new(char, (length*3+1)/2 + 1);
+        r = new(char, (length * 4 + 1) / 2 + 1);
         if (!r)
                 return NULL;
 
-        t = (uint8_t*) r;
+        f = s;
+        t = r;
 
-        for (f = s; f < (const uint8_t*) s + length; f += 2) {
-                uint16_t c;
+        while (f < (const uint8_t*) s + length) {
+                uint16_t w1, w2;
 
-                c = (f[1] << 8) | f[0];
+                /* see RFC 2781 section 2.2 */
 
-                if (c == 0) {
-                        *t = 0;
-                        return r;
-                } else if (c < 0x80) {
-                        *(t++) = (uint8_t) c;
-                } else if (c < 0x800) {
-                        *(t++) = (uint8_t) (0xc0 | (c >> 6));
-                        *(t++) = (uint8_t) (0x80 | (c & 0x3f));
-                } else {
-                        *(t++) = (uint8_t) (0xe0 | (c >> 12));
-                        *(t++) = (uint8_t) (0x80 | ((c >> 6) & 0x3f));
-                        *(t++) = (uint8_t) (0x80 | (c & 0x3f));
+                w1 = f[1] << 8 | f[0];
+                f += 2;
+
+                if (!utf16_is_surrogate(w1)) {
+                        t += utf8_encode_unichar(t, w1);
+
+                        continue;
                 }
+
+                if (utf16_is_trailing_surrogate(w1))
+                        continue;
+                else if (f >= (const uint8_t*) s + length)
+                        break;
+
+                w2 = f[1] << 8 | f[0];
+                f += 2;
+
+                if (!utf16_is_trailing_surrogate(w2)) {
+                        f -= 2;
+                        continue;
+                }
+
+                t += utf8_encode_unichar(t, utf16_surrogate_pair_to_unichar(w1, w2));
         }
 
         *t = 0;
-
         return r;
 }
 
 /* expected size used to encode one unicode char */
 static int utf8_unichar_to_encoded_len(int unichar) {
+
         if (unichar < 0x80)
                 return 1;
         if (unichar < 0x800)
@@ -234,18 +365,19 @@ static int utf8_unichar_to_encoded_len(int unichar) {
                 return 4;
         if (unichar < 0x4000000)
                 return 5;
+
         return 6;
 }
 
 /* validate one encoded unicode char and return its length */
 int utf8_encoded_valid_unichar(const char *str) {
-        int len;
-        int unichar;
-        int i;
+        int len, unichar, i;
+
+        assert(str);
 
         len = utf8_encoded_expected_len(str);
         if (len == 0)
-                return -1;
+                return -EINVAL;
 
         /* ascii is valid */
         if (len == 1)
@@ -254,17 +386,17 @@ int utf8_encoded_valid_unichar(const char *str) {
         /* check if expected encoded chars are available */
         for (i = 0; i < len; i++)
                 if ((str[i] & 0x80) != 0x80)
-                        return -1;
+                        return -EINVAL;
 
         unichar = utf8_encoded_to_unichar(str);
 
         /* check if encoded length matches encoded value */
         if (utf8_unichar_to_encoded_len(unichar) != len)
-                return -1;
+                return -EINVAL;
 
         /* check if value has valid range */
-        if (!is_unicode_valid(unichar))
-                return -1;
+        if (!unichar_is_valid(unichar))
+                return -EINVAL;
 
         return len;
 }