Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / libxml2 / d433046ae52b0488a9fad77d2045c0139b8cada8 / . / doc / html / libxml-xmlregexp.html
blob: 8a8c572cea1bd004bc1cb8ab9e6a98ec5ff28248 [file] [log] [blame]
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame^]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlregexp</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
3 .synopsis, .classsynopsis {
4 background: #eeeeee;
5 border: solid 1px #aaaaaa;
6 padding: 0.5em;
7 }
8 .programlisting {
9 background: #eeeeff;
10 border: solid 1px #aaaaff;
11 padding: 0.5em;
12 }
13 .variablelist {
14 padding: 4px;
15 margin-left: 3em;
16 }
17 .navigation {
18 background: #ffeeee;
19 border: solid 1px #ffaaaa;
20 margin-top: 0.5em;
21 margin-bottom: 0.5em;
22 }
23 .navigation a {
24 color: #770000;
25 }
26 .navigation a:visited {
27 color: #550000;
28 }
29 .navigation .title {
30 font-size: 200%;
31 }
32 </style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual"><link rel="up" href="libxml-lib.html" title="Libxml Library Reference"><link rel="previous" href="libxml-xmlmemory.html" title="xmlmemory"><link rel="next" href="libxml-xmlautomata.html" title="xmlautomata"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-xmlmemory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="libxml-lib.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">Gnome XML Library Reference Manual</th><td><a accesskey="n" href="libxml-xmlautomata.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="libxml-xmlregexp"></a><div class="titlepage"></div><div class="refnamediv"><h2>xmlregexp</h2><p>xmlregexp &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
Daniel Veillard80ce3732002-10-07 17:39:30 +0000[diff] [blame]33
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame^]34
35
36struct <a href="libxml-xmlregexp.html#xmlRegexp">xmlRegexp</a>;
37typedef <a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a>;
38struct <a href="libxml-xmlregexp.html#xmlRegExecCtxt">xmlRegExecCtxt</a>;
39typedef <a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a>;
40<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> <a href="libxml-xmlregexp.html#xmlRegexpCompile">xmlRegexpCompile</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *regexp);
41void <a href="libxml-xmlregexp.html#xmlRegFreeRegexp">xmlRegFreeRegexp</a> (<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> regexp);
42int <a href="libxml-xmlregexp.html#xmlRegexpExec">xmlRegexpExec</a> (<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> comp,
43 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);
44void <a href="libxml-xmlregexp.html#xmlRegexpPrint">xmlRegexpPrint</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
45 <a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> regexp);
46int <a href="libxml-xmlregexp.html#xmlRegexpIsDeterminist">xmlRegexpIsDeterminist</a> (<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> comp);
47void (<a href="libxml-xmlregexp.html#xmlRegExecCallbacks">*xmlRegExecCallbacks</a>) (<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> exec,
48 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *token,
Daniel Veillard80ce3732002-10-07 17:39:30 +0000[diff] [blame]49 void *transdata,
50 void *inputdata);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame^]51<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> <a href="libxml-xmlregexp.html#xmlRegNewExecCtxt">xmlRegNewExecCtxt</a> (<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> comp,
52 <a href="libxml-xmlregexp.html#xmlRegExecCallbacks">xmlRegExecCallbacks</a> callback,
Daniel Veillard80ce3732002-10-07 17:39:30 +0000[diff] [blame]53 void *data);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame^]54void <a href="libxml-xmlregexp.html#xmlRegFreeExecCtxt">xmlRegFreeExecCtxt</a> (<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> exec);
55int <a href="libxml-xmlregexp.html#xmlRegExecPushString">xmlRegExecPushString</a> (<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> exec,
56 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
57 void *data);
58int <a href="libxml-xmlregexp.html#xmlRegExecPushString2">xmlRegExecPushString2</a> (<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> exec,
59 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
60 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value2,
61 void *data);
62</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
63
64</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="xmlRegexp"></a>struct xmlRegexp</h3><pre class="programlisting">struct xmlRegexp;</pre><p>
65
66</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegexpPtr"></a>xmlRegexpPtr</h3><pre class="programlisting">typedef xmlRegexp *xmlRegexpPtr;
67</pre><p>
68A libxml regular expression, they can actually be far more complex
69thank the POSIX regex expressions.</p><p>
70
71</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegExecCtxt"></a>struct xmlRegExecCtxt</h3><pre class="programlisting">struct xmlRegExecCtxt;</pre><p>
72
73</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegExecCtxtPtr"></a>xmlRegExecCtxtPtr</h3><pre class="programlisting">typedef xmlRegExecCtxt *xmlRegExecCtxtPtr;
74</pre><p>
75A libxml progressive regular expression evaluation context</p><p>
76
77</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegexpCompile"></a>xmlRegexpCompile ()</h3><pre class="programlisting"><a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> xmlRegexpCompile (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *regexp);</pre><p>
78Parses a regular expression conforming to XML Schemas Part 2 Datatype
Daniel Veillard80ce3732002-10-07 17:39:30 +0000[diff] [blame]79Appendix F and build an automata suitable for testing strings against
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame^]80that regular expression</p><p>
81
82</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>regexp</tt></i> :</span></td><td> a regular expression string
83</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the compiled expression or NULL in case of error
84</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegFreeRegexp"></a>xmlRegFreeRegexp ()</h3><pre class="programlisting">void xmlRegFreeRegexp (<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> regexp);</pre><p>
85Free a regexp</p><p>
86
87</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>regexp</tt></i> :</span></td><td> the regexp
88</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegexpExec"></a>xmlRegexpExec ()</h3><pre class="programlisting">int xmlRegexpExec (<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> comp,
89 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);</pre><p>
90Check if the regular expression generate the value</p><p>
91
92</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>comp</tt></i> :</span></td><td> the compiled regular expression
93</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td>
94</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if it matches, 0 if not and a negativa value in case of error
95</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegexpPrint"></a>xmlRegexpPrint ()</h3><pre class="programlisting">void xmlRegexpPrint (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
96 <a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> regexp);</pre><p>
97Print the content of the compiled regular expression</p><p>
98
99</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td> the file for the output debug
100</td></tr><tr><td><span class="term"><i><tt>regexp</tt></i> :</span></td><td> the compiled regexp
101</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegexpIsDeterminist"></a>xmlRegexpIsDeterminist ()</h3><pre class="programlisting">int xmlRegexpIsDeterminist (<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> comp);</pre><p>
102Check if the regular expression is determinist</p><p>
103
104</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>comp</tt></i> :</span></td><td> the compiled regular expression
105</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if it yes, 0 if not and a negativa value in case of error
106</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegExecCallbacks"></a>xmlRegExecCallbacks ()</h3><pre class="programlisting">void (*xmlRegExecCallbacks) (<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> exec,
107 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *token,
Daniel Veillard80ce3732002-10-07 17:39:30 +0000[diff] [blame]108 void *transdata,
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame^]109 void *inputdata);</pre><p>
110
111</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>exec</tt></i> :</span></td><td>
112</td></tr><tr><td><span class="term"><i><tt>token</tt></i> :</span></td><td>
113</td></tr><tr><td><span class="term"><i><tt>transdata</tt></i> :</span></td><td>
114</td></tr><tr><td><span class="term"><i><tt>inputdata</tt></i> :</span></td><td>
115
116
117</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegNewExecCtxt"></a>xmlRegNewExecCtxt ()</h3><pre class="programlisting"><a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> xmlRegNewExecCtxt (<a href="libxml-xmlregexp.html#xmlRegexpPtr">xmlRegexpPtr</a> comp,
118 <a href="libxml-xmlregexp.html#xmlRegExecCallbacks">xmlRegExecCallbacks</a> callback,
119 void *data);</pre><p>
120Build a context used for progressive evaluation of a regexp.</p><p>
121
122</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>comp</tt></i> :</span></td><td> a precompiled regular expression
123</td></tr><tr><td><span class="term"><i><tt>callback</tt></i> :</span></td><td> a callback function used for handling progresses in the
124 automata matching phase
125</td></tr><tr><td><span class="term"><i><tt>data</tt></i> :</span></td><td> the context data associated to the callback in this context
126</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new context
127</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegFreeExecCtxt"></a>xmlRegFreeExecCtxt ()</h3><pre class="programlisting">void xmlRegFreeExecCtxt (<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> exec);</pre><p>
128Free the structures associated to a regular expression evaulation context.</p><p>
129
130</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>exec</tt></i> :</span></td><td> a regular expression evaulation context
131</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegExecPushString"></a>xmlRegExecPushString ()</h3><pre class="programlisting">int xmlRegExecPushString (<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> exec,
132 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
133 void *data);</pre><p>
134Push one input token in the execution context</p><p>
135
136</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>exec</tt></i> :</span></td><td> a regexp execution context or NULL to indicate the end
137</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> a string token input
138</td></tr><tr><td><span class="term"><i><tt>data</tt></i> :</span></td><td> data associated to the token to reuse in callbacks
139</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> 1 if the regexp reached a final state, 0 if non-final, and
140 a negative value in case of error.
141</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegExecPushString2"></a>xmlRegExecPushString2 ()</h3><pre class="programlisting">int xmlRegExecPushString2 (<a href="libxml-xmlregexp.html#xmlRegExecCtxtPtr">xmlRegExecCtxtPtr</a> exec,
142 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
143 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value2,
144 void *data);</pre><p>
145Push one input token in the execution context</p><p>
146
147</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>exec</tt></i> :</span></td><td> a regexp execution context or NULL to indicate the end
148</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> the first string token input
149</td></tr><tr><td><span class="term"><i><tt>value2</tt></i> :</span></td><td> the second string token input
150</td></tr><tr><td><span class="term"><i><tt>data</tt></i> :</span></td><td> data associated to the token to reuse in callbacks
151</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> 1 if the regexp reached a final state, 0 if non-final, and
152 a negative value in case of error.
153</td></tr></tbody></table></div></div></div></div><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-xmlmemory.html"><b>&lt;&lt; xmlmemory</b></a></td><td align="right"><a accesskey="n" href="libxml-xmlautomata.html"><b>xmlautomata &gt;&gt;</b></a></td></tr></table></body></html>