30
29
<h2><span class="refentrytitle"><a name="pango-Version-Checking.top_of_page"></a>Version Checking</span></h2>
31
30
<p>Version Checking — Tools for checking Pango version at compile- and run-time.</p>
33
<td valign="top" align="right"></td>
32
<td class="gallery_image" valign="top" align="right"></td>
34
33
</tr></table></div>
35
<div class="refsynopsisdiv">
36
<a name="pango-Version-Checking.synopsis"></a><h2>Synopsis</h2>
37
<pre class="synopsis">#define <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-ENCODE:CAPS" title="PANGO_VERSION_ENCODE()">PANGO_VERSION_ENCODE</a> (major,
40
#define <a class="link" href="pango-Version-Checking.html#PANGO-VERSION:CAPS" title="PANGO_VERSION">PANGO_VERSION</a>
41
#define <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MAJOR:CAPS" title="PANGO_VERSION_MAJOR">PANGO_VERSION_MAJOR</a>
42
#define <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MINOR:CAPS" title="PANGO_VERSION_MINOR">PANGO_VERSION_MINOR</a>
43
#define <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MICRO:CAPS" title="PANGO_VERSION_MICRO">PANGO_VERSION_MICRO</a>
44
#define <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-STRING:CAPS" title="PANGO_VERSION_STRING">PANGO_VERSION_STRING</a>
45
#define <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-CHECK:CAPS" title="PANGO_VERSION_CHECK()">PANGO_VERSION_CHECK</a> (major,
48
<span class="returnvalue">int</span> <a class="link" href="pango-Version-Checking.html#pango-version" title="pango_version ()">pango_version</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
49
const <span class="returnvalue">char</span> * <a class="link" href="pango-Version-Checking.html#pango-version-string" title="pango_version_string ()">pango_version_string</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
50
const <span class="returnvalue">char</span> * <a class="link" href="pango-Version-Checking.html#pango-version-check" title="pango_version_check ()">pango_version_check</a> (<em class="parameter"><code><span class="type">int</span> required_major</code></em>,
51
<em class="parameter"><code><span class="type">int</span> required_minor</code></em>,
52
<em class="parameter"><code><span class="type">int</span> required_micro</code></em>);
34
<div class="refsect1">
35
<a name="pango-Version-Checking.functions"></a><h2>Functions</h2>
36
<div class="informaltable"><table width="100%" border="0">
38
<col width="150px" class="functions_return">
39
<col class="functions_name">
43
<td class="define_keyword">#define</td>
44
<td class="function_name">
45
<a class="link" href="pango-Version-Checking.html#PANGO-VERSION-ENCODE:CAPS" title="PANGO_VERSION_ENCODE()">PANGO_VERSION_ENCODE</a><span class="c_punctuation">()</span>
49
<td class="define_keyword">#define</td>
50
<td class="function_name">
51
<a class="link" href="pango-Version-Checking.html#PANGO-VERSION-CHECK:CAPS" title="PANGO_VERSION_CHECK()">PANGO_VERSION_CHECK</a><span class="c_punctuation">()</span>
55
<td class="function_type">
56
<span class="returnvalue">int</span>
58
<td class="function_name">
59
<a class="link" href="pango-Version-Checking.html#pango-version" title="pango_version ()">pango_version</a> <span class="c_punctuation">()</span>
63
<td class="function_type">const <span class="returnvalue">char</span> *
65
<td class="function_name">
66
<a class="link" href="pango-Version-Checking.html#pango-version-string" title="pango_version_string ()">pango_version_string</a> <span class="c_punctuation">()</span>
70
<td class="function_type">const <span class="returnvalue">char</span> *
72
<td class="function_name">
73
<a class="link" href="pango-Version-Checking.html#pango-version-check" title="pango_version_check ()">pango_version_check</a> <span class="c_punctuation">()</span>
79
<div class="refsect1">
80
<a name="pango-Version-Checking.other"></a><h2>Types and Values</h2>
81
<div class="informaltable"><table width="100%" border="0">
83
<col width="150px" class="name">
84
<col class="description">
88
<td class="define_keyword">#define</td>
89
<td class="function_name"><a class="link" href="pango-Version-Checking.html#PANGO-VERSION:CAPS" title="PANGO_VERSION">PANGO_VERSION</a></td>
92
<td class="define_keyword">#define</td>
93
<td class="function_name"><a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MAJOR:CAPS" title="PANGO_VERSION_MAJOR">PANGO_VERSION_MAJOR</a></td>
96
<td class="define_keyword">#define</td>
97
<td class="function_name"><a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MINOR:CAPS" title="PANGO_VERSION_MINOR">PANGO_VERSION_MINOR</a></td>
100
<td class="define_keyword">#define</td>
101
<td class="function_name"><a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MICRO:CAPS" title="PANGO_VERSION_MICRO">PANGO_VERSION_MICRO</a></td>
104
<td class="define_keyword">#define</td>
105
<td class="function_name"><a class="link" href="pango-Version-Checking.html#PANGO-VERSION-STRING:CAPS" title="PANGO_VERSION_STRING">PANGO_VERSION_STRING</a></td>
55
110
<div class="refsect1">
56
111
<a name="pango-Version-Checking.description"></a><h2>Description</h2>
58
The capital-letter macros defined here can be used to check the version of Pango
112
<p>The capital-letter macros defined here can be used to check the version of Pango
59
113
at compile-time, and to <em class="firstterm">encode</em> Pango versions into integers.</p>
61
The functions can be used to check the version of the linked Pango library at run-time.</p>
114
<p>The functions can be used to check the version of the linked Pango library at run-time.</p>
63
116
<div class="refsect1">
64
<a name="pango-Version-Checking.details"></a><h2>Details</h2>
117
<a name="pango-Version-Checking.functions_details"></a><h2>Functions</h2>
65
118
<div class="refsect2">
66
119
<a name="PANGO-VERSION-ENCODE:CAPS"></a><h3>PANGO_VERSION_ENCODE()</h3>
67
120
<pre class="programlisting">#define PANGO_VERSION_ENCODE(major, minor, micro)</pre>
69
This macro encodes the given Pango version into an integer. The numbers
70
returned by <a class="link" href="pango-Version-Checking.html#PANGO-VERSION:CAPS" title="PANGO_VERSION"><code class="literal">PANGO_VERSION</code></a> and <a class="link" href="pango-Version-Checking.html#pango-version" title="pango_version ()"><code class="function">pango_version()</code></a> are encoded using this macro.
121
<p>This macro encodes the given Pango version into an integer. The numbers
122
returned by <a class="link" href="pango-Version-Checking.html#PANGO-VERSION:CAPS" title="PANGO_VERSION"><code class="literal">PANGO_VERSION</code></a> and <a class="link" href="pango-Version-Checking.html#pango-version" title="pango_version ()"><code class="function">pango_version()</code></a> are encoded using this macro.
71
123
Two encoded version numbers can be compared as integers.</p>
72
<div class="variablelist"><table border="0" class="variablelist">
124
<div class="refsect3">
125
<a name="id-1.4.13.6.2.5"></a><h4>Parameters</h4>
126
<div class="informaltable"><table width="100%" border="0">
74
<col align="left" valign="top">
128
<col width="150px" class="parameters_name">
129
<col class="parameters_description">
130
<col width="200px" class="parameters_annotations">
79
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
80
<td>the major component of the version number</td>
83
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
84
<td>the minor component of the version number</td>
87
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
88
<td>the micro component of the version number</td>
134
<td class="parameter_name"><p>major</p></td>
135
<td class="parameter_description"><p>the major component of the version number</p></td>
136
<td class="parameter_annotations"> </td>
139
<td class="parameter_name"><p>minor</p></td>
140
<td class="parameter_description"><p>the minor component of the version number</p></td>
141
<td class="parameter_annotations"> </td>
144
<td class="parameter_name"><p>micro</p></td>
145
<td class="parameter_description"><p>the micro component of the version number</p></td>
146
<td class="parameter_annotations"> </td>
94
<div class="refsect2">
95
<a name="PANGO-VERSION:CAPS"></a><h3>PANGO_VERSION</h3>
96
<pre class="programlisting">#define PANGO_VERSION</pre>
98
The version of Pango available at compile-time, encoded using <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-ENCODE:CAPS" title="PANGO_VERSION_ENCODE()"><code class="function">PANGO_VERSION_ENCODE()</code></a>.</p>
101
<div class="refsect2">
102
<a name="PANGO-VERSION-MAJOR:CAPS"></a><h3>PANGO_VERSION_MAJOR</h3>
103
<pre class="programlisting">#define PANGO_VERSION_MAJOR 1
106
The major component of the version of Pango available at compile-time.</p>
109
<div class="refsect2">
110
<a name="PANGO-VERSION-MINOR:CAPS"></a><h3>PANGO_VERSION_MINOR</h3>
111
<pre class="programlisting">#define PANGO_VERSION_MINOR 36
114
The minor component of the version of Pango available at compile-time.</p>
117
<div class="refsect2">
118
<a name="PANGO-VERSION-MICRO:CAPS"></a><h3>PANGO_VERSION_MICRO</h3>
119
<pre class="programlisting">#define PANGO_VERSION_MICRO 2
122
The micro component of the version of Pango available at compile-time.</p>
125
<div class="refsect2">
126
<a name="PANGO-VERSION-STRING:CAPS"></a><h3>PANGO_VERSION_STRING</h3>
127
<pre class="programlisting">#define PANGO_VERSION_STRING "1.36.2"
130
A string literal containing the version of Pango available at compile-time.</p>
133
153
<div class="refsect2">
134
154
<a name="PANGO-VERSION-CHECK:CAPS"></a><h3>PANGO_VERSION_CHECK()</h3>
135
155
<pre class="programlisting">#define PANGO_VERSION_CHECK(major,minor,micro)</pre>
137
Checks that the version of Pango available at compile-time is not older than
156
<p>Checks that the version of Pango available at compile-time is not older than
138
157
the provided version number.</p>
139
<div class="variablelist"><table border="0" class="variablelist">
158
<div class="refsect3">
159
<a name="id-1.4.13.6.3.5"></a><h4>Parameters</h4>
160
<div class="informaltable"><table width="100%" border="0">
141
<col align="left" valign="top">
162
<col width="150px" class="parameters_name">
163
<col class="parameters_description">
164
<col width="200px" class="parameters_annotations">
146
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
147
<td>the major component of the version number</td>
150
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
151
<td>the minor component of the version number</td>
154
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
155
<td>the micro component of the version number</td>
168
<td class="parameter_name"><p>major</p></td>
169
<td class="parameter_description"><p>the major component of the version number</p></td>
170
<td class="parameter_annotations"> </td>
173
<td class="parameter_name"><p>minor</p></td>
174
<td class="parameter_description"><p>the minor component of the version number</p></td>
175
<td class="parameter_annotations"> </td>
178
<td class="parameter_name"><p>micro</p></td>
179
<td class="parameter_description"><p>the micro component of the version number</p></td>
180
<td class="parameter_annotations"> </td>
161
187
<div class="refsect2">
162
<a name="pango-version"></a><h3>pango_version ()</h3>
163
<pre class="programlisting"><span class="returnvalue">int</span> pango_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
165
This is similar to the macro <a class="link" href="pango-Version-Checking.html#PANGO-VERSION:CAPS" title="PANGO_VERSION"><code class="literal">PANGO_VERSION</code></a> except that
188
<a name="pango-version"></a><h3>pango_version ()</h3>
189
<pre class="programlisting"><span class="returnvalue">int</span>
190
pango_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
191
<p>This is similar to the macro <a class="link" href="pango-Version-Checking.html#PANGO-VERSION:CAPS" title="PANGO_VERSION"><code class="literal">PANGO_VERSION</code></a> except that
166
192
it returns the encoded version of Pango available at run-time,
167
193
as opposed to the version available at compile-time.</p>
169
A version number can be encoded into an integer using
194
<p>A version number can be encoded into an integer using
170
195
<a class="link" href="pango-Version-Checking.html#PANGO-VERSION-ENCODE:CAPS" title="PANGO_VERSION_ENCODE()"><code class="function">PANGO_VERSION_ENCODE()</code></a>.</p>
171
<div class="variablelist"><table border="0" class="variablelist">
173
<col align="left" valign="top">
177
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
178
<td>The encoded version of Pango library
179
available at run time.</td>
196
<div class="refsect3">
197
<a name="id-1.4.13.6.4.6"></a><h4>Returns</h4>
198
<p> The encoded version of Pango library
199
available at run time.</p>
182
202
<p class="since">Since 1.16</p>
185
205
<div class="refsect2">
186
<a name="pango-version-string"></a><h3>pango_version_string ()</h3>
187
<pre class="programlisting">const <span class="returnvalue">char</span> * pango_version_string (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
189
This is similar to the macro <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-STRING:CAPS" title="PANGO_VERSION_STRING"><code class="literal">PANGO_VERSION_STRING</code></a> except that
206
<a name="pango-version-string"></a><h3>pango_version_string ()</h3>
207
<pre class="programlisting">const <span class="returnvalue">char</span> *
208
pango_version_string (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
209
<p>This is similar to the macro <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-STRING:CAPS" title="PANGO_VERSION_STRING"><code class="literal">PANGO_VERSION_STRING</code></a> except that
190
210
it returns the version of Pango available at run-time, as opposed to
191
211
the version available at compile-time.</p>
192
<div class="variablelist"><table border="0" class="variablelist">
194
<col align="left" valign="top">
198
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
199
<td>A string containing the version of Pango library
212
<div class="refsect3">
213
<a name="id-1.4.13.6.5.5"></a><h4>Returns</h4>
214
<p> A string containing the version of Pango library
200
215
available at run time.
201
216
The returned string is owned by Pango and should not be modified
205
220
<p class="since">Since 1.16</p>
208
223
<div class="refsect2">
209
<a name="pango-version-check"></a><h3>pango_version_check ()</h3>
210
<pre class="programlisting">const <span class="returnvalue">char</span> * pango_version_check (<em class="parameter"><code><span class="type">int</span> required_major</code></em>,
211
<em class="parameter"><code><span class="type">int</span> required_minor</code></em>,
212
<em class="parameter"><code><span class="type">int</span> required_micro</code></em>);</pre>
214
Checks that the Pango library in use is compatible with the
224
<a name="pango-version-check"></a><h3>pango_version_check ()</h3>
225
<pre class="programlisting">const <span class="returnvalue">char</span> *
226
pango_version_check (<em class="parameter"><code><span class="type">int</span> required_major</code></em>,
227
<em class="parameter"><code><span class="type">int</span> required_minor</code></em>,
228
<em class="parameter"><code><span class="type">int</span> required_micro</code></em>);</pre>
229
<p>Checks that the Pango library in use is compatible with the
215
230
given version. Generally you would pass in the constants
216
231
<a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MAJOR:CAPS" title="PANGO_VERSION_MAJOR"><code class="literal">PANGO_VERSION_MAJOR</code></a>, <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MINOR:CAPS" title="PANGO_VERSION_MINOR"><code class="literal">PANGO_VERSION_MINOR</code></a>, <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-MICRO:CAPS" title="PANGO_VERSION_MICRO"><code class="literal">PANGO_VERSION_MICRO</code></a>
217
232
as the three arguments to this function; that produces
218
233
a check that the library in use at run-time is compatible with
219
234
the version of Pango the application or module was compiled against.</p>
221
Compatibility is defined by two things: first the version
235
<p>Compatibility is defined by two things: first the version
222
236
of the running library is newer than the version
223
<em class="parameter"><code>required_major.required_minor</code></em>.<em class="parameter"><code>required_micro</code></em>. Second
237
<em class="parameter"><code>required_major.required_minor</code></em>
238
.<em class="parameter"><code>required_micro</code></em>
224
240
the running library must be binary compatible with the
225
version <em class="parameter"><code>required_major.required_minor</code></em>.<em class="parameter"><code>required_micro</code></em>
241
version <em class="parameter"><code>required_major.required_minor</code></em>
242
.<em class="parameter"><code>required_micro</code></em>
226
244
(same major version.)</p>
228
For compile-time version checking use <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-CHECK:CAPS" title="PANGO_VERSION_CHECK()"><code class="function">PANGO_VERSION_CHECK()</code></a>.</p>
229
<div class="variablelist"><table border="0" class="variablelist">
245
<p>For compile-time version checking use <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-CHECK:CAPS" title="PANGO_VERSION_CHECK()"><code class="function">PANGO_VERSION_CHECK()</code></a>.</p>
246
<div class="refsect3">
247
<a name="id-1.4.13.6.6.7"></a><h4>Parameters</h4>
248
<div class="informaltable"><table width="100%" border="0">
231
<col align="left" valign="top">
250
<col width="150px" class="parameters_name">
251
<col class="parameters_description">
252
<col width="200px" class="parameters_annotations">
236
<td><p><span class="term"><em class="parameter"><code>required_major</code></em> :</span></p></td>
237
<td>the required major version.</td>
240
<td><p><span class="term"><em class="parameter"><code>required_minor</code></em> :</span></p></td>
241
<td>the required minor version.</td>
244
<td><p><span class="term"><em class="parameter"><code>required_micro</code></em> :</span></p></td>
245
<td>the required major version.</td>
248
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
250
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the Pango library is compatible with the
256
<td class="parameter_name"><p>required_major</p></td>
257
<td class="parameter_description"><p>the required major version.</p></td>
258
<td class="parameter_annotations"> </td>
261
<td class="parameter_name"><p>required_minor</p></td>
262
<td class="parameter_description"><p>the required minor version.</p></td>
263
<td class="parameter_annotations"> </td>
266
<td class="parameter_name"><p>required_micro</p></td>
267
<td class="parameter_description"><p>the required major version.</p></td>
268
<td class="parameter_annotations"> </td>
273
<div class="refsect3">
274
<a name="id-1.4.13.6.6.8"></a><h4>Returns</h4>
275
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the Pango library is compatible with the
251
276
given version, or a string describing the version mismatch.
252
277
The returned string is owned by Pango and should not be modified
257
281
<p class="since">Since 1.16</p>
284
<div class="refsect1">
285
<a name="pango-Version-Checking.other_details"></a><h2>Types and Values</h2>
286
<div class="refsect2">
287
<a name="PANGO-VERSION:CAPS"></a><h3>PANGO_VERSION</h3>
288
<pre class="programlisting">#define PANGO_VERSION</pre>
289
<p>The version of Pango available at compile-time, encoded using <a class="link" href="pango-Version-Checking.html#PANGO-VERSION-ENCODE:CAPS" title="PANGO_VERSION_ENCODE()"><code class="function">PANGO_VERSION_ENCODE()</code></a>.</p>
292
<div class="refsect2">
293
<a name="PANGO-VERSION-MAJOR:CAPS"></a><h3>PANGO_VERSION_MAJOR</h3>
294
<pre class="programlisting">#define PANGO_VERSION_MAJOR 1
296
<p>The major component of the version of Pango available at compile-time.</p>
299
<div class="refsect2">
300
<a name="PANGO-VERSION-MINOR:CAPS"></a><h3>PANGO_VERSION_MINOR</h3>
301
<pre class="programlisting">#define PANGO_VERSION_MINOR 36
303
<p>The minor component of the version of Pango available at compile-time.</p>
306
<div class="refsect2">
307
<a name="PANGO-VERSION-MICRO:CAPS"></a><h3>PANGO_VERSION_MICRO</h3>
308
<pre class="programlisting">#define PANGO_VERSION_MICRO 3
310
<p>The micro component of the version of Pango available at compile-time.</p>
313
<div class="refsect2">
314
<a name="PANGO-VERSION-STRING:CAPS"></a><h3>PANGO_VERSION_STRING</h3>
315
<pre class="programlisting">#define PANGO_VERSION_STRING "1.36.3"
317
<p>A string literal containing the version of Pango available at compile-time.</p>
261
321
<div class="footer">
263
Generated by GTK-Doc V1.19.1</div>
323
Generated by GTK-Doc V1.20.1</div>
b'\\ No newline at end of file'