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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MySQL++ SSQLS v2 Translator: ParseV2::Field Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MySQL++ SSQLS v2 Translator
 <span id="projectnumber">3.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classParseV2.html">ParseV2</a></li><li class="navelem"><a class="el" href="classParseV2_1_1Field.html">Field</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classParseV2_1_1Field-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ParseV2::Field Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>'field' directive line
<a href="classParseV2_1_1Field.html#details">More...</a></p>
<p><code>#include <<a class="el" href="parsev2_8h_source.html">parsev2.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ParseV2::Field:</div>
<div class="dyncontent">
<div class="center"><img src="classParseV2_1_1Field__inherit__graph.png" border="0" usemap="#ParseV2_1_1Field_inherit__map" alt="Inheritance graph"/></div>
<map name="ParseV2_1_1Field_inherit__map" id="ParseV2_1_1Field_inherit__map">
<area shape="rect" title="'field' directive line" alt="" coords="5,79,114,104"/>
<area shape="rect" href="classParseV2_1_1Line.html" title="Base class for parsed SSQLS v2 declaration lines." alt="" coords="7,5,112,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ParseV2::Field:</div>
<div class="dyncontent">
<div class="center"><img src="classParseV2_1_1Field__coll__graph.png" border="0" usemap="#ParseV2_1_1Field_coll__map" alt="Collaboration graph"/></div>
<map name="ParseV2_1_1Field_coll__map" id="ParseV2_1_1Field_coll__map">
<area shape="rect" title="'field' directive line" alt="" coords="5,79,114,104"/>
<area shape="rect" href="classParseV2_1_1Line.html" title="Base class for parsed SSQLS v2 declaration lines." alt="" coords="7,5,112,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classParseV2_1_1Field_1_1Type.html">Type</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A smart enum for converting SQL type strings to one of a relatively few types we directly support. <a href="classParseV2_1_1Field_1_1Type.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa6ce22a2c42ea9d0ddeae06d1562e77d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParseV2_1_1Field.html#aa6ce22a2c42ea9d0ddeae06d1562e77d">Field</a> (const std::string &name, const std::string &type, bool is_unsigned=false, bool is_null=false, bool is_autoinc=false, bool is_key=false, const std::string &alias=0)</td></tr>
<tr class="memdesc:aa6ce22a2c42ea9d0ddeae06d1562e77d"><td class="mdescLeft"> </td><td class="mdescRight">Holds information about a SQL field declared in the SSQLS v2 language. <a href="#aa6ce22a2c42ea9d0ddeae06d1562e77d">More...</a><br /></td></tr>
<tr class="separator:aa6ce22a2c42ea9d0ddeae06d1562e77d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6387940cb703182320108eacc6a1b322"><td class="memItemLeft" align="right" valign="top"><a id="a6387940cb703182320108eacc6a1b322"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParseV2_1_1Field.html#a6387940cb703182320108eacc6a1b322">print</a> (std::ostream &os) const</td></tr>
<tr class="memdesc:a6387940cb703182320108eacc6a1b322"><td class="mdescLeft"> </td><td class="mdescRight">Print field description out to a stream in SSQLS v2 form. <br /></td></tr>
<tr class="separator:a6387940cb703182320108eacc6a1b322"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classParseV2_1_1Line"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classParseV2_1_1Line')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classParseV2_1_1Line.html">ParseV2::Line</a></td></tr>
<tr class="memitem:aff17fe2a6e9ffca4cfc9590b43cd9015 inherit pub_methods_classParseV2_1_1Line"><td class="memItemLeft" align="right" valign="top"><a id="aff17fe2a6e9ffca4cfc9590b43cd9015"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classParseV2_1_1Line.html#aff17fe2a6e9ffca4cfc9590b43cd9015">~Line</a> ()</td></tr>
<tr class="memdesc:aff17fe2a6e9ffca4cfc9590b43cd9015 inherit pub_methods_classParseV2_1_1Line"><td class="mdescLeft"> </td><td class="mdescRight">Virtual dtor, since this is a base class. <br /></td></tr>
<tr class="separator:aff17fe2a6e9ffca4cfc9590b43cd9015 inherit pub_methods_classParseV2_1_1Line"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa7f960b3aefb37f18f4c8160c468f2c6"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classParseV2_1_1Field.html">Field</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classParseV2_1_1Field.html#aa7f960b3aefb37f18f4c8160c468f2c6">parse</a> (const <a class="el" href="classParseV2.html#a82c28f8cd009372d06cd0bd39927ff34">StringList</a> &tl, bool subdirective, const <a class="el" href="classParseV2_1_1File.html">File</a> &file)</td></tr>
<tr class="memdesc:aa7f960b3aefb37f18f4c8160c468f2c6"><td class="mdescLeft"> </td><td class="mdescRight">Attempt to create a <a class="el" href="classParseV2_1_1Field.html" title="'field' directive line">Field</a> object from information in the passed StringList. <a href="#aa7f960b3aefb37f18f4c8160c468f2c6">More...</a><br /></td></tr>
<tr class="separator:aa7f960b3aefb37f18f4c8160c468f2c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_static_methods_classParseV2_1_1Line"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classParseV2_1_1Line')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classParseV2_1_1Line.html">ParseV2::Line</a></td></tr>
<tr class="memitem:aa826982abc96f7d5013440572a0dafe1 inherit pub_static_methods_classParseV2_1_1Line"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classParseV2_1_1Line.html">Line</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classParseV2_1_1Line.html#aa826982abc96f7d5013440572a0dafe1">parse</a> (const <a class="el" href="classParseV2.html#a82c28f8cd009372d06cd0bd39927ff34">StringList</a> &tl, bool subdirective, const <a class="el" href="classParseV2_1_1File.html">File</a> &file)</td></tr>
<tr class="memdesc:aa826982abc96f7d5013440572a0dafe1 inherit pub_static_methods_classParseV2_1_1Line"><td class="mdescLeft"> </td><td class="mdescRight">Virtual ctor, creating one of our subclass objects based on what we're passed. <a href="classParseV2_1_1Line.html#aa826982abc96f7d5013440572a0dafe1">More...</a><br /></td></tr>
<tr class="separator:aa826982abc96f7d5013440572a0dafe1 inherit pub_static_methods_classParseV2_1_1Line"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classParseV2_1_1Line"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classParseV2_1_1Line')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classParseV2_1_1Line.html">ParseV2::Line</a></td></tr>
<tr class="memitem:a7b9e9c446ef2a7985598b2f4cb0e2820 inherit pro_methods_classParseV2_1_1Line"><td class="memItemLeft" align="right" valign="top"><a id="a7b9e9c446ef2a7985598b2f4cb0e2820"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classParseV2_1_1Line.html#a7b9e9c446ef2a7985598b2f4cb0e2820">Line</a> ()</td></tr>
<tr class="memdesc:a7b9e9c446ef2a7985598b2f4cb0e2820 inherit pro_methods_classParseV2_1_1Line"><td class="mdescLeft"> </td><td class="mdescRight">Protected ctor, to prevent instantiation. <br /></td></tr>
<tr class="separator:a7b9e9c446ef2a7985598b2f4cb0e2820 inherit pro_methods_classParseV2_1_1Line"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>'field' directive line </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aa6ce22a2c42ea9d0ddeae06d1562e77d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6ce22a2c42ea9d0ddeae06d1562e77d">◆ </a></span>Field()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ParseV2::Field::Field </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>is_unsigned</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>is_null</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>is_autoinc</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>is_key</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>alias</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Holds information about a SQL field declared in the SSQLS v2 language. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>the field's SQL type </td></tr>
<tr><td class="paramname">is_unsigned</td><td>true if type is an integer and is unsigned </td></tr>
<tr><td class="paramname">is_null</td><td>true if field's value is nullable </td></tr>
<tr><td class="paramname">is_autoinc</td><td>true if DB automatically assigns an auto-incrementing value to this field in INSERT if it isn't specified </td></tr>
<tr><td class="paramname">is_key</td><td>true if field is part of the primary key </td></tr>
<tr><td class="paramname">name</td><td>the field's SQL name </td></tr>
<tr><td class="paramname">alias</td><td>the field's C++ name, defaulting to the SQL name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa7f960b3aefb37f18f4c8160c468f2c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7f960b3aefb37f18f4c8160c468f2c6">◆ </a></span>parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classParseV2_1_1Field.html">ParseV2::Field</a> * ParseV2::Field::parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classParseV2.html#a82c28f8cd009372d06cd0bd39927ff34">StringList</a> & </td>
<td class="paramname"><em>tl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>subdirective</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classParseV2_1_1File.html">File</a> & </td>
<td class="paramname"><em>file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempt to create a <a class="el" href="classParseV2_1_1Field.html" title="'field' directive line">Field</a> object from information in the passed StringList. </p>
<p>A kind of pre-processor for the <a class="el" href="classParseV2_1_1Field.html" title="'field' directive line">Field</a> ctor, creating one of those objects only if the given StringList makes sense, using the values we find in that StringList as parameters to the ctor. </p>
<p class="reference">References <a class="el" href="classParseV2_1_1File.html#a398eef7e1fe978865b26b24e8efb7443">ParseV2::File::parse_error()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classParseV2_1_1Line.html#aa826982abc96f7d5013440572a0dafe1">ParseV2::Line::parse()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="parsev2_8h_source.html">parsev2.h</a></li>
<li>parsev2.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jul 21 2019 05:32:21 for MySQL++ SSQLS v2 Translator by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
|
