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 218 219 220 221 222
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: xapian/version.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">xapian-core
 <span id="projectnumber">1.4.18</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f63502d618711192f85ccb772536c6ae.html">xapian</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">version.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Define preprocessor symbols for the library version.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0f644486c65a4d418c51d9bed03736c1"><td class="memItemLeft" align="right" valign="top"><a id="a0f644486c65a4d418c51d9bed03736c1"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a0f644486c65a4d418c51d9bed03736c1">XAPIAN_ENABLE_VISIBILITY</a></td></tr>
<tr class="memdesc:a0f644486c65a4d418c51d9bed03736c1"><td class="mdescLeft"> </td><td class="mdescRight">The library was compiled with GCC's -fvisibility=hidden option. <br /></td></tr>
<tr class="separator:a0f644486c65a4d418c51d9bed03736c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a935bc75275b2f5938a5ab6546c59ef09"><td class="memItemLeft" align="right" valign="top"><a id="a935bc75275b2f5938a5ab6546c59ef09"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a935bc75275b2f5938a5ab6546c59ef09">XAPIAN_VERSION</a>   "1.4.18"</td></tr>
<tr class="memdesc:a935bc75275b2f5938a5ab6546c59ef09"><td class="mdescLeft"> </td><td class="mdescRight">The version of <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> as a C string literal. <br /></td></tr>
<tr class="separator:a935bc75275b2f5938a5ab6546c59ef09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6115d1204830e2412fbecdf350156db0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a6115d1204830e2412fbecdf350156db0">XAPIAN_MAJOR_VERSION</a>   1</td></tr>
<tr class="memdesc:a6115d1204830e2412fbecdf350156db0"><td class="mdescLeft"> </td><td class="mdescRight">The major component of the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> version. <a href="version_8h.html#a6115d1204830e2412fbecdf350156db0">More...</a><br /></td></tr>
<tr class="separator:a6115d1204830e2412fbecdf350156db0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66bfaa7fe54a17b4d54a18e4bd3a9a14"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a66bfaa7fe54a17b4d54a18e4bd3a9a14">XAPIAN_MINOR_VERSION</a>   4</td></tr>
<tr class="memdesc:a66bfaa7fe54a17b4d54a18e4bd3a9a14"><td class="mdescLeft"> </td><td class="mdescRight">The minor component of the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> version. <a href="version_8h.html#a66bfaa7fe54a17b4d54a18e4bd3a9a14">More...</a><br /></td></tr>
<tr class="separator:a66bfaa7fe54a17b4d54a18e4bd3a9a14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68a63b70bf9601be738448a3094009c9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a68a63b70bf9601be738448a3094009c9">XAPIAN_REVISION</a>   18</td></tr>
<tr class="memdesc:a68a63b70bf9601be738448a3094009c9"><td class="mdescLeft"> </td><td class="mdescRight">The revision component of the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> version. <a href="version_8h.html#a68a63b70bf9601be738448a3094009c9">More...</a><br /></td></tr>
<tr class="separator:a68a63b70bf9601be738448a3094009c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b8d40ce5f8bcf102b6b2f28d2995698"><td class="memItemLeft" align="right" valign="top"><a id="a3b8d40ce5f8bcf102b6b2f28d2995698"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a3b8d40ce5f8bcf102b6b2f28d2995698">XAPIAN_DOCID_BASE_TYPE</a>   int</td></tr>
<tr class="memdesc:a3b8d40ce5f8bcf102b6b2f28d2995698"><td class="mdescLeft"> </td><td class="mdescRight">Base (signed) type for <a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f" title="A unique identifier for a document.">Xapian::docid</a> and related types. <br /></td></tr>
<tr class="separator:a3b8d40ce5f8bcf102b6b2f28d2995698"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a776669c66ab35f2d43d68d07d112022a"><td class="memItemLeft" align="right" valign="top"><a id="a776669c66ab35f2d43d68d07d112022a"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a776669c66ab35f2d43d68d07d112022a">XAPIAN_TERMCOUNT_BASE_TYPE</a>   int</td></tr>
<tr class="memdesc:a776669c66ab35f2d43d68d07d112022a"><td class="mdescLeft"> </td><td class="mdescRight">Base (signed) type for <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2" title="A counts of terms.">Xapian::termcount</a> and related types. <br /></td></tr>
<tr class="separator:a776669c66ab35f2d43d68d07d112022a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa48150ca476daa0c0fcfd05ee8d1d5c6"><td class="memItemLeft" align="right" valign="top"><a id="aa48150ca476daa0c0fcfd05ee8d1d5c6"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#aa48150ca476daa0c0fcfd05ee8d1d5c6">XAPIAN_TERMPOS_BASE_TYPE</a>   int</td></tr>
<tr class="memdesc:aa48150ca476daa0c0fcfd05ee8d1d5c6"><td class="mdescLeft"> </td><td class="mdescRight">Base (signed) type for <a class="el" href="namespaceXapian.html#ae1faeb9bd109b4d78a02d4b5f7b123ed" title="A term position within a document or query.">Xapian::termpos</a>. <br /></td></tr>
<tr class="separator:aa48150ca476daa0c0fcfd05ee8d1d5c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ad05b1eae8601c24f4b97b620ee6e38"><td class="memItemLeft" align="right" valign="top"><a id="a4ad05b1eae8601c24f4b97b620ee6e38"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a4ad05b1eae8601c24f4b97b620ee6e38">XAPIAN_TOTALLENGTH_TYPE</a>   unsigned long</td></tr>
<tr class="memdesc:a4ad05b1eae8601c24f4b97b620ee6e38"><td class="mdescLeft"> </td><td class="mdescRight">Type for returning total document length. <br /></td></tr>
<tr class="separator:a4ad05b1eae8601c24f4b97b620ee6e38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9983c4274dd14580000c4ce0fd0068e1"><td class="memItemLeft" align="right" valign="top"><a id="a9983c4274dd14580000c4ce0fd0068e1"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a9983c4274dd14580000c4ce0fd0068e1">XAPIAN_REVISION_TYPE</a>   unsigned long</td></tr>
<tr class="memdesc:a9983c4274dd14580000c4ce0fd0068e1"><td class="mdescLeft"> </td><td class="mdescRight">Underlying type for <a class="el" href="namespaceXapian.html#a5965adf733b07c119183c71ef904419c" title="Revision number of a database.">Xapian::rev</a>. <br /></td></tr>
<tr class="separator:a9983c4274dd14580000c4ce0fd0068e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ff3ffd6eb8cc926c92164b2d59a4808"><td class="memItemLeft" align="right" valign="top"><a id="a5ff3ffd6eb8cc926c92164b2d59a4808"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a5ff3ffd6eb8cc926c92164b2d59a4808">XAPIAN_HAS_CHERT_BACKEND</a>   1</td></tr>
<tr class="memdesc:a5ff3ffd6eb8cc926c92164b2d59a4808"><td class="mdescLeft"> </td><td class="mdescRight">XAPIAN_HAS_CHERT_BACKEND Defined if the chert backend is enabled. <br /></td></tr>
<tr class="separator:a5ff3ffd6eb8cc926c92164b2d59a4808"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc7bf09a0bdb6b0f83877f0f3280f45b"><td class="memItemLeft" align="right" valign="top"><a id="abc7bf09a0bdb6b0f83877f0f3280f45b"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#abc7bf09a0bdb6b0f83877f0f3280f45b">XAPIAN_HAS_GLASS_BACKEND</a>   1</td></tr>
<tr class="memdesc:abc7bf09a0bdb6b0f83877f0f3280f45b"><td class="mdescLeft"> </td><td class="mdescRight">XAPIAN_HAS_GLASS_BACKEND Defined if the glass backend is enabled. <br /></td></tr>
<tr class="separator:abc7bf09a0bdb6b0f83877f0f3280f45b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa676e6c5e3af903ba1cf0a5764744d07"><td class="memItemLeft" align="right" valign="top"><a id="aa676e6c5e3af903ba1cf0a5764744d07"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#aa676e6c5e3af903ba1cf0a5764744d07">XAPIAN_HAS_INMEMORY_BACKEND</a>   1</td></tr>
<tr class="memdesc:aa676e6c5e3af903ba1cf0a5764744d07"><td class="mdescLeft"> </td><td class="mdescRight">XAPIAN_HAS_INMEMORY_BACKEND Defined if the inmemory backend is enabled. <br /></td></tr>
<tr class="separator:aa676e6c5e3af903ba1cf0a5764744d07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a441e90afa8ecb3e4752e51234940baa5"><td class="memItemLeft" align="right" valign="top"><a id="a441e90afa8ecb3e4752e51234940baa5"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a441e90afa8ecb3e4752e51234940baa5">XAPIAN_HAS_REMOTE_BACKEND</a>   1</td></tr>
<tr class="memdesc:a441e90afa8ecb3e4752e51234940baa5"><td class="mdescLeft"> </td><td class="mdescRight">XAPIAN_HAS_REMOTE_BACKEND Defined if the remote backend is enabled. <br /></td></tr>
<tr class="separator:a441e90afa8ecb3e4752e51234940baa5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b7548b728bea46a657207f60e08097f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a8b7548b728bea46a657207f60e08097f">XAPIAN_AT_LEAST</a>(A, B, C)</td></tr>
<tr class="memdesc:a8b7548b728bea46a657207f60e08097f"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="version_8h.html#a8b7548b728bea46a657207f60e08097f" title="XAPIAN_AT_LEAST(A,B,C) checks for xapian-core >= A.B.C - use like so:">XAPIAN_AT_LEAST(A,B,C)</a> checks for xapian-core >= A.B.C - use like so: <a href="version_8h.html#a8b7548b728bea46a657207f60e08097f">More...</a><br /></td></tr>
<tr class="separator:a8b7548b728bea46a657207f60e08097f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Define preprocessor symbols for the library version. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a8b7548b728bea46a657207f60e08097f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b7548b728bea46a657207f60e08097f">◆ </a></span>XAPIAN_AT_LEAST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XAPIAN_AT_LEAST</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">A, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">B, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">C </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> (<a class="code" href="version_8h.html#a6115d1204830e2412fbecdf350156db0">XAPIAN_MAJOR_VERSION</a> > (A) || \</div>
<div class="line"> (<a class="code" href="version_8h.html#a6115d1204830e2412fbecdf350156db0">XAPIAN_MAJOR_VERSION</a> == (A) && \</div>
<div class="line"> (<a class="code" href="version_8h.html#a66bfaa7fe54a17b4d54a18e4bd3a9a14">XAPIAN_MINOR_VERSION</a> > (B) || \</div>
<div class="line"> (<a class="code" href="version_8h.html#a66bfaa7fe54a17b4d54a18e4bd3a9a14">XAPIAN_MINOR_VERSION</a> == (B) && <a class="code" href="version_8h.html#a68a63b70bf9601be738448a3094009c9">XAPIAN_REVISION</a> >= (C)))))</div>
<div class="ttc" id="aversion_8h_html_a6115d1204830e2412fbecdf350156db0"><div class="ttname"><a href="version_8h.html#a6115d1204830e2412fbecdf350156db0">XAPIAN_MAJOR_VERSION</a></div><div class="ttdeci">#define XAPIAN_MAJOR_VERSION</div><div class="ttdoc">The major component of the Xapian version.</div><div class="ttdef"><b>Definition:</b> version.h:58</div></div>
<div class="ttc" id="aversion_8h_html_a66bfaa7fe54a17b4d54a18e4bd3a9a14"><div class="ttname"><a href="version_8h.html#a66bfaa7fe54a17b4d54a18e4bd3a9a14">XAPIAN_MINOR_VERSION</a></div><div class="ttdeci">#define XAPIAN_MINOR_VERSION</div><div class="ttdoc">The minor component of the Xapian version.</div><div class="ttdef"><b>Definition:</b> version.h:63</div></div>
<div class="ttc" id="aversion_8h_html_a68a63b70bf9601be738448a3094009c9"><div class="ttname"><a href="version_8h.html#a68a63b70bf9601be738448a3094009c9">XAPIAN_REVISION</a></div><div class="ttdeci">#define XAPIAN_REVISION</div><div class="ttdoc">The revision component of the Xapian version.</div><div class="ttdef"><b>Definition:</b> version.h:68</div></div>
</div><!-- fragment -->
<p><a class="el" href="version_8h.html#a8b7548b728bea46a657207f60e08097f" title="XAPIAN_AT_LEAST(A,B,C) checks for xapian-core >= A.B.C - use like so:">XAPIAN_AT_LEAST(A,B,C)</a> checks for xapian-core >= A.B.C - use like so: </p>
<div class="fragment"><div class="line"><span class="preprocessor">#if XAPIAN_AT_LEAST(1,4,2)</span></div>
<div class="line"><span class="comment">/* Code needing features needing Xapian >= 1.4.2. */</span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
</div><!-- fragment --><p>Added in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> 1.4.2. </p>
</div>
</div>
<a id="a6115d1204830e2412fbecdf350156db0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6115d1204830e2412fbecdf350156db0">◆ </a></span>XAPIAN_MAJOR_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XAPIAN_MAJOR_VERSION   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The major component of the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> version. </p>
<p>E.g. for <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> 1.0.14 this would be: 1 </p>
</div>
</div>
<a id="a66bfaa7fe54a17b4d54a18e4bd3a9a14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66bfaa7fe54a17b4d54a18e4bd3a9a14">◆ </a></span>XAPIAN_MINOR_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XAPIAN_MINOR_VERSION   4</td>
</tr>
</table>
</div><div class="memdoc">
<p>The minor component of the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> version. </p>
<p>E.g. for <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> 1.0.14 this would be: 0 </p>
</div>
</div>
<a id="a68a63b70bf9601be738448a3094009c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68a63b70bf9601be738448a3094009c9">◆ </a></span>XAPIAN_REVISION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XAPIAN_REVISION   18</td>
</tr>
</table>
</div><div class="memdoc">
<p>The revision component of the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> version. </p>
<p>E.g. for <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> 1.0.14 this would be: 14 </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.1</a>
</small></address>
</body>
</html>
|