Merge branch 'blender-v2.90-release' into master
[blender.git] / intern / utfconv / utfconv.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2012 Blender Foundation.
17  * All rights reserved.
18  *
19  */
20
21 #ifndef __UTFCONV_H__
22 #define __UTFCONV_H__
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <wchar.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /**
33  * Counts how many bytes is required for future utf-8 string using utf-16
34  * \param string16: pointer to working utf-16 string
35  * \return How many bytes must be allocated includeng NULL.
36  */
37 size_t count_utf_8_from_16(const wchar_t *string16);
38
39 /**
40  * Counts how many wchar_t (two byte) is required for future utf-16 string using utf-8
41  * \param string8: pointer to working utf-8 string
42  * \return How many bytes must be allocated includeng NULL.
43  */
44 size_t count_utf_16_from_8(const char *string8);
45
46 /**
47  * conv_utf_*** errors
48  */
49 #define UTF_ERROR_NULL_IN 1 << 0 /* Error occures when requered parameter is missing*/
50 #define UTF_ERROR_ILLCHAR 1 << 1 /* Error if character is in illigal UTF rage*/
51 #define UTF_ERROR_SMALL \
52   1 << 2 /* Passed size is to small. It gives legal string with character missing at the end*/
53 #define UTF_ERROR_ILLSEQ 1 << 3 /* Error if sequence is broken and doesn't finish*/
54
55 /**
56  * Converts utf-16 string to allocated utf-8 string
57  * \param in16: utf-16 string to convert
58  * \param out8: utf-8 string to string the conversion
59  * \param size8: the allocated size in bytes of out8
60  * \return Returns any errors occured during conversion. See the block above,
61  */
62 int conv_utf_16_to_8(const wchar_t *in16, char *out8, size_t size8);
63
64 /**
65  * Converts utf-8 string to allocated utf-16 string
66  * \param in8: utf-8 string to convert
67  * \param out16: utf-16 string to string the conversion
68  * \param size16: the allocated size in wchar_t (two byte) of out16
69  * \return Returns any errors occured during conversion. See the block above,
70  */
71 int conv_utf_8_to_16(const char *in8, wchar_t *out16, size_t size16);
72
73 /**
74  * Allocates and converts the utf-8 string from utf-16
75  * \param in16: utf-16 string to convert
76  * \param add: any additional size which will be allocated for new utf-8 string in bytes
77  * \return New allocated and converted utf-8 string or NULL if in16 is 0.
78  */
79 char *alloc_utf_8_from_16(const wchar_t *in16, size_t add);
80
81 /**
82  * Allocates and converts the utf-16 string from utf-8
83  * \param in8: utf-8 string to convert
84  * \param add: any additional size which will be allocated for new utf-16 string
85  * in wchar_t (two bytes)
86  * \return New allocated and converted utf-16 string or NULL if in8 is 0.
87  */
88 wchar_t *alloc_utf16_from_8(const char *in8, size_t add);
89
90 /* Easy allocation and conversion of new utf-16 string. New string has _16 suffix.
91  * Must be deallocated with UTF16_UN_ENCODE in right order. */
92 #define UTF16_ENCODE(in8str) \
93   if (1) { \
94     wchar_t *in8str##_16 = alloc_utf16_from_8((const char *)in8str, 0)
95
96 #define UTF16_UN_ENCODE(in8str) \
97   free(in8str##_16); \
98   } \
99   (void)0
100
101 #ifdef __cplusplus
102 }
103 #endif
104
105 #endif /* __UTFCONV_H__ */