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