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_get_char_validated ##### -->
 349 <para>
 350
 351 </para>
 352
 353 @p:
 354 @max_len:
 355 @Returns:
 356
 357
 358 <!-- ##### FUNCTION g_utf8_offset_to_pointer ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @str:
 364 @offset:
 365 @Returns:
 366
 367
 368 <!-- ##### FUNCTION g_utf8_pointer_to_offset ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @str:
 374 @pos:
 375 @Returns:
 376
 377
 378 <!-- ##### FUNCTION g_utf8_prev_char ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @p:
 384 @Returns:
 385
 386
 387 <!-- ##### FUNCTION g_utf8_find_next_char ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @p:
 393 @end:
 394 @Returns:
 395 <!-- # Unused Parameters # -->
 396 @bound:
 397
 398
 399 <!-- ##### FUNCTION g_utf8_find_prev_char ##### -->
 400 <para>
 401
 402 </para>
 403
 404 @str:
 405 @p:
 406 @Returns:
 407
 408
 409 <!-- ##### FUNCTION g_utf8_strlen ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @p:
 415 @max:
 416 @Returns:
 417
 418
 419 <!-- ##### FUNCTION g_utf8_strncpy ##### -->
 420 <para>
 421
 422 </para>
 423
 424 @dest:
 425 @src:
 426 @n:
 427 @Returns:
 428
 429
 430 <!-- ##### FUNCTION g_utf8_strchr ##### -->
 431 <para>
 432
 433 </para>
 434
 435 @p:
 436 @len:
 437 @c:
 438 @Returns:
 439 <!-- # Unused Parameters # -->
 440 @ch:
 441
 442
 443 <!-- ##### FUNCTION g_utf8_strrchr ##### -->
 444 <para>
 445
 446 </para>
 447
 448 @p:
 449 @len:
 450 @c:
 451 @Returns:
 452 <!-- # Unused Parameters # -->
 453 @ch:
 454
 455
 456 <!-- ##### FUNCTION g_utf8_validate ##### -->
 457 <para>
 458
 459 </para>
 460
 461 @str:
 462 @max_len:
 463 @end:
 464 @Returns:
 465 <!-- # Unused Parameters # -->
 466 @len:
 467
 468
 469 <!-- ##### FUNCTION g_utf8_strup ##### -->
 470 <para>
 471
 472 </para>
 473
 474 @str:
 475 @len:
 476 @Returns:
 477
 478
 479 <!-- ##### FUNCTION g_utf8_strdown ##### -->
 480 <para>
 481
 482 </para>
 483
 484 @str:
 485 @len:
 486 @Returns:
 487
 488
 489 <!-- ##### FUNCTION g_utf8_casefold ##### -->
 490 <para>
 491
 492 </para>
 493
 494 @str:
 495 @len:
 496 @Returns:
 497
 498
 499 <!-- ##### FUNCTION g_utf8_normalize ##### -->
 500 <para>
 501
 502 </para>
 503
 504 @str:
 505 @len:
 506 @mode:
 507 @Returns:
 508
 509
 510 <!-- ##### ENUM GNormalizeMode ##### -->
 511 <para>
 512
 513 </para>
 514
 515 @G_NORMALIZE_DEFAULT:
 516 @G_NORMALIZE_NFD:
 517 @G_NORMALIZE_DEFAULT_COMPOSE:
 518 @G_NORMALIZE_NFC:
 519 @G_NORMALIZE_ALL:
 520 @G_NORMALIZE_NFKD:
 521 @G_NORMALIZE_ALL_COMPOSE:
 522 @G_NORMALIZE_NFKC:
 523
 524 <!-- ##### FUNCTION g_utf8_collate ##### -->
 525 <para>
 526
 527 </para>
 528
 529 @str1:
 530 @str2:
 531 @Returns:
 532
 533
 534 <!-- ##### FUNCTION g_utf8_collate_key ##### -->
 535 <para>
 536
 537 </para>
 538
 539 @str:
 540 @len:
 541 @Returns:
 542
 543
 544 <!-- ##### FUNCTION g_utf8_to_utf16 ##### -->
 545 <para>
 546
 547 </para>
 548
 549 @str:
 550 @len:
 551 @items_read:
 552 @items_written:
 553 @error:
 554 @Returns:
 555
 556
 557 <!-- ##### FUNCTION g_utf8_to_ucs4 ##### -->
 558 <para>
 559
 560 </para>
 561
 562 @str:
 563 @len:
 564 @items_read:
 565 @items_written:
 566 @error:
 567 @Returns:
 568
 569
 570 <!-- ##### FUNCTION g_utf8_to_ucs4_fast ##### -->
 571 <para>
 572
 573 </para>
 574
 575 @str:
 576 @len:
 577 @items_written:
 578 @Returns:
 579
 580
 581 <!-- ##### FUNCTION g_utf16_to_ucs4 ##### -->
 582 <para>
 583
 584 </para>
 585
 586 @str:
 587 @len:
 588 @items_read:
 589 @items_written:
 590 @error:
 591 @Returns:
 592
 593
 594 <!-- ##### FUNCTION g_utf16_to_utf8 ##### -->
 595 <para>
 596
 597 </para>
 598
 599 @str:
 600 @len:
 601 @items_read:
 602 @items_written:
 603 @error:
 604 @Returns:
 605
 606
 607 <!-- ##### FUNCTION g_ucs4_to_utf16 ##### -->
 608 <para>
 609
 610 </para>
 611
 612 @str:
 613 @len:
 614 @items_read:
 615 @items_written:
 616 @error:
 617 @Returns:
 618
 619
 620 <!-- ##### FUNCTION g_ucs4_to_utf8 ##### -->
 621 <para>
 622
 623 </para>
 624
 625 @str:
 626 @len:
 627 @items_read:
 628 @items_written:
 629 @error:
 630 @Returns:
 631
 632
 633 <!-- ##### FUNCTION g_unichar_to_utf8 ##### -->
 634 <para>
 635
 636 </para>
 637
 638 @c:
 639 @outbuf:
 640 @Returns:
 641
 642