File: class_ipe_xml_parser.html

package info (click to toggle)
ipe 6.0pre27-3
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 5,128 kB
  • ctags: 5,328
  • sloc: cpp: 29,689; ansic: 1,045; xml: 821; makefile: 65
file content (255 lines) | stat: -rw-r--r-- 10,586 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
<!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>Ipelib: IpeXmlParser Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
<h1>IpeXmlParser Class Reference<br>
<small>
[<a class="el" href="group__base.html">Ipe Base</a>]</small>
</h1><!-- doxytag: class="IpeXmlParser" -->Base class for XML stream parsing.  
<a href="#_details">More...</a>
<p>
Inherited by <a class="el" href="class_ipe_iml_parser.html">IpeImlParser</a>.
<p>
<a href="class_ipe_xml_parser-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="class_ipe_xml_parser.html#a0">IpeXmlParser</a> (<a class="el" href="class_ipe_data_source.html">IpeDataSource</a> &amp;source)
<li>virtual <a class="el" href="class_ipe_xml_parser.html#a1">~IpeXmlParser</a> ()
<li><a class="anchor" name="a2"></a><!-- doxytag: member="IpeXmlParser::ParsePosition" ref="a2" args="() const " -->
int <b>ParsePosition</b> () const 
</ul>
<h2>Protected Member Functions</h2>
<ul>
<li><a class="el" href="class_ipe_string.html">IpeString</a> <a class="el" href="class_ipe_xml_parser.html#b0">ParseToTag</a> ()
<li><a class="el" href="class_ipe_string.html">IpeString</a> <a class="el" href="class_ipe_xml_parser.html#b1">ParseToTagX</a> ()
<li>bool <a class="el" href="class_ipe_xml_parser.html#b2">ParseAttributes</a> (<a class="el" href="class_ipe_xml_attributes.html">IpeXmlAttributes</a> &amp;attr, bool qm=false)
<li>bool <a class="el" href="class_ipe_xml_parser.html#b3">ParsePCDATA</a> (<a class="el" href="class_ipe_string.html">IpeString</a> tag, <a class="el" href="class_ipe_string.html">IpeString</a> &amp;pcdata)
<li><a class="anchor" name="b4"></a><!-- doxytag: member="IpeXmlParser::IsTagChar" ref="b4" args="(int ch)" -->
bool <b>IsTagChar</b> (int ch)
<li><a class="anchor" name="b5"></a><!-- doxytag: member="IpeXmlParser::GetChar" ref="b5" args="()" -->
void <b>GetChar</b> ()
<li><a class="anchor" name="b6"></a><!-- doxytag: member="IpeXmlParser::Eos" ref="b6" args="()" -->
bool <b>Eos</b> ()
<li><a class="anchor" name="b7"></a><!-- doxytag: member="IpeXmlParser::SkipWhitespace" ref="b7" args="()" -->
void <b>SkipWhitespace</b> ()
</ul>
<h2>Protected Attributes</h2>
<ul>
<li><a class="anchor" name="p0"></a><!-- doxytag: member="IpeXmlParser::iSource" ref="p0" args="" -->
<a class="el" href="class_ipe_data_source.html">IpeDataSource</a> &amp; <b>iSource</b>
<li><a class="anchor" name="p1"></a><!-- doxytag: member="IpeXmlParser::iTopElement" ref="p1" args="" -->
<a class="el" href="class_ipe_string.html">IpeString</a> <b>iTopElement</b>
<li><a class="anchor" name="p2"></a><!-- doxytag: member="IpeXmlParser::iCh" ref="p2" args="" -->
int <b>iCh</b>
<li><a class="anchor" name="p3"></a><!-- doxytag: member="IpeXmlParser::iPos" ref="p3" args="" -->
int <b>iPos</b>
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for XML stream parsing. 
<p>
This is the base class for Ipe's XML parser. It only provides some utility functions for parsing tags and PCDATA. Derived classes implement the actual parsing using recursive descent parsers---after experimenting with various schemes for XML parsing, this seems to work best for Ipe.<p>
Tag names and attribute names must consist of ASCII letters only. Only entities for '&amp;', '&lt;', and '&gt;' are recognized.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="IpeXmlParser::IpeXmlParser" ref="a0" args="(IpeDataSource &amp;source)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">IpeXmlParser::IpeXmlParser           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_data_source.html">IpeDataSource</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>source</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct with a data source. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a1"></a><!-- doxytag: member="IpeXmlParser::~IpeXmlParser" ref="a1" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">IpeXmlParser::~IpeXmlParser           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Virtual destructor, so one can destroy through pointer. 
<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b0"></a><!-- doxytag: member="IpeXmlParser::ParseToTag" ref="b0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a> IpeXmlParser::ParseToTag           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Parse whitespace and the name of a tag. 
<p>
Like ParseToTagX, but silently skips over all tags whose name starts with "x-"     </td>
  </tr>
</table>
<a class="anchor" name="b1"></a><!-- doxytag: member="IpeXmlParser::ParseToTagX" ref="b1" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a> IpeXmlParser::ParseToTagX           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Parse whitespace and the name of a tag. 
<p>
If the tag is a closing tag, skips &gt; and returns with stream after that. Otherwise, returns with stream just after the tag name.     </td>
  </tr>
</table>
<a class="anchor" name="b2"></a><!-- doxytag: member="IpeXmlParser::ParseAttributes" ref="b2" args="(IpeXmlAttributes &amp;attr, bool qm=false)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">bool IpeXmlParser::ParseAttributes           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_xml_attributes.html">IpeXmlAttributes</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>attr</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>qm</em> = <code>false</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Parse XML attributes. 
<p>
Returns with stream just after &gt;. Caller can check whether the tag ended with a / by checking attr.Slash().     </td>
  </tr>
</table>
<a class="anchor" name="b3"></a><!-- doxytag: member="IpeXmlParser::ParsePCDATA" ref="b3" args="(IpeString tag, IpeString &amp;pcdata)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">bool IpeXmlParser::ParsePCDATA           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>tag</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="class_ipe_string.html">IpeString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>pcdata</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Parse PCDATA. 
<p>
Checks whether the data is terminated by <code>&lt;/tag&gt;</code>, and returns with stream past the &gt;.     </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipexml.h<li>ipexml.cpp</ul>
<hr>
</body></html>