/usr/share/gtk-doc/html/ctpl/ctpl-CtplParser.html is in libctpl-doc 0.3.3.dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CtplParser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="CTPL Reference Manual">
<link rel="up" href="ch02.html" title="API reference">
<link rel="prev" href="ctpl-CtplLexerExpr.html" title="CtplLexerExpr">
<link rel="next" href="ctpl-CtplEval.html" title="CtplEval">
<meta name="generator" content="GTK-Doc V1.17 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="ctpl-CtplLexerExpr.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">CTPL Reference Manual</th>
<td><a accesskey="n" href="ctpl-CtplEval.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ctpl-CtplParser.synopsis" class="shortcut">Top</a>
|
<a href="#ctpl-CtplParser.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="ctpl-CtplParser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ctpl-CtplParser.top_of_page"></a>CtplParser</span></h2>
<p>CtplParser — Token tree parser</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ctpl-CtplParser.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <ctpl/ctpl.h>
#define <a class="link" href="ctpl-CtplParser.html#CTPL-PARSER-ERROR:CAPS" title="CTPL_PARSER_ERROR">CTPL_PARSER_ERROR</a>
enum <a class="link" href="ctpl-CtplParser.html#CtplParserError" title="enum CtplParserError">CtplParserError</a>;
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ctpl-CtplParser.html#ctpl-parser-parse" title="ctpl_parser_parse ()">ctpl_parser_parse</a> (<em class="parameter"><code>const <a class="link" href="ctpl-CtplToken.html#CtplToken" title="CtplToken"><span class="type">CtplToken</span></a> *tree</code></em>,
<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *output</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ctpl-CtplParser.description"></a><h2>Description</h2>
<p>
Parses a <a class="link" href="ctpl-CtplToken.html#CtplToken" title="CtplToken"><span class="type">CtplToken</span></a> tree against a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>.
</p>
<p>
To parse a token tree, use <a class="link" href="ctpl-CtplParser.html#ctpl-parser-parse" title="ctpl_parser_parse ()"><code class="function">ctpl_parser_parse()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="ctpl-CtplParser.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CTPL-PARSER-ERROR:CAPS"></a><h3>CTPL_PARSER_ERROR</h3>
<pre class="programlisting">#define CTPL_PARSER_ERROR (ctpl_parser_error_quark ())
</pre>
<p>
Error domain of CtplParser.
</p>
</div>
<hr>
<div class="refsect2">
<a name="CtplParserError"></a><h3>enum CtplParserError</h3>
<pre class="programlisting">typedef enum _CtplParserError
{
CTPL_PARSER_ERROR_INCOMPATIBLE_SYMBOL,
CTPL_PARSER_ERROR_SYMBOL_NOT_FOUND,
CTPL_PARSER_ERROR_FAILED
} CtplParserError;
</pre>
<p>
Error codes that parsing functions can throw, from the <a class="link" href="ctpl-CtplParser.html#CTPL-PARSER-ERROR:CAPS" title="CTPL_PARSER_ERROR"><code class="literal">CTPL_PARSER_ERROR</code></a>
domain.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="CTPL-PARSER-ERROR-INCOMPATIBLE-SYMBOL:CAPS"></a><span class="term"><code class="literal">CTPL_PARSER_ERROR_INCOMPATIBLE_SYMBOL</code></span></p></td>
<td>A symbol is incompatible with is
usage.
</td>
</tr>
<tr>
<td><p><a name="CTPL-PARSER-ERROR-SYMBOL-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">CTPL_PARSER_ERROR_SYMBOL_NOT_FOUND</code></span></p></td>
<td>A symbol cannot be found in the
environment.
</td>
</tr>
<tr>
<td><p><a name="CTPL-PARSER-ERROR-FAILED:CAPS"></a><span class="term"><code class="literal">CTPL_PARSER_ERROR_FAILED</code></span></p></td>
<td>An error occurred without any precision on what
failed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-parser-parse"></a><h3>ctpl_parser_parse ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> ctpl_parser_parse (<em class="parameter"><code>const <a class="link" href="ctpl-CtplToken.html#CtplToken" title="CtplToken"><span class="type">CtplToken</span></a> *tree</code></em>,
<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *output</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Parses a token tree against an environment and outputs the result to <em class="parameter"><code>output</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tree</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplToken.html#CtplToken" title="CtplToken"><span class="type">CtplToken</span></a> from which start parsing</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> representing the parsing environment</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplInputStream.html#CtplInputStream" title="CtplInputStream"><span class="type">CtplInputStream</span></a> in which write parsing output</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location where return a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore errors</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise, in which case <em class="parameter"><code>error</code></em> shall be
set to the error that occurred.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|