diff options
Diffstat (limited to 'docs/html/raptor2-section-general.html')
| -rw-r--r-- | docs/html/raptor2-section-general.html | 1496 |
1 files changed, 1496 insertions, 0 deletions
diff --git a/docs/html/raptor2-section-general.html b/docs/html/raptor2-section-general.html new file mode 100644 index 0000000..8903e5d --- /dev/null +++ b/docs/html/raptor2-section-general.html @@ -0,0 +1,1496 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>section-general: Raptor RDF Syntax Library Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="Raptor RDF Syntax Library Manual"> +<link rel="up" href="reference-manual.html" title="Part II. Raptor Reference Manual"> +<link rel="prev" href="raptor2-section-world.html" title="section-world"> +<link rel="next" href="raptor2-section-memory.html" title="section-memory"> +<meta name="generator" content="GTK-Doc V1.33.1 (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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#raptor2-section-general.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="raptor2-section-world.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="raptor2-section-memory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="raptor2-section-general"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="raptor2-section-general.top_of_page"></a>section-general</span></h2> +<p>section-general</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="raptor2-section-general.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-statement-handler" title="raptor_statement_handler ()">*raptor_statement_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-general.html#raptor-snprintf" title="raptor_snprintf ()">raptor_snprintf</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-general.html#raptor-vasprintf" title="raptor_vasprintf ()">raptor_vasprintf</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-general.html#raptor-vsnprintf" title="raptor_vsnprintf ()">raptor_vsnprintf</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-general.html#raptor-vsnprintf2" title="raptor_vsnprintf2 ()">raptor_vsnprintf2</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-general.html#raptor-sort-r" title="raptor_sort_r ()">raptor_sort_r</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-log-handler" title="raptor_log_handler ()">*raptor_log_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-general.html#raptor-log-level-get-label" title="raptor_log_level_get_label ()">raptor_log_level_get_label</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-general.html#raptor-domain-get-label" title="raptor_domain_get_label ()">raptor_domain_get_label</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-data-compare-handler" title="raptor_data_compare_handler ()">*raptor_data_compare_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-data-compare-arg-handler" title="raptor_data_compare_arg_handler ()">*raptor_data_compare_arg_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-data-context-free-handler" title="raptor_data_context_free_handler ()">*raptor_data_context_free_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-data-context-print-handler" title="raptor_data_context_print_handler ()">*raptor_data_context_print_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-data-free-handler" title="raptor_data_free_handler ()">*raptor_data_free_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> * +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-data-malloc-handler" title="raptor_data_malloc_handler ()">*raptor_data_malloc_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-data-print-handler" title="raptor_data_print_handler ()">*raptor_data_print_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="raptor2-section-general.html#raptor-generate-bnodeid-handler" title="raptor_generate_bnodeid_handler ()">*raptor_generate_bnodeid_handler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="raptor2-section-general.html#raptor-syntax-description-validate" title="raptor_syntax_description_validate ()">raptor_syntax_description_validate</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="raptor2-section-general.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#RAPTOR-VERSION:CAPS" title="RAPTOR_VERSION">RAPTOR_VERSION</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#RAPTOR-VERSION-MAJOR:CAPS" title="RAPTOR_VERSION_MAJOR">RAPTOR_VERSION_MAJOR</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#RAPTOR-VERSION-MINOR:CAPS" title="RAPTOR_VERSION_MINOR">RAPTOR_VERSION_MINOR</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#RAPTOR-VERSION-RELEASE:CAPS" title="RAPTOR_VERSION_RELEASE">RAPTOR_VERSION_RELEASE</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#RAPTOR-VERSION-STRING:CAPS" title="RAPTOR_VERSION_STRING">RAPTOR_VERSION_STRING</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned int </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-version-major" title="raptor_version_major">raptor_version_major</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned int </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-version-minor" title="raptor_version_minor">raptor_version_minor</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned int </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-version-release" title="raptor_version_release">raptor_version_release</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned int </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-version-decimal" title="raptor_version_decimal">raptor_version_decimal</a></td> +</tr> +<tr> +<td class="variable_type">extern const char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-copyright-string" title="raptor_copyright_string">raptor_copyright_string</a></td> +</tr> +<tr> +<td class="variable_type">extern const char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-home-url-string" title="raptor_home_url_string">raptor_home_url_string</a></td> +</tr> +<tr> +<td class="variable_type">extern const char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-license-string" title="raptor_license_string">raptor_license_string</a></td> +</tr> +<tr> +<td class="variable_type">extern const char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-short-copyright-string" title="raptor_short_copyright_string">raptor_short_copyright_string</a></td> +</tr> +<tr> +<td class="variable_type">extern const char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-version-string" title="raptor_version_string">raptor_version_string</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-owl-namespace-uri" title="raptor_owl_namespace_uri">raptor_owl_namespace_uri</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-rdf-namespace-uri" title="raptor_rdf_namespace_uri">raptor_rdf_namespace_uri</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-rdf-schema-namespace-uri" title="raptor_rdf_schema_namespace_uri">raptor_rdf_schema_namespace_uri</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-xml-literal-datatype-uri-string" title="raptor_xml_literal_datatype_uri_string">raptor_xml_literal_datatype_uri_string</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-xml-namespace-uri" title="raptor_xml_namespace_uri">raptor_xml_namespace_uri</a></td> +</tr> +<tr> +<td class="variable_type">extern const unsigned char * const </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-xmlschema-datatypes-namespace-uri" title="raptor_xmlschema_datatypes_namespace_uri">raptor_xmlschema_datatypes_namespace_uri</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-log-message" title="raptor_log_message">raptor_log_message</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-log-level" title="enum raptor_log_level">raptor_log_level</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-domain" title="enum raptor_domain">raptor_domain</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-syntax-bitflags" title="enum raptor_syntax_bitflags">raptor_syntax_bitflags</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-syntax-description" title="raptor_syntax_description">raptor_syntax_description</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="raptor2-section-general.html#raptor-type-q" title="raptor_type_q">raptor_type_q</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="raptor2-section-general.description"></a><h2>Description</h2> +</div> +<div class="refsect1"> +<a name="raptor2-section-general.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="raptor-statement-handler"></a><h3>raptor_statement_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*raptor_statement_handler<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>, + <em class="parameter"><code><a class="link" href="raptor2-section-triples.html#raptor-statement" title="raptor_statement"><span class="type">raptor_statement</span></a> *statement</code></em>);</pre> +<p>Statement (triple) reporting handler function.</p> +<p>This handler function set with +<a class="link" href="raptor2-section-parser.html#raptor-parser-set-statement-handler" title="raptor_parser_set_statement_handler ()"><code class="function">raptor_parser_set_statement_handler()</code></a> on a parser receives +statements as the parsing proceeds. The <em class="parameter"><code>statement</code></em> + argument to the +handler is shared and must be copied by the caller with +<a class="link" href="raptor2-section-triples.html#raptor-statement-copy" title="raptor_statement_copy ()"><code class="function">raptor_statement_copy()</code></a>.</p> +<div class="refsect3"> +<a name="raptor-statement-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>statement</p></td> +<td class="parameter_description"><p>statement to report</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-snprintf"></a><h3>raptor_snprintf ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_snprintf (<em class="parameter"><code><span class="type">char</span> *buffer</code></em>, + <em class="parameter"><code><span class="type">size_t</span> size</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *format</code></em>, + <em class="parameter"><code>...</code></em>);</pre> +<p>Format output into an allocated sized buffer</p> +<p>This provides a portable version <code class="function">snprintf()</code> over variants on +different systems.</p> +<p>If <em class="parameter"><code>buffer</code></em> + is NULL, calculates the number of bytes needed to +allocate for buffer and do no formatting.</p> +<div class="refsect3"> +<a name="raptor-snprintf.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>buffer</p></td> +<td class="parameter_description"><p>buffer (or NULL)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>bufer size (or 0)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>printf-style format string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>...</p></td> +<td class="parameter_description"><p>format arguments</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-snprintf.returns"></a><h4>Returns</h4> +<p> number of bytes allocated (excluding NUL) or 0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-vasprintf"></a><h3>raptor_vasprintf ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_vasprintf (<em class="parameter"><code><span class="type">char</span> **ret</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *format</code></em>, + <em class="parameter"><code><span class="type">va_list</span> arguments</code></em>);</pre> +<p>Format output into a new buffer and return it</p> +<p>This is a wrapper around the (GNU) vasprintf function that is not +always avaiable.</p> +<div class="refsect3"> +<a name="raptor-vasprintf.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>ret</p></td> +<td class="parameter_description"><p>pointer to store buffer</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>printf-style format string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arguments</p></td> +<td class="parameter_description"><p>format arguments list</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-vasprintf.returns"></a><h4>Returns</h4> +<p> number of bytes allocated (excluding NUL) or < 0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-vsnprintf"></a><h3>raptor_vsnprintf ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +raptor_vsnprintf (<em class="parameter"><code>const <span class="type">char</span> *format</code></em>, + <em class="parameter"><code><span class="type">va_list</span> arguments</code></em>);</pre> +<div class="warning"><p><code class="literal">raptor_vsnprintf</code> is deprecated and should not be used in newly-written code.</p></div> +<p>Format output for a variable arguments list into a newly allocated buffer</p> +<p><em class="parameter"><code>Deprecated</code></em> +: This does not actually conform to vsnprintf's calling +convention and does not return the allocated buffer length. Use +<a class="link" href="raptor2-section-general.html#raptor-vsnprintf2" title="raptor_vsnprintf2 ()"><code class="function">raptor_vsnprintf2()</code></a> or <a class="link" href="raptor2-section-general.html#raptor-vasprintf" title="raptor_vasprintf ()"><code class="function">raptor_vasprintf()</code></a> instead.</p> +<div class="refsect3"> +<a name="raptor-vsnprintf.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>printf-style format string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arguments</p></td> +<td class="parameter_description"><p>variable arguments list</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-vsnprintf.returns"></a><h4>Returns</h4> +<p> a newly allocated string as the formatted result or NULL on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-vsnprintf2"></a><h3>raptor_vsnprintf2 ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_vsnprintf2 (<em class="parameter"><code><span class="type">char</span> *buffer</code></em>, + <em class="parameter"><code><span class="type">size_t</span> size</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *format</code></em>, + <em class="parameter"><code><span class="type">va_list</span> arguments</code></em>);</pre> +<p>Format output for a variable arguments list into an allocated sized buffer.</p> +<p>This is a wrapper around system versions of vsnprintf with +different call and return conventions.</p> +<p>If <em class="parameter"><code>buffer</code></em> + is NULL or size is 0 or the buffer size is too small, +returns the number of bytes that would be needed for buffer</p> +<div class="refsect3"> +<a name="raptor-vsnprintf2.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>buffer</p></td> +<td class="parameter_description"><p>buffer (or NULL)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>size of buffer (or 0)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>printf-style format string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arguments</p></td> +<td class="parameter_description"><p>variable arguments list</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-vsnprintf2.returns"></a><h4>Returns</h4> +<p> number of bytes allocated (excluding NUL) or <0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-sort-r"></a><h3>raptor_sort_r ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +raptor_sort_r (<em class="parameter"><code><span class="type">void</span> *base</code></em>, + <em class="parameter"><code><span class="type">size_t</span> nel</code></em>, + <em class="parameter"><code><span class="type">size_t</span> width</code></em>, + <em class="parameter"><code><a class="link" href="raptor2-section-general.html#raptor-data-compare-arg-handler" title="raptor_data_compare_arg_handler ()"><span class="type">raptor_data_compare_arg_handler</span></a> compar</code></em>, + <em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre> +<p>Sort an array with an extra user data arg for the comparison funciton.</p> +<p>Sorts data at <em class="parameter"><code>base</code></em> + of <em class="parameter"><code>nel</code></em> + elememnts of width <em class="parameter"><code>width</code></em> + using +comparison function <em class="parameter"><code>comp</code></em> + that takes args (void* data1, void* +data2, <em class="parameter"><code>user_data</code></em> +) and returns <0, 0, or >0 for object comparison.</p> +<div class="refsect3"> +<a name="raptor-sort-r.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>base</p></td> +<td class="parameter_description"><p>the array to be sorted</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>nel</p></td> +<td class="parameter_description"><p>the number of elements in the array</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>the size in bytes of each element of the array</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>compar</p></td> +<td class="parameter_description"><p>comparison function</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>a pointer to be passed to the comparison function</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-log-handler"></a><h3>raptor_log_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*raptor_log_handler<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>, + <em class="parameter"><code><a class="link" href="raptor2-section-general.html#raptor-log-message" title="raptor_log_message"><span class="type">raptor_log_message</span></a> *message</code></em>);</pre> +<p>Handler function for log messages with location</p> +<p>Used during parsing and serializing for errors and warnings that +may include location information. Handlers may be set +by <a class="link" href="raptor2-section-world.html#raptor-world-set-log-handler" title="raptor_world_set_log_handler ()"><code class="function">raptor_world_set_log_handler()</code></a>.</p> +<div class="refsect3"> +<a name="raptor-log-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>message</p></td> +<td class="parameter_description"><p>log message</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-log-level-get-label"></a><h3>raptor_log_level_get_label ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +raptor_log_level_get_label (<em class="parameter"><code><a class="link" href="raptor2-section-general.html#raptor-log-level" title="enum raptor_log_level"><span class="type">raptor_log_level</span></a> level</code></em>);</pre> +<p>Get label for a log message level</p> +<div class="refsect3"> +<a name="raptor-log-level-get-label.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>level</p></td> +<td class="parameter_description"><p>log message level</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-log-level-get-label.returns"></a><h4>Returns</h4> +<p> label string or NULL if level is not valid</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-domain-get-label"></a><h3>raptor_domain_get_label ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +raptor_domain_get_label (<em class="parameter"><code><a class="link" href="raptor2-section-general.html#raptor-domain" title="enum raptor_domain"><span class="type">raptor_domain</span></a> domain</code></em>);</pre> +<p>Get label for a domain</p> +<div class="refsect3"> +<a name="raptor-domain-get-label.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>domain</p></td> +<td class="parameter_description"><p>domain</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-domain-get-label.returns"></a><h4>Returns</h4> +<p> label string or NULL if domain is not valid</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-data-compare-handler"></a><h3>raptor_data_compare_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +<span class="c_punctuation">(</span>*raptor_data_compare_handler<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">void</span> *data1</code></em>, + <em class="parameter"><code>const <span class="type">void</span> *data2</code></em>);</pre> +<p>Function to compare two data objects - signature like <code class="function">strcmp()</code> and function pssed to <code class="function">qsort()</code></p> +<p>Designed to be passed into generic data structure constructors +like <a class="link" href="raptor2-section-avltree.html#raptor-new-avltree" title="raptor_new_avltree ()"><code class="function">raptor_new_avltree()</code></a>.</p> +<div class="refsect3"> +<a name="raptor-data-compare-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>data1</p></td> +<td class="parameter_description"><p>first data object</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data2</p></td> +<td class="parameter_description"><p>second data object</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-data-compare-handler.returns"></a><h4>Returns</h4> +<p> compare value <0 if <em class="parameter"><code>data1</code></em> +is before <em class="parameter"><code>data2</code></em> +, =0 if equal, >0 if <em class="parameter"><code>data1</code></em> +is after <em class="parameter"><code>data2</code></em> +</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-data-compare-arg-handler"></a><h3>raptor_data_compare_arg_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +<span class="c_punctuation">(</span>*raptor_data_compare_arg_handler<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">void</span> *data1</code></em>, + <em class="parameter"><code>const <span class="type">void</span> *data2</code></em>, + <em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre> +<p>Function to compare two data objects with a user data argument</p> +<p>Designed to be used with <a class="link" href="raptor2-section-general.html#raptor-sort-r" title="raptor_sort_r ()"><code class="function">raptor_sort_r()</code></a> and compatible functions +such as <a class="link" href="raptor2-section-sequence.html#raptor-sequence-sort-r" title="raptor_sequence_sort_r ()"><code class="function">raptor_sequence_sort_r()</code></a> which uses it.</p> +<div class="refsect3"> +<a name="raptor-data-compare-arg-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>data1</p></td> +<td class="parameter_description"><p>first object</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data2</p></td> +<td class="parameter_description"><p>second object</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data argument</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-data-compare-arg-handler.returns"></a><h4>Returns</h4> +<p> compare value <0 if <em class="parameter"><code>data1</code></em> +is before <em class="parameter"><code>data2</code></em> +, =0 if equal, >0 if <em class="parameter"><code>data1</code></em> +is after <em class="parameter"><code>data2</code></em> +</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-data-context-free-handler"></a><h3>raptor_data_context_free_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*raptor_data_context_free_handler<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *context</code></em>, + <em class="parameter"><code><span class="type">void</span> *object</code></em>);</pre> +<p>Handler function for freeing a sequence item with a contextual pointer.</p> +<p>Set by <a class="link" href="raptor2-section-sequence.html#raptor-new-sequence-with-context" title="raptor_new_sequence_with_context ()"><code class="function">raptor_new_sequence_with_context()</code></a>.</p> +<div class="refsect3"> +<a name="raptor-data-context-free-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>context</p></td> +<td class="parameter_description"><p>context data for the free function</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>object to free</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-data-context-print-handler"></a><h3>raptor_data_context_print_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +<span class="c_punctuation">(</span>*raptor_data_context_print_handler<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *context</code></em>, + <em class="parameter"><code><span class="type">void</span> *object</code></em>, + <em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);</pre> +<p>Function function for printing an object with data context to a stream.</p> +<p>Set by <a class="link" href="raptor2-section-sequence.html#raptor-new-sequence-with-context" title="raptor_new_sequence_with_context ()"><code class="function">raptor_new_sequence_with_context()</code></a></p> +<div class="refsect3"> +<a name="raptor-data-context-print-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>context</p></td> +<td class="parameter_description"><p>context data for the print function</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>object to print</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>fh</p></td> +<td class="parameter_description"><p>FILE* to print to</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-data-context-print-handler.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-data-free-handler"></a><h3>raptor_data_free_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*raptor_data_free_handler<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre> +<p>Typedef for function to free a data object - signature like <code class="function">free()</code></p> +<p>Designed to be passed into generic data structure constructors +like <a class="link" href="raptor2-section-avltree.html#raptor-new-avltree" title="raptor_new_avltree ()"><code class="function">raptor_new_avltree()</code></a>. If <em class="parameter"><code>data</code></em> + is NULL, nothing should be done.</p> +<div class="refsect3"> +<a name="raptor-data-free-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>data object or NULL</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-data-malloc-handler"></a><h3>raptor_data_malloc_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> * +<span class="c_punctuation">(</span>*raptor_data_malloc_handler<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">size_t</span> size</code></em>);</pre> +<p>Typedef for a function to allocate memory - signature like <code class="function">malloc()</code></p> +<p>Designed to be passed into constructors +like raptor_www_fetch_to_string</p> +<div class="refsect3"> +<a name="raptor-data-malloc-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>data size</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-data-malloc-handler.returns"></a><h4>Returns</h4> +<p> pointer to newly allocated memory or NULL on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-data-print-handler"></a><h3>raptor_data_print_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +<span class="c_punctuation">(</span>*raptor_data_print_handler<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *object</code></em>, + <em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);</pre> +<p>Handler function for printing an object to a stream.</p> +<p>Set by <a class="link" href="raptor2-section-sequence.html#raptor-new-sequence" title="raptor_new_sequence ()"><code class="function">raptor_new_sequence()</code></a></p> +<div class="refsect3"> +<a name="raptor-data-print-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>object to print</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>fh</p></td> +<td class="parameter_description"><p>FILE* to print to</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-data-print-handler.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-generate-bnodeid-handler"></a><h3>raptor_generate_bnodeid_handler ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +<span class="c_punctuation">(</span>*raptor_generate_bnodeid_handler<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>, + <em class="parameter"><code>unsigned <span class="type">char</span> *user_bnodeid</code></em>);</pre> +<p>Generate a blank node identifier handler function.</p> +<div class="refsect3"> +<a name="raptor-generate-bnodeid-handler.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_bnodeid</p></td> +<td class="parameter_description"><p>a user-specified ID or NULL if none available.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-generate-bnodeid-handler.returns"></a><h4>Returns</h4> +<p> new blank node ID to use</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-syntax-description-validate"></a><h3>raptor_syntax_description_validate ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +raptor_syntax_description_validate (<em class="parameter"><code><a class="link" href="raptor2-section-general.html#raptor-syntax-description" title="raptor_syntax_description"><span class="type">raptor_syntax_description</span></a> *desc</code></em>);</pre> +<p>Validate a syntax description has the required fields (name, labels) and update counts</p> +<div class="refsect3"> +<a name="raptor-syntax-description-validate.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>desc</p></td> +<td class="parameter_description"><p>description</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="raptor-syntax-description-validate.returns"></a><h4>Returns</h4> +<p> non-0 on failure</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="raptor2-section-general.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="RAPTOR-VERSION:CAPS"></a><h3>RAPTOR_VERSION</h3> +<pre class="programlisting">#define RAPTOR_VERSION 20016 +</pre> +<p>Raptor library version number</p> +<p>Format: major * 10000 + minor * 100 + release</p> +</div> +<hr> +<div class="refsect2"> +<a name="RAPTOR-VERSION-MAJOR:CAPS"></a><h3>RAPTOR_VERSION_MAJOR</h3> +<pre class="programlisting">#define RAPTOR_VERSION_MAJOR 2 +</pre> +<p>Raptor library major version</p> +</div> +<hr> +<div class="refsect2"> +<a name="RAPTOR-VERSION-MINOR:CAPS"></a><h3>RAPTOR_VERSION_MINOR</h3> +<pre class="programlisting">#define RAPTOR_VERSION_MINOR 0 +</pre> +<p>Raptor library minor version</p> +</div> +<hr> +<div class="refsect2"> +<a name="RAPTOR-VERSION-RELEASE:CAPS"></a><h3>RAPTOR_VERSION_RELEASE</h3> +<pre class="programlisting">#define RAPTOR_VERSION_RELEASE 16 +</pre> +<p>Raptor library release</p> +</div> +<hr> +<div class="refsect2"> +<a name="RAPTOR-VERSION-STRING:CAPS"></a><h3>RAPTOR_VERSION_STRING</h3> +<pre class="programlisting">#define RAPTOR_VERSION_STRING "2.0.16" +</pre> +<p>Raptor library version string</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-version-major"></a><h3>raptor_version_major</h3> +<pre class="programlisting">extern const unsigned int raptor_version_major; +</pre> +<p>Library major version number as a decimal integer.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-version-minor"></a><h3>raptor_version_minor</h3> +<pre class="programlisting">extern const unsigned int raptor_version_minor; +</pre> +<p>Library minor version number as a decimal integer.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-version-release"></a><h3>raptor_version_release</h3> +<pre class="programlisting">extern const unsigned int raptor_version_release; +</pre> +<p>Library release version number as a decimal integer.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-version-decimal"></a><h3>raptor_version_decimal</h3> +<pre class="programlisting">extern const unsigned int raptor_version_decimal; +</pre> +<p>Library full version as a decimal integer.</p> +<p>See also <a class="link" href="raptor2-section-general.html#raptor-version-string" title="raptor_version_string"><span class="type">raptor_version_string</span></a>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-copyright-string"></a><h3>raptor_copyright_string</h3> +<pre class="programlisting">extern const char * const raptor_copyright_string; +</pre> +<p>Copyright string (multiple lines).</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-home-url-string"></a><h3>raptor_home_url_string</h3> +<pre class="programlisting">extern const char * const raptor_home_url_string; +</pre> +<p>Raptor home page URL.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-license-string"></a><h3>raptor_license_string</h3> +<pre class="programlisting">extern const char * const raptor_license_string; +</pre> +<p>Raptor license string.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-short-copyright-string"></a><h3>raptor_short_copyright_string</h3> +<pre class="programlisting">extern const char * const raptor_short_copyright_string; +</pre> +<p>Short copyright string (one line).</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-version-string"></a><h3>raptor_version_string</h3> +<pre class="programlisting">extern const char * const raptor_version_string; +</pre> +<p>Library full version as a string.</p> +<p>See also <a class="link" href="raptor2-section-general.html#raptor-version-decimal" title="raptor_version_decimal"><span class="type">raptor_version_decimal</span></a>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-owl-namespace-uri"></a><h3>raptor_owl_namespace_uri</h3> +<pre class="programlisting">extern const unsigned char * const raptor_owl_namespace_uri; +</pre> +<p>OWL (owl:) Namespace URI string.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-rdf-namespace-uri"></a><h3>raptor_rdf_namespace_uri</h3> +<pre class="programlisting">extern const unsigned char * const raptor_rdf_namespace_uri; +</pre> +<p>RDF Namespace (rdf:) URI string.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-rdf-schema-namespace-uri"></a><h3>raptor_rdf_schema_namespace_uri</h3> +<pre class="programlisting">extern const unsigned char * const raptor_rdf_schema_namespace_uri; +</pre> +<p>RDF Schema (rdfs:) Namespace URI string.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-xml-literal-datatype-uri-string"></a><h3>raptor_xml_literal_datatype_uri_string</h3> +<pre class="programlisting">extern const unsigned char * const raptor_xml_literal_datatype_uri_string; +</pre> +<p>XML Literal datatype (rdf:XMLLiteral) URI string.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-xml-namespace-uri"></a><h3>raptor_xml_namespace_uri</h3> +<pre class="programlisting">extern const unsigned char * const raptor_xml_namespace_uri; +</pre> +<p>XML Namespace (xml:) URI string.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-xmlschema-datatypes-namespace-uri"></a><h3>raptor_xmlschema_datatypes_namespace_uri</h3> +<pre class="programlisting">extern const unsigned char * const raptor_xmlschema_datatypes_namespace_uri; +</pre> +<p>XML Schema datatypes (xsd:) namespace URI string.</p> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-log-message"></a><h3>raptor_log_message</h3> +<pre class="programlisting">typedef struct { + int code; + raptor_domain domain; + raptor_log_level level; + raptor_locator *locator; + const char *text; +} raptor_log_message; +</pre> +<p>Log message.</p> +<div class="refsect3"> +<a name="raptor-log-message.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="raptor-log-message.code"></a>code</code></em>;</p></td> +<td class="struct_member_description"><p>error code or < 0 if not used or known</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><a class="link" href="raptor2-section-general.html#raptor-domain" title="enum raptor_domain"><span class="type">raptor_domain</span></a> <em class="structfield"><code><a name="raptor-log-message.domain"></a>domain</code></em>;</p></td> +<td class="struct_member_description"><p>message domain or <a class="link" href="raptor2-section-general.html#RAPTOR-DOMAIN-NONE:CAPS"><span class="type">RAPTOR_DOMAIN_NONE</span></a> if not used or known</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><a class="link" href="raptor2-section-general.html#raptor-log-level" title="enum raptor_log_level"><span class="type">raptor_log_level</span></a> <em class="structfield"><code><a name="raptor-log-message.level"></a>level</code></em>;</p></td> +<td class="struct_member_description"><p>log message level</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><a class="link" href="raptor2-section-locator.html#raptor-locator" title="raptor_locator"><span class="type">raptor_locator</span></a> *<em class="structfield"><code><a name="raptor-log-message.locator"></a>locator</code></em>;</p></td> +<td class="struct_member_description"><p>location associated with message or NULL if not known</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="raptor-log-message.text"></a>text</code></em>;</p></td> +<td class="struct_member_description"><p>message string</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-log-level"></a><h3>enum raptor_log_level</h3> +<p>Log levels</p> +<div class="refsect3"> +<a name="raptor-log-level.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-LOG-LEVEL-NONE:CAPS"></a>RAPTOR_LOG_LEVEL_NONE</p></td> +<td class="enum_member_description"> +<p>Internal</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-LOG-LEVEL-TRACE:CAPS"></a>RAPTOR_LOG_LEVEL_TRACE</p></td> +<td class="enum_member_description"> +<p>very fine-grained tracing messages information</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-LOG-LEVEL-DEBUG:CAPS"></a>RAPTOR_LOG_LEVEL_DEBUG</p></td> +<td class="enum_member_description"> +<p>fine-grained tracing messages suitable for debugging</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-LOG-LEVEL-INFO:CAPS"></a>RAPTOR_LOG_LEVEL_INFO</p></td> +<td class="enum_member_description"> +<p>coarse-grained information messages</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-LOG-LEVEL-WARN:CAPS"></a>RAPTOR_LOG_LEVEL_WARN</p></td> +<td class="enum_member_description"> +<p>warning messages of potentially harmful problems</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-LOG-LEVEL-ERROR:CAPS"></a>RAPTOR_LOG_LEVEL_ERROR</p></td> +<td class="enum_member_description"> +<p>error messages where the application can continue</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-LOG-LEVEL-FATAL:CAPS"></a>RAPTOR_LOG_LEVEL_FATAL</p></td> +<td class="enum_member_description"> +<p>fatal error message where the application will likely abort</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-LOG-LEVEL-LAST:CAPS"></a>RAPTOR_LOG_LEVEL_LAST</p></td> +<td class="enum_member_description"> +<p>Internal</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-domain"></a><h3>enum raptor_domain</h3> +<p>Log domain</p> +<div class="refsect3"> +<a name="raptor-domain.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-NONE:CAPS"></a>RAPTOR_DOMAIN_NONE</p></td> +<td class="enum_member_description"> +<p>Internal</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-IOSTREAM:CAPS"></a>RAPTOR_DOMAIN_IOSTREAM</p></td> +<td class="enum_member_description"> +<p>I/O stream</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-NAMESPACE:CAPS"></a>RAPTOR_DOMAIN_NAMESPACE</p></td> +<td class="enum_member_description"> +<p>XML Namespace / namespace stack</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-PARSER:CAPS"></a>RAPTOR_DOMAIN_PARSER</p></td> +<td class="enum_member_description"> +<p>RDF Parser</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-QNAME:CAPS"></a>RAPTOR_DOMAIN_QNAME</p></td> +<td class="enum_member_description"> +<p>XML QName</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-SAX2:CAPS"></a>RAPTOR_DOMAIN_SAX2</p></td> +<td class="enum_member_description"> +<p>XML SAX2</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-SERIALIZER:CAPS"></a>RAPTOR_DOMAIN_SERIALIZER</p></td> +<td class="enum_member_description"> +<p>RDF Serializer</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-TERM:CAPS"></a>RAPTOR_DOMAIN_TERM</p></td> +<td class="enum_member_description"> +<p>RDF Term</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-TURTLE-WRITER:CAPS"></a>RAPTOR_DOMAIN_TURTLE_WRITER</p></td> +<td class="enum_member_description"> +<p>Turtle Writer</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-URI:CAPS"></a>RAPTOR_DOMAIN_URI</p></td> +<td class="enum_member_description"> +<p>RDF Uri</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-WORLD:CAPS"></a>RAPTOR_DOMAIN_WORLD</p></td> +<td class="enum_member_description"> +<p>RDF world</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-WWW:CAPS"></a>RAPTOR_DOMAIN_WWW</p></td> +<td class="enum_member_description"> +<p>WWW</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-XML-WRITER:CAPS"></a>RAPTOR_DOMAIN_XML_WRITER</p></td> +<td class="enum_member_description"> +<p>XML Writer</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="RAPTOR-DOMAIN-LAST:CAPS"></a>RAPTOR_DOMAIN_LAST</p></td> +<td class="enum_member_description"> +<p>Internal</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-syntax-bitflags"></a><h3>enum raptor_syntax_bitflags</h3> +<p>Bit flags for <a class="link" href="raptor2-section-general.html#raptor-syntax-description" title="raptor_syntax_description"><span class="type">raptor_syntax_description</span></a> flags field</p> +<div class="refsect3"> +<a name="raptor-syntax-bitflags.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody><tr> +<td class="enum_member_name"><p><a name="RAPTOR-SYNTAX-NEED-BASE-URI:CAPS"></a>RAPTOR_SYNTAX_NEED_BASE_URI</p></td> +<td class="enum_member_description"> +<p>the syntax requires a base URI</p> +</td> +<td class="enum_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-syntax-description"></a><h3>raptor_syntax_description</h3> +<pre class="programlisting">typedef struct { + const char* names; + unsigned int names_count; + + const char* label; + + const raptor_type_q* mime_types; + unsigned int mime_types_count; + + const char* uri_strings; + unsigned int uri_strings_count; + + unsigned int flags; +} raptor_syntax_description; +</pre> +<p>Description of a syntax or file format.</p> +<div class="refsect3"> +<a name="raptor-syntax-description.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="raptor-syntax-description.names"></a>names</code></em>;</p></td> +<td class="struct_member_description"><p>array of syntax names - the first one (required) is the public name, the rest are aliases. The array is NULL terminated.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>unsigned <span class="type">int</span> <em class="structfield"><code><a name="raptor-syntax-description.names-count"></a>names_count</code></em>;</p></td> +<td class="struct_member_description"><p>size of <em class="parameter"><code>names</code></em> +array</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="raptor-syntax-description.label"></a>label</code></em>;</p></td> +<td class="struct_member_description"><p>long descriptive label for syntax</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>const <a class="link" href="raptor2-section-general.html#raptor-type-q" title="raptor_type_q"><span class="type">raptor_type_q</span></a> *<em class="structfield"><code><a name="raptor-syntax-description.mime-types"></a>mime_types</code></em>;</p></td> +<td class="struct_member_description"><p>Array of (MIME type, Q) values associated with the syntax (or NULL). If present the array is NULL terminated.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>unsigned <span class="type">int</span> <em class="structfield"><code><a name="raptor-syntax-description.mime-types-count"></a>mime_types_count</code></em>;</p></td> +<td class="struct_member_description"><p>size of <em class="parameter"><code>mime_types</code></em> +array</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="raptor-syntax-description.uri-strings"></a>uri_strings</code></em>;</p></td> +<td class="struct_member_description"><p>array of URIs identifying the syntax (or NULL). The first one if present is the main URI, the rest are aliases. The array is NULL terminated.</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>unsigned <span class="type">int</span> <em class="structfield"><code><a name="raptor-syntax-description.uri-strings-count"></a>uri_strings_count</code></em>;</p></td> +<td class="struct_member_description"><p>size of <em class="parameter"><code>uri_strings</code></em> +array</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>unsigned <span class="type">int</span> <em class="structfield"><code><a name="raptor-syntax-description.flags"></a>flags</code></em>;</p></td> +<td class="struct_member_description"><p>See <a class="link" href="raptor2-section-general.html#raptor-syntax-bitflags" title="enum raptor_syntax_bitflags"><span class="type">raptor_syntax_bitflags</span></a> for the bits</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="raptor-type-q"></a><h3>raptor_type_q</h3> +<pre class="programlisting">typedef struct { + const char* mime_type; + size_t mime_type_len; + unsigned char q; +} raptor_type_q; +</pre> +<p>(MIME Type, Q) pair</p> +<div class="refsect3"> +<a name="raptor-type-q.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="raptor-type-q.mime-type"></a>mime_type</code></em>;</p></td> +<td class="struct_member_description"><p>MIME type string</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">size_t</span> <em class="structfield"><code><a name="raptor-type-q.mime-type-len"></a>mime_type_len</code></em>;</p></td> +<td class="struct_member_description"><p>length of <em class="parameter"><code>mime_type</code></em> +</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p>unsigned <span class="type">char</span> <em class="structfield"><code><a name="raptor-type-q.q"></a>q</code></em>;</p></td> +<td class="struct_member_description"><p>Q value 0-10 standing for decimal 0.0-1.0</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html>
\ No newline at end of file |