-
Notifications
You must be signed in to change notification settings - Fork 1
/
expat.html
138 lines (130 loc) · 11.7 KB
/
expat.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<title> expat - XML parser </title>
<script src="jquery.js"></script>
<script src="jquery-cookie.js"></script>
<script src="jquery-tablesorter.js"></script>
<script src="strftime.js"></script>
<script src="mustache.js"></script>
<script src="config.js"></script>
<script src="main.js"></script>
<link rel="stylesheet" type="text/css" href="templates/reset.css" />
<link rel="stylesheet" type="text/css" href="templates/hack.css" />
<link rel="stylesheet" type="text/css" id="lights_css" />
<script>
var DOCNAME = 'expat'
var PROJECT = 'expat'
//set the lights before rendering starts
set_lights()
</script>
</head>
<body>
<header>
<div class="container">
<div class="btn-container btn-lights-container">
<a href="#" class="btn btn-lights" id="lights">lights</a>
</div>
<div class="btn-container btn-home-container">
<a href="/" class="btn btn-home">luapower</a>
</div>
<table id="header_table">
<tr>
<td style="vertical-align: middle;" width="100%">
<h1> expat </h1>
<h2> XML parser </h2>
</td>
<td style="vertical-align: middle;" align="right" style="height: 150px">
<table><tr><td>
<div class="doc" id="package_info_container">
<div id="package_info"> </div>
<div id="commit_log"> </div>
</div>
<a href="https://github.com/luapower/expat" class="btn btn-rightside btn-github"><span class="icon"></span>View on GitHub</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/expat/tarball/master" class="btn btn-rightside">Download as .tar.gz</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/expat/zipball/master" class="btn btn-rightside">Download as .zip</a>
</td></tr></table>
</td>
</tr>
</table>
<div class="btn-container btn-discuss-container">
<a href="https://github.com/luapower/expat/issues/new" target="_blank"
class="btn btn-rightside btn-discuss"><span class="icon"></span>Discuss</a>
</div>
</div>
</header>
<div class="bg-container">
<div class="bg-center-container">
<div class="bg bg-expat" style="background-image: url('bg/expat.png');"></div>
</div>
</div>
<div class="under-header">
<div class="container">
<div id="toc_container" class="toc_container doc"></div>
<button id=tab1_button class="tab_button hidden">Documentation</button>
<button id=tab2_button class="tab_button hidden">Package Info</button>
<div id="tabs_cointainer">
<div id="tab1_container">
<section class="doc">
<span id="module_info"></span>
<h2 id="local-expat-requireexpat"><code>local expat = require'expat'</code></h2>
<p>A ffi binding for the <a href="http://expat.sourceforge.net/">Expat XML parser</a>.</p>
<h2 id="expat.parsesource-callbacks"><code>expat.parse(source, callbacks)</code></h2>
<p>Parse a XML from a string, cdata, file, or reader function, calling a callback for each piece of the XML parsed.</p>
<pre class="sourceCode lua"><code class="sourceCode lua"><span class="kw">source</span> <span class="ot">=</span> <span class="ot">{</span><span class="kw">path</span> <span class="ot">=</span> <span class="kw">S</span><span class="ot">}</span> | <span class="ot">{</span><span class="kw">string</span> <span class="ot">=</span> <span class="kw">S</span><span class="ot">}</span> | <span class="ot">{</span><span class="kw">cdata</span> <span class="ot">=</span> <span class="kw">CDATA</span><span class="ot">,</span> <span class="kw">size</span> <span class="ot">=</span> <span class="kw">N</span><span class="ot">}</span> | <span class="ot">{</span><span class="fu">read</span> <span class="ot">=</span> <span class="kw">read_function</span><span class="ot">}</span>
<span class="kw">callbacks</span> <span class="ot">=</span> <span class="ot">{</span>
<span class="kw">element</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">,</span> <span class="kw">model</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">attr_list</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">elem</span><span class="ot">,</span> <span class="kw">name</span><span class="ot">,</span> <span class="fu">type</span><span class="ot">,</span> <span class="kw">dflt</span><span class="ot">,</span> <span class="kw">is_required</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">xml</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">version</span><span class="ot">,</span> <span class="kw">encoding</span><span class="ot">,</span> <span class="kw">standalone</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">entity</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">,</span> <span class="kw">is_param_entity</span><span class="ot">,</span> <span class="kw">val</span><span class="ot">,</span> <span class="kw">base</span><span class="ot">,</span> <span class="kw">sysid</span><span class="ot">,</span> <span class="kw">pubid</span><span class="ot">,</span> <span class="kw">notation</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">start_tag</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">,</span> <span class="kw">attrs</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">end_tag</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">cdata</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">s</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">pi</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">target</span><span class="ot">,</span> <span class="kw">data</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">comment</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">s</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">start_cdata</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">()</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">end_cdata</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">()</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">default</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">s</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">default_expand</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">s</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">start_doctype</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">,</span> <span class="kw">sysid</span><span class="ot">,</span> <span class="kw">pubid</span><span class="ot">,</span> <span class="kw">has_internal_subset</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">end_doctype</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">()</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">unparsed</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">,</span> <span class="kw">base</span><span class="ot">,</span> <span class="kw">sysid</span><span class="ot">,</span> <span class="kw">pubid</span><span class="ot">,</span> <span class="kw">notation</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">notation</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">,</span> <span class="kw">base</span><span class="ot">,</span> <span class="kw">sysid</span><span class="ot">,</span> <span class="kw">pubid</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">start_namespace</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">prefix</span><span class="ot">,</span> <span class="kw">uri</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">end_namespace</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">prefix</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">not_standalone</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">()</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">ref</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">parser</span><span class="ot">,</span> <span class="kw">context</span><span class="ot">,</span> <span class="kw">base</span><span class="ot">,</span> <span class="kw">sysid</span><span class="ot">,</span> <span class="kw">pubid</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">skipped</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">,</span> <span class="kw">is_parameter_entity</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="kw">unknown</span> <span class="ot">=</span> <span class="kw">function</span><span class="ot">(</span><span class="kw">name</span><span class="ot">,</span> <span class="kw">info</span><span class="ot">)</span> <span class="kw">end</span><span class="ot">,</span>
<span class="ot">}</span></code></pre>
<h2 id="expat.treeparsesource-known_tags---root_node"><code>expat.treeparse(source, [known_tags]) -> root_node</code></h2>
<p>Parse a XML to a tree of nodes. known_tags filters the output so that only the tags that known_tags indexes are returned.</p>
<p>Nodes look like this:</p>
<pre><code>node = {tag=, attrs={<k>=v}, children={node1,...}, tags={<tag> = node}, cdata=, parent=}</code></pre>
<h2 id="expat.childrennode-tag---iter---node"><code>expat.children(node, tag) -> iter() -> node</code></h2>
<p>Iterate a node's children that have a specific tag.</p>
</section>
</div>
<div id="tab2_container" class="doc"></div>
</div>
</div>
<div class="container">
<footer>
<div id="disqus_thread"></div>
<div class="faint">[email protected] | <a href="http://unlicense.org/">public domain</a></div>
</footer>
</div>
</div>
<script type="text/x-mustache" id=info_tab_template>
<h3>Modules</h3>
<ul>
{{#module_array}}
<li>{{name}}</li>
{{/module_array}}
</ul>
</script>
</body>
</html>