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 A type which can hold any UCS-4 character code.
  20 </para>
  21
  22
  23 <!-- ##### TYPEDEF gunichar2 ##### -->
  24 <para>
  25 A type which can hold any UTF-16 character code.
  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 These are the possible character classifications.
 222 See <ulink url="http://www.unicode.org/Public/UNIDATA/UnicodeData.html"
 223 >http://www.unicode.org/Public/UNIDATA/UnicodeData.html</ulink>.
 224 </para>
 225
 226 @G_UNICODE_CONTROL:
 227 @G_UNICODE_FORMAT:
 228 @G_UNICODE_UNASSIGNED:
 229 @G_UNICODE_PRIVATE_USE:
 230 @G_UNICODE_SURROGATE:
 231 @G_UNICODE_LOWERCASE_LETTER:
 232 @G_UNICODE_MODIFIER_LETTER:
 233 @G_UNICODE_OTHER_LETTER:
 234 @G_UNICODE_TITLECASE_LETTER:
 235 @G_UNICODE_UPPERCASE_LETTER:
 236 @G_UNICODE_COMBINING_MARK:
 237 @G_UNICODE_ENCLOSING_MARK:
 238 @G_UNICODE_NON_SPACING_MARK:
 239 @G_UNICODE_DECIMAL_NUMBER:
 240 @G_UNICODE_LETTER_NUMBER:
 241 @G_UNICODE_OTHER_NUMBER:
 242 @G_UNICODE_CONNECT_PUNCTUATION:
 243 @G_UNICODE_DASH_PUNCTUATION:
 244 @G_UNICODE_CLOSE_PUNCTUATION:
 245 @G_UNICODE_FINAL_PUNCTUATION:
 246 @G_UNICODE_INITIAL_PUNCTUATION:
 247 @G_UNICODE_OTHER_PUNCTUATION:
 248 @G_UNICODE_OPEN_PUNCTUATION:
 249 @G_UNICODE_CURRENCY_SYMBOL:
 250 @G_UNICODE_MODIFIER_SYMBOL:
 251 @G_UNICODE_MATH_SYMBOL:
 252 @G_UNICODE_OTHER_SYMBOL:
 253 @G_UNICODE_LINE_SEPARATOR:
 254 @G_UNICODE_PARAGRAPH_SEPARATOR:
 255 @G_UNICODE_SPACE_SEPARATOR:
 256
 257 <!-- ##### FUNCTION g_unichar_type ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @c:
 263 @Returns:
 264
 265
 266 <!-- ##### ENUM GUnicodeBreakType ##### -->
 267 <para>
 268 These are the possible line break classifications.
 269 See <ulink url="http://www.unicode.org/unicode/reports/tr14/"
 270 >http://www.unicode.org/unicode/reports/tr14/</ulink>.
 271 </para>
 272
 273 @G_UNICODE_BREAK_MANDATORY:
 274 @G_UNICODE_BREAK_CARRIAGE_RETURN:
 275 @G_UNICODE_BREAK_LINE_FEED:
 276 @G_UNICODE_BREAK_COMBINING_MARK:
 277 @G_UNICODE_BREAK_SURROGATE:
 278 @G_UNICODE_BREAK_ZERO_WIDTH_SPACE:
 279 @G_UNICODE_BREAK_INSEPARABLE:
 280 @G_UNICODE_BREAK_NON_BREAKING_GLUE:
 281 @G_UNICODE_BREAK_CONTINGENT:
 282 @G_UNICODE_BREAK_SPACE:
 283 @G_UNICODE_BREAK_AFTER:
 284 @G_UNICODE_BREAK_BEFORE:
 285 @G_UNICODE_BREAK_BEFORE_AND_AFTER:
 286 @G_UNICODE_BREAK_HYPHEN:
 287 @G_UNICODE_BREAK_NON_STARTER:
 288 @G_UNICODE_BREAK_OPEN_PUNCTUATION:
 289 @G_UNICODE_BREAK_CLOSE_PUNCTUATION:
 290 @G_UNICODE_BREAK_QUOTATION:
 291 @G_UNICODE_BREAK_EXCLAMATION:
 292 @G_UNICODE_BREAK_IDEOGRAPHIC:
 293 @G_UNICODE_BREAK_NUMERIC:
 294 @G_UNICODE_BREAK_INFIX_SEPARATOR:
 295 @G_UNICODE_BREAK_SYMBOL:
 296 @G_UNICODE_BREAK_ALPHABETIC:
 297 @G_UNICODE_BREAK_PREFIX:
 298 @G_UNICODE_BREAK_POSTFIX:
 299 @G_UNICODE_BREAK_COMPLEX_CONTEXT:
 300 @G_UNICODE_BREAK_AMBIGUOUS:
 301 @G_UNICODE_BREAK_UNKNOWN:
 302
 303 <!-- ##### FUNCTION g_unichar_break_type ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @c:
 309 @Returns:
 310
 311
 312 <!-- ##### FUNCTION g_unicode_canonical_ordering ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @string:
 318 @len:
 319
 320
 321 <!-- ##### FUNCTION g_unicode_canonical_decomposition ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @ch:
 327 @result_len:
 328 @Returns:
 329
 330
 331 <!-- ##### MACRO g_utf8_next_char ##### -->
 332 <para>
 333 Skips to the next character in a UTF-8 string. The string must be
 334 valid; this macro is as fast as possible, and has zero error-checking.
 335 You would use this macro to iterate over a string character by
 336 character. The macro returns the start of the next UTF-8 character.
 337 Before using this macro, use g_utf8_validate() to validate strings
 338 that may contain invalid UTF-8.
 339 </para>
 340
 341 @p: Pointer to the start of a valid UTF-8 character.
 342
 343
 344 <!-- ##### FUNCTION g_utf8_get_char ##### -->
 345 <para>
 346
 347 </para>
 348
 349 @p:
 350 @Returns:
 351
 352
 353 <!-- ##### FUNCTION g_utf8_get_char_validated ##### -->
 354 <para>
 355
 356 </para>
 357
 358 @p:
 359 @max_len:
 360 @Returns:
 361
 362
 363 <!-- ##### FUNCTION g_utf8_offset_to_pointer ##### -->
 364 <para>
 365
 366 </para>
 367
 368 @str:
 369 @offset:
 370 @Returns:
 371
 372
 373 <!-- ##### FUNCTION g_utf8_pointer_to_offset ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @str:
 379 @pos:
 380 @Returns:
 381
 382
 383 <!-- ##### FUNCTION g_utf8_prev_char ##### -->
 384 <para>
 385
 386 </para>
 387
 388 @p:
 389 @Returns:
 390
 391
 392 <!-- ##### FUNCTION g_utf8_find_next_char ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @p:
 398 @end:
 399 @Returns:
 400 <!-- # Unused Parameters # -->
 401 @bound:
 402
 403
 404 <!-- ##### FUNCTION g_utf8_find_prev_char ##### -->
 405 <para>
 406
 407 </para>
 408
 409 @str:
 410 @p:
 411 @Returns:
 412
 413
 414 <!-- ##### FUNCTION g_utf8_strlen ##### -->
 415 <para>
 416
 417 </para>
 418
 419 @p:
 420 @max:
 421 @Returns:
 422
 423
 424 <!-- ##### FUNCTION g_utf8_strncpy ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @dest:
 430 @src:
 431 @n:
 432 @Returns:
 433
 434
 435 <!-- ##### FUNCTION g_utf8_strchr ##### -->
 436 <para>
 437
 438 </para>
 439
 440 @p:
 441 @len:
 442 @c:
 443 @Returns:
 444 <!-- # Unused Parameters # -->
 445 @ch:
 446
 447
 448 <!-- ##### FUNCTION g_utf8_strrchr ##### -->
 449 <para>
 450
 451 </para>
 452
 453 @p:
 454 @len:
 455 @c:
 456 @Returns:
 457 <!-- # Unused Parameters # -->
 458 @ch:
 459
 460
 461 <!-- ##### FUNCTION g_utf8_validate ##### -->
 462 <para>
 463
 464 </para>
 465
 466 @str:
 467 @max_len:
 468 @end:
 469 @Returns:
 470 <!-- # Unused Parameters # -->
 471 @len:
 472
 473
 474 <!-- ##### FUNCTION g_utf8_strup ##### -->
 475 <para>
 476
 477 </para>
 478
 479 @str:
 480 @len:
 481 @Returns:
 482
 483
 484 <!-- ##### FUNCTION g_utf8_strdown ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @str:
 490 @len:
 491 @Returns:
 492
 493
 494 <!-- ##### FUNCTION g_utf8_casefold ##### -->
 495 <para>
 496
 497 </para>
 498
 499 @str:
 500 @len:
 501 @Returns:
 502
 503
 504 <!-- ##### FUNCTION g_utf8_normalize ##### -->
 505 <para>
 506
 507 </para>
 508
 509 @str:
 510 @len:
 511 @mode:
 512 @Returns:
 513
 514
 515 <!-- ##### ENUM GNormalizeMode ##### -->
 516 <para>
 517
 518 </para>
 519
 520 @G_NORMALIZE_DEFAULT:
 521 @G_NORMALIZE_NFD:
 522 @G_NORMALIZE_DEFAULT_COMPOSE:
 523 @G_NORMALIZE_NFC:
 524 @G_NORMALIZE_ALL:
 525 @G_NORMALIZE_NFKD:
 526 @G_NORMALIZE_ALL_COMPOSE:
 527 @G_NORMALIZE_NFKC:
 528
 529 <!-- ##### FUNCTION g_utf8_collate ##### -->
 530 <para>
 531
 532 </para>
 533
 534 @str1:
 535 @str2:
 536 @Returns:
 537
 538
 539 <!-- ##### FUNCTION g_utf8_collate_key ##### -->
 540 <para>
 541
 542 </para>
 543
 544 @str:
 545 @len:
 546 @Returns:
 547
 548
 549 <!-- ##### FUNCTION g_utf8_to_utf16 ##### -->
 550 <para>
 551
 552 </para>
 553
 554 @str:
 555 @len:
 556 @items_read:
 557 @items_written:
 558 @error:
 559 @Returns:
 560
 561
 562 <!-- ##### FUNCTION g_utf8_to_ucs4 ##### -->
 563 <para>
 564
 565 </para>
 566
 567 @str:
 568 @len:
 569 @items_read:
 570 @items_written:
 571 @error:
 572 @Returns:
 573
 574
 575 <!-- ##### FUNCTION g_utf8_to_ucs4_fast ##### -->
 576 <para>
 577
 578 </para>
 579
 580 @str:
 581 @len:
 582 @items_written:
 583 @Returns:
 584
 585
 586 <!-- ##### FUNCTION g_utf16_to_ucs4 ##### -->
 587 <para>
 588
 589 </para>
 590
 591 @str:
 592 @len:
 593 @items_read:
 594 @items_written:
 595 @error:
 596 @Returns:
 597
 598
 599 <!-- ##### FUNCTION g_utf16_to_utf8 ##### -->
 600 <para>
 601
 602 </para>
 603
 604 @str:
 605 @len:
 606 @items_read:
 607 @items_written:
 608 @error:
 609 @Returns:
 610
 611
 612 <!-- ##### FUNCTION g_ucs4_to_utf16 ##### -->
 613 <para>
 614
 615 </para>
 616
 617 @str:
 618 @len:
 619 @items_read:
 620 @items_written:
 621 @error:
 622 @Returns:
 623
 624
 625 <!-- ##### FUNCTION g_ucs4_to_utf8 ##### -->
 626 <para>
 627
 628 </para>
 629
 630 @str:
 631 @len:
 632 @items_read:
 633 @items_written:
 634 @error:
 635 @Returns:
 636
 637
 638 <!-- ##### FUNCTION g_unichar_to_utf8 ##### -->
 639 <para>
 640
 641 </para>
 642
 643 @c:
 644 @outbuf:
 645 @Returns:
 646
 647