glib/docs.c

   1 /*
   2  * Copyright © 2011 Red Hat, Inc
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the licence, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Author: Matthias Clasen
  18  */
  19
  20
  21 /* This file collects documentation for macros, typedefs and
  22  * the like, which have no good home in any of the 'real' source
  23  * files.
  24  */
  25
  26 /* Basic types {{{1 */
  27
  28 /**
  29  * SECTION:types
  30  * @title: Basic Types
  31  * @short_description: standard GLib types, defined for ease-of-use
  32  *     and portability
  33  *
  34  * GLib defines a number of commonly used types, which can be divided
  35  * into 4 groups:
  36  * - New types which are not part of standard C (but are defined in
  37  *   various C standard library header files) - #gboolean, #gsize,
  38  *   #gssize, #goffset, #gintptr, #guintptr.
  39  * - Integer types which are guaranteed to be the same size across
  40  *   all platforms - #gint8, #guint8, #gint16, #guint16, #gint32,
  41  *   #guint32, #gint64, #guint64.
  42  * - Types which are easier to use than their standard C counterparts -
  43  *   #gpointer, #gconstpointer, #guchar, #guint, #gushort, #gulong.
  44  * - Types which correspond exactly to standard C types, but are
  45  *   included for completeness - #gchar, #gint, #gshort, #glong,
  46  *   #gfloat, #gdouble.
  47  *
  48  * GLib also defines macros for the limits of some of the standard
  49  * integer and floating point types, as well as macros for suitable
  50  * printf() formats for these types.
  51  */
  52
  53 /**
  54  * gboolean:
  55  *
  56  * A standard boolean type.
  57  * Variables of this type should only contain the value
  58  * %TRUE or %FALSE.
  59  */
  60
  61 /**
  62  * gpointer:
  63  *
  64  * An untyped pointer.
  65  * #gpointer looks better and is easier to use than void*.
  66  */
  67
  68 /**
  69  * gconstpointer:
  70  *
  71  * An untyped pointer to constant data.
  72  * The data pointed to should not be changed.
  73  *
  74  * This is typically used in function prototypes to indicate
  75  * that the data pointed to will not be altered by the function.
  76  */
  77
  78 /**
  79  * gchar:
  80  *
  81  * Corresponds to the standard C char type.
  82  */
  83
  84 /**
  85  * guchar:
  86  *
  87  * Corresponds to the standard C unsigned char type.
  88  */
  89
  90 /**
  91  * gint:
  92  *
  93  * Corresponds to the standard C int type.
  94  * Values of this type can range from #G_MININT to #G_MAXINT.
  95  */
  96
  97 /**
  98  * G_MININT:
  99  *
 100  * The minimum value which can be held in a #gint.
 101  */
 102
 103 /**
 104  * G_MAXINT:
 105  *
 106  * The maximum value which can be held in a #gint.
 107  */
 108
 109 /**
 110  * guint:
 111  *
 112  * Corresponds to the standard C unsigned int type.
 113  * Values of this type can range from 0 to #G_MAXUINT.
 114  */
 115
 116 /**
 117  * G_MAXUINT:
 118  *
 119  * The maximum value which can be held in a #guint.
 120  */
 121
 122 /**
 123  * gshort:
 124  *
 125  * Corresponds to the standard C short type.
 126  * Values of this type can range from #G_MINSHORT to #G_MAXSHORT.
 127  */
 128
 129 /**
 130  * G_MINSHORT:
 131  *
 132  * The minimum value which can be held in a #gshort.
 133  */
 134
 135 /**
 136  * G_MAXSHORT:
 137  *
 138  * The maximum value which can be held in a #gshort.
 139  */
 140
 141 /**
 142  * gushort:
 143  *
 144  * Corresponds to the standard C unsigned short type.
 145  * Values of this type can range from 0 to #G_MAXUSHORT.
 146  */
 147
 148 /**
 149  * G_MAXUSHORT:
 150  *
 151  * The maximum value which can be held in a #gushort.
 152  */
 153
 154 /**
 155  * glong:
 156  *
 157  * Corresponds to the standard C long type.
 158  * Values of this type can range from #G_MINLONG to #G_MAXLONG.
 159  */
 160
 161 /**
 162  * G_MINLONG:
 163  *
 164  * The minimum value which can be held in a #glong.
 165  */
 166
 167 /**
 168  * G_MAXLONG:
 169  *
 170  * The maximum value which can be held in a #glong.
 171  */
 172
 173 /**
 174  * gulong:
 175  *
 176  * Corresponds to the standard C unsigned long type.
 177  * Values of this type can range from 0 to #G_MAXULONG.
 178  */
 179
 180 /**
 181  * G_MAXULONG:
 182  *
 183  * The maximum value which can be held in a #gulong.
 184  */
 185
 186 /**
 187  * gint8:
 188  *
 189  * A signed integer guaranteed to be 8 bits on all platforms.
 190  * Values of this type can range from #G_MININT8 (= -128) to
 191  * #G_MAXINT8 (= 127).
 192  */
 193
 194 /**
 195  * G_MININT8:
 196  *
 197  * The minimum value which can be held in a #gint8.
 198  *
 199  * Since: 2.4
 200  */
 201
 202 /**
 203  * G_MAXINT8:
 204  *
 205  * The maximum value which can be held in a #gint8.
 206  *
 207  * Since: 2.4
 208  */
 209
 210 /**
 211  * guint8:
 212  *
 213  * An unsigned integer guaranteed to be 8 bits on all platforms.
 214  * Values of this type can range from 0 to #G_MAXUINT8 (= 255).
 215  */
 216
 217 /**
 218  * G_MAXUINT8:
 219  *
 220  * The maximum value which can be held in a #guint8.
 221  *
 222  * Since: 2.4
 223  */
 224
 225 /**
 226  * gint16:
 227  *
 228  * A signed integer guaranteed to be 16 bits on all platforms.
 229  * Values of this type can range from #G_MININT16 (= -32,768) to
 230  * #G_MAXINT16 (= 32,767).
 231  *
 232  * To print or scan values of this type, use
 233  * %G_GINT16_MODIFIER and/or %G_GINT16_FORMAT.
 234  */
 235
 236 /**
 237  * G_MININT16:
 238  *
 239  * The minimum value which can be held in a #gint16.
 240  *
 241  * Since: 2.4
 242  */
 243
 244 /**
 245  * G_MAXINT16:
 246  *
 247  * The maximum value which can be held in a #gint16.
 248  *
 249  * Since: 2.4
 250  */
 251
 252 /**
 253  * G_GINT16_MODIFIER:
 254  *
 255  * The platform dependent length modifier for conversion specifiers
 256  * for scanning and printing values of type #gint16 or #guint16. It
 257  * is a string literal, but doesn't include the percent-sign, such
 258  * that you can add precision and length modifiers between percent-sign
 259  * and conversion specifier and append a conversion specifier.
 260  *
 261  * The following example prints "0x7b";
 262  * |[<!-- language="C" -->
 263  * gint16 value = 123;
 264  * g_print ("%#" G_GINT16_MODIFIER "x", value);
 265  * ]|
 266  *
 267  * Since: 2.4
 268  */
 269
 270 /**
 271  * G_GINT16_FORMAT:
 272  *
 273  * This is the platform dependent conversion specifier for scanning and
 274  * printing values of type #gint16. It is a string literal, but doesn't
 275  * include the percent-sign, such that you can add precision and length
 276  * modifiers between percent-sign and conversion specifier.
 277  *
 278  * |[<!-- language="C" -->
 279  * gint16 in;
 280  * gint32 out;
 281  * sscanf ("42", "%" G_GINT16_FORMAT, &in)
 282  * out = in * 1000;
 283  * g_print ("%" G_GINT32_FORMAT, out);
 284  * ]|
 285  */
 286
 287 /**
 288  * guint16:
 289  *
 290  * An unsigned integer guaranteed to be 16 bits on all platforms.
 291  * Values of this type can range from 0 to #G_MAXUINT16 (= 65,535).
 292  *
 293  * To print or scan values of this type, use
 294  * %G_GINT16_MODIFIER and/or %G_GUINT16_FORMAT.
 295  */
 296
 297 /**
 298  * G_MAXUINT16:
 299  *
 300  * The maximum value which can be held in a #guint16.
 301  *
 302  * Since: 2.4
 303  */
 304
 305 /**
 306  * G_GUINT16_FORMAT:
 307  *
 308  * This is the platform dependent conversion specifier for scanning
 309  * and printing values of type #guint16. See also #G_GINT16_FORMAT
 310  */
 311
 312 /**
 313  * gint32:
 314  *
 315  * A signed integer guaranteed to be 32 bits on all platforms.
 316  * Values of this type can range from #G_MININT32 (= -2,147,483,648)
 317  * to #G_MAXINT32 (= 2,147,483,647).
 318  *
 319  * To print or scan values of this type, use
 320  * %G_GINT32_MODIFIER and/or %G_GINT32_FORMAT.
 321  */
 322
 323 /**
 324  * G_MININT32:
 325  *
 326  * The minimum value which can be held in a #gint32.
 327  *
 328  * Since: 2.4
 329  */
 330
 331 /**
 332  * G_MAXINT32:
 333  *
 334  * The maximum value which can be held in a #gint32.
 335  *
 336  * Since: 2.4
 337  */
 338
 339 /**
 340  * G_GINT32_MODIFIER:
 341  *
 342  * The platform dependent length modifier for conversion specifiers
 343  * for scanning and printing values of type #gint32 or #guint32. It
 344  * is a string literal. See also #G_GINT16_MODIFIER.
 345  *
 346  * Since: 2.4
 347  */
 348
 349 /**
 350  * G_GINT32_FORMAT:
 351  *
 352  * This is the platform dependent conversion specifier for scanning
 353  * and printing values of type #gint32. See also #G_GINT16_FORMAT.
 354  */
 355
 356 /**
 357  * guint32:
 358  *
 359  * An unsigned integer guaranteed to be 32 bits on all platforms.
 360  * Values of this type can range from 0 to #G_MAXUINT32 (= 4,294,967,295).
 361  *
 362  * To print or scan values of this type, use
 363  * %G_GINT32_MODIFIER and/or %G_GUINT32_FORMAT.
 364  */
 365
 366 /**
 367  * G_MAXUINT32:
 368  *
 369  * The maximum value which can be held in a #guint32.
 370  *
 371  * Since: 2.4
 372  */
 373
 374 /**
 375  * G_GUINT32_FORMAT:
 376  *
 377  * This is the platform dependent conversion specifier for scanning
 378  * and printing values of type #guint32. See also #G_GINT16_FORMAT.
 379  */
 380
 381 /**
 382  * gint64:
 383  *
 384  * A signed integer guaranteed to be 64 bits on all platforms.
 385  * Values of this type can range from #G_MININT64
 386  * (= -9,223,372,036,854,775,808) to #G_MAXINT64
 387  * (= 9,223,372,036,854,775,807).
 388  *
 389  * To print or scan values of this type, use
 390  * %G_GINT64_MODIFIER and/or %G_GINT64_FORMAT.
 391  */
 392
 393 /**
 394  * G_MININT64:
 395  *
 396  * The minimum value which can be held in a #gint64.
 397  */
 398
 399 /**
 400  * G_MAXINT64:
 401  *
 402  * The maximum value which can be held in a #gint64.
 403  */
 404
 405 /**
 406  * G_GINT64_MODIFIER:
 407  *
 408  * The platform dependent length modifier for conversion specifiers
 409  * for scanning and printing values of type #gint64 or #guint64.
 410  * It is a string literal.
 411  *
 412  * Some platforms do not support printing 64-bit integers, even
 413  * though the types are supported. On such platforms %G_GINT64_MODIFIER
 414  * is not defined.
 415  *
 416  * Since: 2.4
 417  */
 418
 419 /**
 420  * G_GINT64_FORMAT:
 421  *
 422  * This is the platform dependent conversion specifier for scanning
 423  * and printing values of type #gint64. See also #G_GINT16_FORMAT.
 424  *
 425  * Some platforms do not support scanning and printing 64-bit integers,
 426  * even though the types are supported. On such platforms %G_GINT64_FORMAT
 427  * is not defined. Note that scanf() may not support 64-bit integers, even
 428  * if %G_GINT64_FORMAT is defined. Due to its weak error handling, scanf()
 429  * is not recommended for parsing anyway; consider using g_ascii_strtoull()
 430  * instead.
 431  */
 432
 433 /**
 434  * guint64:
 435  *
 436  * An unsigned integer guaranteed to be 64-bits on all platforms.
 437  * Values of this type can range from 0 to #G_MAXUINT64
 438  * (= 18,446,744,073,709,551,615).
 439  *
 440  * To print or scan values of this type, use
 441  * %G_GINT64_MODIFIER and/or %G_GUINT64_FORMAT.
 442  */
 443
 444 /**
 445  * G_MAXUINT64:
 446  *
 447  * The maximum value which can be held in a #guint64.
 448  */
 449
 450 /**
 451  * G_GUINT64_FORMAT:
 452  *
 453  * This is the platform dependent conversion specifier for scanning
 454  * and printing values of type #guint64. See also #G_GINT16_FORMAT.
 455  *
 456  * Some platforms do not support scanning and printing 64-bit integers,
 457  * even though the types are supported. On such platforms %G_GUINT64_FORMAT
 458  * is not defined.  Note that scanf() may not support 64-bit integers, even
 459  * if %G_GINT64_FORMAT is defined. Due to its weak error handling, scanf()
 460  * is not recommended for parsing anyway; consider using g_ascii_strtoull()
 461  * instead.
 462  */
 463
 464 /**
 465  * G_GINT64_CONSTANT:
 466  * @val: a literal integer value, e.g. 0x1d636b02300a7aa7
 467  *
 468  * This macro is used to insert 64-bit integer literals
 469  * into the source code.
 470  */
 471
 472 /**
 473  * G_GUINT64_CONSTANT:
 474  * @val: a literal integer value, e.g. 0x1d636b02300a7aa7U
 475  *
 476  * This macro is used to insert 64-bit unsigned integer
 477  * literals into the source code.
 478  *
 479  * Since: 2.10
 480  */
 481
 482 /**
 483  * gfloat:
 484  *
 485  * Corresponds to the standard C float type.
 486  * Values of this type can range from -#G_MAXFLOAT to #G_MAXFLOAT.
 487  */
 488
 489 /**
 490  * G_MINFLOAT:
 491  *
 492  * The minimum positive value which can be held in a #gfloat.
 493  *
 494  * If you are interested in the smallest value which can be held
 495  * in a #gfloat, use -%G_MAXFLOAT.
 496  */
 497
 498 /**
 499  * G_MAXFLOAT:
 500  *
 501  * The maximum value which can be held in a #gfloat.
 502  */
 503
 504 /**
 505  * gdouble:
 506  *
 507  * Corresponds to the standard C double type.
 508  * Values of this type can range from -#G_MAXDOUBLE to #G_MAXDOUBLE.
 509  */
 510
 511 /**
 512  * G_MINDOUBLE:
 513  *
 514  * The minimum positive value which can be held in a #gdouble.
 515  *
 516  * If you are interested in the smallest value which can be held
 517  * in a #gdouble, use -%G_MAXDOUBLE.
 518  */
 519
 520 /**
 521  * G_MAXDOUBLE:
 522  *
 523  * The maximum value which can be held in a #gdouble.
 524  */
 525
 526 /**
 527  * gsize:
 528  *
 529  * An unsigned integer type of the result of the sizeof operator,
 530  * corresponding to the size_t type defined in C99.
 531  * This type is wide enough to hold the numeric value of a pointer,
 532  * so it is usually 32 bit wide on a 32-bit platform and 64 bit wide
 533  * on a 64-bit platform. Values of this type can range from 0 to
 534  * #G_MAXSIZE.
 535  *
 536  * To print or scan values of this type, use
 537  * %G_GSIZE_MODIFIER and/or %G_GSIZE_FORMAT.
 538  */
 539
 540 /**
 541  * G_MAXSIZE:
 542  *
 543  * The maximum value which can be held in a #gsize.
 544  *
 545  * Since: 2.4
 546  */
 547
 548 /**
 549  * G_GSIZE_MODIFIER:
 550  *
 551  * The platform dependent length modifier for conversion specifiers
 552  * for scanning and printing values of type #gsize. It
 553  * is a string literal.
 554  *
 555  * Since: 2.6
 556  */
 557
 558 /**
 559  * G_GSIZE_FORMAT:
 560  *
 561  * This is the platform dependent conversion specifier for scanning
 562  * and printing values of type #gsize. See also #G_GINT16_FORMAT.
 563  *
 564  * Since: 2.6
 565  */
 566
 567 /**
 568  * gssize:
 569  *
 570  * A signed variant of #gsize, corresponding to the
 571  * ssize_t defined on most platforms.
 572  * Values of this type can range from #G_MINSSIZE
 573  * to #G_MAXSSIZE.
 574  *
 575  * To print or scan values of this type, use
 576  * %G_GSSIZE_MODIFIER and/or %G_GSSIZE_FORMAT.
 577  */
 578
 579 /**
 580  * G_MINSSIZE:
 581  *
 582  * The minimum value which can be held in a #gssize.
 583  *
 584  * Since: 2.14
 585  */
 586
 587 /**
 588  * G_MAXSSIZE:
 589  *
 590  * The maximum value which can be held in a #gssize.
 591  *
 592  * Since: 2.14
 593  */
 594
 595 /**
 596  * G_GSSIZE_FORMAT:
 597  *
 598  * This is the platform dependent conversion specifier for scanning
 599  * and printing values of type #gssize. See also #G_GINT16_FORMAT.
 600  *
 601  * Since: 2.6
 602  */
 603
 604 /**
 605  * G_GSSIZE_MODIFIER:
 606  *
 607  * The platform dependent length modifier for conversion specifiers
 608  * for scanning and printing values of type #gssize. It
 609  * is a string literal.
 610  *
 611  * Since: 2.6
 612  */
 613
 614 /**
 615  * goffset:
 616  *
 617  * A signed integer type that is used for file offsets,
 618  * corresponding to the C99 type off64_t.
 619  * Values of this type can range from #G_MINOFFSET to
 620  * #G_MAXOFFSET.
 621  *
 622  * To print or scan values of this type, use
 623  * %G_GOFFSET_MODIFIER and/or %G_GOFFSET_FORMAT.
 624  *
 625  * Since: 2.14
 626  */
 627
 628 /**
 629  * G_MINOFFSET:
 630  *
 631  * The minimum value which can be held in a #goffset.
 632  */
 633
 634 /**
 635  * G_MAXOFFSET:
 636  *
 637  * The maximum value which can be held in a #goffset.
 638  */
 639
 640 /**
 641  * G_GOFFSET_MODIFIER:
 642  *
 643  * The platform dependent length modifier for conversion specifiers
 644  * for scanning and printing values of type #goffset. It is a string
 645  * literal. See also #G_GINT64_MODIFIER.
 646  *
 647  * Since: 2.20
 648  */
 649
 650 /**
 651  * G_GOFFSET_FORMAT:
 652  *
 653  * This is the platform dependent conversion specifier for scanning
 654  * and printing values of type #goffset. See also #G_GINT64_FORMAT.
 655  *
 656  * Since: 2.20
 657  */
 658
 659 /**
 660  * G_GOFFSET_CONSTANT:
 661  * @val: a literal integer value, e.g. 0x1d636b02300a7aa7
 662  *
 663  * This macro is used to insert #goffset 64-bit integer literals
 664  * into the source code.
 665  *
 666  * See also #G_GINT64_CONSTANT.
 667  *
 668  * Since: 2.20
 669  */
 670
 671 /**
 672  * gintptr:
 673  *
 674  * Corresponds to the C99 type intptr_t,
 675  * a signed integer type that can hold any pointer.
 676  *
 677  * To print or scan values of this type, use
 678  * %G_GINTPTR_MODIFIER and/or %G_GINTPTR_FORMAT.
 679  *
 680  * Since: 2.18
 681  */
 682
 683 /**
 684  * G_GINTPTR_MODIFIER:
 685  *
 686  * The platform dependent length modifier for conversion specifiers
 687  * for scanning and printing values of type #gintptr or #guintptr.
 688  * It is a string literal.
 689  *
 690  * Since: 2.22
 691  */
 692
 693 /**
 694  * G_GINTPTR_FORMAT:
 695  *
 696  * This is the platform dependent conversion specifier for scanning
 697  * and printing values of type #gintptr.
 698  *
 699  * Since: 2.22
 700  */
 701
 702 /**
 703  * guintptr:
 704  *
 705  * Corresponds to the C99 type uintptr_t,
 706  * an unsigned integer type that can hold any pointer.
 707  *
 708  * To print or scan values of this type, use
 709  * %G_GINTPTR_MODIFIER and/or %G_GUINTPTR_FORMAT.
 710  *
 711  * Since: 2.18
 712  */
 713
 714 /**
 715  * G_GUINTPTR_FORMAT:
 716  *
 717  * This is the platform dependent conversion specifier
 718  * for scanning and printing values of type #guintptr.
 719  *
 720  * Since: 2.22
 721  */
 722
 723 /* Type conversion {{{1 */
 724
 725 /**
 726  * SECTION:type_conversion
 727  * @title: Type Conversion Macros
 728  * @short_description: portably storing integers in pointer variables
 729  *
 730  * Many times GLib, GTK+, and other libraries allow you to pass "user
 731  * data" to a callback, in the form of a void pointer. From time to time
 732  * you want to pass an integer instead of a pointer. You could allocate
 733  * an integer, with something like:
 734  * |[<!-- language="C" -->
 735  *   int *ip = g_new (int, 1);
 736  *   *ip = 42;
 737  * ]|
 738  * But this is inconvenient, and it's annoying to have to free the
 739  * memory at some later time.
 740  *
 741  * Pointers are always at least 32 bits in size (on all platforms GLib
 742  * intends to support). Thus you can store at least 32-bit integer values
 743  * in a pointer value. Naively, you might try this, but it's incorrect:
 744  * |[<!-- language="C" -->
 745  *   gpointer p;
 746  *   int i;
 747  *   p = (void*) 42;
 748  *   i = (int) p;
 749  * ]|
 750  * Again, that example was not correct, don't copy it.
 751  * The problem is that on some systems you need to do this:
 752  * |[<!-- language="C" -->
 753  *   gpointer p;
 754  *   int i;
 755  *   p = (void*) (long) 42;
 756  *   i = (int) (long) p;
 757  * ]|
 758  * The GLib macros GPOINTER_TO_INT(), GINT_TO_POINTER(), etc. take care
 759  * to do the right thing on the every platform.
 760  *
 761  * Warning: You may not store pointers in integers. This is not
 762  * portable in any way, shape or form. These macros only allow storing
 763  * integers in pointers, and only preserve 32 bits of the integer; values
 764  * outside the range of a 32-bit integer will be mangled.
 765  */
 766
 767 /**
 768  * GINT_TO_POINTER:
 769  * @i: integer to stuff into a pointer
 770  *
 771  * Stuffs an integer into a pointer type.
 772  *
 773  * Remember, you may not store pointers in integers. This is not portable
 774  * in any way, shape or form. These macros only allow storing integers in
 775  * pointers, and only preserve 32 bits of the integer; values outside the
 776  * range of a 32-bit integer will be mangled.
 777  */
 778
 779 /**
 780  * GPOINTER_TO_INT:
 781  * @p: pointer containing an integer
 782  *
 783  * Extracts an integer from a pointer. The integer must have
 784  * been stored in the pointer with GINT_TO_POINTER().
 785  *
 786  * Remember, you may not store pointers in integers. This is not portable
 787  * in any way, shape or form. These macros only allow storing integers in
 788  * pointers, and only preserve 32 bits of the integer; values outside the
 789  * range of a 32-bit integer will be mangled.
 790  */
 791
 792 /**
 793  * GUINT_TO_POINTER:
 794  * @u: unsigned integer to stuff into the pointer
 795  *
 796  * Stuffs an unsigned integer into a pointer type.
 797  */
 798
 799 /**
 800  * GPOINTER_TO_UINT:
 801  * @p: pointer to extract an unsigned integer from
 802  *
 803  * Extracts an unsigned integer from a pointer. The integer must have
 804  * been stored in the pointer with GUINT_TO_POINTER().
 805  */
 806
 807 /**
 808  * GSIZE_TO_POINTER:
 809  * @s: #gsize to stuff into the pointer
 810  *
 811  * Stuffs a #gsize into a pointer type.
 812  */
 813
 814 /**
 815  * GPOINTER_TO_SIZE:
 816  * @p: pointer to extract a #gsize from
 817  *
 818  * Extracts a #gsize from a pointer. The #gsize must have
 819  * been stored in the pointer with GSIZE_TO_POINTER().
 820  */
 821
 822 /* Byte order {{{1 */
 823
 824 /**
 825  * SECTION:byte_order
 826  * @title: Byte Order Macros
 827  * @short_description: a portable way to convert between different byte orders
 828  *
 829  * These macros provide a portable way to determine the host byte order
 830  * and to convert values between different byte orders.
 831  *
 832  * The byte order is the order in which bytes are stored to create larger
 833  * data types such as the #gint and #glong values.
 834  * The host byte order is the byte order used on the current machine.
 835  *
 836  * Some processors store the most significant bytes (i.e. the bytes that
 837  * hold the largest part of the value) first. These are known as big-endian
 838  * processors. Other processors (notably the x86 family) store the most
 839  * significant byte last. These are known as little-endian processors.
 840  *
 841  * Finally, to complicate matters, some other processors store the bytes in
 842  * a rather curious order known as PDP-endian. For a 4-byte word, the 3rd
 843  * most significant byte is stored first, then the 4th, then the 1st and
 844  * finally the 2nd.
 845  *
 846  * Obviously there is a problem when these different processors communicate
 847  * with each other, for example over networks or by using binary file formats.
 848  * This is where these macros come in. They are typically used to convert
 849  * values into a byte order which has been agreed on for use when
 850  * communicating between different processors. The Internet uses what is
 851  * known as 'network byte order' as the standard byte order (which is in
 852  * fact the big-endian byte order).
 853  *
 854  * Note that the byte order conversion macros may evaluate their arguments
 855  * multiple times, thus you should not use them with arguments which have
 856  * side-effects.
 857  */
 858
 859 /**
 860  * G_BYTE_ORDER:
 861  *
 862  * The host byte order.
 863  * This can be either #G_LITTLE_ENDIAN or #G_BIG_ENDIAN (support for
 864  * #G_PDP_ENDIAN may be added in future.)
 865  */
 866
 867 /**
 868  * G_LITTLE_ENDIAN:
 869  *
 870  * Specifies one of the possible types of byte order.
 871  * See #G_BYTE_ORDER.
 872  */
 873
 874 /**
 875  * G_BIG_ENDIAN:
 876  *
 877  * Specifies one of the possible types of byte order.
 878  * See #G_BYTE_ORDER.
 879  */
 880
 881 /**
 882  * G_PDP_ENDIAN:
 883  *
 884  * Specifies one of the possible types of byte order
 885  * (currently unused). See #G_BYTE_ORDER.
 886  */
 887
 888 /**
 889  * g_htonl:
 890  * @val: a 32-bit integer value in host byte order
 891  *
 892  * Converts a 32-bit integer value from host to network byte order.
 893  *
 894  * Returns: @val converted to network byte order
 895  */
 896
 897 /**
 898  * g_htons:
 899  * @val: a 16-bit integer value in host byte order
 900  *
 901  * Converts a 16-bit integer value from host to network byte order.
 902  *
 903  * Returns: @val converted to network byte order
 904  */
 905
 906 /**
 907  * g_ntohl:
 908  * @val: a 32-bit integer value in network byte order
 909  *
 910  * Converts a 32-bit integer value from network to host byte order.
 911  *
 912  * Returns: @val converted to host byte order.
 913  */
 914
 915 /**
 916  * g_ntohs:
 917  * @val: a 16-bit integer value in network byte order
 918  *
 919  * Converts a 16-bit integer value from network to host byte order.
 920  *
 921  * Returns: @val converted to host byte order
 922  */
 923
 924 /**
 925  * GINT_FROM_BE:
 926  * @val: a #gint value in big-endian byte order
 927  *
 928  * Converts a #gint value from big-endian to host byte order.
 929  *
 930  * Returns: @val converted to host byte order
 931  */
 932
 933 /**
 934  * GINT_FROM_LE:
 935  * @val: a #gint value in little-endian byte order
 936  *
 937  * Converts a #gint value from little-endian to host byte order.
 938  *
 939  * Returns: @val converted to host byte order
 940  */
 941
 942 /**
 943  * GINT_TO_BE:
 944  * @val: a #gint value in host byte order
 945  *
 946  * Converts a #gint value from host byte order to big-endian.
 947  *
 948  * Returns: @val converted to big-endian byte order
 949  */
 950
 951 /**
 952  * GINT_TO_LE:
 953  * @val: a #gint value in host byte order
 954  *
 955  * Converts a #gint value from host byte order to little-endian.
 956  *
 957  * Returns: @val converted to little-endian byte order
 958  */
 959
 960 /**
 961  * GUINT_FROM_BE:
 962  * @val: a #guint value in big-endian byte order
 963  *
 964  * Converts a #guint value from big-endian to host byte order.
 965  *
 966  * Returns: @val converted to host byte order
 967  */
 968
 969 /**
 970  * GUINT_FROM_LE:
 971  * @val: a #guint value in little-endian byte order
 972  *
 973  * Converts a #guint value from little-endian to host byte order.
 974  *
 975  * Returns: @val converted to host byte order
 976  */
 977
 978 /**
 979  * GUINT_TO_BE:
 980  * @val: a #guint value in host byte order
 981  *
 982  * Converts a #guint value from host byte order to big-endian.
 983  *
 984  * Returns: @val converted to big-endian byte order
 985  */
 986
 987 /**
 988  * GUINT_TO_LE:
 989  * @val: a #guint value in host byte order
 990  *
 991  * Converts a #guint value from host byte order to little-endian.
 992  *
 993  * Returns: @val converted to little-endian byte order.
 994  */
 995
 996 /**
 997  * GLONG_FROM_BE:
 998  * @val: a #glong value in big-endian byte order
 999  *
1000  * Converts a #glong value from big-endian to the host byte order.
1001  *
1002  * Returns: @val converted to host byte order
1003  */
1004
1005 /**
1006  * GLONG_FROM_LE:
1007  * @val: a #glong value in little-endian byte order
1008  *
1009  * Converts a #glong value from little-endian to host byte order.
1010  *
1011  * Returns: @val converted to host byte order
1012  */
1013
1014 /**
1015  * GLONG_TO_BE:
1016  * @val: a #glong value in host byte order
1017  *
1018  * Converts a #glong value from host byte order to big-endian.
1019  *
1020  * Returns: @val converted to big-endian byte order
1021  */
1022
1023 /**
1024  * GLONG_TO_LE:
1025  * @val: a #glong value in host byte order
1026  *
1027  * Converts a #glong value from host byte order to little-endian.
1028  *
1029  * Returns: @val converted to little-endian
1030  */
1031
1032 /**
1033  * GULONG_FROM_BE:
1034  * @val: a #gulong value in big-endian byte order
1035  *
1036  * Converts a #gulong value from big-endian to host byte order.
1037  *
1038  * Returns: @val converted to host byte order
1039  */
1040
1041 /**
1042  * GULONG_FROM_LE:
1043  * @val: a #gulong value in little-endian byte order
1044  *
1045  * Converts a #gulong value from little-endian to host byte order.
1046  *
1047  * Returns: @val converted to host byte order
1048  */
1049
1050 /**
1051  * GULONG_TO_BE:
1052  * @val: a #gulong value in host byte order
1053  *
1054  * Converts a #gulong value from host byte order to big-endian.
1055  *
1056  * Returns: @val converted to big-endian
1057  */
1058
1059 /**
1060  * GULONG_TO_LE:
1061  * @val: a #gulong value in host byte order
1062  *
1063  * Converts a #gulong value from host byte order to little-endian.
1064  *
1065  * Returns: @val converted to little-endian
1066  */
1067
1068 /**
1069  * GSIZE_FROM_BE:
1070  * @val: a #gsize value in big-endian byte order
1071  *
1072  * Converts a #gsize value from big-endian to the host byte order.
1073  *
1074  * Returns: @val converted to host byte order
1075  */
1076
1077 /**
1078  * GSIZE_FROM_LE:
1079  * @val: a #gsize value in little-endian byte order
1080  *
1081  * Converts a #gsize value from little-endian to host byte order.
1082  *
1083  * Returns: @val converted to host byte order
1084  */
1085
1086 /**
1087  * GSIZE_TO_BE:
1088  * @val: a #gsize value in host byte order
1089  *
1090  * Converts a #gsize value from host byte order to big-endian.
1091  *
1092  * Returns: @val converted to big-endian byte order
1093  */
1094
1095 /**
1096  * GSIZE_TO_LE:
1097  * @val: a #gsize value in host byte order
1098  *
1099  * Converts a #gsize value from host byte order to little-endian.
1100  *
1101  * Returns: @val converted to little-endian
1102  */
1103
1104 /**
1105  * GSSIZE_FROM_BE:
1106  * @val: a #gssize value in big-endian byte order
1107  *
1108  * Converts a #gssize value from big-endian to host byte order.
1109  *
1110  * Returns: @val converted to host byte order
1111  */
1112
1113 /**
1114  * GSSIZE_FROM_LE:
1115  * @val: a #gssize value in little-endian byte order
1116  *
1117  * Converts a #gssize value from little-endian to host byte order.
1118  *
1119  * Returns: @val converted to host byte order
1120  */
1121
1122 /**
1123  * GSSIZE_TO_BE:
1124  * @val: a #gssize value in host byte order
1125  *
1126  * Converts a #gssize value from host byte order to big-endian.
1127  *
1128  * Returns: @val converted to big-endian
1129  */
1130
1131 /**
1132  * GSSIZE_TO_LE:
1133  * @val: a #gssize value in host byte order
1134  *
1135  * Converts a #gssize value from host byte order to little-endian.
1136  *
1137  * Returns: @val converted to little-endian
1138  */
1139
1140 /**
1141  * GINT16_FROM_BE:
1142  * @val: a #gint16 value in big-endian byte order
1143  *
1144  * Converts a #gint16 value from big-endian to host byte order.
1145  *
1146  * Returns: @val converted to host byte order
1147  */
1148
1149 /**
1150  * GINT16_FROM_LE:
1151  * @val: a #gint16 value in little-endian byte order
1152  *
1153  * Converts a #gint16 value from little-endian to host byte order.
1154  *
1155  * Returns: @val converted to host byte order
1156  */
1157
1158 /**
1159  * GINT16_TO_BE:
1160  * @val: a #gint16 value in host byte order
1161  *
1162  * Converts a #gint16 value from host byte order to big-endian.
1163  *
1164  * Returns: @val converted to big-endian
1165  */
1166
1167 /**
1168  * GINT16_TO_LE:
1169  * @val: a #gint16 value in host byte order
1170  *
1171  * Converts a #gint16 value from host byte order to little-endian.
1172  *
1173  * Returns: @val converted to little-endian
1174  */
1175
1176 /**
1177  * GUINT16_FROM_BE:
1178  * @val: a #guint16 value in big-endian byte order
1179  *
1180  * Converts a #guint16 value from big-endian to host byte order.
1181  *
1182  * Returns: @val converted to host byte order
1183  */
1184
1185 /**
1186  * GUINT16_FROM_LE:
1187  * @val: a #guint16 value in little-endian byte order
1188  *
1189  * Converts a #guint16 value from little-endian to host byte order.
1190  *
1191  * Returns: @val converted to host byte order
1192  */
1193
1194 /**
1195  * GUINT16_TO_BE:
1196  * @val: a #guint16 value in host byte order
1197  *
1198  * Converts a #guint16 value from host byte order to big-endian.
1199  *
1200  * Returns: @val converted to big-endian
1201  */
1202
1203 /**
1204  * GUINT16_TO_LE:
1205  * @val: a #guint16 value in host byte order
1206  *
1207  * Converts a #guint16 value from host byte order to little-endian.
1208  *
1209  * Returns: @val converted to little-endian
1210  */
1211
1212 /**
1213  * GINT32_FROM_BE:
1214  * @val: a #gint32 value in big-endian byte order
1215  *
1216  * Converts a #gint32 value from big-endian to host byte order.
1217  *
1218  * Returns: @val converted to host byte order
1219  */
1220
1221 /**
1222  * GINT32_FROM_LE:
1223  * @val: a #gint32 value in little-endian byte order
1224  *
1225  * Converts a #gint32 value from little-endian to host byte order.
1226  *
1227  * Returns: @val converted to host byte order
1228  */
1229
1230 /**
1231  * GINT32_TO_BE:
1232  * @val: a #gint32 value in host byte order
1233  *
1234  * Converts a #gint32 value from host byte order to big-endian.
1235  *
1236  * Returns: @val converted to big-endian
1237  */
1238
1239 /**
1240  * GINT32_TO_LE:
1241  * @val: a #gint32 value in host byte order
1242  *
1243  * Converts a #gint32 value from host byte order to little-endian.
1244  *
1245  * Returns: @val converted to little-endian
1246  */
1247
1248 /**
1249  * GUINT32_FROM_BE:
1250  * @val: a #guint32 value in big-endian byte order
1251  *
1252  * Converts a #guint32 value from big-endian to host byte order.
1253  *
1254  * Returns: @val converted to host byte order
1255  */
1256
1257 /**
1258  * GUINT32_FROM_LE:
1259  * @val: a #guint32 value in little-endian byte order
1260  *
1261  * Converts a #guint32 value from little-endian to host byte order.
1262  *
1263  * Returns: @val converted to host byte order
1264  */
1265
1266 /**
1267  * GUINT32_TO_BE:
1268  * @val: a #guint32 value in host byte order
1269  *
1270  * Converts a #guint32 value from host byte order to big-endian.
1271  *
1272  * Returns: @val converted to big-endian
1273  */
1274
1275 /**
1276  * GUINT32_TO_LE:
1277  * @val: a #guint32 value in host byte order
1278  *
1279  * Converts a #guint32 value from host byte order to little-endian.
1280  *
1281  * Returns: @val converted to little-endian
1282  */
1283
1284 /**
1285  * GINT64_FROM_BE:
1286  * @val: a #gint64 value in big-endian byte order
1287  *
1288  * Converts a #gint64 value from big-endian to host byte order.
1289  *
1290  * Returns: @val converted to host byte order
1291  */
1292
1293 /**
1294  * GINT64_FROM_LE:
1295  * @val: a #gint64 value in little-endian byte order
1296  *
1297  * Converts a #gint64 value from little-endian to host byte order.
1298  *
1299  * Returns: @val converted to host byte order
1300  */
1301
1302 /**
1303  * GINT64_TO_BE:
1304  * @val: a #gint64 value in host byte order
1305  *
1306  * Converts a #gint64 value from host byte order to big-endian.
1307  *
1308  * Returns: @val converted to big-endian
1309  */
1310
1311 /**
1312  * GINT64_TO_LE:
1313  * @val: a #gint64 value in host byte order
1314  *
1315  * Converts a #gint64 value from host byte order to little-endian.
1316  *
1317  * Returns: @val converted to little-endian
1318  */
1319
1320 /**
1321  * GUINT64_FROM_BE:
1322  * @val: a #guint64 value in big-endian byte order
1323  *
1324  * Converts a #guint64 value from big-endian to host byte order.
1325  *
1326  * Returns: @val converted to host byte order
1327  */
1328
1329 /**
1330  * GUINT64_FROM_LE:
1331  * @val: a #guint64 value in little-endian byte order
1332  *
1333  * Converts a #guint64 value from little-endian to host byte order.
1334  *
1335  * Returns: @val converted to host byte order
1336  */
1337
1338 /**
1339  * GUINT64_TO_BE:
1340  * @val: a #guint64 value in host byte order
1341  *
1342  * Converts a #guint64 value from host byte order to big-endian.
1343  *
1344  * Returns: @val converted to big-endian
1345  */
1346
1347 /**
1348  * GUINT64_TO_LE:
1349  * @val: a #guint64 value in host byte order
1350  *
1351  * Converts a #guint64 value from host byte order to little-endian.
1352  *
1353  * Returns: @val converted to little-endian
1354  */
1355
1356 /**
1357  * GUINT16_SWAP_BE_PDP:
1358  * @val: a #guint16 value in big-endian or pdp-endian byte order
1359  *
1360  * Converts a #guint16 value between big-endian and pdp-endian byte order.
1361  * The conversion is symmetric so it can be used both ways.
1362  *
1363  * Returns: @val converted to the opposite byte order
1364  */
1365
1366 /**
1367  * GUINT16_SWAP_LE_BE:
1368  * @val: a #guint16 value in little-endian or big-endian byte order
1369  *
1370  * Converts a #guint16 value between little-endian and big-endian byte order.
1371  * The conversion is symmetric so it can be used both ways.
1372  *
1373  * Returns: @val converted to the opposite byte order
1374  */
1375
1376 /**
1377  * GUINT16_SWAP_LE_PDP:
1378  * @val: a #guint16 value in little-endian or pdp-endian byte order
1379  *
1380  * Converts a #guint16 value between little-endian and pdp-endian byte order.
1381  * The conversion is symmetric so it can be used both ways.
1382  *
1383  * Returns: @val converted to the opposite byte order
1384  */
1385
1386 /**
1387  * GUINT32_SWAP_BE_PDP:
1388  * @val: a #guint32 value in big-endian or pdp-endian byte order
1389  *
1390  * Converts a #guint32 value between big-endian and pdp-endian byte order.
1391  * The conversion is symmetric so it can be used both ways.
1392  *
1393  * Returns: @val converted to the opposite byte order
1394  */
1395
1396 /**
1397  * GUINT32_SWAP_LE_BE:
1398  * @val: a #guint32 value in little-endian or big-endian byte order
1399  *
1400  * Converts a #guint32 value between little-endian and big-endian byte order.
1401  * The conversion is symmetric so it can be used both ways.
1402  *
1403  * Returns: @val converted to the opposite byte order
1404  */
1405
1406 /**
1407  * GUINT32_SWAP_LE_PDP:
1408  * @val: a #guint32 value in little-endian or pdp-endian byte order
1409  *
1410  * Converts a #guint32 value between little-endian and pdp-endian byte order.
1411  * The conversion is symmetric so it can be used both ways.
1412  *
1413  * Returns: @val converted to the opposite byte order
1414  */
1415
1416 /**
1417  * GUINT64_SWAP_LE_BE:
1418  * @val: a #guint64 value in little-endian or big-endian byte order
1419  *
1420  * Converts a #guint64 value between little-endian and big-endian byte order.
1421  * The conversion is symmetric so it can be used both ways.
1422  *
1423  * Returns: @val converted to the opposite byte order
1424  */
1425
1426 /* Numerical Definitions {{{1 */
1427
1428 /**
1429  * SECTION:numerical
1430  * @title: Numerical Definitions
1431  * @short_description: mathematical constants, and floating point decomposition
1432  *
1433  * GLib offers mathematical constants such as #G_PI for the value of pi;
1434  * many platforms have these in the C library, but some don't, the GLib
1435  * versions always exist.
1436  *
1437  * The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the
1438  * sign, mantissa and exponent of IEEE floats and doubles. These unions are
1439  * defined as appropriate for a given platform. IEEE floats and doubles are
1440  * supported (used for storage) by at least Intel, PPC and Sparc. See
1441  * [IEEE 754-2008](http://en.wikipedia.org/wiki/IEEE_float)
1442  * for more information about IEEE number formats.
1443  */
1444
1445 /**
1446  * G_IEEE754_FLOAT_BIAS:
1447  *
1448  * The bias by which exponents in single-precision floats are offset.
1449  */
1450
1451 /**
1452  * G_IEEE754_DOUBLE_BIAS:
1453  *
1454  * The bias by which exponents in double-precision floats are offset.
1455  */
1456
1457 /**
1458  * GFloatIEEE754:
1459  * @v_float: the double value
1460  *
1461  * The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the sign,
1462  * mantissa and exponent of IEEE floats and doubles. These unions are defined
1463  * as appropriate for a given platform. IEEE floats and doubles are supported
1464  * (used for storage) by at least Intel, PPC and Sparc.
1465  */
1466
1467 /**
1468  * GDoubleIEEE754:
1469  * @v_double: the double value
1470  *
1471  * The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the sign,
1472  * mantissa and exponent of IEEE floats and doubles. These unions are defined
1473  * as appropriate for a given platform. IEEE floats and doubles are supported
1474  * (used for storage) by at least Intel, PPC and Sparc.
1475  */
1476
1477 /**
1478  * G_E:
1479  *
1480  * The base of natural logarithms.
1481  */
1482
1483 /**
1484  * G_LN2:
1485  *
1486  * The natural logarithm of 2.
1487  */
1488
1489 /**
1490  * G_LN10:
1491  *
1492  * The natural logarithm of 10.
1493  */
1494
1495 /**
1496  * G_PI:
1497  *
1498  * The value of pi (ratio of circle's circumference to its diameter).
1499  */
1500
1501 /**
1502  * G_PI_2:
1503  *
1504  * Pi divided by 2.
1505  */
1506
1507 /**
1508  * G_PI_4:
1509  *
1510  * Pi divided by 4.
1511  */
1512
1513 /**
1514  * G_SQRT2:
1515  *
1516  * The square root of two.
1517  */
1518
1519 /**
1520  * G_LOG_2_BASE_10:
1521  *
1522  * Multiplying the base 2 exponent by this number yields the base 10 exponent.
1523  */
1524
1525 /* Macros {{{1 */
1526
1527 /**
1528  * SECTION:macros
1529  * @title: Standard Macros
1530  * @short_description: commonly-used macros
1531  *
1532  * These macros provide a few commonly-used features.
1533  */
1534
1535 /**
1536  * G_OS_WIN32:
1537  *
1538  * This macro is defined only on Windows. So you can bracket
1539  * Windows-specific code in "\#ifdef G_OS_WIN32".
1540  */
1541
1542 /**
1543  * G_OS_UNIX:
1544  *
1545  * This macro is defined only on UNIX. So you can bracket
1546  * UNIX-specific code in "\#ifdef G_OS_UNIX".
1547  */
1548
1549 /**
1550  * G_DIR_SEPARATOR:
1551  *
1552  * The directory separator character.
1553  * This is '/' on UNIX machines and '\' under Windows.
1554  */
1555
1556 /**
1557  * G_DIR_SEPARATOR_S:
1558  *
1559  * The directory separator as a string.
1560  * This is "/" on UNIX machines and "\" under Windows.
1561  */
1562
1563 /**
1564  * G_IS_DIR_SEPARATOR:
1565  * @c: a character
1566  *
1567  * Checks whether a character is a directory
1568  * separator. It returns %TRUE for '/' on UNIX
1569  * machines and for '\' or '/' under Windows.
1570  *
1571  * Since: 2.6
1572  */
1573
1574 /**
1575  * G_SEARCHPATH_SEPARATOR:
1576  *
1577  * The search path separator character.
1578  * This is ':' on UNIX machines and ';' under Windows.
1579  */
1580
1581 /**
1582  * G_SEARCHPATH_SEPARATOR_S:
1583  *
1584  * The search path separator as a string.
1585  * This is ":" on UNIX machines and ";" under Windows.
1586  */
1587
1588 /**
1589  * TRUE:
1590  *
1591  * Defines the %TRUE value for the #gboolean type.
1592  */
1593
1594 /**
1595  * FALSE:
1596  *
1597  * Defines the %FALSE value for the #gboolean type.
1598  */
1599
1600 /**
1601  * NULL:
1602  *
1603  * Defines the standard %NULL pointer.
1604  */
1605
1606 /**
1607  * MIN:
1608  * @a: a numeric value
1609  * @b: a numeric value
1610  *
1611  * Calculates the minimum of @a and @b.
1612  *
1613  * Returns: the minimum of @a and @b.
1614  */
1615
1616 /**
1617  * MAX:
1618  * @a: a numeric value
1619  * @b: a numeric value
1620  *
1621  * Calculates the maximum of @a and @b.
1622  *
1623  * Returns: the maximum of @a and @b.
1624  */
1625
1626 /**
1627  * ABS:
1628  * @a: a numeric value
1629  *
1630  * Calculates the absolute value of @a.
1631  * The absolute value is simply the number with any negative sign taken away.
1632  *
1633  * For example,
1634  * - ABS(-10) is 10.
1635  * - ABS(10) is also 10.
1636  *
1637  * Returns: the absolute value of @a.
1638  */
1639
1640 /**
1641  * CLAMP:
1642  * @x: the value to clamp
1643  * @low: the minimum value allowed
1644  * @high: the maximum value allowed
1645  *
1646  * Ensures that @x is between the limits set by @low and @high. If @low is
1647  * greater than @high the result is undefined.
1648  *
1649  * For example,
1650  * - CLAMP(5, 10, 15) is 10.
1651  * - CLAMP(15, 5, 10) is 10.
1652  * - CLAMP(20, 15, 25) is 20.
1653  *
1654  * Returns: the value of @x clamped to the range between @low and @high
1655  */
1656
1657 /**
1658  * G_STRUCT_MEMBER:
1659  * @member_type: the type of the struct field
1660  * @struct_p: a pointer to a struct
1661  * @struct_offset: the offset of the field from the start of the struct,
1662  *     in bytes
1663  *
1664  * Returns a member of a structure at a given offset, using the given type.
1665  *
1666  * Returns: the struct member
1667  */
1668
1669 /**
1670  * G_STRUCT_MEMBER_P:
1671  * @struct_p: a pointer to a struct
1672  * @struct_offset: the offset from the start of the struct, in bytes
1673  *
1674  * Returns an untyped pointer to a given offset of a struct.
1675  *
1676  * Returns: an untyped pointer to @struct_p plus @struct_offset bytes
1677  */
1678
1679 /**
1680  * G_STRUCT_OFFSET:
1681  * @struct_type: a structure type, e.g. #GtkWidget
1682  * @member: a field in the structure, e.g. @window
1683  *
1684  * Returns the offset, in bytes, of a member of a struct.
1685  *
1686  * Returns: the offset of @member from the start of @struct_type
1687  */
1688
1689 /**
1690  * G_CONST_RETURN:
1691  *
1692  * If %G_DISABLE_CONST_RETURNS is defined, this macro expands
1693  * to nothing. By default, the macro expands to const. The macro
1694  * can be used in place of const for functions that return a value
1695  * that should not be modified. The purpose of this macro is to allow
1696  * us to turn on const for returned constant strings by default, while
1697  * allowing programmers who find that annoying to turn it off. This macro
1698  * should only be used for return values and for "out" parameters, it
1699  * doesn't make sense for "in" parameters.
1700  *
1701  * Deprecated: 2.30: API providers should replace all existing uses with
1702  * const and API consumers should adjust their code accordingly
1703  */
1704
1705 /**
1706  * G_N_ELEMENTS:
1707  * @arr: the array
1708  *
1709  * Determines the number of elements in an array. The array must be
1710  * declared so the compiler knows its size at compile-time; this
1711  * macro will not work on an array allocated on the heap, only static
1712  * arrays or arrays on the stack.
1713  */
1714
1715 /* Miscellaneous Macros {{{1 */
1716
1717 /**
1718  * SECTION:macros_misc
1719  * @title: Miscellaneous Macros
1720  * @short_description: specialized macros which are not used often
1721  *
1722  * These macros provide more specialized features which are not
1723  * needed so often by application programmers.
1724  */
1725
1726 /**
1727  * G_INLINE_FUNC:
1728  *
1729  * This macro is used to export function prototypes so they can be linked
1730  * with an external version when no inlining is performed. The file which
1731  * implements the functions should define %G_IMPLEMENTS_INLINES
1732  * before including the headers which contain %G_INLINE_FUNC declarations.
1733  * Since inlining is very compiler-dependent using these macros correctly
1734  * is very difficult. Their use is strongly discouraged.
1735  *
1736  * This macro is often mistaken for a replacement for the inline keyword;
1737  * inline is already declared in a portable manner in the GLib headers
1738  * and can be used normally.
1739  */
1740
1741 /**
1742  * G_STMT_START:
1743  *
1744  * Used within multi-statement macros so that they can be used in places
1745  * where only one statement is expected by the compiler.
1746  */
1747
1748 /**
1749  * G_STMT_END:
1750  *
1751  * Used within multi-statement macros so that they can be used in places
1752  * where only one statement is expected by the compiler.
1753  */
1754
1755 /**
1756  * G_BEGIN_DECLS:
1757  *
1758  * Used (along with #G_END_DECLS) to bracket header files. If the
1759  * compiler in use is a C++ compiler, adds extern "C"
1760  * around the header.
1761  */
1762
1763 /**
1764  * G_END_DECLS:
1765  *
1766  * Used (along with #G_BEGIN_DECLS) to bracket header files. If the
1767  * compiler in use is a C++ compiler, adds extern "C"
1768  * around the header.
1769  */
1770
1771 /**
1772  * G_VA_COPY:
1773  * @ap1: the va_list variable to place a copy of @ap2 in
1774  * @ap2: a va_list
1775  *
1776  * Portable way to copy va_list variables.
1777  *
1778  * In order to use this function, you must include string.h yourself,
1779  * because this macro may use memmove() and GLib does not include
1780  * string.h for you.
1781  */
1782
1783 /**
1784  * G_STRINGIFY:
1785  * @macro_or_string: a macro or a string
1786  *
1787  * Accepts a macro or a string and converts it into a string after
1788  * preprocessor argument expansion. For example, the following code:
1789  *
1790  * |[<!-- language="C" -->
1791  * #define AGE 27
1792  * const gchar *greeting = G_STRINGIFY (AGE) " today!";
1793  * ]|
1794  *
1795  * is transformed by the preprocessor into (code equivalent to):
1796  *
1797  * |[<!-- language="C" -->
1798  * const gchar *greeting = "27 today!";
1799  * ]|
1800  */
1801
1802 /**
1803  * G_PASTE:
1804  * @identifier1: an identifier
1805  * @identifier2: an identifier
1806  *
1807  * Yields a new preprocessor pasted identifier
1808  * @identifier1identifier2 from its expanded
1809  * arguments @identifier1 and @identifier2. For example,
1810  * the following code:
1811  * |[<!-- language="C" -->
1812  * #define GET(traveller,method) G_PASTE(traveller_get_, method) (traveller)
1813  * const gchar *name = GET (traveller, name);
1814  * const gchar *quest = GET (traveller, quest);
1815  * GdkColor *favourite = GET (traveller, favourite_colour);
1816  * ]|
1817  *
1818  * is transformed by the preprocessor into:
1819  * |[<!-- language="C" -->
1820  * const gchar *name = traveller_get_name (traveller);
1821  * const gchar *quest = traveller_get_quest (traveller);
1822  * GdkColor *favourite = traveller_get_favourite_colour (traveller);
1823  * ]|
1824  *
1825  * Since: 2.20
1826  */
1827
1828 /**
1829  * G_STATIC_ASSERT:
1830  * @expr: a constant expression
1831  *
1832  * The G_STATIC_ASSERT() macro lets the programmer check
1833  * a condition at compile time, the condition needs to
1834  * be compile time computable. The macro can be used in
1835  * any place where a typedef is valid.
1836  *
1837  * A typedef is generally allowed in exactly the same places that
1838  * a variable declaration is allowed. For this reason, you should
1839  * not use G_STATIC_ASSERT() in the middle of blocks of code.
1840  *
1841  * The macro should only be used once per source code line.
1842  *
1843  * Since: 2.20
1844  */
1845
1846 /**
1847  * G_STATIC_ASSERT_EXPR:
1848  * @expr: a constant expression
1849  *
1850  * The G_STATIC_ASSERT_EXPR() macro lets the programmer check
1851  * a condition at compile time. The condition needs to be
1852  * compile time computable.
1853  *
1854  * Unlike G_STATIC_ASSERT(), this macro evaluates to an expression
1855  * and, as such, can be used in the middle of other expressions.
1856  * Its value should be ignored. This can be accomplished by placing
1857  * it as the first argument of a comma expression.
1858  *
1859  * |[<!-- language="C" -->
1860  * #define ADD_ONE_TO_INT(x) \
1861  *   (G_STATIC_ASSERT_EXPR(sizeof (x) == sizeof (int)), ((x) + 1))
1862  * ]|
1863  *
1864  * Since: 2.30
1865  */
1866
1867 /**
1868  * G_GNUC_EXTENSION:
1869  *
1870  * Expands to __extension__ when gcc is used as the compiler. This simply
1871  * tells gcc not to warn about the following non-standard code when compiling
1872  * with the `-pedantic` option.
1873  */
1874
1875 /**
1876  * G_GNUC_CONST:
1877  *
1878  * Expands to the GNU C const function attribute if the compiler is gcc.
1879  * Declaring a function as const enables better optimization of calls to
1880  * the function. A const function doesn't examine any values except its
1881  * parameters, and has no effects except its return value.
1882  *
1883  * Place the attribute after the declaration, just before the semicolon.
1884  *
1885  * See the GNU C documentation for more details.
1886  *
1887  * A function that has pointer arguments and examines the data pointed to
1888  * must not be declared const. Likewise, a function that calls a non-const
1889  * function usually must not be const. It doesn't make sense for a const
1890  * function to return void.
1891  */
1892
1893 /**
1894  * G_GNUC_PURE:
1895  *
1896  * Expands to the GNU C pure function attribute if the compiler is gcc.
1897  * Declaring a function as pure enables better optimization of calls to
1898  * the function. A pure function has no effects except its return value
1899  * and the return value depends only on the parameters and/or global
1900  * variables.
1901  *
1902  * Place the attribute after the declaration, just before the semicolon.
1903  *
1904  * See the GNU C documentation for more details.
1905  */
1906
1907 /**
1908  * G_GNUC_MALLOC:
1909  *
1910  * Expands to the GNU C malloc function attribute if the compiler is gcc.
1911  * Declaring a function as malloc enables better optimization of the function.
1912  * A function can have the malloc attribute if it returns a pointer which is
1913  * guaranteed to not alias with any other pointer when the function returns
1914  * (in practice, this means newly allocated memory).
1915  *
1916  * Place the attribute after the declaration, just before the semicolon.
1917  *
1918  * See the GNU C documentation for more details.
1919  *
1920  * Since: 2.6
1921  */
1922
1923 /**
1924  * G_GNUC_ALLOC_SIZE:
1925  * @x: the index of the argument specifying the allocation size
1926  *
1927  * Expands to the GNU C alloc_size function attribute if the compiler
1928  * is a new enough gcc. This attribute tells the compiler that the
1929  * function returns a pointer to memory of a size that is specified
1930  * by the @xth function parameter.
1931  *
1932  * Place the attribute after the function declaration, just before the
1933  * semicolon.
1934  *
1935  * See the GNU C documentation for more details.
1936  *
1937  * Since: 2.18
1938  */
1939
1940 /**
1941  * G_GNUC_ALLOC_SIZE2:
1942  * @x: the index of the argument specifying one factor of the allocation size
1943  * @y: the index of the argument specifying the second factor of the allocation size
1944  *
1945  * Expands to the GNU C alloc_size function attribute if the compiler is a
1946  * new enough gcc. This attribute tells the compiler that the function returns
1947  * a pointer to memory of a size that is specified by the product of two
1948  * function parameters.
1949  *
1950  * Place the attribute after the function declaration, just before the
1951  * semicolon.
1952  *
1953  * See the GNU C documentation for more details.
1954  *
1955  * Since: 2.18
1956  */
1957
1958 /**
1959  * G_GNUC_DEPRECATED:
1960  *
1961  * Expands to the GNU C deprecated attribute if the compiler is gcc.
1962  * It can be used to mark typedefs, variables and functions as deprecated.
1963  * When called with the `-Wdeprecated-declarations` option,
1964  * gcc will generate warnings when deprecated interfaces are used.
1965  *
1966  * Place the attribute after the declaration, just before the semicolon.
1967  *
1968  * See the GNU C documentation for more details.
1969  *
1970  * Since: 2.2
1971  */
1972
1973 /**
1974  * G_GNUC_DEPRECATED_FOR:
1975  * @f: the intended replacement for the deprecated symbol,
1976  *     such as the name of a function
1977  *
1978  * Like %G_GNUC_DEPRECATED, but names the intended replacement for the
1979  * deprecated symbol if the version of gcc in use is new enough to support
1980  * custom deprecation messages.
1981  *
1982  * Place the attribute after the declaration, just before the semicolon.
1983  *
1984  * See the GNU C documentation for more details.
1985  *
1986  * Note that if @f is a macro, it will be expanded in the warning message.
1987  * You can enclose it in quotes to prevent this. (The quotes will show up
1988  * in the warning, but it's better than showing the macro expansion.)
1989  *
1990  * Since: 2.26
1991  */
1992
1993 /**
1994  * G_GNUC_BEGIN_IGNORE_DEPRECATIONS:
1995  *
1996  * Tells gcc (if it is a new enough version) to temporarily stop emitting
1997  * warnings when functions marked with %G_GNUC_DEPRECATED or
1998  * %G_GNUC_DEPRECATED_FOR are called. This is useful for when you have
1999  * one deprecated function calling another one, or when you still have
2000  * regression tests for deprecated functions.
2001  *
2002  * Use %G_GNUC_END_IGNORE_DEPRECATIONS to begin warning again. (If you
2003  * are not compiling with `-Wdeprecated-declarations` then neither macro
2004  * has any effect.)
2005  *
2006  * This macro can be used either inside or outside of a function body,
2007  * but must appear on a line by itself.
2008  *
2009  * Since: 2.32
2010  */
2011
2012 /**
2013  * G_GNUC_END_IGNORE_DEPRECATIONS:
2014  *
2015  * Undoes the effect of %G_GNUC_BEGIN_IGNORE_DEPRECATIONS, telling
2016  * gcc to begin outputting warnings again (assuming those warnings
2017  * had been enabled to begin with).
2018  *
2019  * This macro can be used either inside or outside of a function body,
2020  * but must appear on a line by itself.
2021  *
2022  * Since: 2.32
2023  */
2024
2025 /**
2026  * G_DEPRECATED:
2027  *
2028  * This macro is similar to %G_GNUC_DEPRECATED, and can be used to mark
2029  * functions declarations as deprecated. Unlike %G_GNUC_DEPRECATED, it is
2030  * meant to be portable across different compilers and must be placed
2031  * before the function declaration.
2032  *
2033  * Since: 2.32
2034  */
2035
2036 /**
2037  * G_DEPRECATED_FOR:
2038  * @f: the name of the function that this function was deprecated for
2039  *
2040  * This macro is similar to %G_GNUC_DEPRECATED_FOR, and can be used to mark
2041  * functions declarations as deprecated. Unlike %G_GNUC_DEPRECATED_FOR, it
2042  * is meant to be portable across different compilers and must be placed
2043  * before the function declaration.
2044  *
2045  * Since: 2.32
2046  */
2047
2048 /**
2049  * G_UNAVAILABLE:
2050  * @maj: the major version that introduced the symbol
2051  * @min: the minor version that introduced the symbol
2052  *
2053  * This macro can be used to mark a function declaration as unavailable.
2054  * It must be placed before the function declaration. Use of a function
2055  * that has been annotated with this macros will produce a compiler warning.
2056  *
2057  * Since: 2.32
2058  */
2059
2060 /**
2061  * GLIB_DISABLE_DEPRECATION_WARNINGS:
2062  *
2063  * A macro that should be defined before including the glib.h header.
2064  * If it is defined, no compiler warnings will be produced for uses
2065  * of deprecated GLib APIs.
2066  */
2067
2068 /**
2069  * G_GNUC_NORETURN:
2070  *
2071  * Expands to the GNU C noreturn function attribute if the compiler is gcc.
2072  * It is used for declaring functions which never return. It enables
2073  * optimization of the function, and avoids possible compiler warnings.
2074  *
2075  * Place the attribute after the declaration, just before the semicolon.
2076  *
2077  * See the GNU C documentation for more details.
2078  */
2079
2080 /**
2081  * G_GNUC_UNUSED:
2082  *
2083  * Expands to the GNU C unused function attribute if the compiler is gcc.
2084  * It is used for declaring functions and arguments which may never be used.
2085  * It avoids possible compiler warnings.
2086  *
2087  * For functions, place the attribute after the declaration, just before the
2088  * semicolon. For arguments, place the attribute at the beginning of the
2089  * argument declaration.
2090  *
2091  * |[<!-- language="C" -->
2092  * void my_unused_function (G_GNUC_UNUSED gint unused_argument,
2093  *                          gint other_argument) G_GNUC_UNUSED;
2094  * ]|
2095  *
2096  * See the GNU C documentation for more details.
2097  */
2098
2099 /**
2100  * G_GNUC_PRINTF:
2101  * @format_idx: the index of the argument corresponding to the
2102  *     format string (The arguments are numbered from 1)
2103  * @arg_idx: the index of the first of the format arguments
2104  *
2105  * Expands to the GNU C format function attribute if the compiler is gcc.
2106  * This is used for declaring functions which take a variable number of
2107  * arguments, with the same syntax as printf(). It allows the compiler
2108  * to type-check the arguments passed to the function.
2109  *
2110  * Place the attribute after the function declaration, just before the
2111  * semicolon.
2112  *
2113  * See the GNU C documentation for more details.
2114  *
2115  * |[<!-- language="C" -->
2116  * gint g_snprintf (gchar  *string,
2117  *                  gulong       n,
2118  *                  gchar const *format,
2119  *                  ...) G_GNUC_PRINTF (3, 4);
2120  * ]|
2121  */
2122
2123 /**
2124  * G_GNUC_SCANF:
2125  * @format_idx: the index of the argument corresponding to
2126  *     the format string (The arguments are numbered from 1)
2127  * @arg_idx: the index of the first of the format arguments
2128  *
2129  * Expands to the GNU C format function attribute if the compiler is gcc.
2130  * This is used for declaring functions which take a variable number of
2131  * arguments, with the same syntax as scanf(). It allows the compiler
2132  * to type-check the arguments passed to the function.
2133  *
2134  * See the GNU C documentation for details.
2135  */
2136
2137 /**
2138  * G_GNUC_FORMAT:
2139  * @arg_idx: the index of the argument
2140  *
2141  * Expands to the GNU C format_arg function attribute if the compiler
2142  * is gcc. This function attribute specifies that a function takes a
2143  * format string for a printf(), scanf(), strftime() or strfmon() style
2144  * function and modifies it, so that the result can be passed to a printf(),
2145  * scanf(), strftime() or strfmon() style function (with the remaining
2146  * arguments to the format function the same as they would have been
2147  * for the unmodified string).
2148  *
2149  * Place the attribute after the function declaration, just before the
2150  * semicolon.
2151  *
2152  * See the GNU C documentation for more details.
2153  *
2154  * |[<!-- language="C" -->
2155  * gchar *g_dgettext (gchar *domain_name, gchar *msgid) G_GNUC_FORMAT (2);
2156  * ]|
2157  */
2158
2159 /**
2160  * G_GNUC_NULL_TERMINATED:
2161  *
2162  * Expands to the GNU C sentinel function attribute if the compiler is gcc.
2163  * This function attribute only applies to variadic functions and instructs
2164  * the compiler to check that the argument list is terminated with an
2165  * explicit %NULL.
2166  *
2167  * Place the attribute after the declaration, just before the semicolon.
2168  *
2169  * See the GNU C documentation for more details.
2170  *
2171  * Since: 2.8
2172  */
2173
2174 /**
2175  * G_GNUC_WARN_UNUSED_RESULT:
2176  *
2177  * Expands to the GNU C warn_unused_result function attribute if the compiler
2178  * is gcc. This function attribute makes the compiler emit a warning if the
2179  * result of a function call is ignored.
2180  *
2181  * Place the attribute after the declaration, just before the semicolon.
2182  *
2183  * See the GNU C documentation for more details.
2184  *
2185  * Since: 2.10
2186  */
2187
2188 /**
2189  * G_GNUC_FUNCTION:
2190  *
2191  * Expands to "" on all modern compilers, and to  __FUNCTION__ on gcc
2192  * version 2.x. Don't use it.
2193  *
2194  * Deprecated: 2.16: Use G_STRFUNC() instead
2195  */
2196
2197 /**
2198  * G_GNUC_PRETTY_FUNCTION:
2199  *
2200  * Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__
2201  * on gcc version 2.x. Don't use it.
2202  *
2203  * Deprecated: 2.16: Use G_STRFUNC() instead
2204  */
2205
2206 /**
2207  * G_GNUC_NO_INSTRUMENT:
2208  *
2209  * Expands to the GNU C no_instrument_function function attribute if the
2210  * compiler is gcc. Functions with this attribute will not be instrumented
2211  * for profiling, when the compiler is called with the
2212  * `-finstrument-functions` option.
2213  *
2214  * Place the attribute after the declaration, just before the semicolon.
2215  *
2216  * See the GNU C documentation for more details.
2217  */
2218
2219 /**
2220  * G_GNUC_INTERNAL:
2221  *
2222  * This attribute can be used for marking library functions as being used
2223  * internally to the library only, which may allow the compiler to handle
2224  * function calls more efficiently. Note that static functions do not need
2225  * to be marked as internal in this way. See the GNU C documentation for
2226  * details.
2227  *
2228  * When using a compiler that supports the GNU C hidden visibility attribute,
2229  * this macro expands to __attribute__((visibility("hidden"))).
2230  * When using the Sun Studio compiler, it expands to __hidden.
2231  *
2232  * Note that for portability, the attribute should be placed before the
2233  * function declaration. While GCC allows the macro after the declaration,
2234  * Sun Studio does not.
2235  *
2236  * |[<!-- language="C" -->
2237  * G_GNUC_INTERNAL
2238  * void _g_log_fallback_handler (const gchar    *log_domain,
2239  *                               GLogLevelFlags  log_level,
2240  *                               const gchar    *message,
2241  *                               gpointer        unused_data);
2242  * ]|
2243  *
2244  * Since: 2.6
2245  */
2246
2247 /**
2248  * G_GNUC_MAY_ALIAS:
2249  *
2250  * Expands to the GNU C may_alias type attribute if the compiler is gcc.
2251  * Types with this attribute will not be subjected to type-based alias
2252  * analysis, but are assumed to alias with any other type, just like char.
2253  *
2254  * See the GNU C documentation for details.
2255  *
2256  * Since: 2.14
2257  */
2258
2259 /**
2260  * G_LIKELY:
2261  * @expr: the expression
2262  *
2263  * Hints the compiler that the expression is likely to evaluate to
2264  * a true value. The compiler may use this information for optimizations.
2265  *
2266  * |[<!-- language="C" -->
2267  * if (G_LIKELY (random () != 1))
2268  *   g_print ("not one");
2269  * ]|
2270  *
2271  * Returns: the value of @expr
2272  *
2273  * Since: 2.2
2274  */
2275
2276 /**
2277  * G_UNLIKELY:
2278  * @expr: the expression
2279  *
2280  * Hints the compiler that the expression is unlikely to evaluate to
2281  * a true value. The compiler may use this information for optimizations.
2282  *
2283  * |[<!-- language="C" -->
2284  * if (G_UNLIKELY (random () == 1))
2285  *   g_print ("a random one");
2286  * ]|
2287  *
2288  * Returns: the value of @expr
2289  *
2290  * Since: 2.2
2291  */
2292
2293 /**
2294  * G_STRLOC:
2295  *
2296  * Expands to a string identifying the current code position.
2297  */
2298
2299 /**
2300  * G_STRFUNC:
2301  *
2302  * Expands to a string identifying the current function.
2303  *
2304  * Since: 2.4
2305  */
2306
2307 /**
2308  * G_HAVE_GNUC_VISIBILITY:
2309  *
2310  * Defined to 1 if gcc-style visibility handling is supported.
2311  */
2312
2313 /* g_auto(), g_autoptr() and helpers {{{1 */
2314
2315 /**
2316  * g_auto:
2317  * @typename: a supported variable type
2318  *
2319  * Helper to declare a variable with automatic cleanup.
2320  *
2321  * The variable is cleaned up in a way appropriate to its type when the
2322  * variable goes out of scope.  The type must support this.
2323  *
2324  * This feature is only supported on GCC and clang.  This macro is not
2325  * defined on other compilers and should not be used in programs that
2326  * are intended to be portable to those compilers.
2327  *
2328  * This is meant to be used with stack-allocated structures and
2329  * non-pointer types.  For the (more commonly used) pointer version, see
2330  * g_autoptr().
2331  *
2332  * This macro can be used to avoid having to do explicit cleanups of
2333  * local variables when exiting functions.  It often vastly simplifies
2334  * handling of error conditions, removing the need for various tricks
2335  * such as 'goto out' or repeating of cleanup code.  It is also helpful
2336  * for non-error cases.
2337  *
2338  * Consider the following example:
2339  *
2340  * |[
2341  * GVariant *
2342  * my_func(void)
2343  * {
2344  *   g_auto(GQueue) queue = G_QUEUE_INIT;
2345  *   g_auto(GVariantBuilder) builder;
2346  *
2347  *   g_variant_builder_init (&builder, G_VARIANT_TYPE_VARDICT);
2348  *
2349  *   ...
2350  *
2351  *   if (error_condition)
2352  *     return NULL;
2353  *
2354  *   ...
2355  *
2356  *   return g_variant_builder_end (&builder);
2357  * }
2358  * ]|
2359  *
2360  * You must initialise the variable in some way -- either by use of an
2361  * initialiser or by ensuring that an _init function will be called on
2362  * it unconditionally before it goes out of scope.
2363  *
2364  * Since: 2.44
2365  */
2366
2367 /**
2368  * g_autoptr:
2369  * @typename: a supported variable type
2370  *
2371  * Helper to declare a pointer variable with automatic cleanup.
2372  *
2373  * The variable is cleaned up in a way appropriate to its type when the
2374  * variable goes out of scope.  The type must support this.
2375  *
2376  * This feature is only supported on GCC and clang.  This macro is not
2377  * defined on other compilers and should not be used in programs that
2378  * are intended to be portable to those compilers.
2379  *
2380  * This is meant to be used to declare pointers to types with cleanup
2381  * functions.  The type of the variable is a pointer to @typename.  You
2382  * must not add your own '*'.
2383  *
2384  * This macro can be used to avoid having to do explicit cleanups of
2385  * local variables when exiting functions.  It often vastly simplifies
2386  * handling of error conditions, removing the need for various tricks
2387  * such as 'goto out' or repeating of cleanup code.  It is also helpful
2388  * for non-error cases.
2389  *
2390  * Consider the following example:
2391  *
2392  * |[
2393  * gboolean
2394  * check_exists(GVariant *dict)
2395  * {
2396  *   g_autoptr(GVariant) dirname;
2397  *   g_autoptr(GVariant) basename = NULL;
2398  *   g_autoptr(gchar) path = NULL;
2399  *
2400  *   dirname = g_variant_lookup_value (dict, "dirname", G_VARIANT_TYPE_STRING);
2401  *
2402  *   if (dirname == NULL)
2403  *     return FALSE;
2404  *
2405  *   basename = g_variant_lookup_value (dict, "basename", G_VARIANT_TYPE_STRING);
2406  *
2407  *   if (basename == NULL)
2408  *     return FALSE;
2409  *
2410  *   path = g_build_filename (g_variant_get_string (dirname, NULL),
2411  *                            g_variant_get_string (basename, NULL),
2412  *                            NULL);
2413  *
2414  *   return g_access (path, R_OK) == 0;
2415  * }
2416  * ]|
2417  *
2418  * You must initialise the variable in some way -- either by use of an
2419  * initialiser or by ensuring that it is assigned to unconditionally
2420  * before it goes out of scope.
2421  *
2422  * Since: 2.44
2423  */
2424
2425 /**
2426  * G_DEFINE_AUTOPTR_CLEANUP_FUNC:
2427  * @TypeName: a type name to define a g_autoptr() cleanup function for
2428  * @func: the cleanup function
2429  *
2430  * Defines the appropriate cleanup function for a pointer type.
2431  *
2432  * The function will not be called if the variable to be cleaned up
2433  * contains %NULL.
2434  *
2435  * This will typically be the _free() or _unref() function for the given
2436  * type.
2437  *
2438  * With this definition, it will be possible to use g_autoptr() with
2439  * @TypeName.
2440  *
2441  * |[
2442  * G_DEFINE_AUTOPTR_CLEANUP_FUNC(GObject, g_object_unref)
2443  * ]|
2444  *
2445  * This macro should be used unconditionally; it is a no-op on compilers
2446  * where cleanup is not supported.
2447  *
2448  * Since: 2.44
2449  */
2450
2451 /**
2452  * G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC:
2453  * @TypeName: a type name to define a g_auto() cleanup function for
2454  * @func: the clear function
2455  *
2456  * Defines the appropriate cleanup function for a type.
2457  *
2458  * This will typically be the _clear() function for the given type.
2459  *
2460  * With this definition, it will be possible to use g_auto() with
2461  * @TypeName.
2462  *
2463  * |[
2464  * G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(GQueue, g_queue_clear)
2465  * ]|
2466  *
2467  * This macro should be used unconditionally; it is a no-op on compilers
2468  * where cleanup is not supported.
2469  *
2470  * Since: 2.44
2471  */
2472
2473 /**
2474  * G_DEFINE_AUTO_CLEANUP_FREE_FUNC:
2475  * @TypeName: a type name to define a g_auto() cleanup function for
2476  * @func: the free function
2477  * @none: the "none" value for the type
2478  *
2479  * Defines the appropriate cleanup function for a type.
2480  *
2481  * With this definition, it will be possible to use g_auto() with
2482  * @TypeName.
2483  *
2484  * This function will be rarely used.  It is used with pointer-based
2485  * typedefs and non-pointer types where the value of the variable
2486  * represents a resource that must be freed.  Two examples are #GStrv
2487  * and file descriptors.
2488  *
2489  * @none specifies the "none" value for the type in question.  It is
2490  * probably something like %NULL or -1.  If the variable is found to
2491  * contain this value then the free function will not be called.
2492  *
2493  * |[
2494  * G_DEFINE_AUTO_CLEANUP_FREE_FUNC(GStrv, g_strfreev, NULL)
2495  * ]|
2496  *
2497  * This macro should be used unconditionally; it is a no-op on compilers
2498  * where cleanup is not supported.
2499  *
2500  * Since: 2.44
2501  */
2502
2503 /* Windows Compatibility Functions {{{1 */
2504
2505 /**
2506  * SECTION:windows
2507  * @title: Windows Compatibility Functions
2508  * @short_description: UNIX emulation on Windows
2509  *
2510  * These functions provide some level of UNIX emulation on the
2511  * Windows platform. If your application really needs the POSIX
2512  * APIs, we suggest you try the Cygwin project.
2513  */
2514
2515 /**
2516  * MAXPATHLEN:
2517  *
2518  * Provided for UNIX emulation on Windows; equivalent to UNIX
2519  * macro %MAXPATHLEN, which is the maximum length of a filename
2520  * (including full path).
2521  */
2522
2523 /**
2524  * G_WIN32_DLLMAIN_FOR_DLL_NAME:
2525  * @static: empty or "static"
2526  * @dll_name: the name of the (pointer to the) char array where
2527  *     the DLL name will be stored. If this is used, you must also
2528  *     include `windows.h`. If you need a more complex DLL entry
2529  *     point function, you cannot use this
2530  *
2531  * On Windows, this macro defines a DllMain() function that stores
2532  * the actual DLL name that the code being compiled will be included in.
2533  *
2534  * On non-Windows platforms, expands to nothing.
2535  */
2536
2537 /**
2538  * G_WIN32_HAVE_WIDECHAR_API:
2539  *
2540  * On Windows, this macro defines an expression which evaluates to
2541  * %TRUE if the code is running on a version of Windows where the wide
2542  * character versions of the Win32 API functions, and the wide character
2543  * versions of the C library functions work. (They are always present in
2544  * the DLLs, but don't work on Windows 9x and Me.)
2545  *
2546  * On non-Windows platforms, it is not defined.
2547  *
2548  * Since: 2.6
2549  */
2550
2551
2552 /**
2553  * G_WIN32_IS_NT_BASED:
2554  *
2555  * On Windows, this macro defines an expression which evaluates to
2556  * %TRUE if the code is running on an NT-based Windows operating system.
2557  *
2558  * On non-Windows platforms, it is not defined.
2559  *
2560  * Since: 2.6
2561  */
2562
2563  /* Epilogue {{{1 */
2564 /* vim: set foldmethod=marker: */