summaryrefslogtreecommitdiff
path: root/src/libtracker-sparql/tracker-version.h
blob: ddad9b3638991e9f3b8a2e719975d89bc1b9a094 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
 * Copyright (C) 2006, Jamie McCracken <jamiemcc@gnome.org>
 * Copyright (C) 2008, Nokia <ivan.frade@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 */

#ifndef __LIBTRACKER_SPARQL_VERSION_H__
#define __LIBTRACKER_SPARQL_VERSION_H__

#include <glib.h>

G_BEGIN_DECLS

#if !defined (__LIBTRACKER_SPARQL_INSIDE__) && !defined (TRACKER_COMPILATION)
#error "only <libtracker-sparql/tracker-sparql.h> must be included directly."
#endif

#ifndef _TRACKER_EXTERN
#define _TRACKER_EXTERN __attribute__((visibility("default"))) extern
#endif

#define _TRACKER_UNAVAILABLE(maj, min) G_UNAVAILABLE(maj, min) _TRACKER_EXTERN
#define _TRACKER_DEPRECATED G_DEPRECATED _TRACKER_EXTERN
#define _TRACKER_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f) _TRACKER_EXTERN

#define TRACKER_VERSION_3_0 G_ENCODE_VERSION (3, 0)
#define TRACKER_VERSION_3_1 G_ENCODE_VERSION (3, 1)
#define TRACKER_VERSION_3_2 G_ENCODE_VERSION (3, 2)
#define TRACKER_VERSION_3_3 G_ENCODE_VERSION (3, 3)
#define TRACKER_VERSION_3_4 G_ENCODE_VERSION (3, 4)
#define TRACKER_VERSION_3_5 G_ENCODE_VERSION (3, 5)
#define TRACKER_VERSION_CUR G_ENCODE_VERSION (TRACKER_MAJOR_VERSION, TRACKER_MINOR_VERSION)

#ifndef TRACKER_VERSION_MIN_REQUIRED
#define TRACKER_VERSION_MIN_REQUIRED TRACKER_VERSION_CUR
#endif

#ifndef TRACKER_VERSION_MAX_ALLOWED
#define TRACKER_VERSION_MAX_ALLOWED TRACKER_VERSION_CUR
#endif

#if TRACKER_VERSION_MIN_REQUIRED > TRACKER_VERSION_MAX_ALLOWED
#error "TRACKER_VERSION_MAX_ALLOWED must be >= TRACKER_VERSION_MIN_REQUIRED"
#endif

#define TRACKER_AVAILABLE_IN_ALL _TRACKER_EXTERN

/* 3.1 */
#if TRACKER_VERSION_MIN_REQUIRED >= TRACKER_VERSION_3_1
#define TRACKER_DEPRECATED_IN_3_1 _TRACKER_DEPRECATED
#define TRACKER_DEPRECATED_IN_3_1_FOR(f) _TRACKER_DEPRECATED_FOR(f)
#else
#define TRACKER_DEPRECATED_IN_3_1 _TRACKER_EXTERN
#define TRACKER_DEPRECATED_IN_3_1_FOR(f) _TRACKER_EXTERN
#endif

#if TRACKER_VERSION_MAX_ALLOWED < TRACKER_VERSION_3_1
#define TRACKER_AVAILABLE_IN_3_1 _TRACKER_UNAVAILABLE(3, 1)
#else
#define TRACKER_AVAILABLE_IN_3_1 _TRACKER_EXTERN
#endif

/* 3.2 */
#if TRACKER_VERSION_MIN_REQUIRED >= TRACKER_VERSION_3_2
#define TRACKER_DEPRECATED_IN_3_2 _TRACKER_DEPRECATED
#define TRACKER_DEPRECATED_IN_3_2_FOR(f) _TRACKER_DEPRECATED_FOR(f)
#else
#define TRACKER_DEPRECATED_IN_3_2 _TRACKER_EXTERN
#define TRACKER_DEPRECATED_IN_3_2_FOR(f) _TRACKER_EXTERN
#endif

#if TRACKER_VERSION_MAX_ALLOWED < TRACKER_VERSION_3_2
#define TRACKER_AVAILABLE_IN_3_2 _TRACKER_UNAVAILABLE(3, 2)
#else
#define TRACKER_AVAILABLE_IN_3_2 _TRACKER_EXTERN
#endif

/* 3.3 */
#if TRACKER_VERSION_MIN_REQUIRED >= TRACKER_VERSION_3_3
#define TRACKER_DEPRECATED_IN_3_3 _TRACKER_DEPRECATED
#define TRACKER_DEPRECATED_IN_3_3_FOR(f) _TRACKER_DEPRECATED_FOR(f)
#else
#define TRACKER_DEPRECATED_IN_3_3 _TRACKER_EXTERN
#define TRACKER_DEPRECATED_IN_3_3_FOR(f) _TRACKER_EXTERN
#endif

#if TRACKER_VERSION_MAX_ALLOWED < TRACKER_VERSION_3_3
#define TRACKER_AVAILABLE_IN_3_3 _TRACKER_UNAVAILABLE(3, 3)
#else
#define TRACKER_AVAILABLE_IN_3_3 _TRACKER_EXTERN
#endif

/* 3.4 */
#if TRACKER_VERSION_MIN_REQUIRED >= TRACKER_VERSION_3_4
#define TRACKER_DEPRECATED_IN_3_4 _TRACKER_DEPRECATED
#define TRACKER_DEPRECATED_IN_3_4_FOR(f) _TRACKER_DEPRECATED_FOR(f)
#else
#define TRACKER_DEPRECATED_IN_3_4 _TRACKER_EXTERN
#define TRACKER_DEPRECATED_IN_3_4_FOR(f) _TRACKER_EXTERN
#endif

#if TRACKER_VERSION_MAX_ALLOWED < TRACKER_VERSION_3_4
#define TRACKER_AVAILABLE_IN_3_4 _TRACKER_UNAVAILABLE(3, 4)
#else
#define TRACKER_AVAILABLE_IN_3_4 _TRACKER_EXTERN
#endif

/* 3.5 */
#if TRACKER_VERSION_MIN_REQUIRED >= TRACKER_VERSION_3_5
#define TRACKER_DEPRECATED_IN_3_5 _TRACKER_DEPRECATED
#define TRACKER_DEPRECATED_IN_3_5_FOR(f) _TRACKER_DEPRECATED_FOR(f)
#else
#define TRACKER_DEPRECATED_IN_3_5 _TRACKER_EXTERN
#define TRACKER_DEPRECATED_IN_3_5_FOR(f) _TRACKER_EXTERN
#endif

#if TRACKER_VERSION_MAX_ALLOWED < TRACKER_VERSION_3_5
#define TRACKER_AVAILABLE_IN_3_5 _TRACKER_UNAVAILABLE(3, 5)
#else
#define TRACKER_AVAILABLE_IN_3_5 _TRACKER_EXTERN
#endif

/**
 * tracker_major_version:
 *
 * The major version of the Tracker library.
 *
 * An integer variable exported from the library linked against at application run time.
 */
GLIB_VAR const guint tracker_major_version;

/**
 * tracker_minor_version:
 *
 * The minor version of the Tracker library.
 *
 * An integer variable exported from the library linked against at application run time.
 */
GLIB_VAR const guint tracker_minor_version;

/**
 * tracker_micro_version:
 *
 * The micro version of the Tracker library.
 *
 * An integer variable exported from the library linked against at application run time.
 */
GLIB_VAR const guint tracker_micro_version;

/**
 * tracker_interface_age:
 *
 * The interface age of the Tracker library. Defines how far back the API has last been extended.
 *
 * An integer variable exported from the library linked against at application run time.
 */
GLIB_VAR const guint tracker_interface_age;

/**
 * tracker_binary_age:
 *
 * The binary age of the Tracker library. Defines how far back backwards compatibility reaches.
 *
 * An integer variable exported from the library linked against at application run time.
 */
GLIB_VAR const guint tracker_binary_age;

/**
 * TRACKER_CHECK_VERSION:
 * @major: the required major version.
 * @minor: the required minor version.
 * @micro: the required micro version.
 *
 * This macro essentially does the same thing as
 * tracker_check_version() but as a pre-processor operation rather
 * than a run-time operation. It will evaluate true or false based the
 * version passed in and the version available.
 *
 * <example>
 * <title>Simple version check example</title>
 * An example of how to make sure you have the version of Tracker
 * installed to run your code.
 * <programlisting>
 * if (!TRACKER_CHECK_VERSION (0, 10, 7)) {
 *         g_error ("Tracker version 0.10.7 or above is needed");
 * }
 * </programlisting>
 * </example>
 **/
#define TRACKER_CHECK_VERSION(major,minor,micro)    \
    (TRACKER_MAJOR_VERSION > (major) || \
     (TRACKER_MAJOR_VERSION == (major) && TRACKER_MINOR_VERSION > (minor)) || \
     (TRACKER_MAJOR_VERSION == (major) && TRACKER_MINOR_VERSION == (minor) && \
      TRACKER_MICRO_VERSION >= (micro)))

TRACKER_AVAILABLE_IN_ALL
const gchar * tracker_check_version (guint required_major,
                                     guint required_minor,
                                     guint required_micro);

G_END_DECLS

#endif /* __LIBTRACKER_SPARQL_VERSION_H__ */