3
<TITLE>class toSQLParse</TITLE>
5
<META NAME="Generator" CONTENT="KDOC ">
7
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
8
<TABLE WIDTH="100%" BORDER="0">
12
<TR><TD valign="top" align="left" cellspacing="10">
13
<h1>class toSQLParse</h1>
15
<TD valign="top" align="right" colspan="1"> A bunch of functions to parse and indent SQL text. <small><A HREF="#longdesc">More...</A></small></TD></TR>
19
<TR><TH>Definition</TH><TD><code>#include <<A HREF="tosqlparse_h.html">tosqlparse.h</A>></code></TD></TR>
20
<TR><TH><A HREF="full-list-toSQLParse.html">List of all Methods</A></TH></TR>
23
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
24
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
25
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
26
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
27
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
28
</TABLE></TD></TR></TABLE>
29
<h4>Public Types</h4><ul><LI>struct <A HREF="toSQLParse__settings.html">settings</A>
31
<LI>class <A HREF="toSQLParse__statement.html">statement</A>
33
<LI>class <i><A HREF="toSQLParse__tokenizer.html">tokenizer</A></i>
35
<LI>class <A HREF="toSQLParse__stringTokenizer.html">stringTokenizer</A>
37
<LI>class <A HREF="toSQLParse__editorTokenizer.html">editorTokenizer</A>
39
</ul><h4>Public Static Methods</h4><ul><LI>static std::list<statement> <b><A HREF="#ref6">parse</A></b> (tokenizer &tokens)
41
<LI>static std::list<statement> <b><A HREF="#ref7">parse</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str)
43
<LI>static std::list<statement> <b><A HREF="#ref8">parse</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,<A HREF="toConnection.html">toConnection</A> &conn)
45
<LI>static statement <b><A HREF="#ref9">parseStatement</A></b> (tokenizer &tokens)
47
<LI>static statement <b><A HREF="#ref10">parseStatement</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str)
49
<LI>static statement <b><A HREF="#ref11">parseStatement</A></b> (tokenizer &tokens,<A HREF="toConnection.html">toConnection</A> &conn)
51
<LI>static statement <b><A HREF="#ref12">parseStatement</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,<A HREF="toConnection.html">toConnection</A> &conn)
53
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref13">indent</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str)
55
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref14">indentStatement</A></b> (statement &stat,<A HREF="toConnection.html">toConnection</A> &conn,int level=0)
57
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref15">indentStatement</A></b> (statement &stat,int level=0)
59
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref16">indent</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,<A HREF="toConnection.html">toConnection</A> &conn)
61
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref17">indentString</A></b> (int level)
63
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref18">indent</A></b> (std::list<statement> &stat,<A HREF="toConnection.html">toConnection</A> &conn)
65
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref19">indent</A></b> (std::list<statement> &stat)
67
<LI>static int <b><A HREF="#ref20">countIndent</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,int &chars)
69
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref21">indent</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,<A HREF="toSyntaxAnalyzer.html">toSyntaxAnalyzer</A> &syntax)
71
<LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref22">indent</A></b> (std::list<statement> &stat,<A HREF="toSyntaxAnalyzer.html">toSyntaxAnalyzer</A> &syntax)
73
<LI>static settings <b><A HREF="#ref26">getSetting</A></b> (void)
75
<LI>static void <b><A HREF="#ref27">setSetting</A></b> (const settings &setting)
77
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p> A bunch of functions to parse and indent SQL text.
79
<A NAME="toSQLParse__settings.html"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td><strong>settings</strong> <small>(struct)</small></td><td align="right"><h3><strong>settings</strong></h3></td></tr></table><p></p><A NAME="toSQLParse__statement.html"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td><strong>statement</strong> <small>(class)</small></td><td align="right"><h3><strong>statement</strong></h3></td></tr></table><p></p><p> Structure the statement is parsed into.
81
<A NAME="toSQLParse__tokenizer.html"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td><strong>tokenizer</strong> <small>(class)</small></td><td align="right"><h3><strong>tokenizer</strong></h3></td></tr></table><p></p><p> Abstract class to define a source of tokens for the parser.
83
<A NAME="toSQLParse__stringTokenizer.html"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td><strong>stringTokenizer</strong> <small>(class)</small></td><td align="right"><h3><strong>stringTokenizer</strong></h3></td></tr></table><p></p><p> Tokenizer class which gets tokens from a string.
85
<A NAME="toSQLParse__editorTokenizer.html"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td><strong>editorTokenizer</strong> <small>(class)</small></td><td align="right"><h3><strong>editorTokenizer</strong></h3></td></tr></table><p></p><p> Tokenizer class which gets tokens from an editor.
87
<A NAME="parse"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<statement> <strong>parse</strong> (tokenizer &tokens)
88
<br></td><td align="right"><h3><strong>parse</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Parse a string.
90
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
91
<TR><TD align="left" valign="top"><i>tokens</i></TD><TD align="left" valign="top">Tokenizer provider to generate parsed tree from.
94
<p><b>Returns</b>: Parsed statement tree.
96
<A NAME="parse"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<statement> <strong>parse</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str)
97
<br></td><td align="right"><h3><strong>parse</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Parse a string.
99
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
100
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String to parse.
103
<p><b>Returns</b>: Parsed statement tree.
105
<A NAME="parse"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<statement> <strong>parse</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,<A HREF="toConnection.html">toConnection</A> &conn)
106
<br></td><td align="right"><h3><strong>parse</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Parse a string.
108
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
109
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String to parse.
111
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">Connection to determine SQL dialect. (For future use)
114
<p><b>Returns</b>: Parsed statement tree.
116
<A NAME="parseStatement"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> statement <strong>parseStatement</strong> (tokenizer &tokens)
117
<br></td><td align="right"><h3><strong>parseStatement</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get one statement (or block) from the root of an editor or string.
119
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
120
<TR><TD align="left" valign="top"><i>tokens</i></TD><TD align="left" valign="top">Tokenizer to get tokens from.
122
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">Connection to determine SQL dialog. (For future use)
125
<A NAME="parseStatement"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> statement <strong>parseStatement</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str)
126
<br></td><td align="right"><h3><strong>parseStatement</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get one statement (or block) from the root of an editor or string.
128
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
129
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">Tokenizer to get tokens from.
131
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">Connection to determine SQL dialog. (For future use)
134
<A NAME="parseStatement"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> statement <strong>parseStatement</strong> (tokenizer &tokens,<A HREF="toConnection.html">toConnection</A> &conn)
135
<br></td><td align="right"><h3><strong>parseStatement</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get one statement (or block) from the root of an editor or string.
137
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
138
<TR><TD align="left" valign="top"><i>tokens</i></TD><TD align="left" valign="top">Tokenizer to get tokens from.
140
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">Connection to determine SQL dialog. (For future use)
143
<A NAME="parseStatement"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> statement <strong>parseStatement</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,<A HREF="toConnection.html">toConnection</A> &conn)
144
<br></td><td align="right"><h3><strong>parseStatement</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get one statement (or block) from the root of an editor or string.
146
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
147
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">Tokenizer to get tokens from.
149
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">Connection to determine SQL dialog. (For future use)
152
<A NAME="indent"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indent</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str)
153
<br></td><td align="right"><h3><strong>indent</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Indent a string.
155
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
156
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String to indent.
159
<p><b>Returns</b>: An indented string.
161
<A NAME="indentStatement"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indentStatement</strong> (statement &stat,<A HREF="toConnection.html">toConnection</A> &conn,int level=0)
162
<br></td><td align="right"><h3><strong>indentStatement</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Indent a parse statement structure into a string.
164
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
165
<TR><TD align="left" valign="top"><i>stat</i></TD><TD align="left" valign="top">Statement to indent.
167
<TR><TD align="left" valign="top"><i>level</i></TD><TD align="left" valign="top">Initial indentation level to use.
169
<TR><TD align="left" valign="top"><i>syntax</i></TD><TD align="left" valign="top">The syntax analyzer to use.
172
<p><b>Returns</b>: A string with the indented statement.
174
<A NAME="indentStatement"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indentStatement</strong> (statement &stat,int level=0)
175
<br></td><td align="right"><h3><strong>indentStatement</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Indent a parse statement structure into a string.
177
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
178
<TR><TD align="left" valign="top"><i>stat</i></TD><TD align="left" valign="top">Statement to indent.
180
<TR><TD align="left" valign="top"><i>level</i></TD><TD align="left" valign="top">Initial indentation level to use.
183
<p><b>Returns</b>: A string with the indented statement.
185
<A NAME="indent"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indent</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,<A HREF="toConnection.html">toConnection</A> &conn)
186
<br></td><td align="right"><h3><strong>indent</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Indent a string.
188
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
189
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String to indent.
191
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">Connection to determine SQL dialect. (For future use)
194
<p><b>Returns</b>: An indented string.
196
<A NAME="indentString"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indentString</strong> (int level)
197
<br></td><td align="right"><h3><strong>indentString</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Create an indentation string.
199
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
200
<TR><TD align="left" valign="top"><i>level</i></TD><TD align="left" valign="top">Number of characters to indent.
203
<A NAME="indent"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indent</strong> (std::list<statement> &stat,<A HREF="toConnection.html">toConnection</A> &conn)
204
<br></td><td align="right"><h3><strong>indent</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Indent a string.
206
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
207
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">List of statements
209
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">Connection to determine SQL dialect. (For future use)
212
<p><b>Returns</b>: An indented string.
214
<A NAME="indent"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indent</strong> (std::list<statement> &stat)
215
<br></td><td align="right"><h3><strong>indent</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Indent a string.
217
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
218
<TR><TD align="left" valign="top"><i>stat</i></TD><TD align="left" valign="top">List of statements
221
<p><b>Returns</b>: An indented string.
223
<A NAME="countIndent"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td> int <strong>countIndent</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,int &chars)
224
<br></td><td align="right"><h3><strong>countIndent</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Count indentation level of a string.
226
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
227
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String to check.
229
<TR><TD align="left" valign="top"><i>chars</i></TD><TD align="left" valign="top">Position in string.
232
<A NAME="indent"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indent</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &str,<A HREF="toSyntaxAnalyzer.html">toSyntaxAnalyzer</A> &syntax)
233
<br></td><td align="right"><h3><strong>indent</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Indent a string.
235
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
236
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String to indent.
238
<TR><TD align="left" valign="top"><i>syntax</i></TD><TD align="left" valign="top">Syntax analyzer to determine SQL dialect. (For future use)
241
<p><b>Returns</b>: An indented string.
243
<A NAME="indent"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>indent</strong> (std::list<statement> &stat,<A HREF="toSyntaxAnalyzer.html">toSyntaxAnalyzer</A> &syntax)
244
<br></td><td align="right"><h3><strong>indent</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Indent a string.
246
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
247
<TR><TD align="left" valign="top"><i>stat</i></TD><TD align="left" valign="top">List of statements
249
<TR><TD align="left" valign="top"><i>syntax</i></TD><TD align="left" valign="top">Syntax analyzer to determine SQL dialect. (For future use)
252
<p><b>Returns</b>: An indented string.
254
<A NAME="getSetting"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td> settings <strong>getSetting</strong> (void)
255
<br></td><td align="right"><h3><strong>getSetting</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get current settings.
257
<A NAME="setSetting"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setSetting</strong> (const settings &setting)
258
<br></td><td align="right"><h3><strong>setSetting</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get current settings.
262
<tr><td><small>Generated by: nneul on skyhawk on Wed Feb 23 19:49:58 2005, using kdoc 2.0a54.</small></td></tr>