gem-graph-client/doc/docbook/db/d07/parse_8c.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_parse_8c" xml:lang="en-US">
<title>src/util/parse.c File Reference</title>
<indexterm><primary>src/util/parse.c</primary></indexterm>
<para>

<para>Gem-graph-client parsing functions. </para>
 
</para>
<programlisting linenumbering="unnumbered">#include &lt;libxml/parser.h&gt;<?linebreak?>#include &lt;libxml/xmlreader.h&gt;<?linebreak?>#include &quot;../../include/base.h&quot;<?linebreak?></programlisting><simplesect>
    <title>Macros    </title>
        <itemizedlist>
            <listitem><para><anchor xml:id="_parse_8c_1a243152ef9966a28fe78eb35c58230175"/>#define <emphasis role="strong">READ_SITE</emphasis>&#160;&#160;&#160;1 &lt;&lt; 0</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para><anchor xml:id="_parse_8c_1a19926ecef0b8dcd05e806c8d81b9bca2"/>#define <emphasis role="strong">READ_WEIGHT</emphasis>&#160;&#160;&#160;1 &lt;&lt; 1</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para><anchor xml:id="_parse_8c_1a9dbc8566c78418c119feff0898d736d4"/>#define <emphasis role="strong">READ_X</emphasis>&#160;&#160;&#160;1 &lt;&lt; 2</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para><anchor xml:id="_parse_8c_1ac456a60674cd053582a76e83eb0747b5"/>#define <emphasis role="strong">READ_Y</emphasis>&#160;&#160;&#160;1 &lt;&lt; 3</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para><anchor xml:id="_parse_8c_1ae7e82b096a83fb71f659e82a93dd3a74"/>#define <emphasis role="strong">READ_Z</emphasis>&#160;&#160;&#160;1 &lt;&lt; 4</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para><anchor xml:id="_parse_8c_1ab7b4166b740376df6b6d9130cb731a34"/>#define <emphasis role="strong">SUCCESSFUL_READ_ARROW_X</emphasis>&#160;&#160;&#160;(<link linkend="_parse_8c_1a243152ef9966a28fe78eb35c58230175">READ_SITE</link> | <link linkend="_parse_8c_1a19926ecef0b8dcd05e806c8d81b9bca2">READ_WEIGHT</link> | <link linkend="_parse_8c_1a9dbc8566c78418c119feff0898d736d4">READ_X</link>)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para><anchor xml:id="_parse_8c_1ab10e1b90399de44c5e40e48fd960707b"/>#define <emphasis role="strong">SUCCESSFUL_READ_ARROW_XY</emphasis>&#160;&#160;&#160;(<link linkend="_parse_8c_1a243152ef9966a28fe78eb35c58230175">READ_SITE</link> | <link linkend="_parse_8c_1a19926ecef0b8dcd05e806c8d81b9bca2">READ_WEIGHT</link> | <link linkend="_parse_8c_1a9dbc8566c78418c119feff0898d736d4">READ_X</link> | <link linkend="_parse_8c_1ac456a60674cd053582a76e83eb0747b5">READ_Y</link>)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para><anchor xml:id="_parse_8c_1ac8bc06ebb55212f33f80f1982673b06f"/>#define <emphasis role="strong">SUCCESSFUL_READ_ARROW_XYZ</emphasis>&#160;&#160;&#160;(<link linkend="_parse_8c_1a243152ef9966a28fe78eb35c58230175">READ_SITE</link> | <link linkend="_parse_8c_1a19926ecef0b8dcd05e806c8d81b9bca2">READ_WEIGHT</link> | <link linkend="_parse_8c_1a9dbc8566c78418c119feff0898d736d4">READ_X</link> | <link linkend="_parse_8c_1ac456a60674cd053582a76e83eb0747b5">READ_Y</link> | <link linkend="_parse_8c_1ae7e82b096a83fb71f659e82a93dd3a74">READ_Z</link>)</para>

<para>Phantom documentation. </para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>bool <link linkend="_parse_8c_1a1d3cbba0db1e6175e60b7df68820fe4e">parse_model_init</link> (const char *content, size_t length, const char *basename)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para>bool <link linkend="_parse_8c_1ae2e7d278df2f9cd33246b94d3d9774a7">parse_model_shutdown</link> (void)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para>char <link linkend="_parse_8c_1a99b1c8dabcf4f7c0e4e7851c89cf31fa">parse_model_get_dim</link> (void)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para>long <link linkend="_parse_8c_1a53d57da5244be4a906ead03d35cad071">parse_model_get_dim_value</link> (const char *axis)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para>char <link linkend="_parse_8c_1a65cbc55feddd49729e9cedad453d323f">parse_model_get_multiplicity</link> (void)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para>bool <link linkend="_parse_8c_1a562cd593d672af0d4828ea491b44415f">parse_model_get_next_state</link> (char *new_state_id)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para>long <link linkend="_parse_8c_1ad5a0d65870999086f22a8304535e45b1">parse_model_get_state_arrows_count</link> (const char *state_id)</para>

<para>Phantom documentation. </para>
</listitem>
            <listitem><para>bool <link linkend="_parse_8c_1ad6c895b8ab8296dda321188b930218cc">parse_model_get_next_arrow</link> (struct <link linkend="_structarrow__t">arrow_t</link> *new_arrow, const char *state_id, char dimension)</para>

<para>Phantom documentation. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Gem-graph-client parsing functions. </para>

<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_parse_8c_1a99b1c8dabcf4f7c0e4e7851c89cf31fa"/><section>
    <title>parse_model_get_dim()</title>
<indexterm><primary>parse_model_get_dim</primary><secondary>parse.c</secondary></indexterm>
<indexterm><primary>parse.c</primary><secondary>parse_model_get_dim</secondary></indexterm>
<para><computeroutput>char parse_model_get_dim (void )</computeroutput></para><para>

<para>Phantom documentation. </para>
</para>

<para><formalpara><title>Returns</title>

<para>char </para>
</formalpara>
</para>
</section>
<anchor xml:id="_parse_8c_1a53d57da5244be4a906ead03d35cad071"/><section>
    <title>parse_model_get_dim_value()</title>
<indexterm><primary>parse_model_get_dim_value</primary><secondary>parse.c</secondary></indexterm>
<indexterm><primary>parse.c</primary><secondary>parse_model_get_dim_value</secondary></indexterm>
<para><computeroutput>long parse_model_get_dim_value (const char * axis)</computeroutput></para><para>

<para>Phantom documentation. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters</title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
<entry>*axis</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>long </para>
</formalpara>
</para>
</section>
<anchor xml:id="_parse_8c_1a65cbc55feddd49729e9cedad453d323f"/><section>
    <title>parse_model_get_multiplicity()</title>
<indexterm><primary>parse_model_get_multiplicity</primary><secondary>parse.c</secondary></indexterm>
<indexterm><primary>parse.c</primary><secondary>parse_model_get_multiplicity</secondary></indexterm>
<para><computeroutput>char parse_model_get_multiplicity (void )</computeroutput></para><para>

<para>Phantom documentation. </para>
</para>

<para><formalpara><title>Returns</title>

<para>char </para>
</formalpara>
</para>
</section>
<anchor xml:id="_parse_8c_1ad6c895b8ab8296dda321188b930218cc"/><section>
    <title>parse_model_get_next_arrow()</title>
<indexterm><primary>parse_model_get_next_arrow</primary><secondary>parse.c</secondary></indexterm>
<indexterm><primary>parse.c</primary><secondary>parse_model_get_next_arrow</secondary></indexterm>
<para><computeroutput>bool parse_model_get_next_arrow (struct <link linkend="_structarrow__t">arrow_t</link> * new_arrow, const char * state_id, char dimension)</computeroutput></para><para>

<para>Phantom documentation. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters</title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
<entry>*new_arrow</entry><entry>
<para></para>
</entry>
                            </row>
                            <row>
<entry>*state_id</entry><entry>
<para></para>
</entry>
                            </row>
                            <row>
<entry>dimension</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>bool </para>
</formalpara>
</para>
</section>
<anchor xml:id="_parse_8c_1a562cd593d672af0d4828ea491b44415f"/><section>
    <title>parse_model_get_next_state()</title>
<indexterm><primary>parse_model_get_next_state</primary><secondary>parse.c</secondary></indexterm>
<indexterm><primary>parse.c</primary><secondary>parse_model_get_next_state</secondary></indexterm>
<para><computeroutput>bool parse_model_get_next_state (char * new_state_id)</computeroutput></para><para>

<para>Phantom documentation. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters</title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
<entry>*new_state_id</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>bool </para>
</formalpara>
</para>
</section>
<anchor xml:id="_parse_8c_1ad5a0d65870999086f22a8304535e45b1"/><section>
    <title>parse_model_get_state_arrows_count()</title>
<indexterm><primary>parse_model_get_state_arrows_count</primary><secondary>parse.c</secondary></indexterm>
<indexterm><primary>parse.c</primary><secondary>parse_model_get_state_arrows_count</secondary></indexterm>
<para><computeroutput>long parse_model_get_state_arrows_count (const char * state_id)</computeroutput></para><para>

<para>Phantom documentation. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters</title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
<entry>*state_id</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>long </para>
</formalpara>
</para>
</section>
<anchor xml:id="_parse_8c_1a1d3cbba0db1e6175e60b7df68820fe4e"/><section>
    <title>parse_model_init()</title>
<indexterm><primary>parse_model_init</primary><secondary>parse.c</secondary></indexterm>
<indexterm><primary>parse.c</primary><secondary>parse_model_init</secondary></indexterm>
<para><computeroutput>bool parse_model_init (const char * content, size_t length, const char * basename)</computeroutput></para><para>

<para>Phantom documentation. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters</title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
<entry>*content</entry><entry>
<para></para>
</entry>
                            </row>
                            <row>
<entry>length</entry><entry>
<para></para>
</entry>
                            </row>
                            <row>
<entry>*basename</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>bool </para>
</formalpara>
</para>
</section>
<anchor xml:id="_parse_8c_1ae2e7d278df2f9cd33246b94d3d9774a7"/><section>
    <title>parse_model_shutdown()</title>
<indexterm><primary>parse_model_shutdown</primary><secondary>parse.c</secondary></indexterm>
<indexterm><primary>parse.c</primary><secondary>parse_model_shutdown</secondary></indexterm>
<para><computeroutput>bool parse_model_shutdown (void )</computeroutput></para><para>

<para>Phantom documentation. </para>
</para>

<para>returns bool </para>
</section>
</section>
</section>