Redland
view release on metacpan or search on metacpan
redland/raptor/docs/xml/section-xml.xml view on Meta::CPAN
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="raptor-section-xml">
<refmeta>
<refentrytitle role="top_of_page">XML</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RAPTOR Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>XML</refname>
<refpurpose>XML and XML Writer</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="raptor-xml-element">raptor_xml_element</link>;
<link linkend="raptor-xml-element">raptor_xml_element</link>* <link linkend="raptor-new-xml-element">raptor_new_xml_element</link> (<link linkend="raptor-qname">raptor_qname</link> *name,
unsigned <link linkend="char">char</link> *xml_language,
<link linkend="raptor-uri">raptor_uri</link> *xml_base);
<link linkend="void">void</link> <link linkend="raptor-free-xml-element">raptor_free_xml_element</link> (<link linkend="raptor-xml-element">raptor_xml_element</link> *element);
<link linkend="raptor-qname">raptor_qname</link>* <link linkend="raptor-xml-element-get-name">raptor_xml_element_get_name</link> (<link linkend="raptor-xml-element">raptor_xml_element</link> *xml_element);
<link linkend="raptor-qname">raptor_qname</link>** <link linkend="raptor-xml-element-get-attributes">raptor_xml_element_get_attributes</link>
(<link linkend="raptor-xml-element">raptor_xml_element</link> *xml_element);
<link linkend="int">int</link> <link linkend="raptor-xml-element-get-attributes-count">raptor_xml_element_get_attributes_count</link>
(<link linkend="raptor-xml-element">raptor_xml_element</link> *xml_element);
<link linkend="void">void</link> <link linkend="raptor-xml-element-set-attributes">raptor_xml_element_set_attributes</link>
(<link linkend="raptor-xml-element">raptor_xml_element</link> *xml_element,
<link linkend="raptor-qname">raptor_qname</link> **attributes,
<link linkend="int">int</link> count);
<link linkend="int">int</link> <link linkend="raptor-xml-element-declare-namespace">raptor_xml_element_declare_namespace</link>
(<link linkend="raptor-xml-element">raptor_xml_element</link> *xml_element,
<link linkend="raptor-namespace">raptor_namespace</link> *nspace);
<link linkend="int">int</link> <link linkend="raptor-xml-element-is-empty">raptor_xml_element_is_empty</link> (<link linkend="raptor-xml-element">raptor_xml_element</link> *xml_element);
<link linkend="raptor-xml-writer">raptor_xml_writer</link>* <link linkend="raptor-new-xml-writer">raptor_new_xml_writer</link> (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-uri-handler">raptor_uri_handler</link> *uri_handler,
<link linkend="void">void</link> *uri_context,
<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
<link linkend="raptor-simple-message-handler">raptor_simple_message_handler</link> error_handler,
<link linkend="void">void</link> *error_data,
<link linkend="int">int</link> canonicalize);
<link linkend="void">void</link> <link linkend="raptor-free-xml-writer">raptor_free_xml_writer</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-empty-element">raptor_xml_writer_empty_element</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-xml-element">raptor_xml_element</link> *element);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-start-element">raptor_xml_writer_start_element</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-xml-element">raptor_xml_element</link> *element);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-end-element">raptor_xml_writer_end_element</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-xml-element">raptor_xml_element</link> *element);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-cdata">raptor_xml_writer_cdata</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-cdata-counted">raptor_xml_writer_cdata_counted</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s,
unsigned <link linkend="int">int</link> len);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-raw">raptor_xml_writer_raw</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-raw-counted">raptor_xml_writer_raw_counted</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s,
unsigned <link linkend="int">int</link> len);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-comment">raptor_xml_writer_comment</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s);
<link linkend="void">void</link> <link linkend="raptor-xml-writer-comment-counted">raptor_xml_writer_comment_counted</link>
(<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s,
unsigned <link linkend="int">int</link> len);
<link linkend="int">int</link> <link linkend="raptor-xml-writer-features-enumerate">raptor_xml_writer_features_enumerate</link>
(const <link linkend="raptor-feature">raptor_feature</link> feature,
const <link linkend="char">char</link> **name,
<link linkend="raptor-uri">raptor_uri</link> **uri,
const <link linkend="char">char</link> **label);
<link linkend="int">int</link> <link linkend="raptor-xml-writer-set-feature">raptor_xml_writer_set_feature</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-feature">raptor_feature</link> feature,
<link linkend="int">int</link> value);
<link linkend="int">int</link> <link linkend="raptor-xml-writer-set-feature-string">raptor_xml_writer_set_feature_string</link>
(<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-feature">raptor_feature</link> feature,
unsigned <link linkend="char">char</link> *value);
<link linkend="int">int</link> <link linkend="raptor-xml-writer-get-feature">raptor_xml_writer_get_feature</link> (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-feature">raptor_feature</link> feature);
const unsigned <link linkend="char">char</link>* <link linkend="raptor-xml-writer-get-feature-string">raptor_xml_writer_get_feature_string</link>
(<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-feature">raptor_feature</link> feature);
<link linkend="int">int</link> <link linkend="raptor-iostream-write-xml-element">raptor_iostream_write_xml_element</link>
(<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
<link linkend="raptor-xml-element">raptor_xml_element</link> *element,
<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="int">int</link> is_empty,
<link linkend="int">int</link> is_end,
<link linkend="raptor-simple-message-handler">raptor_simple_message_handler</link> error_handler,
<link linkend="void">void</link> *error_data,
<link linkend="int">int</link> depth);
typedef <link linkend="raptor-xml-writer">raptor_xml_writer</link>;
<link linkend="int">int</link> <link linkend="raptor-xml-any-escape-string">raptor_xml_any_escape_string</link> (unsigned <link linkend="char">char</link> *string,
<link linkend="size-t">size_t</link> len,
unsigned <link linkend="char">char</link> *buffer,
<link linkend="size-t">size_t</link> length,
<link linkend="char">char</link> quote,
<link linkend="int">int</link> xml_version,
<link linkend="raptor-simple-message-handler">raptor_simple_message_handler</link> error_handler,
<link linkend="void">void</link> *error_data);
<link linkend="int">int</link> <link linkend="raptor-xml-escape-string">raptor_xml_escape_string</link> (unsigned <link linkend="char">char</link> *string,
<link linkend="size-t">size_t</link> len,
unsigned <link linkend="char">char</link> *buffer,
<link linkend="size-t">size_t</link> length,
<link linkend="char">char</link> quote,
<link linkend="raptor-simple-message-handler">raptor_simple_message_handler</link> error_handler,
<link linkend="void">void</link> *error_data);
<link linkend="int">int</link> <link linkend="raptor-iostream-write-xml-any-escaped-string">raptor_iostream_write_xml_any_escaped_string</link>
(<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
unsigned <link linkend="char">char</link> *string,
<link linkend="size-t">size_t</link> len,
<link linkend="char">char</link> quote,
redland/raptor/docs/xml/section-xml.xml view on Meta::CPAN
<link linkend="raptor-xml-element">raptor_xml_element</link> *element);</programlisting>
<para>
Write an empty XML element to the XML writer.
</para>
<para>
Closes any previous empty element if XML writer feature AUTO_EMPTY
is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml_writer</parameter> :</term>
<listitem><simpara> XML writer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>element</parameter> :</term>
<listitem><simpara> XML element object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-xml-writer-start-element" role="function"/>raptor_xml_writer_start_element ()</title>
<indexterm><primary>raptor_xml_writer_start_element</primary></indexterm><programlisting><link linkend="void">void</link> raptor_xml_writer_start_element (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-xml-element">raptor_xml_element</link> *element);</programlisting>
<para>
Write a start XML element to the XML writer.
</para>
<para>
Closes any previous empty element if XML writer feature AUTO_EMPTY
is enabled.
</para>
<para>
Indents the start element if XML writer feature AUTO_INDENT is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml_writer</parameter> :</term>
<listitem><simpara> XML writer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>element</parameter> :</term>
<listitem><simpara> XML element object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-xml-writer-end-element" role="function"/>raptor_xml_writer_end_element ()</title>
<indexterm><primary>raptor_xml_writer_end_element</primary></indexterm><programlisting><link linkend="void">void</link> raptor_xml_writer_end_element (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
<link linkend="raptor-xml-element">raptor_xml_element</link> *element);</programlisting>
<para>
Write an end XML element to the XML writer.
</para>
<para>
Indents the end element if XML writer feature AUTO_INDENT is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml_writer</parameter> :</term>
<listitem><simpara> XML writer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>element</parameter> :</term>
<listitem><simpara> XML element object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-xml-writer-cdata" role="function"/>raptor_xml_writer_cdata ()</title>
<indexterm><primary>raptor_xml_writer_cdata</primary></indexterm><programlisting><link linkend="void">void</link> raptor_xml_writer_cdata (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s);</programlisting>
<para>
Write CDATA XML-escaped to the XML writer.
</para>
<para>
Closes any previous empty element if XML writer feature AUTO_EMPTY
is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml_writer</parameter> :</term>
<listitem><simpara> XML writer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>s</parameter> :</term>
<listitem><simpara> string to XML escape and write
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-xml-writer-cdata-counted" role="function"/>raptor_xml_writer_cdata_counted ()</title>
<indexterm><primary>raptor_xml_writer_cdata_counted</primary></indexterm><programlisting><link linkend="void">void</link> raptor_xml_writer_cdata_counted (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s,
unsigned <link linkend="int">int</link> len);</programlisting>
<para>
Write counted CDATA XML-escaped to the XML writer.
</para>
<para>
Closes any previous empty element if XML writer feature AUTO_EMPTY
is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml_writer</parameter> :</term>
<listitem><simpara> XML writer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>s</parameter> :</term>
<listitem><simpara> string to XML escape and write
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> length of string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-xml-writer-raw" role="function"/>raptor_xml_writer_raw ()</title>
<indexterm><primary>raptor_xml_writer_raw</primary></indexterm><programlisting><link linkend="void">void</link> raptor_xml_writer_raw (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s);</programlisting>
<para>
Write a string raw to the XML writer.
</para>
<para>
Closes any previous empty element if XML writer feature AUTO_EMPTY
is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml_writer</parameter> :</term>
<listitem><simpara> XML writer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>s</parameter> :</term>
<listitem><simpara> string to write
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-xml-writer-raw-counted" role="function"/>raptor_xml_writer_raw_counted ()</title>
<indexterm><primary>raptor_xml_writer_raw_counted</primary></indexterm><programlisting><link linkend="void">void</link> raptor_xml_writer_raw_counted (<link linkend="raptor-xml-writer">raptor_xml_writer</link> *xml_writer,
unsigned <link linkend="char">char</link> *s,
unsigned <link linkend="int">int</link> len);</programlisting>
<para>
Write a counted string raw to the XML writer.
</para>
<para>
Closes any previous empty element if XML writer feature AUTO_EMPTY
is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml_writer</parameter> :</term>
<listitem><simpara> XML writer object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>s</parameter> :</term>
<listitem><simpara> string to write
( run in 0.568 second using v1.01-cache-2.11-cpan-39bf76dae61 )