glib/gversionmacros.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   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 License, 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
  18 /*
  19  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GLib Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __G_VERSION_MACROS_H__
  26 #define __G_VERSION_MACROS_H__
  27
  28 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  29 #error "Only <glib.h> can be included directly."
  30 #endif
  31
  32 /* Version boundaries checks */
  33
  34 #define G_ENCODE_VERSION(major,minor)   ((major) << 16 | (minor) << 8)
  35
  36 /* XXX: Every new stable minor release bump should add a macro here */
  37
  38 /**
  39  * GLIB_VERSION_2_26:
  40  *
  41  * A macro that evaluates to the 2.26 version of GLib, in a format
  42  * that can be used by the C pre-processor.
  43  *
  44  * Since: 2.32
  45  */
  46 #define GLIB_VERSION_2_26       (G_ENCODE_VERSION (2, 26))
  47
  48 /**
  49  * GLIB_VERSION_2_28:
  50  *
  51  * A macro that evaluates to the 2.28 version of GLib, in a format
  52  * that can be used by the C pre-processor.
  53  *
  54  * Since: 2.32
  55  */
  56 #define GLIB_VERSION_2_28       (G_ENCODE_VERSION (2, 28))
  57
  58 /**
  59  * GLIB_VERSION_2_30:
  60  *
  61  * A macro that evaluates to the 2.30 version of GLib, in a format
  62  * that can be used by the C pre-processor.
  63  *
  64  * Since: 2.32
  65  */
  66 #define GLIB_VERSION_2_30       (G_ENCODE_VERSION (2, 30))
  67
  68 /**
  69  * GLIB_VERSION_2_32:
  70  *
  71  * A macro that evaluates to the 2.32 version of GLib, in a format
  72  * that can be used by the C pre-processor.
  73  *
  74  * Since: 2.32
  75  */
  76 #define GLIB_VERSION_2_32       (G_ENCODE_VERSION (2, 32))
  77
  78 /**
  79  * GLIB_VERSION_2_34:
  80  *
  81  * A macro that evaluates to the 2.34 version of GLib, in a format
  82  * that can be used by the C pre-processor.
  83  *
  84  * Since: 2.34
  85  */
  86 #define GLIB_VERSION_2_34       (G_ENCODE_VERSION (2, 34))
  87
  88 /**
  89  * GLIB_VERSION_2_36:
  90  *
  91  * A macro that evaluates to the 2.36 version of GLib, in a format
  92  * that can be used by the C pre-processor.
  93  *
  94  * Since: 2.36
  95  */
  96 #define GLIB_VERSION_2_36       (G_ENCODE_VERSION (2, 36))
  97
  98 /**
  99  * GLIB_VERSION_2_38:
 100  *
 101  * A macro that evaluates to the 2.38 version of GLib, in a format
 102  * that can be used by the C pre-processor.
 103  *
 104  * Since: 2.38
 105  */
 106 #define GLIB_VERSION_2_38       (G_ENCODE_VERSION (2, 38))
 107
 108 /**
 109  * GLIB_VERSION_2_40:
 110  *
 111  * A macro that evaluates to the 2.40 version of GLib, in a format
 112  * that can be used by the C pre-processor.
 113  *
 114  * Since: 2.40
 115  */
 116 #define GLIB_VERSION_2_40       (G_ENCODE_VERSION (2, 40))
 117
 118 /**
 119  * GLIB_VERSION_2_42:
 120  *
 121  * A macro that evaluates to the 2.42 version of GLib, in a format
 122  * that can be used by the C pre-processor.
 123  *
 124  * Since: 2.42
 125  */
 126 #define GLIB_VERSION_2_42       (G_ENCODE_VERSION (2, 42))
 127
 128 /* evaluates to the current stable version; for development cycles,
 129  * this means the next stable target
 130  */
 131 #if (GLIB_MINOR_VERSION % 2)
 132 #define GLIB_VERSION_CUR_STABLE         (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION + 1))
 133 #else
 134 #define GLIB_VERSION_CUR_STABLE         (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION))
 135 #endif
 136
 137 /* evaluates to the previous stable version */
 138 #if (GLIB_MINOR_VERSION % 2)
 139 #define GLIB_VERSION_PREV_STABLE        (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION - 1))
 140 #else
 141 #define GLIB_VERSION_PREV_STABLE        (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION - 2))
 142 #endif
 143
 144 /**
 145  * GLIB_VERSION_2_44:
 146  *
 147  * A macro that evaluates to the 2.44 version of GLib, in a format
 148  * that can be used by the C pre-processor.
 149  *
 150  * Since: 2.44
 151  */
 152 #define GLIB_VERSION_2_44       (G_ENCODE_VERSION (2, 44))
 153
 154 /**
 155  * GLIB_VERSION_MIN_REQUIRED:
 156  *
 157  * A macro that should be defined by the user prior to including
 158  * the glib.h header.
 159  * The definition should be one of the predefined GLib version
 160  * macros: %GLIB_VERSION_2_26, %GLIB_VERSION_2_28,...
 161  *
 162  * This macro defines the earliest version of GLib that the package is
 163  * required to be able to compile against.
 164  *
 165  * If the compiler is configured to warn about the use of deprecated
 166  * functions, then using functions that were deprecated in version
 167  * %GLIB_VERSION_MIN_REQUIRED or earlier will cause warnings (but
 168  * using functions deprecated in later releases will not).
 169  *
 170  * Since: 2.32
 171  */
 172 /* If the package sets GLIB_VERSION_MIN_REQUIRED to some future
 173  * GLIB_VERSION_X_Y value that we don't know about, it will compare as
 174  * 0 in preprocessor tests.
 175  */
 176 #ifndef GLIB_VERSION_MIN_REQUIRED
 177 # define GLIB_VERSION_MIN_REQUIRED      (GLIB_VERSION_CUR_STABLE)
 178 #elif GLIB_VERSION_MIN_REQUIRED == 0
 179 # undef  GLIB_VERSION_MIN_REQUIRED
 180 # define GLIB_VERSION_MIN_REQUIRED      (GLIB_VERSION_CUR_STABLE + 2)
 181 #endif
 182
 183 /**
 184  * GLIB_VERSION_MAX_ALLOWED:
 185  *
 186  * A macro that should be defined by the user prior to including
 187  * the glib.h header.
 188  * The definition should be one of the predefined GLib version
 189  * macros: %GLIB_VERSION_2_26, %GLIB_VERSION_2_28,...
 190  *
 191  * This macro defines the latest version of the GLib API that the
 192  * package is allowed to make use of.
 193  *
 194  * If the compiler is configured to warn about the use of deprecated
 195  * functions, then using functions added after version
 196  * %GLIB_VERSION_MAX_ALLOWED will cause warnings.
 197  *
 198  * Unless you are using GLIB_CHECK_VERSION() or the like to compile
 199  * different code depending on the GLib version, then this should be
 200  * set to the same value as %GLIB_VERSION_MIN_REQUIRED.
 201  *
 202  * Since: 2.32
 203  */
 204 #if !defined (GLIB_VERSION_MAX_ALLOWED) || (GLIB_VERSION_MAX_ALLOWED == 0)
 205 # undef GLIB_VERSION_MAX_ALLOWED
 206 # define GLIB_VERSION_MAX_ALLOWED      (GLIB_VERSION_CUR_STABLE)
 207 #endif
 208
 209 /* sanity checks */
 210 #if GLIB_VERSION_MIN_REQUIRED > GLIB_VERSION_CUR_STABLE
 211 #error "GLIB_VERSION_MIN_REQUIRED must be <= GLIB_VERSION_CUR_STABLE"
 212 #endif
 213 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_MIN_REQUIRED
 214 #error "GLIB_VERSION_MAX_ALLOWED must be >= GLIB_VERSION_MIN_REQUIRED"
 215 #endif
 216 #if GLIB_VERSION_MIN_REQUIRED < GLIB_VERSION_2_26
 217 #error "GLIB_VERSION_MIN_REQUIRED must be >= GLIB_VERSION_2_26"
 218 #endif
 219
 220 /* These macros are used to mark deprecated functions in GLib headers,
 221  * and thus have to be exposed in installed headers. But please
 222  * do *not* use them in other projects. Instead, use G_DEPRECATED
 223  * or define your own wrappers around it.
 224  */
 225 #define GLIB_AVAILABLE_IN_ALL                   _GLIB_EXTERN
 226
 227 /* XXX: Every new stable minor release should add a set of macros here */
 228
 229 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_26
 230 # define GLIB_DEPRECATED_IN_2_26                GLIB_DEPRECATED
 231 # define GLIB_DEPRECATED_IN_2_26_FOR(f)         GLIB_DEPRECATED_FOR(f)
 232 #else
 233 # define GLIB_DEPRECATED_IN_2_26                _GLIB_EXTERN
 234 # define GLIB_DEPRECATED_IN_2_26_FOR(f)         _GLIB_EXTERN
 235 #endif
 236
 237 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_26
 238 # define GLIB_AVAILABLE_IN_2_26                 GLIB_UNAVAILABLE(2, 26)
 239 #else
 240 # define GLIB_AVAILABLE_IN_2_26                 _GLIB_EXTERN
 241 #endif
 242
 243 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_28
 244 # define GLIB_DEPRECATED_IN_2_28                GLIB_DEPRECATED
 245 # define GLIB_DEPRECATED_IN_2_28_FOR(f)         GLIB_DEPRECATED_FOR(f)
 246 #else
 247 # define GLIB_DEPRECATED_IN_2_28                _GLIB_EXTERN
 248 # define GLIB_DEPRECATED_IN_2_28_FOR(f)         _GLIB_EXTERN
 249 #endif
 250
 251 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_28
 252 # define GLIB_AVAILABLE_IN_2_28                 GLIB_UNAVAILABLE(2, 28)
 253 #else
 254 # define GLIB_AVAILABLE_IN_2_28                 _GLIB_EXTERN
 255 #endif
 256
 257 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_30
 258 # define GLIB_DEPRECATED_IN_2_30                GLIB_DEPRECATED
 259 # define GLIB_DEPRECATED_IN_2_30_FOR(f)         GLIB_DEPRECATED_FOR(f)
 260 #else
 261 # define GLIB_DEPRECATED_IN_2_30                _GLIB_EXTERN
 262 # define GLIB_DEPRECATED_IN_2_30_FOR(f)         _GLIB_EXTERN
 263 #endif
 264
 265 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_30
 266 # define GLIB_AVAILABLE_IN_2_30                 GLIB_UNAVAILABLE(2, 30)
 267 #else
 268 # define GLIB_AVAILABLE_IN_2_30                 _GLIB_EXTERN
 269 #endif
 270
 271 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_32
 272 # define GLIB_DEPRECATED_IN_2_32                GLIB_DEPRECATED
 273 # define GLIB_DEPRECATED_IN_2_32_FOR(f)         GLIB_DEPRECATED_FOR(f)
 274 #else
 275 # define GLIB_DEPRECATED_IN_2_32                _GLIB_EXTERN
 276 # define GLIB_DEPRECATED_IN_2_32_FOR(f)         _GLIB_EXTERN
 277 #endif
 278
 279 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_32
 280 # define GLIB_AVAILABLE_IN_2_32                 GLIB_UNAVAILABLE(2, 32)
 281 #else
 282 # define GLIB_AVAILABLE_IN_2_32                 _GLIB_EXTERN
 283 #endif
 284
 285 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_34
 286 # define GLIB_DEPRECATED_IN_2_34                GLIB_DEPRECATED
 287 # define GLIB_DEPRECATED_IN_2_34_FOR(f)         GLIB_DEPRECATED_FOR(f)
 288 #else
 289 # define GLIB_DEPRECATED_IN_2_34                _GLIB_EXTERN
 290 # define GLIB_DEPRECATED_IN_2_34_FOR(f)         _GLIB_EXTERN
 291 #endif
 292
 293 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_34
 294 # define GLIB_AVAILABLE_IN_2_34                 GLIB_UNAVAILABLE(2, 34)
 295 #else
 296 # define GLIB_AVAILABLE_IN_2_34                 _GLIB_EXTERN
 297 #endif
 298
 299 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_36
 300 # define GLIB_DEPRECATED_IN_2_36                GLIB_DEPRECATED
 301 # define GLIB_DEPRECATED_IN_2_36_FOR(f)         GLIB_DEPRECATED_FOR(f)
 302 #else
 303 # define GLIB_DEPRECATED_IN_2_36                _GLIB_EXTERN
 304 # define GLIB_DEPRECATED_IN_2_36_FOR(f)         _GLIB_EXTERN
 305 #endif
 306
 307 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_36
 308 # define GLIB_AVAILABLE_IN_2_36                 GLIB_UNAVAILABLE(2, 36)
 309 #else
 310 # define GLIB_AVAILABLE_IN_2_36                 _GLIB_EXTERN
 311 #endif
 312
 313 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_38
 314 # define GLIB_DEPRECATED_IN_2_38                GLIB_DEPRECATED
 315 # define GLIB_DEPRECATED_IN_2_38_FOR(f)         GLIB_DEPRECATED_FOR(f)
 316 #else
 317 # define GLIB_DEPRECATED_IN_2_38                _GLIB_EXTERN
 318 # define GLIB_DEPRECATED_IN_2_38_FOR(f)         _GLIB_EXTERN
 319 #endif
 320
 321 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_38
 322 # define GLIB_AVAILABLE_IN_2_38                 GLIB_UNAVAILABLE(2, 38)
 323 #else
 324 # define GLIB_AVAILABLE_IN_2_38                 _GLIB_EXTERN
 325 #endif
 326
 327 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_40
 328 # define GLIB_DEPRECATED_IN_2_40                GLIB_DEPRECATED
 329 # define GLIB_DEPRECATED_IN_2_40_FOR(f)         GLIB_DEPRECATED_FOR(f)
 330 #else
 331 # define GLIB_DEPRECATED_IN_2_40                _GLIB_EXTERN
 332 # define GLIB_DEPRECATED_IN_2_40_FOR(f)         _GLIB_EXTERN
 333 #endif
 334
 335 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_40
 336 # define GLIB_AVAILABLE_IN_2_40                 GLIB_UNAVAILABLE(2, 40)
 337 #else
 338 # define GLIB_AVAILABLE_IN_2_40                 _GLIB_EXTERN
 339 #endif
 340
 341 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_42
 342 # define GLIB_DEPRECATED_IN_2_42                GLIB_DEPRECATED
 343 # define GLIB_DEPRECATED_IN_2_42_FOR(f)         GLIB_DEPRECATED_FOR(f)
 344 #else
 345 # define GLIB_DEPRECATED_IN_2_42                _GLIB_EXTERN
 346 # define GLIB_DEPRECATED_IN_2_42_FOR(f)         _GLIB_EXTERN
 347 #endif
 348
 349 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_42
 350 # define GLIB_AVAILABLE_IN_2_42                 GLIB_UNAVAILABLE(2, 42)
 351 #else
 352 # define GLIB_AVAILABLE_IN_2_42                 _GLIB_EXTERN
 353 #endif
 354
 355 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_44
 356 # define GLIB_DEPRECATED_IN_2_44                GLIB_DEPRECATED
 357 # define GLIB_DEPRECATED_IN_2_44_FOR(f)         GLIB_DEPRECATED_FOR(f)
 358 #else
 359 # define GLIB_DEPRECATED_IN_2_44                _GLIB_EXTERN
 360 # define GLIB_DEPRECATED_IN_2_44_FOR(f)         _GLIB_EXTERN
 361 #endif
 362
 363 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_44
 364 # define GLIB_AVAILABLE_IN_2_44                 GLIB_UNAVAILABLE(2, 44)
 365 #else
 366 # define GLIB_AVAILABLE_IN_2_44                 _GLIB_EXTERN
 367 #endif
 368
 369 #endif /*  __G_VERSION_MACROS_H__ */