Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-05-07 23:32:53 +02:00
Code Issues Releases Wiki Activity
audacity/lib-src/libraptor/docs/html/raptor-section-locator.html
ra 58caf78a86 Move library tree where it belongs
2010-01-24 09:19:39 +00:00

322 lines
13 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.73.2">
<link rel="start" 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.10 (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"><nobr><a href="#raptor-section-locator.synopsis" class="shortcut">Top</a>
 | 
<a href="#raptor-section-locator.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<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">
<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>;
void <a class="link" href="raptor-section-locator.html#raptor-print-locator" title="raptor_print_locator ()">raptor_print_locator</a> (FILE *stream,
<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</a> *locator);
int <a class="link" href="raptor-section-locator.html#raptor-format-locator" title="raptor_format_locator ()">raptor_format_locator</a> (char *buffer,
size_t length,
<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</a> *locator);
int <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">raptor_locator</a> *locator);
int <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">raptor_locator</a> *locator);
int <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">raptor_locator</a> *locator);
const char* <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">raptor_locator</a> *locator);
const char* <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">raptor_locator</a> *locator);
</pre>
</div>
<div class="refsect1" lang="en">
<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" lang="en">
<a name="raptor-section-locator.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<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>
<p>
</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">raptor_uri</a> *<em class="structfield"><code>uri</code></em>;</span></p></td>
<td> URI of location (or NULL)
</td>
</tr>
<tr>
<td><p><span class="term">const char *<em class="structfield"><code>file</code></em>;</span></p></td>
<td> Filename of location (or NULL)
</td>
</tr>
<tr>
<td><p><span class="term">int <em class="structfield"><code>line</code></em>;</span></p></td>
<td> Line number of location (or &lt;0 for no line)
</td>
</tr>
<tr>
<td><p><span class="term">int <em class="structfield"><code>column</code></em>;</span></p></td>
<td> Column number of location (or &lt;0 for no column)
</td>
</tr>
<tr>
<td><p><span class="term">int <em class="structfield"><code>byte</code></em>;</span></p></td>
<td> Byte number of location (or &lt;0 for no byte)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="raptor-print-locator"></a><h3>raptor_print_locator ()</h3>
<pre class="programlisting">void raptor_print_locator (FILE *stream,
<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</a> *locator);</pre>
<p>
Print a raptor locator to a stream.</p>
<p>
</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" lang="en">
<a name="raptor-format-locator"></a><h3>raptor_format_locator ()</h3>
<pre class="programlisting">int raptor_format_locator (char *buffer,
size_t length,
<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</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>
</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, &gt;0 if additional bytes required in buffer, &lt;0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="raptor-locator-line"></a><h3>raptor_locator_line ()</h3>
<pre class="programlisting">int raptor_locator_line (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</a> *locator);</pre>
<p>
Get line number from locator.</p>
<p>
</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" lang="en">
<a name="raptor-locator-column"></a><h3>raptor_locator_column ()</h3>
<pre class="programlisting">int raptor_locator_column (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</a> *locator);</pre>
<p>
Get column number from locator.</p>
<p>
</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" lang="en">
<a name="raptor-locator-byte"></a><h3>raptor_locator_byte ()</h3>
<pre class="programlisting">int raptor_locator_byte (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</a> *locator);</pre>
<p>
Get the locator byte offset from locator.</p>
<p>
</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" lang="en">
<a name="raptor-locator-file"></a><h3>raptor_locator_file ()</h3>
<pre class="programlisting">const char* raptor_locator_file (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</a> *locator);</pre>
<p>
Get file name from locator.</p>
<p>
</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" lang="en">
<a name="raptor-locator-uri"></a><h3>raptor_locator_uri ()</h3>
<pre class="programlisting">const char* raptor_locator_uri (<a class="link" href="raptor-section-locator.html#raptor-locator" title="raptor_locator">raptor_locator</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>
</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.10</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink