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