-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlanguage_specific.html
169 lines (159 loc) · 8.39 KB
/
language_specific.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://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/html; charset=utf-8" />
<title>C++ Specific Notes — Getting Started with Xapian v1.4.1</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Getting Started with Xapian v1.4.1" href="index.html" />
<link rel="next" title="Core concepts" href="concepts/index.html" />
<link rel="prev" title="Introduction" href="overview.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="concepts/index.html" title="Core concepts"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="overview.html" title="Introduction"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Getting Started with Xapian v1.4</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="c-specific-notes">
<h1>C++ Specific Notes<a class="headerlink" href="#c-specific-notes" title="Permalink to this headline">¶</a></h1>
<div class="section" id="exceptions">
<h2>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this headline">¶</a></h2>
<p>Xapian reports errors by throwing exceptions. For failures in things like
memory allocation, you will see exceptions derived from <code class="docutils literal"><span class="pre">std::exception</span></code>,
but exceptions related to Xapian-specific issues will be derived from
<code class="docutils literal"><span class="pre">Xapian::Error</span></code>.</p>
<p>Uncaught exceptions will cause your program to terminate, so it’s wise
to at least have a top-level exception handler which can catch any
exceptions and report what they were. You can call the <code class="docutils literal"><span class="pre">get_description()</span></code>
method on a <code class="docutils literal"><span class="pre">Xapian::Error</span></code> object to get a human readable string including
all the information the object contains.</p>
<p>Because <code class="docutils literal"><span class="pre">Xapian::Error</span></code> is an abstract base class you need to catch
it by reference:</p>
<div class="highlight-c++"><div class="highlight"><pre><span></span><span class="k">try</span> <span class="p">{</span>
<span class="n">do_something_with_xapian</span><span class="p">();</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="k">const</span> <span class="n">Xapian</span><span class="o">::</span><span class="n">Error</span> <span class="o">&</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span>
<span class="n">cout</span> <span class="o"><<</span> <span class="s">"Exception: "</span> <span class="o"><<</span> <span class="n">e</span><span class="p">.</span><span class="n">get_description</span><span class="p">()</span> <span class="o"><<</span> <span class="n">endl</span><span class="p">;</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="k">const</span> <span class="n">std</span><span class="o">::</span><span class="n">exception</span> <span class="o">&</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span>
<span class="n">cout</span> <span class="o"><<</span> <span class="s">"Exception: "</span> <span class="o"><<</span> <span class="n">e</span><span class="p">.</span><span class="n">what</span><span class="p">()</span> <span class="o"><<</span> <span class="n">endl</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition-todo admonition" id="index-0">
<p class="first admonition-title">Todo</p>
<p class="last">Xapian::Error hierarchy</p>
</div>
</div>
<div class="section" id="object-copying">
<h2>Object Copying<a class="headerlink" href="#object-copying" title="Permalink to this headline">¶</a></h2>
<p>Objects are either reference counted handles or relatively cheap to copy.</p>
</div>
<div class="section" id="object-ownership">
<h2>Object Ownership<a class="headerlink" href="#object-ownership" title="Permalink to this headline">¶</a></h2>
<p>Creator owns.</p>
<div class="admonition-todo admonition" id="index-1">
<p class="first admonition-title">Todo</p>
<p class="last">write me</p>
</div>
</div>
<div class="section" id="stl-compatibility">
<h2>STL Compatibility<a class="headerlink" href="#stl-compatibility" title="Permalink to this headline">¶</a></h2>
<div class="admonition-todo admonition" id="index-2">
<p class="first admonition-title">Todo</p>
<p class="last">write me</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">C++ Specific Notes</a><ul>
<li><a class="reference internal" href="#exceptions">Exceptions</a></li>
<li><a class="reference internal" href="#object-copying">Object Copying</a></li>
<li><a class="reference internal" href="#object-ownership">Object Ownership</a></li>
<li><a class="reference internal" href="#stl-compatibility">STL Compatibility</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="overview.html"
title="previous chapter">Introduction</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="concepts/index.html"
title="next chapter">Core concepts</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/language_specific.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="concepts/index.html" title="Core concepts"
>next</a> |</li>
<li class="right" >
<a href="overview.html" title="Introduction"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Getting Started with Xapian v1.4</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2017 Xapian Documentation Team & Contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</body>
</html>