1 /*
2  * UTF-32 string functions
3  *
4  * Copyright (C) 2008-2020, Joachim Metz <joachim.metz@gmail.com>
5  *
6  * Refer to AUTHORS for acknowledgements.
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
20  */
21 
22 #if !defined( _LIBUNA_UTF32_STRING_H )
23 #define _LIBUNA_UTF32_STRING_H
24 
25 #include <common.h>
26 #include <types.h>
27 
28 #include "libuna_extern.h"
29 #include "libuna_libcerror.h"
30 #include "libuna_types.h"
31 
32 #if defined( __cplusplus )
33 extern "C" {
34 #endif
35 
36 LIBUNA_EXTERN \
37 int libuna_utf32_string_size_from_byte_stream(
38      const uint8_t *byte_stream,
39      size_t byte_stream_size,
40      int codepage,
41      size_t *utf32_string_size,
42      libcerror_error_t **error );
43 
44 LIBUNA_EXTERN \
45 int libuna_utf32_string_copy_from_byte_stream(
46      libuna_utf32_character_t *utf32_string,
47      size_t utf32_string_size,
48      const uint8_t *byte_stream,
49      size_t byte_stream_size,
50      int codepage,
51      libcerror_error_t **error );
52 
53 /* The functionality for libuna_utf32_string_copy_to_byte_stream is implemented by
54  * libuna_byte_stream_copy_from_utf32
55  */
56 
57 LIBUNA_EXTERN \
58 int libuna_utf32_string_with_index_copy_from_byte_stream(
59      libuna_utf32_character_t *utf32_string,
60      size_t utf32_string_size,
61      size_t *utf32_string_index,
62      const uint8_t *byte_stream,
63      size_t byte_stream_size,
64      int codepage,
65      libcerror_error_t **error );
66 
67 LIBUNA_EXTERN \
68 int libuna_utf32_string_compare_with_byte_stream(
69      const libuna_utf32_character_t *utf32_string,
70      size_t utf32_string_size,
71      const uint8_t *byte_stream,
72      size_t byte_stream_size,
73      int codepage,
74      libcerror_error_t **error );
75 
76 LIBUNA_EXTERN \
77 int libuna_utf32_string_size_from_utf7_stream(
78      const uint8_t *utf7_stream,
79      size_t utf7_stream_size,
80      size_t *utf32_string_size,
81      libcerror_error_t **error );
82 
83 LIBUNA_EXTERN \
84 int libuna_utf32_string_copy_from_utf7_stream(
85      libuna_utf32_character_t *utf32_string,
86      size_t utf32_string_size,
87      const uint8_t *utf7_stream,
88      size_t utf7_stream_size,
89      libcerror_error_t **error );
90 
91 /* The functionality for libuna_utf32_string_copy_to_utf7_stream is implemented by
92  * libuna_utf7_stream_copy_from_utf32
93  */
94 
95 LIBUNA_EXTERN \
96 int libuna_utf32_string_with_index_copy_from_utf7_stream(
97      libuna_utf32_character_t *utf32_string,
98      size_t utf32_string_size,
99      size_t *utf32_string_index,
100      const uint8_t *utf7_stream,
101      size_t utf7_stream_size,
102      libcerror_error_t **error );
103 
104 LIBUNA_EXTERN \
105 int libuna_utf32_string_compare_with_utf7_stream(
106      const libuna_utf32_character_t *utf32_string,
107      size_t utf32_string_size,
108      const uint8_t *utf7_stream,
109      size_t utf7_stream_size,
110      libcerror_error_t **error );
111 
112 LIBUNA_EXTERN \
113 int libuna_utf32_string_size_from_utf8(
114      const libuna_utf8_character_t *utf8_string,
115      size_t utf8_string_size,
116      size_t *utf32_string_size,
117      libcerror_error_t **error );
118 
119 LIBUNA_EXTERN \
120 int libuna_utf32_string_copy_from_utf8(
121      libuna_utf32_character_t *utf32_string,
122      size_t utf32_string_size,
123      const libuna_utf8_character_t *utf8_string,
124      size_t utf8_string_size,
125      libcerror_error_t **error );
126 
127 /* The functionality for libuna_utf32_string_copy_to_utf8 is implemented by
128  * libuna_utf8_string_copy_from_utf32
129  */
130 
131 LIBUNA_EXTERN \
132 int libuna_utf32_string_with_index_copy_from_utf8(
133      libuna_utf32_character_t *utf32_string,
134      size_t utf32_string_size,
135      size_t *utf32_string_index,
136      const libuna_utf8_character_t *utf8_string,
137      size_t utf8_string_size,
138      libcerror_error_t **error );
139 
140 /* The functionality for libuna_utf32_string_compare_with_utf8 is implemented by
141  * libuna_utf8_string_compare_with_utf32
142  */
143 
144 LIBUNA_EXTERN \
145 int libuna_utf32_string_size_from_utf8_stream(
146      const uint8_t *utf32_stream,
147      size_t utf32_stream_size,
148      size_t *utf32_string_size,
149      libcerror_error_t **error );
150 
151 LIBUNA_EXTERN \
152 int libuna_utf32_string_copy_from_utf8_stream(
153      libuna_utf32_character_t *utf32_string,
154      size_t utf32_string_size,
155      const uint8_t *utf8_stream,
156      size_t utf8_stream_size,
157      libcerror_error_t **error );
158 
159 /* The functionality for libuna_utf32_string_copy_to_utf8_stream is implemented by
160  * libuna_utf8_stream_copy_from_utf32
161  */
162 
163 LIBUNA_EXTERN \
164 int libuna_utf32_string_with_index_copy_from_utf8_stream(
165      libuna_utf32_character_t *utf32_string,
166      size_t utf32_string_size,
167      size_t *utf32_string_index,
168      const uint8_t *utf8_stream,
169      size_t utf8_stream_size,
170      libcerror_error_t **error );
171 
172 LIBUNA_EXTERN \
173 int libuna_utf32_string_compare_with_utf8_stream(
174      const libuna_utf32_character_t *utf32_string,
175      size_t utf32_string_size,
176      const uint8_t *utf8_stream,
177      size_t utf8_stream_size,
178      libcerror_error_t **error );
179 
180 LIBUNA_EXTERN \
181 int libuna_utf32_string_size_from_utf16(
182      const libuna_utf16_character_t *utf16_string,
183      size_t utf16_string_size,
184      size_t *utf32_string_size,
185      libcerror_error_t **error );
186 
187 LIBUNA_EXTERN \
188 int libuna_utf32_string_copy_from_utf16(
189      libuna_utf32_character_t *utf32_string,
190      size_t utf32_string_size,
191      const libuna_utf16_character_t *utf16_string,
192      size_t utf16_string_size,
193      libcerror_error_t **error );
194 
195 /* The functionality for libuna_utf32_string_copy_to_utf16 is implemented by
196  * libuna_utf16_string_copy_from_utf32
197  */
198 
199 LIBUNA_EXTERN \
200 int libuna_utf32_string_with_index_copy_from_utf16(
201      libuna_utf32_character_t *utf32_string,
202      size_t utf32_string_size,
203      size_t *utf32_string_index,
204      const libuna_utf16_character_t *utf16_string,
205      size_t utf16_string_size,
206      libcerror_error_t **error );
207 
208 /* The functionality for libuna_utf32_string_compare_with_utf16 is implemented by
209  * libuna_utf16_string_compare_with_utf32
210  */
211 
212 LIBUNA_EXTERN \
213 int libuna_utf32_string_size_from_utf16_stream(
214      const uint8_t *utf16_stream,
215      size_t utf16_stream_size,
216      int byte_order,
217      size_t *utf32_string_size,
218      libcerror_error_t **error );
219 
220 LIBUNA_EXTERN \
221 int libuna_utf32_string_copy_from_utf16_stream(
222      libuna_utf32_character_t *utf32_string,
223      size_t utf32_string_size,
224      const uint8_t *utf16_stream,
225      size_t utf16_stream_size,
226      int byte_order,
227      libcerror_error_t **error );
228 
229 /* The functionality for libuna_utf32_string_copy_to_utf16_stream is implemented by
230  * libuna_utf16_stream_copy_from_utf32
231  */
232 
233 LIBUNA_EXTERN \
234 int libuna_utf32_string_with_index_copy_from_utf16_stream(
235      libuna_utf32_character_t *utf32_string,
236      size_t utf32_string_size,
237      size_t *utf32_string_index,
238      const uint8_t *utf16_stream,
239      size_t utf16_stream_size,
240      int byte_order,
241      libcerror_error_t **error );
242 
243 LIBUNA_EXTERN \
244 int libuna_utf32_string_compare_with_utf16_stream(
245      const libuna_utf32_character_t *utf32_string,
246      size_t utf32_string_size,
247      const uint8_t *utf16_stream,
248      size_t utf16_stream_size,
249      int byte_order,
250      libcerror_error_t **error );
251 
252 LIBUNA_EXTERN \
253 int libuna_utf32_string_size_from_utf32_stream(
254      const uint8_t *utf32_stream,
255      size_t utf32_stream_size,
256      int byte_order,
257      size_t *utf32_string_size,
258      libcerror_error_t **error );
259 
260 LIBUNA_EXTERN \
261 int libuna_utf32_string_copy_from_utf32_stream(
262      libuna_utf32_character_t *utf32_string,
263      size_t utf32_string_size,
264      const uint8_t *utf32_stream,
265      size_t utf32_stream_size,
266      int byte_order,
267      libcerror_error_t **error );
268 
269 /* The functionality for libuna_utf32_string_copy_to_utf32_stream is implemented by
270  * libuna_utf32_stream_copy_from_utf32
271  */
272 
273 LIBUNA_EXTERN \
274 int libuna_utf32_string_with_index_copy_from_utf32_stream(
275      libuna_utf32_character_t *utf32_string,
276      size_t utf32_string_size,
277      size_t *utf32_string_index,
278      const uint8_t *utf32_stream,
279      size_t utf32_stream_size,
280      int byte_order,
281      libcerror_error_t **error );
282 
283 LIBUNA_EXTERN \
284 int libuna_utf32_string_compare_with_utf32_stream(
285      const libuna_utf32_character_t *utf32_string,
286      size_t utf32_string_size,
287      const uint8_t *utf32_stream,
288      size_t utf32_stream_size,
289      int byte_order,
290      libcerror_error_t **error );
291 
292 LIBUNA_EXTERN \
293 int libuna_utf32_string_size_from_scsu_stream(
294      const uint8_t *scsu_stream,
295      size_t scsu_stream_size,
296      size_t *utf32_string_size,
297      libcerror_error_t **error );
298 
299 LIBUNA_EXTERN \
300 int libuna_utf32_string_copy_from_scsu_stream(
301      libuna_utf32_character_t *utf32_string,
302      size_t utf32_string_size,
303      const uint8_t *scsu_stream,
304      size_t scsu_stream_size,
305      libcerror_error_t **error );
306 
307 LIBUNA_EXTERN \
308 int libuna_utf32_string_with_index_copy_from_scsu_stream(
309      libuna_utf32_character_t *utf32_string,
310      size_t utf32_string_size,
311      size_t *utf32_string_index,
312      const uint8_t *scsu_stream,
313      size_t scsu_stream_size,
314      libcerror_error_t **error );
315 
316 #if defined( __cplusplus )
317 }
318 #endif
319 
320 #endif /* !defined( _LIBUNA_UTF32_STRING_H ) */
321 
322