add glibintl.h
[platform/upstream/glib.git] / docs / reference / glib / tmpl / unicode.sgml
1 <!-- ##### SECTION Title ##### -->
2 Unicode Manipulation
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 </para>
11
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
14
15 </para>
16
17 <!-- ##### TYPEDEF gunichar ##### -->
18 <para>
19
20 </para>
21
22
23 <!-- ##### TYPEDEF gunichar2 ##### -->
24 <para>
25
26 </para>
27
28
29 <!-- ##### FUNCTION g_get_charset ##### -->
30 <para>
31
32 </para>
33
34 @charset: 
35 @Returns: 
36
37
38 <!-- ##### FUNCTION g_unichar_validate ##### -->
39 <para>
40
41 </para>
42
43 @ch: 
44 @Returns: 
45
46
47 <!-- ##### FUNCTION g_unichar_isalnum ##### -->
48 <para>
49
50 </para>
51
52 @c: 
53 @Returns: 
54
55
56 <!-- ##### FUNCTION g_unichar_isalpha ##### -->
57 <para>
58
59 </para>
60
61 @c: 
62 @Returns: 
63
64
65 <!-- ##### FUNCTION g_unichar_iscntrl ##### -->
66 <para>
67
68 </para>
69
70 @c: 
71 @Returns: 
72
73
74 <!-- ##### FUNCTION g_unichar_isdigit ##### -->
75 <para>
76
77 </para>
78
79 @c: 
80 @Returns: 
81
82
83 <!-- ##### FUNCTION g_unichar_isgraph ##### -->
84 <para>
85
86 </para>
87
88 @c: 
89 @Returns: 
90
91
92 <!-- ##### FUNCTION g_unichar_islower ##### -->
93 <para>
94
95 </para>
96
97 @c: 
98 @Returns: 
99
100
101 <!-- ##### FUNCTION g_unichar_isprint ##### -->
102 <para>
103
104 </para>
105
106 @c: 
107 @Returns: 
108
109
110 <!-- ##### FUNCTION g_unichar_ispunct ##### -->
111 <para>
112
113 </para>
114
115 @c: 
116 @Returns: 
117
118
119 <!-- ##### FUNCTION g_unichar_isspace ##### -->
120 <para>
121
122 </para>
123
124 @c: 
125 @Returns: 
126
127
128 <!-- ##### FUNCTION g_unichar_isupper ##### -->
129 <para>
130
131 </para>
132
133 @c: 
134 @Returns: 
135
136
137 <!-- ##### FUNCTION g_unichar_isxdigit ##### -->
138 <para>
139
140 </para>
141
142 @c: 
143 @Returns: 
144
145
146 <!-- ##### FUNCTION g_unichar_istitle ##### -->
147 <para>
148
149 </para>
150
151 @c: 
152 @Returns: 
153
154
155 <!-- ##### FUNCTION g_unichar_isdefined ##### -->
156 <para>
157
158 </para>
159
160 @c: 
161 @Returns: 
162
163
164 <!-- ##### FUNCTION g_unichar_iswide ##### -->
165 <para>
166
167 </para>
168
169 @c: 
170 @Returns: 
171
172
173 <!-- ##### FUNCTION g_unichar_toupper ##### -->
174 <para>
175
176 </para>
177
178 @c: 
179 @Returns: 
180
181
182 <!-- ##### FUNCTION g_unichar_tolower ##### -->
183 <para>
184
185 </para>
186
187 @c: 
188 @Returns: 
189
190
191 <!-- ##### FUNCTION g_unichar_totitle ##### -->
192 <para>
193
194 </para>
195
196 @c: 
197 @Returns: 
198
199
200 <!-- ##### FUNCTION g_unichar_digit_value ##### -->
201 <para>
202
203 </para>
204
205 @c: 
206 @Returns: 
207
208
209 <!-- ##### FUNCTION g_unichar_xdigit_value ##### -->
210 <para>
211
212 </para>
213
214 @c: 
215 @Returns: 
216
217
218 <!-- ##### ENUM GUnicodeType ##### -->
219 <para>
220
221 </para>
222
223 @G_UNICODE_CONTROL: 
224 @G_UNICODE_FORMAT: 
225 @G_UNICODE_UNASSIGNED: 
226 @G_UNICODE_PRIVATE_USE: 
227 @G_UNICODE_SURROGATE: 
228 @G_UNICODE_LOWERCASE_LETTER: 
229 @G_UNICODE_MODIFIER_LETTER: 
230 @G_UNICODE_OTHER_LETTER: 
231 @G_UNICODE_TITLECASE_LETTER: 
232 @G_UNICODE_UPPERCASE_LETTER: 
233 @G_UNICODE_COMBINING_MARK: 
234 @G_UNICODE_ENCLOSING_MARK: 
235 @G_UNICODE_NON_SPACING_MARK: 
236 @G_UNICODE_DECIMAL_NUMBER: 
237 @G_UNICODE_LETTER_NUMBER: 
238 @G_UNICODE_OTHER_NUMBER: 
239 @G_UNICODE_CONNECT_PUNCTUATION: 
240 @G_UNICODE_DASH_PUNCTUATION: 
241 @G_UNICODE_CLOSE_PUNCTUATION: 
242 @G_UNICODE_FINAL_PUNCTUATION: 
243 @G_UNICODE_INITIAL_PUNCTUATION: 
244 @G_UNICODE_OTHER_PUNCTUATION: 
245 @G_UNICODE_OPEN_PUNCTUATION: 
246 @G_UNICODE_CURRENCY_SYMBOL: 
247 @G_UNICODE_MODIFIER_SYMBOL: 
248 @G_UNICODE_MATH_SYMBOL: 
249 @G_UNICODE_OTHER_SYMBOL: 
250 @G_UNICODE_LINE_SEPARATOR: 
251 @G_UNICODE_PARAGRAPH_SEPARATOR: 
252 @G_UNICODE_SPACE_SEPARATOR: 
253
254 <!-- ##### FUNCTION g_unichar_type ##### -->
255 <para>
256
257 </para>
258
259 @c: 
260 @Returns: 
261
262
263 <!-- ##### ENUM GUnicodeBreakType ##### -->
264 <para>
265
266 </para>
267
268 @G_UNICODE_BREAK_MANDATORY: 
269 @G_UNICODE_BREAK_CARRIAGE_RETURN: 
270 @G_UNICODE_BREAK_LINE_FEED: 
271 @G_UNICODE_BREAK_COMBINING_MARK: 
272 @G_UNICODE_BREAK_SURROGATE: 
273 @G_UNICODE_BREAK_ZERO_WIDTH_SPACE: 
274 @G_UNICODE_BREAK_INSEPARABLE: 
275 @G_UNICODE_BREAK_NON_BREAKING_GLUE: 
276 @G_UNICODE_BREAK_CONTINGENT: 
277 @G_UNICODE_BREAK_SPACE: 
278 @G_UNICODE_BREAK_AFTER: 
279 @G_UNICODE_BREAK_BEFORE: 
280 @G_UNICODE_BREAK_BEFORE_AND_AFTER: 
281 @G_UNICODE_BREAK_HYPHEN: 
282 @G_UNICODE_BREAK_NON_STARTER: 
283 @G_UNICODE_BREAK_OPEN_PUNCTUATION: 
284 @G_UNICODE_BREAK_CLOSE_PUNCTUATION: 
285 @G_UNICODE_BREAK_QUOTATION: 
286 @G_UNICODE_BREAK_EXCLAMATION: 
287 @G_UNICODE_BREAK_IDEOGRAPHIC: 
288 @G_UNICODE_BREAK_NUMERIC: 
289 @G_UNICODE_BREAK_INFIX_SEPARATOR: 
290 @G_UNICODE_BREAK_SYMBOL: 
291 @G_UNICODE_BREAK_ALPHABETIC: 
292 @G_UNICODE_BREAK_PREFIX: 
293 @G_UNICODE_BREAK_POSTFIX: 
294 @G_UNICODE_BREAK_COMPLEX_CONTEXT: 
295 @G_UNICODE_BREAK_AMBIGUOUS: 
296 @G_UNICODE_BREAK_UNKNOWN: 
297
298 <!-- ##### FUNCTION g_unichar_break_type ##### -->
299 <para>
300
301 </para>
302
303 @c: 
304 @Returns: 
305
306
307 <!-- ##### FUNCTION g_unicode_canonical_ordering ##### -->
308 <para>
309
310 </para>
311
312 @string: 
313 @len: 
314
315
316 <!-- ##### FUNCTION g_unicode_canonical_decomposition ##### -->
317 <para>
318
319 </para>
320
321 @ch: 
322 @result_len: 
323 @Returns: 
324
325
326 <!-- ##### MACRO g_utf8_next_char ##### -->
327 <para>
328 Skips to the next character in a UTF-8 string. The string must be
329 valid; this macro is as fast as possible, and has zero error-checking.
330 You would use this macro to iterate over a string character by
331 character. The macro returns the start of the next UTF-8 character.
332 Before using this macro, use g_utf8_validate() to validate strings
333 that may contain invalid UTF-8.
334 </para>
335
336 @p: Pointer to the start of a valid UTF-8 character.
337
338
339 <!-- ##### FUNCTION g_utf8_get_char ##### -->
340 <para>
341
342 </para>
343
344 @p: 
345 @Returns: 
346
347
348 <!-- ##### FUNCTION g_utf8_offset_to_pointer ##### -->
349 <para>
350
351 </para>
352
353 @str: 
354 @offset: 
355 @Returns: 
356
357
358 <!-- ##### FUNCTION g_utf8_pointer_to_offset ##### -->
359 <para>
360
361 </para>
362
363 @str: 
364 @pos: 
365 @Returns: 
366
367
368 <!-- ##### FUNCTION g_utf8_prev_char ##### -->
369 <para>
370
371 </para>
372
373 @p: 
374 @Returns: 
375
376
377 <!-- ##### FUNCTION g_utf8_find_next_char ##### -->
378 <para>
379
380 </para>
381
382 @p: 
383 @end: 
384 @Returns: 
385 <!-- # Unused Parameters # -->
386 @bound: 
387
388
389 <!-- ##### FUNCTION g_utf8_find_prev_char ##### -->
390 <para>
391
392 </para>
393
394 @str: 
395 @p: 
396 @Returns: 
397
398
399 <!-- ##### FUNCTION g_utf8_strlen ##### -->
400 <para>
401
402 </para>
403
404 @p: 
405 @max: 
406 @Returns: 
407
408
409 <!-- ##### FUNCTION g_utf8_strncpy ##### -->
410 <para>
411
412 </para>
413
414 @dest: 
415 @src: 
416 @n: 
417 @Returns: 
418
419
420 <!-- ##### FUNCTION g_utf8_strchr ##### -->
421 <para>
422
423 </para>
424
425 @p: 
426 @c: 
427 @Returns: 
428 <!-- # Unused Parameters # -->
429 @ch: 
430
431
432 <!-- ##### FUNCTION g_utf8_strrchr ##### -->
433 <para>
434
435 </para>
436
437 @p: 
438 @c: 
439 @Returns: 
440 <!-- # Unused Parameters # -->
441 @ch: 
442
443
444 <!-- ##### FUNCTION g_utf8_validate ##### -->
445 <para>
446
447 </para>
448
449 @str: 
450 @max_len: 
451 @end: 
452 @Returns: 
453 <!-- # Unused Parameters # -->
454 @len: 
455
456
457 <!-- ##### FUNCTION g_utf8_to_utf16 ##### -->
458 <para>
459
460 </para>
461
462 @str: 
463 @len: 
464 @items_read: 
465 @items_written: 
466 @error: 
467 @Returns: 
468
469
470 <!-- ##### FUNCTION g_utf8_to_ucs4 ##### -->
471 <para>
472
473 </para>
474
475 @str: 
476 @len: 
477 @items_read: 
478 @items_written: 
479 @error: 
480 @Returns: 
481
482
483 <!-- ##### FUNCTION g_utf8_to_ucs4_fast ##### -->
484 <para>
485
486 </para>
487
488 @str: 
489 @len: 
490 @items_written: 
491 @Returns: 
492
493
494 <!-- ##### FUNCTION g_utf16_to_ucs4 ##### -->
495 <para>
496
497 </para>
498
499 @str: 
500 @len: 
501 @items_read: 
502 @items_written: 
503 @error: 
504 @Returns: 
505
506
507 <!-- ##### FUNCTION g_utf16_to_utf8 ##### -->
508 <para>
509
510 </para>
511
512 @str: 
513 @len: 
514 @items_read: 
515 @items_written: 
516 @error: 
517 @Returns: 
518
519
520 <!-- ##### FUNCTION g_ucs4_to_utf16 ##### -->
521 <para>
522
523 </para>
524
525 @str: 
526 @len: 
527 @items_read: 
528 @items_written: 
529 @error: 
530 @Returns: 
531
532
533 <!-- ##### FUNCTION g_ucs4_to_utf8 ##### -->
534 <para>
535
536 </para>
537
538 @str: 
539 @len: 
540 @items_read: 
541 @items_written: 
542 @error: 
543 @Returns: 
544
545
546 <!-- ##### FUNCTION g_unichar_to_utf8 ##### -->
547 <para>
548
549 </para>
550
551 @c: 
552 @outbuf: 
553 @Returns: 
554
555