glib/gmacros.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-or-later
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 /* This file must not include any other glib header file and must thus
  28  * not refer to variables from glibconfig.h
  29  */
  30
  31 #ifndef __G_MACROS_H__
  32 #define __G_MACROS_H__
  33
  34 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  35 #error "Only <glib.h> can be included directly."
  36 #endif
  37
  38 /* We include stddef.h to get the system's definition of NULL
  39  */
  40 #include <stddef.h>
  41
  42 /*
  43  * Note: Clang (but not clang-cl) defines __GNUC__ and __GNUC_MINOR__.
  44  * Both Clang 11.1 on current Arch Linux and Apple's Clang 12.0 define
  45  * __GNUC__ = 4 and __GNUC_MINOR__ = 2. So G_GNUC_CHECK_VERSION(4, 2) on
  46  * current Clang will be 1.
  47  */
  48 #ifdef __GNUC__
  49 #define G_GNUC_CHECK_VERSION(major, minor) \
  50     ((__GNUC__ > (major)) || \
  51      ((__GNUC__ == (major)) && \
  52       (__GNUC_MINOR__ >= (minor))))
  53 #else
  54 #define G_GNUC_CHECK_VERSION(major, minor) 0
  55 #endif
  56
  57 /* Here we provide G_GNUC_EXTENSION as an alias for __extension__,
  58  * where this is valid. This allows for warningless compilation of
  59  * "long long" types even in the presence of '-ansi -pedantic'.
  60  */
  61 #if G_GNUC_CHECK_VERSION(2, 8)
  62 #define G_GNUC_EXTENSION __extension__
  63 #else
  64 #define G_GNUC_EXTENSION
  65 #endif
  66
  67 #if !defined (__cplusplus)
  68
  69 # undef G_CXX_STD_VERSION
  70 # define G_CXX_STD_CHECK_VERSION(version) (0)
  71
  72 # if defined (__STDC_VERSION__)
  73 #  define G_C_STD_VERSION __STDC_VERSION__
  74 # else
  75 #  define G_C_STD_VERSION 199000L
  76 # endif /* defined (__STDC_VERSION__) */
  77
  78 # define G_C_STD_CHECK_VERSION(version) ( \
  79   ((version) >= 199000L && (version) <= G_C_STD_VERSION) || \
  80   ((version) == 89 && G_C_STD_VERSION >= 199000L) || \
  81   ((version) == 90 && G_C_STD_VERSION >= 199000L) || \
  82   ((version) == 99 && G_C_STD_VERSION >= 199901L) || \
  83   ((version) == 11 && G_C_STD_VERSION >= 201112L) || \
  84   ((version) == 17 && G_C_STD_VERSION >= 201710L) || \
  85   0)
  86
  87 #else /* defined (__cplusplus) */
  88
  89 # undef G_C_STD_VERSION
  90 # define G_C_STD_CHECK_VERSION(version) (0)
  91
  92 # if defined (_MSVC_LANG)
  93 #  define G_CXX_STD_VERSION (_MSVC_LANG > __cplusplus ? _MSVC_LANG : __cplusplus)
  94 # else
  95 #  define G_CXX_STD_VERSION __cplusplus
  96 # endif /* defined(_MSVC_LANG) */
  97
  98 # define G_CXX_STD_CHECK_VERSION(version) ( \
  99   ((version) >= 199711L && (version) <= G_CXX_STD_VERSION) || \
 100   ((version) == 98 && G_CXX_STD_VERSION >= 199711L) || \
 101   ((version) == 03 && G_CXX_STD_VERSION >= 199711L) || \
 102   ((version) == 11 && G_CXX_STD_VERSION >= 201103L) || \
 103   ((version) == 14 && G_CXX_STD_VERSION >= 201402L) || \
 104   ((version) == 17 && G_CXX_STD_VERSION >= 201703L) || \
 105   ((version) == 20 && G_CXX_STD_VERSION >= 202002L) || \
 106   0)
 107
 108 #endif /* !defined (__cplusplus) */
 109
 110 /* Every compiler that we target supports inlining, but some of them may
 111  * complain about it if we don't say "__inline".  If we have C99, or if
 112  * we are using C++, then we can use "inline" directly.
 113  * Otherwise, we say "__inline" to avoid the warning.
 114  * Unfortunately Visual Studio does not define __STDC_VERSION__ (if not
 115  * using /std:cXX) so we need to check whether we are on Visual Studio 2013
 116  * or earlier to see whether we need to say "__inline" in C mode.
 117  */
 118 #define G_CAN_INLINE
 119 #ifdef G_C_STD_VERSION
 120 # ifdef _MSC_VER
 121 #  if (_MSC_VER < 1900)
 122 #   define G_INLINE_DEFINE_NEEDED
 123 #  endif
 124 # elif !G_C_STD_CHECK_VERSION (99)
 125 #  define G_INLINE_DEFINE_NEEDED
 126 # endif
 127 #endif
 128
 129 #ifdef G_INLINE_DEFINE_NEEDED
 130 # undef inline
 131 # define inline __inline
 132 #endif
 133
 134 #undef G_INLINE_DEFINE_NEEDED
 135
 136 /**
 137  * G_INLINE_FUNC:
 138  *
 139  * This macro used to be used to conditionally define inline functions
 140  * in a compatible way before this feature was supported in all
 141  * compilers.  These days, GLib requires inlining support from the
 142  * compiler, so your GLib-using programs can safely assume that the
 143  * "inline" keyword works properly.
 144  *
 145  * Never use this macro anymore.  Just say "static inline".
 146  *
 147  * Deprecated: 2.48: Use "static inline" instead
 148  */
 149
 150 /* For historical reasons we need to continue to support those who
 151  * define G_IMPLEMENT_INLINES to mean "don't implement this here".
 152  */
 153 #ifdef G_IMPLEMENT_INLINES
 154 #  define G_INLINE_FUNC extern GLIB_DEPRECATED_MACRO_IN_2_48_FOR(static inline)
 155 #  undef  G_CAN_INLINE
 156 #else
 157 #  define G_INLINE_FUNC static inline GLIB_DEPRECATED_MACRO_IN_2_48_FOR(static inline)
 158 #endif /* G_IMPLEMENT_INLINES */
 159
 160 /*
 161  * Attribute support detection. Works on clang and GCC >= 5
 162  * https://clang.llvm.org/docs/LanguageExtensions.html#has-attribute
 163  * https://gcc.gnu.org/onlinedocs/cpp/_005f_005fhas_005fattribute.html
 164  */
 165
 166 #ifdef __has_attribute
 167 #define g_macro__has_attribute __has_attribute
 168 #else
 169
 170 /*
 171  * Fallback for GCC < 5 and other compilers not supporting __has_attribute.
 172  */
 173 #define g_macro__has_attribute(x) g_macro__has_attribute_##x
 174
 175 #define g_macro__has_attribute___alloc_size__ G_GNUC_CHECK_VERSION (4, 3)
 176 #define g_macro__has_attribute___always_inline__ G_GNUC_CHECK_VERSION (2, 0)
 177 #define g_macro__has_attribute___const__ G_GNUC_CHECK_VERSION (2, 4)
 178 #define g_macro__has_attribute___deprecated__ G_GNUC_CHECK_VERSION (3, 1)
 179 #define g_macro__has_attribute___format__ G_GNUC_CHECK_VERSION (2, 4)
 180 #define g_macro__has_attribute___format_arg__ G_GNUC_CHECK_VERSION (2, 4)
 181 #define g_macro__has_attribute___malloc__ G_GNUC_CHECK_VERSION (2, 96)
 182 #define g_macro__has_attribute___no_instrument_function__ G_GNUC_CHECK_VERSION (2, 4)
 183 #define g_macro__has_attribute___noinline__ G_GNUC_CHECK_VERSION (2, 96)
 184 #define g_macro__has_attribute___noreturn__ (G_GNUC_CHECK_VERSION (2, 8) || (0x5110 <= __SUNPRO_C))
 185 #define g_macro__has_attribute___pure__ G_GNUC_CHECK_VERSION (2, 96)
 186 #define g_macro__has_attribute___sentinel__ G_GNUC_CHECK_VERSION (4, 0)
 187 #define g_macro__has_attribute___unused__ G_GNUC_CHECK_VERSION (2, 4)
 188 #define g_macro__has_attribute_cleanup G_GNUC_CHECK_VERSION (3, 3)
 189 #define g_macro__has_attribute_fallthrough G_GNUC_CHECK_VERSION (6, 0)
 190 #define g_macro__has_attribute_may_alias G_GNUC_CHECK_VERSION (3, 3)
 191 #define g_macro__has_attribute_warn_unused_result G_GNUC_CHECK_VERSION (3, 4)
 192
 193 #endif
 194
 195 /* Provide macros to feature the GCC function attribute.
 196  */
 197
 198 /**
 199  * G_GNUC_PURE:
 200  *
 201  * Expands to the GNU C `pure` function attribute if the compiler is gcc.
 202  * Declaring a function as `pure` enables better optimization of calls to
 203  * the function. A `pure` function has no effects except its return value
 204  * and the return value depends only on the parameters and/or global
 205  * variables.
 206  *
 207  * Place the attribute after the declaration, just before the semicolon.
 208  *
 209  * |[<!-- language="C" -->
 210  * gboolean g_type_check_value (const GValue *value) G_GNUC_PURE;
 211  * ]|
 212  *
 213  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-pure-function-attribute) for more details.
 214  */
 215
 216 /**
 217  * G_GNUC_MALLOC:
 218  *
 219  * Expands to the
 220  * [GNU C `malloc` function attribute](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-functions-that-behave-like-malloc)
 221  * if the compiler is gcc.
 222  * Declaring a function as `malloc` enables better optimization of the function,
 223  * but must only be done if the allocation behaviour of the function is fully
 224  * understood, otherwise miscompilation can result.
 225  *
 226  * A function can have the `malloc` attribute if it returns a pointer which is
 227  * guaranteed to not alias with any other pointer valid when the function
 228  * returns, and moreover no pointers to valid objects occur in any storage
 229  * addressed by the returned pointer.
 230  *
 231  * In practice, this means that `G_GNUC_MALLOC` can be used with any function
 232  * which returns unallocated or zeroed-out memory, but not with functions which
 233  * return initialised structures containing other pointers, or with functions
 234  * that reallocate memory. This definition changed in GLib 2.58 to match the
 235  * stricter definition introduced around GCC 5.
 236  *
 237  * Place the attribute after the declaration, just before the semicolon.
 238  *
 239  * |[<!-- language="C" -->
 240  * gpointer g_malloc (gsize n_bytes) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
 241  * ]|
 242  *
 243  * See the
 244  * [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-functions-that-behave-like-malloc)
 245  * for more details.
 246  *
 247  * Since: 2.6
 248  */
 249
 250 /**
 251  * G_GNUC_NO_INLINE:
 252  *
 253  * Expands to the GNU C `noinline` function attribute if the compiler is gcc.
 254  * If the compiler is not gcc, this macro expands to nothing.
 255  *
 256  * Declaring a function as `noinline` prevents the function from being
 257  * considered for inlining.
 258  *
 259  * This macro is provided for retro-compatibility and will be eventually
 260  * deprecated, but %G_NO_INLINE should be used instead.
 261  *
 262  * The attribute may be placed before the declaration or definition,
 263  * right before the `static` keyword.
 264  *
 265  * |[<!-- language="C" -->
 266  * G_GNUC_NO_INLINE
 267  * static int
 268  * do_not_inline_this (void)
 269  * {
 270  *   ...
 271  * }
 272  * ]|
 273  *
 274  * See the
 275  * [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-noinline-function-attribute)
 276  * for more details.
 277  *
 278  * See also: %G_NO_INLINE, %G_ALWAYS_INLINE.
 279  *
 280  * Since: 2.58
 281  */
 282
 283 #if g_macro__has_attribute(__pure__)
 284 #define G_GNUC_PURE __attribute__((__pure__))
 285 #else
 286 #define G_GNUC_PURE
 287 #endif
 288
 289 #if g_macro__has_attribute(__malloc__)
 290 #define G_GNUC_MALLOC __attribute__ ((__malloc__))
 291 #else
 292 #define G_GNUC_MALLOC
 293 #endif
 294
 295 #if g_macro__has_attribute(__noinline__)
 296 #define G_GNUC_NO_INLINE __attribute__ ((__noinline__)) \
 297   GLIB_AVAILABLE_MACRO_IN_2_58
 298 #else
 299 #define G_GNUC_NO_INLINE \
 300   GLIB_AVAILABLE_MACRO_IN_2_58
 301 #endif
 302
 303 /**
 304  * G_GNUC_NULL_TERMINATED:
 305  *
 306  * Expands to the GNU C `sentinel` function attribute if the compiler is gcc.
 307  * This function attribute only applies to variadic functions and instructs
 308  * the compiler to check that the argument list is terminated with an
 309  * explicit %NULL.
 310  *
 311  * Place the attribute after the declaration, just before the semicolon.
 312  *
 313  * |[<!-- language="C" -->
 314  * gchar *g_strconcat (const gchar *string1,
 315  *                     ...) G_GNUC_NULL_TERMINATED;
 316  * ]|
 317  *
 318  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-sentinel-function-attribute) for more details.
 319  *
 320  * Since: 2.8
 321  */
 322 #if g_macro__has_attribute(__sentinel__)
 323 #define G_GNUC_NULL_TERMINATED __attribute__((__sentinel__))
 324 #else
 325 #define G_GNUC_NULL_TERMINATED
 326 #endif
 327
 328 /*
 329  * Clang feature detection: http://clang.llvm.org/docs/LanguageExtensions.html
 330  * These are not available on GCC, but since the pre-processor doesn't do
 331  * operator short-circuiting, we can't use it in a statement or we'll get:
 332  *
 333  * error: missing binary operator before token "("
 334  *
 335  * So we define it to 0 to satisfy the pre-processor.
 336  */
 337
 338 #ifdef __has_feature
 339 #define g_macro__has_feature __has_feature
 340 #else
 341 #define g_macro__has_feature(x) 0
 342 #endif
 343
 344 #ifdef __has_builtin
 345 #define g_macro__has_builtin __has_builtin
 346 #else
 347 #define g_macro__has_builtin(x) 0
 348 #endif
 349
 350 #ifdef __has_extension
 351 #define g_macro__has_extension __has_extension
 352 #else
 353 #define g_macro__has_extension(x) 0
 354 #endif
 355
 356 /**
 357  * G_GNUC_ALLOC_SIZE:
 358  * @x: the index of the argument specifying the allocation size
 359  *
 360  * Expands to the GNU C `alloc_size` function attribute if the compiler
 361  * is a new enough gcc. This attribute tells the compiler that the
 362  * function returns a pointer to memory of a size that is specified
 363  * by the @xth function parameter.
 364  *
 365  * Place the attribute after the function declaration, just before the
 366  * semicolon.
 367  *
 368  * |[<!-- language="C" -->
 369  * gpointer g_malloc (gsize n_bytes) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
 370  * ]|
 371  *
 372  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-alloc_005fsize-function-attribute) for more details.
 373  *
 374  * Since: 2.18
 375  */
 376
 377 /**
 378  * G_GNUC_ALLOC_SIZE2:
 379  * @x: the index of the argument specifying one factor of the allocation size
 380  * @y: the index of the argument specifying the second factor of the allocation size
 381  *
 382  * Expands to the GNU C `alloc_size` function attribute if the compiler is a
 383  * new enough gcc. This attribute tells the compiler that the function returns
 384  * a pointer to memory of a size that is specified by the product of two
 385  * function parameters.
 386  *
 387  * Place the attribute after the function declaration, just before the
 388  * semicolon.
 389  *
 390  * |[<!-- language="C" -->
 391  * gpointer g_malloc_n (gsize n_blocks,
 392  *                      gsize n_block_bytes) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE2(1, 2);
 393  * ]|
 394  *
 395  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-alloc_005fsize-function-attribute) for more details.
 396  *
 397  * Since: 2.18
 398  */
 399 #if g_macro__has_attribute(__alloc_size__)
 400 #define G_GNUC_ALLOC_SIZE(x) __attribute__((__alloc_size__(x)))
 401 #define G_GNUC_ALLOC_SIZE2(x,y) __attribute__((__alloc_size__(x,y)))
 402 #else
 403 #define G_GNUC_ALLOC_SIZE(x)
 404 #define G_GNUC_ALLOC_SIZE2(x,y)
 405 #endif
 406
 407 /**
 408  * G_GNUC_PRINTF:
 409  * @format_idx: the index of the argument corresponding to the
 410  *     format string (the arguments are numbered from 1)
 411  * @arg_idx: the index of the first of the format arguments, or 0 if
 412  *     there are no format arguments
 413  *
 414  * Expands to the GNU C `format` function attribute if the compiler is gcc.
 415  * This is used for declaring functions which take a variable number of
 416  * arguments, with the same syntax as `printf()`. It allows the compiler
 417  * to type-check the arguments passed to the function.
 418  *
 419  * Place the attribute after the function declaration, just before the
 420  * semicolon.
 421  *
 422  * See the
 423  * [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-3288)
 424  * for more details.
 425  *
 426  * |[<!-- language="C" -->
 427  * gint g_snprintf (gchar  *string,
 428  *                  gulong       n,
 429  *                  gchar const *format,
 430  *                  ...) G_GNUC_PRINTF (3, 4);
 431  * ]|
 432  */
 433
 434 /**
 435  * G_GNUC_SCANF:
 436  * @format_idx: the index of the argument corresponding to
 437  *     the format string (the arguments are numbered from 1)
 438  * @arg_idx: the index of the first of the format arguments, or 0 if
 439  *     there are no format arguments
 440  *
 441  * Expands to the GNU C `format` function attribute if the compiler is gcc.
 442  * This is used for declaring functions which take a variable number of
 443  * arguments, with the same syntax as `scanf()`. It allows the compiler
 444  * to type-check the arguments passed to the function.
 445  *
 446  * |[<!-- language="C" -->
 447  * int my_scanf (MyStream *stream,
 448  *               const char *format,
 449  *               ...) G_GNUC_SCANF (2, 3);
 450  * int my_vscanf (MyStream *stream,
 451  *                const char *format,
 452  *                va_list ap) G_GNUC_SCANF (2, 0);
 453  * ]|
 454  *
 455  * See the
 456  * [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-3288)
 457  * for details.
 458  */
 459
 460 /**
 461  * G_GNUC_STRFTIME:
 462  * @format_idx: the index of the argument corresponding to
 463  *     the format string (the arguments are numbered from 1)
 464  *
 465  * Expands to the GNU C `strftime` format function attribute if the compiler
 466  * is gcc. This is used for declaring functions which take a format argument
 467  * which is passed to `strftime()` or an API implementing its formats. It allows
 468  * the compiler check the format passed to the function.
 469  *
 470  * |[<!-- language="C" -->
 471  * gsize my_strftime (MyBuffer *buffer,
 472  *                    const char *format,
 473  *                    const struct tm *tm) G_GNUC_STRFTIME (2);
 474  * ]|
 475  *
 476  * See the
 477  * [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-3288)
 478  * for details.
 479  *
 480  * Since: 2.60
 481  */
 482
 483 /**
 484  * G_GNUC_FORMAT:
 485  * @arg_idx: the index of the argument
 486  *
 487  * Expands to the GNU C `format_arg` function attribute if the compiler
 488  * is gcc. This function attribute specifies that a function takes a
 489  * format string for a `printf()`, `scanf()`, `strftime()` or `strfmon()` style
 490  * function and modifies it, so that the result can be passed to a `printf()`,
 491  * `scanf()`, `strftime()` or `strfmon()` style function (with the remaining
 492  * arguments to the format function the same as they would have been
 493  * for the unmodified string).
 494  *
 495  * Place the attribute after the function declaration, just before the
 496  * semicolon.
 497  *
 498  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-nonliteral-1) for more details.
 499  *
 500  * |[<!-- language="C" -->
 501  * gchar *g_dgettext (gchar *domain_name, gchar *msgid) G_GNUC_FORMAT (2);
 502  * ]|
 503  */
 504
 505 /**
 506  * G_GNUC_NORETURN:
 507  *
 508  * Expands to the GNU C `noreturn` function attribute if the compiler is gcc.
 509  * It is used for declaring functions which never return. It enables
 510  * optimization of the function, and avoids possible compiler warnings.
 511  *
 512  * Since 2.68, it is recommended that code uses %G_NORETURN instead of
 513  * %G_GNUC_NORETURN, as that works on more platforms and compilers (in
 514  * particular, MSVC and C++11) than %G_GNUC_NORETURN, which works with GCC and
 515  * Clang only. %G_GNUC_NORETURN continues to work, so has not been deprecated
 516  * yet.
 517  *
 518  * Place the attribute after the declaration, just before the semicolon.
 519  *
 520  * |[<!-- language="C" -->
 521  * void g_abort (void) G_GNUC_NORETURN;
 522  * ]|
 523  *
 524  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-noreturn-function-attribute) for more details.
 525  */
 526
 527 /**
 528  * G_GNUC_CONST:
 529  *
 530  * Expands to the GNU C `const` function attribute if the compiler is gcc.
 531  * Declaring a function as `const` enables better optimization of calls to
 532  * the function. A `const` function doesn't examine any values except its
 533  * parameters, and has no effects except its return value.
 534  *
 535  * Place the attribute after the declaration, just before the semicolon.
 536  *
 537  * |[<!-- language="C" -->
 538  * gchar g_ascii_tolower (gchar c) G_GNUC_CONST;
 539  * ]|
 540  *
 541  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-const-function-attribute) for more details.
 542  *
 543  * A function that has pointer arguments and examines the data pointed to
 544  * must not be declared `const`. Likewise, a function that calls a non-`const`
 545  * function usually must not be `const`. It doesn't make sense for a `const`
 546  * function to return `void`.
 547  */
 548
 549 /**
 550  * G_GNUC_UNUSED:
 551  *
 552  * Expands to the GNU C `unused` function attribute if the compiler is gcc.
 553  * It is used for declaring functions and arguments which may never be used.
 554  * It avoids possible compiler warnings.
 555  *
 556  * For functions, place the attribute after the declaration, just before the
 557  * semicolon. For arguments, place the attribute at the beginning of the
 558  * argument declaration.
 559  *
 560  * |[<!-- language="C" -->
 561  * void my_unused_function (G_GNUC_UNUSED gint unused_argument,
 562  *                          gint other_argument) G_GNUC_UNUSED;
 563  * ]|
 564  *
 565  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-unused-function-attribute) for more details.
 566  */
 567
 568 /**
 569  * G_GNUC_NO_INSTRUMENT:
 570  *
 571  * Expands to the GNU C `no_instrument_function` function attribute if the
 572  * compiler is gcc. Functions with this attribute will not be instrumented
 573  * for profiling, when the compiler is called with the
 574  * `-finstrument-functions` option.
 575  *
 576  * Place the attribute after the declaration, just before the semicolon.
 577  *
 578  * |[<!-- language="C" -->
 579  * int do_uninteresting_things (void) G_GNUC_NO_INSTRUMENT;
 580  * ]|
 581  *
 582  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-no_005finstrument_005ffunction-function-attribute) for more details.
 583  */
 584
 585 #if g_macro__has_attribute(__format__)
 586
 587 #if !defined (__clang__) && G_GNUC_CHECK_VERSION (4, 4)
 588 #define G_GNUC_PRINTF( format_idx, arg_idx )    \
 589   __attribute__((__format__ (gnu_printf, format_idx, arg_idx)))
 590 #define G_GNUC_SCANF( format_idx, arg_idx )     \
 591   __attribute__((__format__ (gnu_scanf, format_idx, arg_idx)))
 592 #define G_GNUC_STRFTIME( format_idx )    \
 593   __attribute__((__format__ (gnu_strftime, format_idx, 0))) \
 594   GLIB_AVAILABLE_MACRO_IN_2_60
 595 #else
 596 #define G_GNUC_PRINTF( format_idx, arg_idx )    \
 597   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
 598 #define G_GNUC_SCANF( format_idx, arg_idx )     \
 599   __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
 600 #define G_GNUC_STRFTIME( format_idx )    \
 601   __attribute__((__format__ (__strftime__, format_idx, 0))) \
 602   GLIB_AVAILABLE_MACRO_IN_2_60
 603 #endif
 604
 605 #else
 606
 607 #define G_GNUC_PRINTF( format_idx, arg_idx )
 608 #define G_GNUC_SCANF( format_idx, arg_idx )
 609 #define G_GNUC_STRFTIME( format_idx ) \
 610   GLIB_AVAILABLE_MACRO_IN_2_60
 611
 612 #endif
 613
 614 #if g_macro__has_attribute(__format_arg__)
 615 #define G_GNUC_FORMAT(arg_idx) \
 616   __attribute__ ((__format_arg__ (arg_idx)))
 617 #else
 618 #define G_GNUC_FORMAT( arg_idx )
 619 #endif
 620
 621 #if g_macro__has_attribute(__noreturn__)
 622 #define G_GNUC_NORETURN \
 623   __attribute__ ((__noreturn__))
 624 #else
 625 /* NOTE: MSVC has __declspec(noreturn) but unlike GCC __attribute__,
 626  * __declspec can only be placed at the start of the function prototype
 627  * and not at the end, so we can't use it without breaking API.
 628  */
 629 #define G_GNUC_NORETURN
 630 #endif
 631
 632 #if g_macro__has_attribute(__const__)
 633 #define G_GNUC_CONST \
 634   __attribute__ ((__const__))
 635 #else
 636 #define G_GNUC_CONST
 637 #endif
 638
 639 #if g_macro__has_attribute(__unused__)
 640 #define G_GNUC_UNUSED \
 641   __attribute__ ((__unused__))
 642 #else
 643 #define G_GNUC_UNUSED
 644 #endif
 645
 646 #if g_macro__has_attribute(__no_instrument_function__)
 647 #define G_GNUC_NO_INSTRUMENT \
 648   __attribute__ ((__no_instrument_function__))
 649 #else
 650 #define G_GNUC_NO_INSTRUMENT
 651 #endif
 652
 653 /**
 654  * G_GNUC_FALLTHROUGH:
 655  *
 656  * Expands to the GNU C `fallthrough` statement attribute if the compiler supports it.
 657  * This allows declaring case statement to explicitly fall through in switch
 658  * statements. To enable this feature, use `-Wimplicit-fallthrough` during
 659  * compilation.
 660  *
 661  * Put the attribute right before the case statement you want to fall through
 662  * to.
 663  *
 664  * |[<!-- language="C" -->
 665  * switch (foo)
 666  *   {
 667  *     case 1:
 668  *       g_message ("it's 1");
 669  *       G_GNUC_FALLTHROUGH;
 670  *     case 2:
 671  *       g_message ("it's either 1 or 2");
 672  *       break;
 673  *   }
 674  * ]|
 675  *
 676  *
 677  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Statement-Attributes.html#index-fallthrough-statement-attribute) for more details.
 678  *
 679  * Since: 2.60
 680  */
 681 #if g_macro__has_attribute(fallthrough)
 682 #define G_GNUC_FALLTHROUGH __attribute__((fallthrough)) \
 683   GLIB_AVAILABLE_MACRO_IN_2_60
 684 #else
 685 #define G_GNUC_FALLTHROUGH \
 686   GLIB_AVAILABLE_MACRO_IN_2_60
 687 #endif
 688
 689 /**
 690  * G_GNUC_DEPRECATED:
 691  *
 692  * Expands to the GNU C `deprecated` attribute if the compiler is gcc.
 693  * It can be used to mark `typedef`s, variables and functions as deprecated.
 694  * When called with the `-Wdeprecated-declarations` option,
 695  * gcc will generate warnings when deprecated interfaces are used.
 696  *
 697  * Place the attribute after the declaration, just before the semicolon.
 698  *
 699  * |[<!-- language="C" -->
 700  * int my_mistake (void) G_GNUC_DEPRECATED;
 701  * ]|
 702  *
 703  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-deprecated-function-attribute) for more details.
 704  *
 705  * Since: 2.2
 706  */
 707 #if g_macro__has_attribute(__deprecated__)
 708 #define G_GNUC_DEPRECATED __attribute__((__deprecated__))
 709 #else
 710 #define G_GNUC_DEPRECATED
 711 #endif /* __GNUC__ */
 712
 713 /**
 714  * G_GNUC_DEPRECATED_FOR:
 715  * @f: the intended replacement for the deprecated symbol,
 716  *     such as the name of a function
 717  *
 718  * Like %G_GNUC_DEPRECATED, but names the intended replacement for the
 719  * deprecated symbol if the version of gcc in use is new enough to support
 720  * custom deprecation messages.
 721  *
 722  * Place the attribute after the declaration, just before the semicolon.
 723  *
 724  * |[<!-- language="C" -->
 725  * int my_mistake (void) G_GNUC_DEPRECATED_FOR(my_replacement);
 726  * ]|
 727  *
 728  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-deprecated-function-attribute) for more details.
 729  *
 730  * Note that if @f is a macro, it will be expanded in the warning message.
 731  * You can enclose it in quotes to prevent this. (The quotes will show up
 732  * in the warning, but it's better than showing the macro expansion.)
 733  *
 734  * Since: 2.26
 735  */
 736 #if G_GNUC_CHECK_VERSION(4, 5) || defined(__clang__)
 737 #define G_GNUC_DEPRECATED_FOR(f)                        \
 738   __attribute__((deprecated("Use " #f " instead")))     \
 739   GLIB_AVAILABLE_MACRO_IN_2_26
 740 #else
 741 #define G_GNUC_DEPRECATED_FOR(f)      G_GNUC_DEPRECATED \
 742   GLIB_AVAILABLE_MACRO_IN_2_26
 743 #endif /* __GNUC__ */
 744
 745 #ifdef __ICC
 746 #define G_GNUC_BEGIN_IGNORE_DEPRECATIONS                \
 747   _Pragma ("warning (push)")                            \
 748   _Pragma ("warning (disable:1478)")
 749 #define G_GNUC_END_IGNORE_DEPRECATIONS                  \
 750   _Pragma ("warning (pop)")
 751 #elif G_GNUC_CHECK_VERSION(4, 6)
 752 #define G_GNUC_BEGIN_IGNORE_DEPRECATIONS                \
 753   _Pragma ("GCC diagnostic push")                       \
 754   _Pragma ("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
 755 #define G_GNUC_END_IGNORE_DEPRECATIONS                  \
 756   _Pragma ("GCC diagnostic pop")
 757 #elif defined (_MSC_VER) && (_MSC_VER >= 1500) && !defined (__clang__)
 758 #define G_GNUC_BEGIN_IGNORE_DEPRECATIONS                \
 759   __pragma (warning (push))  \
 760   __pragma (warning (disable : 4996))
 761 #define G_GNUC_END_IGNORE_DEPRECATIONS                  \
 762   __pragma (warning (pop))
 763 #elif defined (__clang__)
 764 #define G_GNUC_BEGIN_IGNORE_DEPRECATIONS \
 765   _Pragma("clang diagnostic push") \
 766   _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"")
 767 #define G_GNUC_END_IGNORE_DEPRECATIONS \
 768   _Pragma("clang diagnostic pop")
 769 #else
 770 #define G_GNUC_BEGIN_IGNORE_DEPRECATIONS
 771 #define G_GNUC_END_IGNORE_DEPRECATIONS
 772 #define GLIB_CANNOT_IGNORE_DEPRECATIONS
 773 #endif
 774
 775 /**
 776  * G_GNUC_MAY_ALIAS:
 777  *
 778  * Expands to the GNU C `may_alias` type attribute if the compiler is gcc.
 779  * Types with this attribute will not be subjected to type-based alias
 780  * analysis, but are assumed to alias with any other type, just like `char`.
 781  *
 782  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Type-Attributes.html#index-may_005falias-type-attribute) for details.
 783  *
 784  * Since: 2.14
 785  */
 786 #if g_macro__has_attribute(may_alias)
 787 #define G_GNUC_MAY_ALIAS __attribute__((may_alias))
 788 #else
 789 #define G_GNUC_MAY_ALIAS
 790 #endif
 791
 792 /**
 793  * G_GNUC_WARN_UNUSED_RESULT:
 794  *
 795  * Expands to the GNU C `warn_unused_result` function attribute if the compiler
 796  * is gcc. This function attribute makes the compiler emit a warning if the
 797  * result of a function call is ignored.
 798  *
 799  * Place the attribute after the declaration, just before the semicolon.
 800  *
 801  * |[<!-- language="C" -->
 802  * GList *g_list_append (GList *list,
 803  *                       gpointer data) G_GNUC_WARN_UNUSED_RESULT;
 804  * ]|
 805  *
 806  * See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-warn_005funused_005fresult-function-attribute) for more details.
 807  *
 808  * Since: 2.10
 809  */
 810 #if g_macro__has_attribute(warn_unused_result)
 811 #define G_GNUC_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
 812 #else
 813 #define G_GNUC_WARN_UNUSED_RESULT
 814 #endif /* __GNUC__ */
 815
 816 /**
 817  * G_GNUC_FUNCTION:
 818  *
 819  * Expands to "" on all modern compilers, and to  __FUNCTION__ on gcc
 820  * version 2.x. Don't use it.
 821  *
 822  * Deprecated: 2.16: Use G_STRFUNC() instead
 823  */
 824
 825 /**
 826  * G_GNUC_PRETTY_FUNCTION:
 827  *
 828  * Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__
 829  * on gcc version 2.x. Don't use it.
 830  *
 831  * Deprecated: 2.16: Use G_STRFUNC() instead
 832  */
 833
 834 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
 835  * macros, so we can refer to them as strings unconditionally.
 836  * usage not-recommended since gcc-3.0
 837  *
 838  * Mark them as deprecated since 2.26, since that’s when version macros were
 839  * introduced.
 840  */
 841 #if defined (__GNUC__) && (__GNUC__ < 3)
 842 #define G_GNUC_FUNCTION         __FUNCTION__ GLIB_DEPRECATED_MACRO_IN_2_26_FOR(G_STRFUNC)
 843 #define G_GNUC_PRETTY_FUNCTION  __PRETTY_FUNCTION__ GLIB_DEPRECATED_MACRO_IN_2_26_FOR(G_STRFUNC)
 844 #else   /* !__GNUC__ */
 845 #define G_GNUC_FUNCTION         "" GLIB_DEPRECATED_MACRO_IN_2_26_FOR(G_STRFUNC)
 846 #define G_GNUC_PRETTY_FUNCTION  "" GLIB_DEPRECATED_MACRO_IN_2_26_FOR(G_STRFUNC)
 847 #endif  /* !__GNUC__ */
 848
 849 #if g_macro__has_feature(attribute_analyzer_noreturn) && defined(__clang_analyzer__)
 850 #define G_ANALYZER_ANALYZING 1
 851 #define G_ANALYZER_NORETURN __attribute__((analyzer_noreturn))
 852 #elif defined(__COVERITY__)
 853 #define G_ANALYZER_ANALYZING 1
 854 #define G_ANALYZER_NORETURN __attribute__((noreturn))
 855 #else
 856 #define G_ANALYZER_ANALYZING 0
 857 #define G_ANALYZER_NORETURN
 858 #endif
 859
 860 #define G_STRINGIFY(macro_or_string)    G_STRINGIFY_ARG (macro_or_string)
 861 #define G_STRINGIFY_ARG(contents)       #contents
 862
 863 #ifndef __GI_SCANNER__ /* The static assert macro really confuses the introspection parser */
 864 #define G_PASTE_ARGS(identifier1,identifier2) identifier1 ## identifier2
 865 #define G_PASTE(identifier1,identifier2)      G_PASTE_ARGS (identifier1, identifier2)
 866 #if G_CXX_STD_CHECK_VERSION (11)
 867 #define G_STATIC_ASSERT(expr) static_assert (expr, "Expression evaluates to false")
 868 #elif (G_C_STD_CHECK_VERSION (11) || \
 869      g_macro__has_feature(c_static_assert) || g_macro__has_extension(c_static_assert))
 870 #define G_STATIC_ASSERT(expr) _Static_assert (expr, "Expression evaluates to false")
 871 #else
 872 #ifdef __COUNTER__
 873 #define G_STATIC_ASSERT(expr) typedef char G_PASTE (_GStaticAssertCompileTimeAssertion_, __COUNTER__)[(expr) ? 1 : -1] G_GNUC_UNUSED
 874 #else
 875 #define G_STATIC_ASSERT(expr) typedef char G_PASTE (_GStaticAssertCompileTimeAssertion_, __LINE__)[(expr) ? 1 : -1] G_GNUC_UNUSED
 876 #endif
 877 #endif /* G_CXX_STD_CHECK_VERSION (11) */
 878 #define G_STATIC_ASSERT_EXPR(expr) ((void) sizeof (char[(expr) ? 1 : -1]))
 879 #endif /* !__GI_SCANNER__ */
 880
 881 /* Provide a string identifying the current code position */
 882 #if defined (__GNUC__) && (__GNUC__ < 3) && !defined (G_CXX_STD_VERSION)
 883 #define G_STRLOC        __FILE__ ":" G_STRINGIFY (__LINE__) ":" __PRETTY_FUNCTION__ "()"
 884 #else
 885 #define G_STRLOC        __FILE__ ":" G_STRINGIFY (__LINE__)
 886 #endif
 887
 888 /* Provide a string identifying the current function, non-concatenatable */
 889 #if defined (__GNUC__) && defined (G_CXX_STD_VERSION)
 890 #define G_STRFUNC     ((const char*) (__PRETTY_FUNCTION__))
 891 #elif G_C_STD_CHECK_VERSION (99)
 892 #define G_STRFUNC     ((const char*) (__func__))
 893 #elif defined (__GNUC__) || (defined(_MSC_VER) && (_MSC_VER > 1300))
 894 #define G_STRFUNC     ((const char*) (__FUNCTION__))
 895 #else
 896 #define G_STRFUNC     ((const char*) ("???"))
 897 #endif
 898
 899 /* Guard C code in headers, while including them from C++ */
 900 #ifdef  G_CXX_STD_VERSION
 901 #define G_BEGIN_DECLS  extern "C" {
 902 #define G_END_DECLS    }
 903 #else
 904 #define G_BEGIN_DECLS
 905 #define G_END_DECLS
 906 #endif
 907
 908 /* Provide definitions for some commonly used macros.
 909  *  Some of them are only provided if they haven't already
 910  *  been defined. It is assumed that if they are already
 911  *  defined then the current definition is correct.
 912  */
 913 #ifndef NULL
 914 #  if G_CXX_STD_CHECK_VERSION (11)
 915 #    define NULL (nullptr)
 916 #  elif defined (G_CXX_STD_VERSION)
 917 #    define NULL (0L)
 918 #  else
 919 #    define NULL ((void*) 0)
 920 #  endif /* G_CXX_STD_CHECK_VERSION (11) */
 921 #endif
 922
 923 #ifndef FALSE
 924 #define FALSE   (0)
 925 #endif
 926
 927 #ifndef TRUE
 928 #define TRUE    (!FALSE)
 929 #endif
 930
 931 #undef  MAX
 932 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
 933
 934 #undef  MIN
 935 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
 936
 937 #undef  ABS
 938 #define ABS(a)     (((a) < 0) ? -(a) : (a))
 939
 940 #undef  CLAMP
 941 #define CLAMP(x, low, high)  (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
 942
 943 #define G_APPROX_VALUE(a, b, epsilon) \
 944   (((a) > (b) ? (a) - (b) : (b) - (a)) < (epsilon))
 945
 946 /* Count the number of elements in an array. The array must be defined
 947  * as such; using this with a dynamically allocated array will give
 948  * incorrect results.
 949  */
 950 #define G_N_ELEMENTS(arr)               (sizeof (arr) / sizeof ((arr)[0]))
 951
 952 /* Macros by analogy to GINT_TO_POINTER, GPOINTER_TO_INT
 953  */
 954 #define GPOINTER_TO_SIZE(p)     ((gsize) (p))
 955 #define GSIZE_TO_POINTER(s)     ((gpointer) (guintptr) (gsize) (s))
 956
 957 /* Provide convenience macros for handling structure
 958  * fields through their offsets.
 959  */
 960
 961 #if G_GNUC_CHECK_VERSION(4, 0) || defined(_MSC_VER)
 962 #define G_STRUCT_OFFSET(struct_type, member) \
 963       ((glong) offsetof (struct_type, member))
 964 #else
 965 #define G_STRUCT_OFFSET(struct_type, member)    \
 966       ((glong) ((guint8*) &((struct_type*) 0)->member))
 967 #endif
 968
 969 #define G_STRUCT_MEMBER_P(struct_p, struct_offset)   \
 970     ((gpointer) ((guint8*) (struct_p) + (glong) (struct_offset)))
 971 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset)   \
 972     (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
 973
 974 /* Provide simple macro statement wrappers:
 975  *   G_STMT_START { statements; } G_STMT_END;
 976  * This can be used as a single statement, like:
 977  *   if (x) G_STMT_START { ... } G_STMT_END; else ...
 978  * This intentionally does not use compiler extensions like GCC's '({...})' to
 979  * avoid portability issue or side effects when compiled with different compilers.
 980  * MSVC complains about "while(0)": C4127: "Conditional expression is constant",
 981  * so we use __pragma to avoid the warning since the use here is intentional.
 982  */
 983 #if !(defined (G_STMT_START) && defined (G_STMT_END))
 984 #define G_STMT_START  do
 985 #if defined (_MSC_VER) && (_MSC_VER >= 1500)
 986 #define G_STMT_END \
 987     __pragma(warning(push)) \
 988     __pragma(warning(disable:4127)) \
 989     while(0) \
 990     __pragma(warning(pop))
 991 #else
 992 #define G_STMT_END    while (0)
 993 #endif
 994 #endif
 995
 996 /* Provide G_ALIGNOF alignment macro.
 997  *
 998  * Note we cannot use the gcc __alignof__ operator here, as that returns the
 999  * preferred alignment rather than the minimal alignment. See
1000  * https://gitlab.gnome.org/GNOME/glib/merge_requests/538/diffs#note_390790.
1001  */
1002
1003 /**
1004  * G_ALIGNOF
1005  * @type: a type-name
1006  *
1007  * Return the minimal alignment required by the platform ABI for values of the given
1008  * type. The address of a variable or struct member of the given type must always be
1009  * a multiple of this alignment. For example, most platforms require int variables
1010  * to be aligned at a 4-byte boundary, so `G_ALIGNOF (int)` is 4 on most platforms.
1011  *
1012  * Note this is not necessarily the same as the value returned by GCC’s
1013  * `__alignof__` operator, which returns the preferred alignment for a type.
1014  * The preferred alignment may be a stricter alignment than the minimal
1015  * alignment.
1016  *
1017  * Since: 2.60
1018  */
1019 #if G_C_STD_CHECK_VERSION (11)
1020 #define G_ALIGNOF(type) _Alignof (type) \
1021   GLIB_AVAILABLE_MACRO_IN_2_60
1022 #else
1023 #define G_ALIGNOF(type) (G_STRUCT_OFFSET (struct { char a; type b; }, b)) \
1024   GLIB_AVAILABLE_MACRO_IN_2_60
1025 #endif
1026
1027 /**
1028  * G_CONST_RETURN:
1029  *
1030  * If %G_DISABLE_CONST_RETURNS is defined, this macro expands
1031  * to nothing. By default, the macro expands to const. The macro
1032  * can be used in place of const for functions that return a value
1033  * that should not be modified. The purpose of this macro is to allow
1034  * us to turn on const for returned constant strings by default, while
1035  * allowing programmers who find that annoying to turn it off. This macro
1036  * should only be used for return values and for "out" parameters, it
1037  * doesn't make sense for "in" parameters.
1038  *
1039  * Deprecated: 2.30: API providers should replace all existing uses with
1040  * const and API consumers should adjust their code accordingly
1041  */
1042 #ifdef G_DISABLE_CONST_RETURNS
1043 #define G_CONST_RETURN GLIB_DEPRECATED_MACRO_IN_2_30_FOR(const)
1044 #else
1045 #define G_CONST_RETURN const GLIB_DEPRECATED_MACRO_IN_2_30_FOR(const)
1046 #endif
1047
1048 /**
1049  * G_NORETURN:
1050  *
1051  * Expands to the GNU C or MSVC `noreturn` function attribute depending on
1052  * the compiler. It is used for declaring functions which never return.
1053  * Enables optimization of the function, and avoids possible compiler warnings.
1054  *
1055  * Note that %G_NORETURN supersedes the previous %G_GNUC_NORETURN macro, which
1056  * will eventually be deprecated. %G_NORETURN supports more platforms.
1057  *
1058  * Place the attribute before the function declaration as follows:
1059  *
1060  * |[<!-- language="C" -->
1061  * G_NORETURN void g_abort (void);
1062  * ]|
1063  *
1064  * Since: 2.68
1065  */
1066 /* Note: We can’t annotate this with GLIB_AVAILABLE_MACRO_IN_2_68 because it’s
1067  * used within the GLib headers in function declarations which are always
1068  * evaluated when a header is included. This results in warnings in third party
1069  * code which includes glib.h, even if the third party code doesn’t use the new
1070  * macro itself. */
1071 #if G_CXX_STD_CHECK_VERSION (11)
1072   /* Use ISO C++11 syntax when the compiler supports it.  */
1073 # define G_NORETURN [[noreturn]]
1074 #elif g_macro__has_attribute(__noreturn__)
1075   /* For compatibility with G_NORETURN_FUNCPTR on clang, use
1076      __attribute__((__noreturn__)), not _Noreturn.  */
1077 # define G_NORETURN __attribute__ ((__noreturn__))
1078 #elif defined (_MSC_VER) && (1200 <= _MSC_VER)
1079   /* Use MSVC specific syntax.  */
1080 # define G_NORETURN __declspec (noreturn)
1081   /* Use ISO C11 syntax when the compiler supports it.  */
1082 #elif G_C_STD_CHECK_VERSION (11)
1083 # define G_NORETURN _Noreturn
1084 #else
1085 # define G_NORETURN /* empty */
1086 #endif
1087
1088 /**
1089  * G_NORETURN_FUNCPTR:
1090  *
1091  * Expands to the GNU C or MSVC `noreturn` function attribute depending on
1092  * the compiler. It is used for declaring function pointers which never return.
1093  * Enables optimization of the function, and avoids possible compiler warnings.
1094  *
1095  * Place the attribute before the function declaration as follows:
1096  *
1097  * |[<!-- language="C" -->
1098  * G_NORETURN_FUNCPTR void (*funcptr) (void);
1099  * ]|
1100  *
1101  * Note that if the function is not a function pointer, you can simply use
1102  * the %G_NORETURN macro as follows:
1103  *
1104  * |[<!-- language="C" -->
1105  * G_NORETURN void g_abort (void);
1106  * ]|
1107  *
1108  * Since: 2.68
1109  */
1110 #if g_macro__has_attribute(__noreturn__)
1111 # define G_NORETURN_FUNCPTR __attribute__ ((__noreturn__))      \
1112   GLIB_AVAILABLE_MACRO_IN_2_68
1113 #else
1114 # define G_NORETURN_FUNCPTR /* empty */         \
1115   GLIB_AVAILABLE_MACRO_IN_2_68
1116 #endif
1117
1118 /**
1119  * G_ALWAYS_INLINE:
1120  *
1121  * Expands to the GNU C `always_inline` or MSVC `__forceinline` function
1122  * attribute depending on the compiler. It is used for declaring functions
1123  * as always inlined, ignoring the compiler optimization levels.
1124  *
1125  * The attribute may be placed before the declaration or definition,
1126  * right before the `static` keyword.
1127  *
1128  * |[<!-- language="C" -->
1129  * G_ALWAYS_INLINE
1130  * static int
1131  * do_inline_this (void)
1132  * {
1133  *   ...
1134  * }
1135  * ]|
1136  *
1137  * See the
1138  * [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-always_005finline-function-attribute)
1139  * and the
1140  * [MSVC documentation](https://docs.microsoft.com/en-us/visualstudio/misc/inline-inline-forceinline)
1141  *
1142  * Since: 2.74
1143  */
1144 /* Note: We can’t annotate this with GLIB_AVAILABLE_MACRO_IN_2_74 because it’s
1145  * used within the GLib headers in function declarations which are always
1146  * evaluated when a header is included. This results in warnings in third party
1147  * code which includes glib.h, even if the third party code doesn’t use the new
1148  * macro itself. */
1149 #if g_macro__has_attribute(__always_inline__)
1150 # if G_CXX_STD_CHECK_VERSION (11)
1151     /* Use ISO C++11 syntax when the compiler supports it. */
1152 #   define G_ALWAYS_INLINE [[gnu::always_inline]]
1153 # else
1154 #   define G_ALWAYS_INLINE __attribute__ ((__always_inline__))
1155 # endif
1156 #elif defined (_MSC_VER)
1157   /* Use MSVC specific syntax.  */
1158 # if G_CXX_STD_CHECK_VERSION (20) && _MSC_VER >= 1927
1159 #  define G_ALWAYS_INLINE [[msvc::forceinline]]
1160 # else
1161 #  define G_ALWAYS_INLINE __forceinline
1162 # endif
1163 #else
1164 # define G_ALWAYS_INLINE /* empty */
1165 #endif
1166
1167 /**
1168  * G_NO_INLINE:
1169  *
1170  * Expands to the GNU C or MSVC `noinline` function attribute
1171  * depending on the compiler. It is used for declaring functions
1172  * preventing from being considered for inlining.
1173  *
1174  * Note that %G_NO_INLINE supersedes the previous %G_GNUC_NO_INLINE
1175  * macro, which will eventually be deprecated.
1176  * %G_NO_INLINE supports more platforms.
1177  *
1178  * The attribute may be placed before the declaration or definition,
1179  * right before the `static` keyword.
1180  *
1181  * |[<!-- language="C" -->
1182  * G_NO_INLINE
1183  * static int
1184  * do_not_inline_this (void)
1185  * {
1186  *   ...
1187  * }
1188  * ]|
1189  *
1190  * Since: 2.74
1191  */
1192 /* Note: We can’t annotate this with GLIB_AVAILABLE_MACRO_IN_2_74 because it’s
1193  * used within the GLib headers in function declarations which are always
1194  * evaluated when a header is included. This results in warnings in third party
1195  * code which includes glib.h, even if the third party code doesn’t use the new
1196  * macro itself. */
1197 #if g_macro__has_attribute(__noinline__)
1198 # if G_CXX_STD_CHECK_VERSION (11)
1199     /* Use ISO C++11 syntax when the compiler supports it. */
1200 #   if defined (__GNUC__)
1201 #      define G_NO_INLINE [[gnu::noinline]]
1202 #   elif defined (_MSC_VER)
1203 #      if G_CXX_STD_CHECK_VERSION (20) && _MSC_VER >= 1927
1204 #        define G_NO_INLINE [[msvc::noinline]]
1205 #      else
1206 #        define G_NO_INLINE __declspec (noinline)
1207 #      endif
1208 #   endif
1209 # else
1210 #   define G_NO_INLINE __attribute__ ((__noinline__))
1211 # endif
1212 #elif defined (_MSC_VER) && (1200 <= _MSC_VER)
1213   /* Use MSVC specific syntax.  */
1214     /* Use ISO C++11 syntax when the compiler supports it. */
1215 # if G_CXX_STD_CHECK_VERSION (20) && _MSC_VER >= 1927
1216 #   define G_NO_INLINE [[msvc::noinline]]
1217 # else
1218 #   define G_NO_INLINE __declspec (noinline)
1219 # endif
1220 #else
1221 # define G_NO_INLINE /* empty */
1222 #endif
1223
1224 /*
1225  * The G_LIKELY and G_UNLIKELY macros let the programmer give hints to
1226  * the compiler about the expected result of an expression. Some compilers
1227  * can use this information for optimizations.
1228  *
1229  * The _G_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
1230  * putting assignments in g_return_if_fail ().
1231  */
1232 #if G_GNUC_CHECK_VERSION(2, 0) && defined(__OPTIMIZE__)
1233 #define _G_BOOLEAN_EXPR_IMPL(uniq, expr)        \
1234  G_GNUC_EXTENSION ({                            \
1235    int G_PASTE (_g_boolean_var_, uniq);         \
1236    if (expr)                                    \
1237       G_PASTE (_g_boolean_var_, uniq) = 1;      \
1238    else                                         \
1239       G_PASTE (_g_boolean_var_, uniq) = 0;      \
1240    G_PASTE (_g_boolean_var_, uniq);             \
1241 })
1242 #define _G_BOOLEAN_EXPR(expr) _G_BOOLEAN_EXPR_IMPL (__COUNTER__, expr)
1243 #define G_LIKELY(expr) (__builtin_expect (_G_BOOLEAN_EXPR(expr), 1))
1244 #define G_UNLIKELY(expr) (__builtin_expect (_G_BOOLEAN_EXPR(expr), 0))
1245 #else
1246 #define G_LIKELY(expr) (expr)
1247 #define G_UNLIKELY(expr) (expr)
1248 #endif
1249
1250 #if __GNUC__ >= 4 && !defined(_WIN32) && !defined(__CYGWIN__)
1251 #define G_HAVE_GNUC_VISIBILITY 1
1252 #endif
1253
1254 /* GLIB_CANNOT_IGNORE_DEPRECATIONS is defined above for compilers that do not
1255  * have a way to temporarily suppress deprecation warnings. In these cases,
1256  * suppress the deprecated attribute altogether (otherwise a simple #include
1257  * <glib.h> will emit a barrage of warnings).
1258  */
1259 #if defined(GLIB_CANNOT_IGNORE_DEPRECATIONS)
1260 #define G_DEPRECATED
1261 #elif G_GNUC_CHECK_VERSION(3, 1) || defined(__clang__)
1262 #define G_DEPRECATED __attribute__((__deprecated__))
1263 #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
1264 #define G_DEPRECATED __declspec(deprecated)
1265 #else
1266 #define G_DEPRECATED
1267 #endif
1268
1269 #if defined(GLIB_CANNOT_IGNORE_DEPRECATIONS)
1270 #define G_DEPRECATED_FOR(f) G_DEPRECATED
1271 #elif G_GNUC_CHECK_VERSION(4, 5) || defined(__clang__)
1272 #define G_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
1273 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
1274 #define G_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
1275 #else
1276 #define G_DEPRECATED_FOR(f) G_DEPRECATED
1277 #endif
1278
1279 #if G_GNUC_CHECK_VERSION(4, 5) || defined(__clang__)
1280 #define G_UNAVAILABLE(maj,min) __attribute__((deprecated("Not available before " #maj "." #min)))
1281 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
1282 #define G_UNAVAILABLE(maj,min) __declspec(deprecated("is not available before " #maj "." #min))
1283 #else
1284 #define G_UNAVAILABLE(maj,min) G_DEPRECATED
1285 #endif
1286
1287 /* These macros are used to mark deprecated symbols in GLib headers,
1288  * and thus have to be exposed in installed headers. But please
1289  * do *not* use them in other projects. Instead, use G_DEPRECATED
1290  * or define your own wrappers around it.
1291  */
1292
1293 #if !defined(GLIB_DISABLE_DEPRECATION_WARNINGS) && \
1294     (G_GNUC_CHECK_VERSION(4, 6) ||                 \
1295      __clang_major__ > 3 || (__clang_major__ == 3 && __clang_minor__ >= 4))
1296 #define _GLIB_GNUC_DO_PRAGMA(x) _Pragma(G_STRINGIFY (x))
1297 #define GLIB_DEPRECATED_MACRO _GLIB_GNUC_DO_PRAGMA(GCC warning "Deprecated pre-processor symbol")
1298 #define GLIB_DEPRECATED_MACRO_FOR(f) \
1299   _GLIB_GNUC_DO_PRAGMA(GCC warning G_STRINGIFY (Deprecated pre-processor symbol: replace with #f))
1300 #define GLIB_UNAVAILABLE_MACRO(maj,min) \
1301   _GLIB_GNUC_DO_PRAGMA(GCC warning G_STRINGIFY (Not available before maj.min))
1302 #else
1303 #define GLIB_DEPRECATED_MACRO
1304 #define GLIB_DEPRECATED_MACRO_FOR(f)
1305 #define GLIB_UNAVAILABLE_MACRO(maj,min)
1306 #endif
1307
1308 #if !defined(GLIB_DISABLE_DEPRECATION_WARNINGS) && \
1309     (G_GNUC_CHECK_VERSION(6, 1) ||                 \
1310      (defined (__clang_major__) && (__clang_major__ > 3 || (__clang_major__ == 3 && __clang_minor__ >= 0))))
1311 #define GLIB_DEPRECATED_ENUMERATOR G_DEPRECATED
1312 #define GLIB_DEPRECATED_ENUMERATOR_FOR(f) G_DEPRECATED_FOR(f)
1313 #define GLIB_UNAVAILABLE_ENUMERATOR(maj,min) G_UNAVAILABLE(maj,min)
1314 #else
1315 #define GLIB_DEPRECATED_ENUMERATOR
1316 #define GLIB_DEPRECATED_ENUMERATOR_FOR(f)
1317 #define GLIB_UNAVAILABLE_ENUMERATOR(maj,min)
1318 #endif
1319
1320 #if !defined(GLIB_DISABLE_DEPRECATION_WARNINGS) && \
1321     (G_GNUC_CHECK_VERSION(3, 1) ||                 \
1322      (defined (__clang_major__) && (__clang_major__ > 3 || (__clang_major__ == 3 && __clang_minor__ >= 0))))
1323 #define GLIB_DEPRECATED_TYPE G_DEPRECATED
1324 #define GLIB_DEPRECATED_TYPE_FOR(f) G_DEPRECATED_FOR(f)
1325 #define GLIB_UNAVAILABLE_TYPE(maj,min) G_UNAVAILABLE(maj,min)
1326 #else
1327 #define GLIB_DEPRECATED_TYPE
1328 #define GLIB_DEPRECATED_TYPE_FOR(f)
1329 #define GLIB_UNAVAILABLE_TYPE(maj,min)
1330 #endif
1331
1332 #ifndef __GI_SCANNER__
1333
1334 #if g_macro__has_attribute(cleanup)
1335
1336 /* these macros are private; note that gstdio.h also uses _GLIB_CLEANUP */
1337 #define _GLIB_AUTOPTR_FUNC_NAME(TypeName) glib_autoptr_cleanup_##TypeName
1338 #define _GLIB_AUTOPTR_CLEAR_FUNC_NAME(TypeName) glib_autoptr_clear_##TypeName
1339 #define _GLIB_AUTOPTR_TYPENAME(TypeName)  TypeName##_autoptr
1340 #define _GLIB_AUTOPTR_LIST_FUNC_NAME(TypeName) glib_listautoptr_cleanup_##TypeName
1341 #define _GLIB_AUTOPTR_LIST_TYPENAME(TypeName)  TypeName##_listautoptr
1342 #define _GLIB_AUTOPTR_SLIST_FUNC_NAME(TypeName) glib_slistautoptr_cleanup_##TypeName
1343 #define _GLIB_AUTOPTR_SLIST_TYPENAME(TypeName)  TypeName##_slistautoptr
1344 #define _GLIB_AUTOPTR_QUEUE_FUNC_NAME(TypeName) glib_queueautoptr_cleanup_##TypeName
1345 #define _GLIB_AUTOPTR_QUEUE_TYPENAME(TypeName)  TypeName##_queueautoptr
1346 #define _GLIB_AUTO_FUNC_NAME(TypeName)    glib_auto_cleanup_##TypeName
1347 #define _GLIB_CLEANUP(func)               __attribute__((cleanup(func)))
1348 #define _GLIB_DEFINE_AUTOPTR_CLEANUP_FUNCS(TypeName, ParentName, cleanup) \
1349   typedef TypeName *_GLIB_AUTOPTR_TYPENAME(TypeName);                                                           \
1350   typedef GList *_GLIB_AUTOPTR_LIST_TYPENAME(TypeName);                                                         \
1351   typedef GSList *_GLIB_AUTOPTR_SLIST_TYPENAME(TypeName);                                                       \
1352   typedef GQueue *_GLIB_AUTOPTR_QUEUE_TYPENAME(TypeName);                                                       \
1353   G_GNUC_BEGIN_IGNORE_DEPRECATIONS                                                                              \
1354   static G_GNUC_UNUSED inline void _GLIB_AUTOPTR_CLEAR_FUNC_NAME(TypeName) (TypeName *_ptr)                     \
1355     { if (_ptr) (cleanup) ((ParentName *) _ptr); }                                                              \
1356   static G_GNUC_UNUSED inline void _GLIB_AUTOPTR_FUNC_NAME(TypeName) (TypeName **_ptr)                          \
1357     { _GLIB_AUTOPTR_CLEAR_FUNC_NAME(TypeName) (*_ptr); }                                                        \
1358   static G_GNUC_UNUSED inline void _GLIB_AUTOPTR_LIST_FUNC_NAME(TypeName) (GList **_l)                          \
1359     { g_list_free_full (*_l, (GDestroyNotify) (void(*)(void)) cleanup); }                                       \
1360   static G_GNUC_UNUSED inline void _GLIB_AUTOPTR_SLIST_FUNC_NAME(TypeName) (GSList **_l)                        \
1361     { g_slist_free_full (*_l, (GDestroyNotify) (void(*)(void)) cleanup); }                                      \
1362   static G_GNUC_UNUSED inline void _GLIB_AUTOPTR_QUEUE_FUNC_NAME(TypeName) (GQueue **_q)                        \
1363     { if (*_q) g_queue_free_full (*_q, (GDestroyNotify) (void(*)(void)) cleanup); }                             \
1364   G_GNUC_END_IGNORE_DEPRECATIONS
1365 #define _GLIB_DEFINE_AUTOPTR_CHAINUP(ModuleObjName, ParentName) \
1366   _GLIB_DEFINE_AUTOPTR_CLEANUP_FUNCS(ModuleObjName, ParentName, _GLIB_AUTOPTR_CLEAR_FUNC_NAME(ParentName))
1367
1368
1369 /* these macros are API */
1370 #define G_DEFINE_AUTOPTR_CLEANUP_FUNC(TypeName, func) \
1371   _GLIB_DEFINE_AUTOPTR_CLEANUP_FUNCS(TypeName, TypeName, func)
1372 #define G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(TypeName, func) \
1373   G_GNUC_BEGIN_IGNORE_DEPRECATIONS                                                                              \
1374   static G_GNUC_UNUSED inline void _GLIB_AUTO_FUNC_NAME(TypeName) (TypeName *_ptr) { (func) (_ptr); }                         \
1375   G_GNUC_END_IGNORE_DEPRECATIONS
1376 #define G_DEFINE_AUTO_CLEANUP_FREE_FUNC(TypeName, func, none) \
1377   G_GNUC_BEGIN_IGNORE_DEPRECATIONS                                                                              \
1378   static G_GNUC_UNUSED inline void _GLIB_AUTO_FUNC_NAME(TypeName) (TypeName *_ptr) { if (*_ptr != none) (func) (*_ptr); }     \
1379   G_GNUC_END_IGNORE_DEPRECATIONS
1380 #define g_autoptr(TypeName) _GLIB_CLEANUP(_GLIB_AUTOPTR_FUNC_NAME(TypeName)) _GLIB_AUTOPTR_TYPENAME(TypeName)
1381 #define g_autolist(TypeName) _GLIB_CLEANUP(_GLIB_AUTOPTR_LIST_FUNC_NAME(TypeName)) _GLIB_AUTOPTR_LIST_TYPENAME(TypeName)
1382 #define g_autoslist(TypeName) _GLIB_CLEANUP(_GLIB_AUTOPTR_SLIST_FUNC_NAME(TypeName)) _GLIB_AUTOPTR_SLIST_TYPENAME(TypeName)
1383 #define g_autoqueue(TypeName) _GLIB_CLEANUP(_GLIB_AUTOPTR_QUEUE_FUNC_NAME(TypeName)) _GLIB_AUTOPTR_QUEUE_TYPENAME(TypeName)
1384 #define g_auto(TypeName) _GLIB_CLEANUP(_GLIB_AUTO_FUNC_NAME(TypeName)) TypeName
1385 #define g_autofree _GLIB_CLEANUP(g_autoptr_cleanup_generic_gfree)
1386
1387 #else /* not GNU C */
1388 /* this (dummy) macro is private */
1389 #define _GLIB_DEFINE_AUTOPTR_CHAINUP(ModuleObjName, ParentName)
1390
1391 /* these (dummy) macros are API */
1392 #define G_DEFINE_AUTOPTR_CLEANUP_FUNC(TypeName, func)
1393 #define G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(TypeName, func)
1394 #define G_DEFINE_AUTO_CLEANUP_FREE_FUNC(TypeName, func, none)
1395
1396 /* no declaration of g_auto() or g_autoptr() here */
1397 #endif /* __GNUC__ */
1398
1399 #else
1400
1401 #define _GLIB_DEFINE_AUTOPTR_CHAINUP(ModuleObjName, ParentName)
1402
1403 #define G_DEFINE_AUTOPTR_CLEANUP_FUNC(TypeName, func)
1404 #define G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(TypeName, func)
1405 #define G_DEFINE_AUTO_CLEANUP_FREE_FUNC(TypeName, func, none)
1406
1407 #endif /* __GI_SCANNER__ */
1408
1409 /**
1410  * G_SIZEOF_MEMBER:
1411  * @struct_type: a structure type, e.g. #GOutputVector
1412  * @member: a field in the structure, e.g. `size`
1413  *
1414  * Returns the size of @member in the struct definition without having a
1415  * declared instance of @struct_type.
1416  *
1417  * Returns: the size of @member in bytes.
1418  *
1419  * Since: 2.64
1420  */
1421 #define G_SIZEOF_MEMBER(struct_type, member) \
1422     GLIB_AVAILABLE_MACRO_IN_2_64 \
1423     sizeof (((struct_type *) 0)->member)
1424
1425 #endif /* __G_MACROS_H__ */