File: classVariableTypeStore.html

package info (click to toggle)
xqilla 2.3.3-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 44,220 kB
  • ctags: 27,890
  • sloc: cpp: 72,812; ansic: 21,322; sh: 10,157; yacc: 4,806; xml: 4,327; makefile: 1,071; lex: 800; sed: 17
file content (319 lines) | stat: -rw-r--r-- 16,306 bytes parent folder | download
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>VariableTypeStore Class Reference</h1><!-- doxytag: class="VariableTypeStore" --><!-- doxytag: inherits="xercesc::XMemory" -->
<p>This is the wrapper class for the variable store, which implements the lookup and scoping of simple variables.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="VariableTypeStore_8hpp_source.html">VariableTypeStore.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for VariableTypeStore:</div>
<div class="dynsection">
<div class="center"><img src="classVariableTypeStore__inherit__graph.png" border="0" usemap="#VariableTypeStore_inherit__map" alt="Inheritance graph"/></div>
<map name="VariableTypeStore_inherit__map" id="VariableTypeStore_inherit__map">
<area shape="rect" id="node2" href="classxercesc_1_1XMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete..." alt="" coords="5,5,155,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classVariableTypeStore-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a7a83c010d27e45ebe851d06dc2b3a0ff">~VariableTypeStore</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default destructor  <a href="#a7a83c010d27e45ebe851d06dc2b3a0ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a055a4b1120213b805cbb8faa4176f06f">clear</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears all variable values and added scopes from the store.  <a href="#a055a4b1120213b805cbb8faa4176f06f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a15fbc9a1c3488a60d7d7e027c9f2e276">addLocalScope</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new local scope to the store.  <a href="#a15fbc9a1c3488a60d7d7e027c9f2e276"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a26fd1d2ed4f7b6f8d8c71ac6ee70fada">addLogicalBlockScope</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new logical block scope to the store.  <a href="#a26fd1d2ed4f7b6f8d8c71ac6ee70fada"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a0f19eac8660c0ab793f97a22baa1e6eb">removeScope</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes the top level scope from the store.  <a href="#a0f19eac8660c0ab793f97a22baa1e6eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a4eea70dce24f2ff3c1480124fb4cd0b6">declareGlobalVar</a> (const XMLCh *namespaceURI, const XMLCh *name, const <a class="el" href="classStaticAnalysis.html">StaticAnalysis</a> &amp;src, XQGlobalVariable *global)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Declares and/or sets a variable in the global scope.  <a href="#a4eea70dce24f2ff3c1480124fb4cd0b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classStaticAnalysis.html">StaticAnalysis</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a2a650f1008013ebe87c7bdb04c924782">getGlobalVar</a> (const XMLCh *namespaceURI, const XMLCh *name, XQGlobalVariable **global=0) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets a variable from the global scope.  <a href="#a2a650f1008013ebe87c7bdb04c924782"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a6e4172447c63112c4fcb89a96e04c992">declareVar</a> (const XMLCh *namespaceURI, const XMLCh *name, const <a class="el" href="classStaticAnalysis.html">StaticAnalysis</a> &amp;src)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Declare a var in the top level scope (A full set of these namespaceURI/name pair methods should be made).  <a href="#a6e4172447c63112c4fcb89a96e04c992"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classStaticAnalysis.html">StaticAnalysis</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVariableTypeStore.html#a71752d341d5ac7614986925b275c57c8">getVar</a> (const XMLCh *namespaceURI, const XMLCh *name, XQGlobalVariable **global=0) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Looks up the value of a variable in the current scope, using ident as an qname.  <a href="#a71752d341d5ac7614986925b275c57c8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is the wrapper class for the variable store, which implements the lookup and scoping of simple variables. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7a83c010d27e45ebe851d06dc2b3a0ff"></a><!-- doxytag: member="VariableTypeStore::~VariableTypeStore" ref="a7a83c010d27e45ebe851d06dc2b3a0ff" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual VariableTypeStore::~VariableTypeStore </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>default destructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a15fbc9a1c3488a60d7d7e027c9f2e276"></a><!-- doxytag: member="VariableTypeStore::addLocalScope" ref="a15fbc9a1c3488a60d7d7e027c9f2e276" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void VariableTypeStore::addLocalScope </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Adds a new local scope to the store. </p>

</div>
</div>
<a class="anchor" id="a26fd1d2ed4f7b6f8d8c71ac6ee70fada"></a><!-- doxytag: member="VariableTypeStore::addLogicalBlockScope" ref="a26fd1d2ed4f7b6f8d8c71ac6ee70fada" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void VariableTypeStore::addLogicalBlockScope </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Adds a new logical block scope to the store. </p>

</div>
</div>
<a class="anchor" id="a055a4b1120213b805cbb8faa4176f06f"></a><!-- doxytag: member="VariableTypeStore::clear" ref="a055a4b1120213b805cbb8faa4176f06f" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void VariableTypeStore::clear </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Clears all variable values and added scopes from the store. </p>

</div>
</div>
<a class="anchor" id="a4eea70dce24f2ff3c1480124fb4cd0b6"></a><!-- doxytag: member="VariableTypeStore::declareGlobalVar" ref="a4eea70dce24f2ff3c1480124fb4cd0b6" args="(const XMLCh *namespaceURI, const XMLCh *name, const StaticAnalysis &amp;src, XQGlobalVariable *global)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void VariableTypeStore::declareGlobalVar </td>
          <td>(</td>
          <td class="paramtype">const XMLCh *&nbsp;</td>
          <td class="paramname"> <em>namespaceURI</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XMLCh *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classStaticAnalysis.html">StaticAnalysis</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XQGlobalVariable *&nbsp;</td>
          <td class="paramname"> <em>global</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Declares and/or sets a variable in the global scope. </p>

</div>
</div>
<a class="anchor" id="a6e4172447c63112c4fcb89a96e04c992"></a><!-- doxytag: member="VariableTypeStore::declareVar" ref="a6e4172447c63112c4fcb89a96e04c992" args="(const XMLCh *namespaceURI, const XMLCh *name, const StaticAnalysis &amp;src)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void VariableTypeStore::declareVar </td>
          <td>(</td>
          <td class="paramtype">const XMLCh *&nbsp;</td>
          <td class="paramname"> <em>namespaceURI</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XMLCh *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classStaticAnalysis.html">StaticAnalysis</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>src</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Declare a var in the top level scope (A full set of these namespaceURI/name pair methods should be made). </p>

</div>
</div>
<a class="anchor" id="a2a650f1008013ebe87c7bdb04c924782"></a><!-- doxytag: member="VariableTypeStore::getGlobalVar" ref="a2a650f1008013ebe87c7bdb04c924782" args="(const XMLCh *namespaceURI, const XMLCh *name, XQGlobalVariable **global=0) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classStaticAnalysis.html">StaticAnalysis</a>* VariableTypeStore::getGlobalVar </td>
          <td>(</td>
          <td class="paramtype">const XMLCh *&nbsp;</td>
          <td class="paramname"> <em>namespaceURI</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XMLCh *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XQGlobalVariable **&nbsp;</td>
          <td class="paramname"> <em>global</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets a variable from the global scope. </p>

</div>
</div>
<a class="anchor" id="a71752d341d5ac7614986925b275c57c8"></a><!-- doxytag: member="VariableTypeStore::getVar" ref="a71752d341d5ac7614986925b275c57c8" args="(const XMLCh *namespaceURI, const XMLCh *name, XQGlobalVariable **global=0) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classStaticAnalysis.html">StaticAnalysis</a>* VariableTypeStore::getVar </td>
          <td>(</td>
          <td class="paramtype">const XMLCh *&nbsp;</td>
          <td class="paramname"> <em>namespaceURI</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XMLCh *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XQGlobalVariable **&nbsp;</td>
          <td class="paramname"> <em>global</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Looks up the value of a variable in the current scope, using ident as an qname. </p>
<p>Returns a boolean (true if successful), and the SequenceType value of the variable </p>

</div>
</div>
<a class="anchor" id="a0f19eac8660c0ab793f97a22baa1e6eb"></a><!-- doxytag: member="VariableTypeStore::removeScope" ref="a0f19eac8660c0ab793f97a22baa1e6eb" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void VariableTypeStore::removeScope </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Removes the top level scope from the store. </p>
<p>To be called at the end of methods to implement scoping. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="VariableTypeStore_8hpp_source.html">VariableTypeStore.hpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 18 May 2015 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>