Imported Upstream version 2.53.3
[platform/upstream/glib.git] / 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.1 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 /**
129  * GLIB_VERSION_2_44:
130  *
131  * A macro that evaluates to the 2.44 version of GLib, in a format
132  * that can be used by the C pre-processor.
133  *
134  * Since: 2.44
135  */
136 #define GLIB_VERSION_2_44       (G_ENCODE_VERSION (2, 44))
137
138 /**
139  * GLIB_VERSION_2_46:
140  *
141  * A macro that evaluates to the 2.46 version of GLib, in a format
142  * that can be used by the C pre-processor.
143  *
144  * Since: 2.46
145  */
146 #define GLIB_VERSION_2_46       (G_ENCODE_VERSION (2, 46))
147
148 /**
149  * GLIB_VERSION_2_48:
150  *
151  * A macro that evaluates to the 2.48 version of GLib, in a format
152  * that can be used by the C pre-processor.
153  *
154  * Since: 2.48
155  */
156 #define GLIB_VERSION_2_48       (G_ENCODE_VERSION (2, 48))
157
158 /**
159  * GLIB_VERSION_2_50:
160  *
161  * A macro that evaluates to the 2.50 version of GLib, in a format
162  * that can be used by the C pre-processor.
163  *
164  * Since: 2.50
165  */
166 #define GLIB_VERSION_2_50       (G_ENCODE_VERSION (2, 50))
167
168 /**
169  * GLIB_VERSION_2_52:
170  *
171  * A macro that evaluates to the 2.52 version of GLib, in a format
172  * that can be used by the C pre-processor.
173  *
174  * Since: 2.52
175  */
176 #define GLIB_VERSION_2_52       (G_ENCODE_VERSION (2, 52))
177
178 /**
179  * GLIB_VERSION_2_54:
180  *
181  * A macro that evaluates to the 2.54 version of GLib, in a format
182  * that can be used by the C pre-processor.
183  *
184  * Since: 2.54
185  */
186 #define GLIB_VERSION_2_54       (G_ENCODE_VERSION (2, 54))
187
188 /* evaluates to the current stable version; for development cycles,
189  * this means the next stable target
190  */
191 #if (GLIB_MINOR_VERSION % 2)
192 #define GLIB_VERSION_CUR_STABLE         (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION + 1))
193 #else
194 #define GLIB_VERSION_CUR_STABLE         (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION))
195 #endif
196
197 /* evaluates to the previous stable version */
198 #if (GLIB_MINOR_VERSION % 2)
199 #define GLIB_VERSION_PREV_STABLE        (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION - 1))
200 #else
201 #define GLIB_VERSION_PREV_STABLE        (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION - 2))
202 #endif
203
204 /**
205  * GLIB_VERSION_MIN_REQUIRED:
206  *
207  * A macro that should be defined by the user prior to including
208  * the glib.h header.
209  * The definition should be one of the predefined GLib version
210  * macros: %GLIB_VERSION_2_26, %GLIB_VERSION_2_28,...
211  *
212  * This macro defines the earliest version of GLib that the package is
213  * required to be able to compile against.
214  *
215  * If the compiler is configured to warn about the use of deprecated
216  * functions, then using functions that were deprecated in version
217  * %GLIB_VERSION_MIN_REQUIRED or earlier will cause warnings (but
218  * using functions deprecated in later releases will not).
219  *
220  * Since: 2.32
221  */
222 /* If the package sets GLIB_VERSION_MIN_REQUIRED to some future
223  * GLIB_VERSION_X_Y value that we don't know about, it will compare as
224  * 0 in preprocessor tests.
225  */
226 #ifndef GLIB_VERSION_MIN_REQUIRED
227 # define GLIB_VERSION_MIN_REQUIRED      (GLIB_VERSION_CUR_STABLE)
228 #elif GLIB_VERSION_MIN_REQUIRED == 0
229 # undef  GLIB_VERSION_MIN_REQUIRED
230 # define GLIB_VERSION_MIN_REQUIRED      (GLIB_VERSION_CUR_STABLE + 2)
231 #endif
232
233 /**
234  * GLIB_VERSION_MAX_ALLOWED:
235  *
236  * A macro that should be defined by the user prior to including
237  * the glib.h header.
238  * The definition should be one of the predefined GLib version
239  * macros: %GLIB_VERSION_2_26, %GLIB_VERSION_2_28,...
240  *
241  * This macro defines the latest version of the GLib API that the
242  * package is allowed to make use of.
243  *
244  * If the compiler is configured to warn about the use of deprecated
245  * functions, then using functions added after version
246  * %GLIB_VERSION_MAX_ALLOWED will cause warnings.
247  *
248  * Unless you are using GLIB_CHECK_VERSION() or the like to compile
249  * different code depending on the GLib version, then this should be
250  * set to the same value as %GLIB_VERSION_MIN_REQUIRED.
251  *
252  * Since: 2.32
253  */
254 #if !defined (GLIB_VERSION_MAX_ALLOWED) || (GLIB_VERSION_MAX_ALLOWED == 0)
255 # undef GLIB_VERSION_MAX_ALLOWED
256 # define GLIB_VERSION_MAX_ALLOWED      (GLIB_VERSION_CUR_STABLE)
257 #endif
258
259 /* sanity checks */
260 #if GLIB_VERSION_MIN_REQUIRED > GLIB_VERSION_CUR_STABLE
261 #error "GLIB_VERSION_MIN_REQUIRED must be <= GLIB_VERSION_CUR_STABLE"
262 #endif
263 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_MIN_REQUIRED
264 #error "GLIB_VERSION_MAX_ALLOWED must be >= GLIB_VERSION_MIN_REQUIRED"
265 #endif
266 #if GLIB_VERSION_MIN_REQUIRED < GLIB_VERSION_2_26
267 #error "GLIB_VERSION_MIN_REQUIRED must be >= GLIB_VERSION_2_26"
268 #endif
269
270 /* These macros are used to mark deprecated functions in GLib headers,
271  * and thus have to be exposed in installed headers. But please
272  * do *not* use them in other projects. Instead, use G_DEPRECATED
273  * or define your own wrappers around it.
274  */
275 #define GLIB_AVAILABLE_IN_ALL                   _GLIB_EXTERN
276
277 /* XXX: Every new stable minor release should add a set of macros here */
278
279 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_26
280 # define GLIB_DEPRECATED_IN_2_26                GLIB_DEPRECATED
281 # define GLIB_DEPRECATED_IN_2_26_FOR(f)         GLIB_DEPRECATED_FOR(f)
282 #else
283 # define GLIB_DEPRECATED_IN_2_26                _GLIB_EXTERN
284 # define GLIB_DEPRECATED_IN_2_26_FOR(f)         _GLIB_EXTERN
285 #endif
286
287 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_26
288 # define GLIB_AVAILABLE_IN_2_26                 GLIB_UNAVAILABLE(2, 26)
289 #else
290 # define GLIB_AVAILABLE_IN_2_26                 _GLIB_EXTERN
291 #endif
292
293 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_28
294 # define GLIB_DEPRECATED_IN_2_28                GLIB_DEPRECATED
295 # define GLIB_DEPRECATED_IN_2_28_FOR(f)         GLIB_DEPRECATED_FOR(f)
296 #else
297 # define GLIB_DEPRECATED_IN_2_28                _GLIB_EXTERN
298 # define GLIB_DEPRECATED_IN_2_28_FOR(f)         _GLIB_EXTERN
299 #endif
300
301 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_28
302 # define GLIB_AVAILABLE_IN_2_28                 GLIB_UNAVAILABLE(2, 28)
303 #else
304 # define GLIB_AVAILABLE_IN_2_28                 _GLIB_EXTERN
305 #endif
306
307 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_30
308 # define GLIB_DEPRECATED_IN_2_30                GLIB_DEPRECATED
309 # define GLIB_DEPRECATED_IN_2_30_FOR(f)         GLIB_DEPRECATED_FOR(f)
310 #else
311 # define GLIB_DEPRECATED_IN_2_30                _GLIB_EXTERN
312 # define GLIB_DEPRECATED_IN_2_30_FOR(f)         _GLIB_EXTERN
313 #endif
314
315 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_30
316 # define GLIB_AVAILABLE_IN_2_30                 GLIB_UNAVAILABLE(2, 30)
317 #else
318 # define GLIB_AVAILABLE_IN_2_30                 _GLIB_EXTERN
319 #endif
320
321 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_32
322 # define GLIB_DEPRECATED_IN_2_32                GLIB_DEPRECATED
323 # define GLIB_DEPRECATED_IN_2_32_FOR(f)         GLIB_DEPRECATED_FOR(f)
324 #else
325 # define GLIB_DEPRECATED_IN_2_32                _GLIB_EXTERN
326 # define GLIB_DEPRECATED_IN_2_32_FOR(f)         _GLIB_EXTERN
327 #endif
328
329 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_32
330 # define GLIB_AVAILABLE_IN_2_32                 GLIB_UNAVAILABLE(2, 32)
331 #else
332 # define GLIB_AVAILABLE_IN_2_32                 _GLIB_EXTERN
333 #endif
334
335 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_34
336 # define GLIB_DEPRECATED_IN_2_34                GLIB_DEPRECATED
337 # define GLIB_DEPRECATED_IN_2_34_FOR(f)         GLIB_DEPRECATED_FOR(f)
338 #else
339 # define GLIB_DEPRECATED_IN_2_34                _GLIB_EXTERN
340 # define GLIB_DEPRECATED_IN_2_34_FOR(f)         _GLIB_EXTERN
341 #endif
342
343 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_34
344 # define GLIB_AVAILABLE_IN_2_34                 GLIB_UNAVAILABLE(2, 34)
345 #else
346 # define GLIB_AVAILABLE_IN_2_34                 _GLIB_EXTERN
347 #endif
348
349 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_36
350 # define GLIB_DEPRECATED_IN_2_36                GLIB_DEPRECATED
351 # define GLIB_DEPRECATED_IN_2_36_FOR(f)         GLIB_DEPRECATED_FOR(f)
352 #else
353 # define GLIB_DEPRECATED_IN_2_36                _GLIB_EXTERN
354 # define GLIB_DEPRECATED_IN_2_36_FOR(f)         _GLIB_EXTERN
355 #endif
356
357 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_36
358 # define GLIB_AVAILABLE_IN_2_36                 GLIB_UNAVAILABLE(2, 36)
359 #else
360 # define GLIB_AVAILABLE_IN_2_36                 _GLIB_EXTERN
361 #endif
362
363 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_38
364 # define GLIB_DEPRECATED_IN_2_38                GLIB_DEPRECATED
365 # define GLIB_DEPRECATED_IN_2_38_FOR(f)         GLIB_DEPRECATED_FOR(f)
366 #else
367 # define GLIB_DEPRECATED_IN_2_38                _GLIB_EXTERN
368 # define GLIB_DEPRECATED_IN_2_38_FOR(f)         _GLIB_EXTERN
369 #endif
370
371 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_38
372 # define GLIB_AVAILABLE_IN_2_38                 GLIB_UNAVAILABLE(2, 38)
373 #else
374 # define GLIB_AVAILABLE_IN_2_38                 _GLIB_EXTERN
375 #endif
376
377 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_40
378 # define GLIB_DEPRECATED_IN_2_40                GLIB_DEPRECATED
379 # define GLIB_DEPRECATED_IN_2_40_FOR(f)         GLIB_DEPRECATED_FOR(f)
380 #else
381 # define GLIB_DEPRECATED_IN_2_40                _GLIB_EXTERN
382 # define GLIB_DEPRECATED_IN_2_40_FOR(f)         _GLIB_EXTERN
383 #endif
384
385 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_40
386 # define GLIB_AVAILABLE_IN_2_40                 GLIB_UNAVAILABLE(2, 40)
387 #else
388 # define GLIB_AVAILABLE_IN_2_40                 _GLIB_EXTERN
389 #endif
390
391 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_42
392 # define GLIB_DEPRECATED_IN_2_42                GLIB_DEPRECATED
393 # define GLIB_DEPRECATED_IN_2_42_FOR(f)         GLIB_DEPRECATED_FOR(f)
394 #else
395 # define GLIB_DEPRECATED_IN_2_42                _GLIB_EXTERN
396 # define GLIB_DEPRECATED_IN_2_42_FOR(f)         _GLIB_EXTERN
397 #endif
398
399 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_42
400 # define GLIB_AVAILABLE_IN_2_42                 GLIB_UNAVAILABLE(2, 42)
401 #else
402 # define GLIB_AVAILABLE_IN_2_42                 _GLIB_EXTERN
403 #endif
404
405 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_44
406 # define GLIB_DEPRECATED_IN_2_44                GLIB_DEPRECATED
407 # define GLIB_DEPRECATED_IN_2_44_FOR(f)         GLIB_DEPRECATED_FOR(f)
408 #else
409 # define GLIB_DEPRECATED_IN_2_44                _GLIB_EXTERN
410 # define GLIB_DEPRECATED_IN_2_44_FOR(f)         _GLIB_EXTERN
411 #endif
412
413 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_44
414 # define GLIB_AVAILABLE_IN_2_44                 GLIB_UNAVAILABLE(2, 44)
415 #else
416 # define GLIB_AVAILABLE_IN_2_44                 _GLIB_EXTERN
417 #endif
418
419 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_46
420 # define GLIB_DEPRECATED_IN_2_46                GLIB_DEPRECATED
421 # define GLIB_DEPRECATED_IN_2_46_FOR(f)         GLIB_DEPRECATED_FOR(f)
422 #else
423 # define GLIB_DEPRECATED_IN_2_46                _GLIB_EXTERN
424 # define GLIB_DEPRECATED_IN_2_46_FOR(f)         _GLIB_EXTERN
425 #endif
426
427 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_46
428 # define GLIB_AVAILABLE_IN_2_46                 GLIB_UNAVAILABLE(2, 46)
429 #else
430 # define GLIB_AVAILABLE_IN_2_46                 _GLIB_EXTERN
431 #endif
432
433 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_48
434 # define GLIB_DEPRECATED_IN_2_48                GLIB_DEPRECATED
435 # define GLIB_DEPRECATED_IN_2_48_FOR(f)         GLIB_DEPRECATED_FOR(f)
436 #else
437 # define GLIB_DEPRECATED_IN_2_48                _GLIB_EXTERN
438 # define GLIB_DEPRECATED_IN_2_48_FOR(f)         _GLIB_EXTERN
439 #endif
440
441 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_48
442 # define GLIB_AVAILABLE_IN_2_48                 GLIB_UNAVAILABLE(2, 48)
443 #else
444 # define GLIB_AVAILABLE_IN_2_48                 _GLIB_EXTERN
445 #endif
446
447 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_50
448 # define GLIB_DEPRECATED_IN_2_50                GLIB_DEPRECATED
449 # define GLIB_DEPRECATED_IN_2_50_FOR(f)         GLIB_DEPRECATED_FOR(f)
450 #else
451 # define GLIB_DEPRECATED_IN_2_50                _GLIB_EXTERN
452 # define GLIB_DEPRECATED_IN_2_50_FOR(f)         _GLIB_EXTERN
453 #endif
454
455 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_50
456 # define GLIB_AVAILABLE_IN_2_50                 GLIB_UNAVAILABLE(2, 50)
457 #else
458 # define GLIB_AVAILABLE_IN_2_50                 _GLIB_EXTERN
459 #endif
460
461 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_52
462 # define GLIB_DEPRECATED_IN_2_52                GLIB_DEPRECATED
463 # define GLIB_DEPRECATED_IN_2_52_FOR(f)         GLIB_DEPRECATED_FOR(f)
464 #else
465 # define GLIB_DEPRECATED_IN_2_52                _GLIB_EXTERN
466 # define GLIB_DEPRECATED_IN_2_52_FOR(f)         _GLIB_EXTERN
467 #endif
468
469 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_52
470 # define GLIB_AVAILABLE_IN_2_52                 GLIB_UNAVAILABLE(2, 52)
471 #else
472 # define GLIB_AVAILABLE_IN_2_52                 _GLIB_EXTERN
473 #endif
474
475 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_54
476 # define GLIB_DEPRECATED_IN_2_54                GLIB_DEPRECATED
477 # define GLIB_DEPRECATED_IN_2_54_FOR(f)         GLIB_DEPRECATED_FOR(f)
478 #else
479 # define GLIB_DEPRECATED_IN_2_54                _GLIB_EXTERN
480 # define GLIB_DEPRECATED_IN_2_54_FOR(f)         _GLIB_EXTERN
481 #endif
482
483 #if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_54
484 # define GLIB_AVAILABLE_IN_2_54                 GLIB_UNAVAILABLE(2, 54)
485 #else
486 # define GLIB_AVAILABLE_IN_2_54                 _GLIB_EXTERN
487 #endif
488
489 #endif /*  __G_VERSION_MACROS_H__ */