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