/usr/share/gtk-doc/html/raptor/raptor-section-locator.html is in libraptor1-doc 1.4.21-10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Locator</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Raptor RDF Syntax Parsing and Serializing Library Manual">
<link rel="up" href="reference-manual.html" title="Part II. Raptor Reference Manual">
<link rel="prev" href="raptor-section-iostream.html" title="I/O Stream">
<link rel="next" href="raptor-section-parser.html" title="Parser">
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="introduction.html" title="Raptor Overview">
<link rel="part" href="tutorial.html" title="Part I. Raptor Tutorial">
<link rel="chapter" href="tutorial-initialising-finishing.html" title="Initialising and Finishing using the Library">
<link rel="chapter" href="tutorial-querying-functionality.html" title="Listing built-in functionality">
<link rel="chapter" href="tutorial-parsing.html" title="Parsing syntaxes to RDF Triples">
<link rel="chapter" href="tutorial-serializing.html" title="Serializing RDF triples to a syntax">
<link rel="part" href="reference-manual.html" title="Part II. Raptor Reference Manual">
<link rel="chapter" href="raptor-parsers.html" title="Parsers in Raptor (syntax to triples)">
<link rel="chapter" href="raptor-serializers.html" title="Serializers in Raptor (triples to syntax)">
<link rel="index" href="ix01.html" title="Index">
</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="raptor-section-iostream.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="reference-manual.html"><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">Raptor RDF Syntax Parsing and Serializing Library Manual</th>
<td><a accesskey="n" href="raptor-section-parser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#raptor-section-locator.synopsis" class="shortcut">Top</a>
|
<a href="#raptor-section-locator.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Locator">
<a name="raptor-section-locator"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="raptor-section-locator.top_of_page"></a>Locator</span></h2>
<p>Locator — Location information for errors, warnings and messages.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="raptor-section-locator.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</a>;
<span class="returnvalue">void</span> <a class="link" href="raptor-section-locator.html#raptor-print-locator" title="raptor_print_locator ()">raptor_print_locator</a> (<span class="returnvalue">FILE</span> *stream,
<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);
<span class="returnvalue">int</span> <a class="link" href="raptor-section-locator.html#raptor-format-locator" title="raptor_format_locator ()">raptor_format_locator</a> (<span class="returnvalue">char</span> *buffer,
<span class="returnvalue">size_t</span> length,
<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);
<span class="returnvalue">int</span> <a class="link" href="raptor-section-locator.html#raptor-locator-line" title="raptor_locator_line ()">raptor_locator_line</a> (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);
<span class="returnvalue">int</span> <a class="link" href="raptor-section-locator.html#raptor-locator-column" title="raptor_locator_column ()">raptor_locator_column</a> (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);
<span class="returnvalue">int</span> <a class="link" href="raptor-section-locator.html#raptor-locator-byte" title="raptor_locator_byte ()">raptor_locator_byte</a> (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);
const <span class="returnvalue">char</span> * <a class="link" href="raptor-section-locator.html#raptor-locator-file" title="raptor_locator_file ()">raptor_locator_file</a> (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);
const <span class="returnvalue">char</span> * <a class="link" href="raptor-section-locator.html#raptor-locator-uri" title="raptor_locator_uri ()">raptor_locator_uri</a> (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="raptor-section-locator.description"></a><h2>Description</h2>
<p>
A small structure that can be optionally filled in when
errors, warnings or other messages are generated and returned
to user code.
</p>
</div>
<div class="refsect1" title="Details">
<a name="raptor-section-locator.details"></a><h2>Details</h2>
<div class="refsect2" title="raptor_locator">
<a name="raptor-locator"></a><h3>raptor_locator</h3>
<pre class="programlisting">typedef struct {
raptor_uri *uri;
const char *file;
int line;
int column;
int byte;
} raptor_locator;
</pre>
<p>
Location information for an error, warning or information message.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="type">raptor_uri</span></a> *<em class="structfield"><code><a name="raptor-locator.uri"></a>uri</code></em>;</span></p></td>
<td> URI of location (or NULL)
</td>
</tr>
<tr>
<td><p><span class="term">const <span class="type">char</span> *<em class="structfield"><code><a name="raptor-locator.file"></a>file</code></em>;</span></p></td>
<td> Filename of location (or NULL)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="raptor-locator.line"></a>line</code></em>;</span></p></td>
<td> Line number of location (or <0 for no line)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="raptor-locator.column"></a>column</code></em>;</span></p></td>
<td> Column number of location (or <0 for no column)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="raptor-locator.byte"></a>byte</code></em>;</span></p></td>
<td> Byte number of location (or <0 for no byte)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_print_locator ()">
<a name="raptor-print-locator"></a><h3>raptor_print_locator ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_print_locator (<span class="returnvalue">FILE</span> *stream,
<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);</pre>
<p>
Print a raptor locator to a stream.
</p>
<p>
<a class="link" href="raptor-section-world.html#raptor-init" title="raptor_init ()"><code class="function">raptor_init()</code></a> MUST have been called before calling this function.
Use <code class="function">raptor_print_locator_v2()</code> if using raptor_world APIs.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td> stream to print to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locator</code></em> :</span></p></td>
<td> <a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="type">raptor_locator</span></a> to print
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_format_locator ()">
<a name="raptor-format-locator"></a><h3>raptor_format_locator ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> raptor_format_locator (<span class="returnvalue">char</span> *buffer,
<span class="returnvalue">size_t</span> length,
<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);</pre>
<p>
Format a raptor locator as a string.
</p>
<p>
If buffer is NULL or length is insufficient for the size of
the locator, returns the number of additional bytes required
in the buffer to write the locator.
</p>
<p>
<a class="link" href="raptor-section-world.html#raptor-init" title="raptor_init ()"><code class="function">raptor_init()</code></a> MUST have been called before calling this function.
Use <code class="function">raptor_format_locator_v2()</code> if using raptor_world APIs.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td> buffer to store format
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td> size of buffer
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locator</code></em> :</span></p></td>
<td> <a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="type">raptor_locator</span></a> to format
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 0 on success, >0 if additional bytes required in buffer, <0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_locator_line ()">
<a name="raptor-locator-line"></a><h3>raptor_locator_line ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> raptor_locator_line (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);</pre>
<p>
Get line number from locator.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>locator</code></em> :</span></p></td>
<td> locator
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> integer line number, or -1 if there is no line number available
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_locator_column ()">
<a name="raptor-locator-column"></a><h3>raptor_locator_column ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> raptor_locator_column (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);</pre>
<p>
Get column number from locator.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>locator</code></em> :</span></p></td>
<td> locator
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> integer column number, or -1 if there is no column number available
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_locator_byte ()">
<a name="raptor-locator-byte"></a><h3>raptor_locator_byte ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> raptor_locator_byte (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);</pre>
<p>
Get the locator byte offset from locator.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>locator</code></em> :</span></p></td>
<td> locator
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> integer byte number, or -1 if there is no byte offset available
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_locator_file ()">
<a name="raptor-locator-file"></a><h3>raptor_locator_file ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * raptor_locator_file (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);</pre>
<p>
Get file name from locator.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>locator</code></em> :</span></p></td>
<td> locator
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> string file name, or NULL if there is no filename available
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_locator_uri ()">
<a name="raptor-locator-uri"></a><h3>raptor_locator_uri ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * raptor_locator_uri (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator"><span class="returnvalue">raptor_locator</span></a> *locator);</pre>
<p>
Get URI from locator.
</p>
<p>
Returns a pointer to a shared string version of the URI in
the locator. This must be copied if it is needed.
</p>
<p>
<a class="link" href="raptor-section-world.html#raptor-init" title="raptor_init ()"><code class="function">raptor_init()</code></a> MUST have been called before calling this function.
Use <code class="function">raptor_locator_uri_v2()</code> if using raptor_world APIs.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>locator</code></em> :</span></p></td>
<td> locator
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> string URI, or NULL if there is no URI available
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.13</div>
</body>
</html>
|