Cleanup: fix compiler warnings.
[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 <wchar.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27
28 #ifdef __cplusplus 
29 extern  "C" {
30 #endif
31
32 /**
33  * Counts how many bytes is requered for for future utf-8 string using utf-16
34  * @param string-16 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 requered for for future utf-16 string using utf-8
41  * @param string-8 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   1 << 2 /* Passed size is to small. It gives legal string with character missing at the end*/
52 #define UTF_ERROR_ILLSEQ  1 << 3 /* Error if sequence is broken and doesn't finish*/
53
54 /**
55  * Converts utf-16 string to allocated utf-8 string
56  * @param in16 utf-16 string to convert
57  * @param out8 utf-8 string to string the conversion
58  * @param size8 the allocated size in bytes of out8
59  * @return Returns any errors occured during conversion. See the block above,
60  */
61 int conv_utf_16_to_8(const wchar_t *in16, char *out8, size_t size8);
62
63 /**
64  * Converts utf-8 string to allocated utf-16 string
65  * @param in8 utf-8 string to convert
66  * @param out16 utf-16 string to string the conversion
67  * @param size16 the allocated size in wchar_t (two byte) of out16
68  * @return Returns any errors occured during conversion. See the block above,
69  */
70 int conv_utf_8_to_16(const char *in8, wchar_t *out16, size_t size16);
71
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 in wchar_t (two bytes)
85  * @return New allocated and converted utf-16 string or NULL if in8 is 0.
86  */
87 wchar_t *alloc_utf16_from_8(const char *in8, size_t add);
88
89 /* Easy allocation and conversion of new utf-16 string. New string has _16 suffix. Must be deallocated with UTF16_UN_ENCODE in right order*/
90 #define UTF16_ENCODE(in8str) if (1) { \
91                 wchar_t *in8str ## _16 = alloc_utf16_from_8((const char *)in8str, 0)
92
93 #define UTF16_UN_ENCODE(in8str) \
94         free(in8str ## _16); } (void)0
95
96 #ifdef __cplusplus 
97 }
98 #endif
99
100 #endif  /* __UTFCONV_H__ */