File: liblangtag-Database.html

package info (click to toggle)
liblangtag 0.5.1-3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 5,772 kB
  • ctags: 1,757
  • sloc: xml: 51,385; ansic: 11,921; sh: 11,409; makefile: 817
file content (261 lines) | stat: -rw-r--r-- 17,504 bytes parent folder | download
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Database</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="liblangtag Documentation">
<link rel="up" href="ch01.html#Database" title="Database APIs">
<link rel="prev" href="ch01.html" title="liblangtag API References">
<link rel="next" href="liblangtag-Database---Extlang.html" title="Database - Extlang">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html#Database"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">liblangtag Documentation</th>
<td><a accesskey="n" href="liblangtag-Database---Extlang.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#liblangtag-Database.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#liblangtag-Database.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="liblangtag-Database"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="liblangtag-Database.top_of_page"></a>Database</span></h2>
<p>Database — convenient function sets to deal with the language tags database</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="liblangtag-Database.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span>                <a class="link" href="liblangtag-Database.html#lt-db-finalize" title="lt_db_finalize ()">lt_db_finalize</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="liblangtag-Database.html#lt-db-get-datadir" title="lt_db_get_datadir ()">lt_db_get_datadir</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="liblangtag-Database---Extlang.html#lt-extlang-db-t" title="lt_extlang_db_t"><span class="returnvalue">lt_extlang_db_t</span></a> *   <a class="link" href="liblangtag-Database.html#lt-db-get-extlang" title="lt_db_get_extlang ()">lt_db_get_extlang</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="liblangtag-Database---Grandfathered.html#lt-grandfathered-db-t" title="lt_grandfathered_db_t"><span class="returnvalue">lt_grandfathered_db_t</span></a> * <a class="link" href="liblangtag-Database.html#lt-db-get-grandfathered" title="lt_db_get_grandfathered ()">lt_db_get_grandfathered</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="liblangtag-Database---Language.html#lt-lang-db-t" title="lt_lang_db_t"><span class="returnvalue">lt_lang_db_t</span></a> *      <a class="link" href="liblangtag-Database.html#lt-db-get-lang" title="lt_db_get_lang ()">lt_db_get_lang</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="liblangtag-Database---Redundant.html#lt-redundant-db-t" title="lt_redundant_db_t"><span class="returnvalue">lt_redundant_db_t</span></a> * <a class="link" href="liblangtag-Database.html#lt-db-get-redundant" title="lt_db_get_redundant ()">lt_db_get_redundant</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="liblangtag-Database---Region.html#lt-region-db-t" title="lt_region_db_t"><span class="returnvalue">lt_region_db_t</span></a> *    <a class="link" href="liblangtag-Database.html#lt-db-get-region" title="lt_db_get_region ()">lt_db_get_region</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="liblangtag-Database---Script.html#lt-script-db-t" title="lt_script_db_t"><span class="returnvalue">lt_script_db_t</span></a> *    <a class="link" href="liblangtag-Database.html#lt-db-get-script" title="lt_db_get_script ()">lt_db_get_script</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="liblangtag-Database---Variant.html#lt-variant-db-t" title="lt_variant_db_t"><span class="returnvalue">lt_variant_db_t</span></a> *   <a class="link" href="liblangtag-Database.html#lt-db-get-variant" title="lt_db_get_variant ()">lt_db_get_variant</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()">lt_db_initialize</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="liblangtag-Database.html#lt-db-set-datadir" title="lt_db_set_datadir ()">lt_db_set_datadir</a>                   (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="liblangtag-Database.description"></a><h2>Description</h2>
<p>
This section describes convenient functions to obtain the database instance.
</p>
</div>
<div class="refsect1">
<a name="liblangtag-Database.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="lt-db-finalize"></a><h3>lt_db_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                lt_db_finalize                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Decreases the reference count of the language tags database, which was
increased with <a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-get-datadir"></a><h3>lt_db_get_datadir ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        lt_db_get_datadir                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Obtain the directory where database files are installed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the directory name.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-get-extlang"></a><h3>lt_db_get_extlang ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Database---Extlang.html#lt-extlang-db-t" title="lt_extlang_db_t"><span class="returnvalue">lt_extlang_db_t</span></a> *   lt_db_get_extlang                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Obtains the instance of <a class="link" href="liblangtag-Database---Extlang.html#lt-extlang-db-t" title="lt_extlang_db_t"><span class="type">lt_extlang_db_t</span></a>. This still allows to use without
<a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a>. but it will takes some time to load the database on
the memory every time.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The instance of <a class="link" href="liblangtag-Database---Extlang.html#lt-extlang-db-t" title="lt_extlang_db_t"><span class="type">lt_extlang_db_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-get-grandfathered"></a><h3>lt_db_get_grandfathered ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Database---Grandfathered.html#lt-grandfathered-db-t" title="lt_grandfathered_db_t"><span class="returnvalue">lt_grandfathered_db_t</span></a> * lt_db_get_grandfathered         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Obtains the instance of <a class="link" href="liblangtag-Database---Grandfathered.html#lt-grandfathered-db-t" title="lt_grandfathered_db_t"><span class="type">lt_grandfathered_db_t</span></a>. This still allows to use
without <a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a>. but it will takes some time to load the database
on the memory every time.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The instance of <a class="link" href="liblangtag-Database---Grandfathered.html#lt-grandfathered-db-t" title="lt_grandfathered_db_t"><span class="type">lt_grandfathered_db_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-get-lang"></a><h3>lt_db_get_lang ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Database---Language.html#lt-lang-db-t" title="lt_lang_db_t"><span class="returnvalue">lt_lang_db_t</span></a> *      lt_db_get_lang                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Obtains the instance of <a class="link" href="liblangtag-Database---Language.html#lt-lang-db-t" title="lt_lang_db_t"><span class="type">lt_lang_db_t</span></a>. This still allows to use without
<a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a>. but it will takes some time to load the database on
the memory every time.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The instance of <a class="link" href="liblangtag-Database---Language.html#lt-lang-db-t" title="lt_lang_db_t"><span class="type">lt_lang_db_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-get-redundant"></a><h3>lt_db_get_redundant ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Database---Redundant.html#lt-redundant-db-t" title="lt_redundant_db_t"><span class="returnvalue">lt_redundant_db_t</span></a> * lt_db_get_redundant                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Obtains the instance of <a class="link" href="liblangtag-Database---Redundant.html#lt-redundant-db-t" title="lt_redundant_db_t"><span class="type">lt_redundant_db_t</span></a>. This still allows to use
without <a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a>. but it will takes some time to load the database
on the memory every time.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The instance of <a class="link" href="liblangtag-Database---Redundant.html#lt-redundant-db-t" title="lt_redundant_db_t"><span class="type">lt_redundant_db_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-get-region"></a><h3>lt_db_get_region ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Database---Region.html#lt-region-db-t" title="lt_region_db_t"><span class="returnvalue">lt_region_db_t</span></a> *    lt_db_get_region                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Obtains the instance of <a class="link" href="liblangtag-Database---Region.html#lt-region-db-t" title="lt_region_db_t"><span class="type">lt_region_db_t</span></a>. This still allows to use without
<a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a>. but it will takes some time to load the database on
the memory every time.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The instance of <a class="link" href="liblangtag-Database---Region.html#lt-region-db-t" title="lt_region_db_t"><span class="type">lt_region_db_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-get-script"></a><h3>lt_db_get_script ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Database---Script.html#lt-script-db-t" title="lt_script_db_t"><span class="returnvalue">lt_script_db_t</span></a> *    lt_db_get_script                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Obtains the instance of <a class="link" href="liblangtag-Database---Script.html#lt-script-db-t" title="lt_script_db_t"><span class="type">lt_script_db_t</span></a>. This still allows to use without
<a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a>. but it will takes some time to load the database on
the memory every time.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The instance of <a class="link" href="liblangtag-Database---Script.html#lt-script-db-t" title="lt_script_db_t"><span class="type">lt_script_db_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-get-variant"></a><h3>lt_db_get_variant ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Database---Variant.html#lt-variant-db-t" title="lt_variant_db_t"><span class="returnvalue">lt_variant_db_t</span></a> *   lt_db_get_variant                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Obtains the instance of <a class="link" href="liblangtag-Database---Variant.html#lt-variant-db-t" title="lt_variant_db_t"><span class="type">lt_variant_db_t</span></a>. This still allows to use without
<a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a>. but it will takes some time to load the database on
the memory every time.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The instance of <a class="link" href="liblangtag-Database---Variant.html#lt-variant-db-t" title="lt_variant_db_t"><span class="type">lt_variant_db_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-initialize"></a><h3>lt_db_initialize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                lt_db_initialize                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initialize all of the language tags database instance.
</p>
</div>
<hr>
<div class="refsect2">
<a name="lt-db-set-datadir"></a><h3>lt_db_set_datadir ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                lt_db_set_datadir                   (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
<p>
Set <em class="parameter"><code>path</code></em> as the default location of the database files.
This has to be called before <a class="link" href="liblangtag-Database.html#lt-db-initialize" title="lt_db_initialize ()"><code class="function">lt_db_initialize()</code></a> or any
initialization for each databases.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the directory where database files are installed.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>