<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: dox/IO/vtkXMLParser.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>dox/IO/vtkXMLParser.h</h1><a href="a03236.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Program: Visualization Toolkit</span>
<a name="l00004"></a>00004 <span class="comment"> Module: $RCSfile: vtkXMLParser.h,v $</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span>
<a name="l00007"></a>00007 <span class="comment"> All rights reserved.</span>
<a name="l00008"></a>00008 <span class="comment"> See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This software is distributed WITHOUT ANY WARRANTY; without even</span>
<a name="l00011"></a>00011 <span class="comment"> the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span>
<a name="l00012"></a>00012 <span class="comment"> PURPOSE. See the above copyright notice for more information.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef __vtkXMLParser_h</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define __vtkXMLParser_h</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="a02079.html">vtkObject.h</a>"</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">extern</span> <span class="stringliteral">"C"</span>
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keywordtype">void</span> <a class="code" href="a03236.html#803cbcb437529b0dcc0d26accaae5fdb">vtkXMLParserStartElement</a>(<span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span>**);
<a name="l00036"></a>00036 <span class="keywordtype">void</span> <a class="code" href="a03236.html#91db1f4cec3bcddf2d4e9439e1d5bd35">vtkXMLParserEndElement</a>(<span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span>*);
<a name="l00037"></a>00037 <span class="keywordtype">void</span> <a class="code" href="a03236.html#40562000ecd47286815c28d7d428c694">vtkXMLParserCharacterDataHandler</a>(<span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keywordtype">int</span>);
<a name="l00038"></a>00038 }
<a name="l00039"></a>00039
<a name="l00040"></a><a class="code" href="a01921.html">00040</a> <span class="keyword">class </span><a class="code" href="a02170.html#aab695c81fb47ab75c91e111e17cbe2c">VTK_IO_EXPORT</a> <a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a> : <span class="keyword">public</span> <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">public</span>:
<a name="l00043"></a><a class="code" href="a01921.html#7d17b61eda15ff97b3018d3e69787b60">00043</a> vtkTypeRevisionMacro(<a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a>,<a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>);
<a name="l00044"></a>00044 <span class="keywordtype">void</span> <a class="code" href="a01084.html#bf3dbb4154289b56a12483eee3866263">PrintSelf</a>(ostream& os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent);
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">static</span> <a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a>* <a class="code" href="a01084.html#4d5b227267c076d6f9e38483370b6612">New</a>();
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">//BTX</span>
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 vtkSetMacro(Stream, istream*);
<a name="l00052"></a>00052 vtkGetMacro(Stream, istream*);
<a name="l00053"></a>00053 <span class="comment">//ETX</span>
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00057"></a>00057
<a name="l00060"></a>00060 <span class="keywordtype">long</span> TellG();
<a name="l00061"></a>00061 <span class="keywordtype">void</span> SeekG(<span class="keywordtype">long</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210d43ac71820d660e3c543657c794b3d8c">position</a>);
<a name="l00063"></a>00063
<a name="l00065"></a>00065 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Parse();
<a name="l00066"></a>00066
<a name="l00068"></a>00068
<a name="l00070"></a>00070 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Parse(<span class="keyword">const</span> <span class="keywordtype">char</span>* inputString);
<a name="l00071"></a>00071 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Parse(<span class="keyword">const</span> <span class="keywordtype">char</span>* inputString, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21042c5d76c3275f5d17bc1b329d83ab003">length</a>);
<a name="l00073"></a>00073
<a name="l00075"></a>00075
<a name="l00080"></a>00080 <span class="keyword">virtual</span> <span class="keywordtype">int</span> InitializeParser();
<a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ParseChunk(<span class="keyword">const</span> <span class="keywordtype">char</span>* inputString, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21042c5d76c3275f5d17bc1b329d83ab003">length</a>);
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">int</span> CleanupParser();
<a name="l00084"></a>00084
<a name="l00086"></a>00086
<a name="l00087"></a>00087 vtkSetStringMacro(FileName);
<a name="l00088"></a>00088 vtkGetStringMacro(FileName);
<a name="l00090"></a>00090
<a name="l00092"></a>00092
<a name="l00095"></a>00095 vtkSetMacro(IgnoreCharacterData, <span class="keywordtype">int</span>);
<a name="l00096"></a>00096 vtkGetMacro(IgnoreCharacterData, <span class="keywordtype">int</span>);
<a name="l00098"></a>00098
<a name="l00100"></a>00100
<a name="l00104"></a>00104 vtkSetStringMacro(Encoding);
<a name="l00105"></a>00105 vtkGetStringMacro(Encoding);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keyword">protected</span>:
<a name="l00109"></a>00109 <a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a>();
<a name="l00110"></a>00110 ~<a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a>();
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// Input stream. Set by user.</span>
<a name="l00113"></a><a class="code" href="a01921.html#6a1949c994face17535098217d2cec9a">00113</a> istream* Stream;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="comment">// File name to parse</span>
<a name="l00116"></a><a class="code" href="a01921.html#5f2f4e8514132369924bba339923d6d9">00116</a> <span class="keywordtype">char</span>* FileName;
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="comment">// Encoding</span>
<a name="l00119"></a><a class="code" href="a01921.html#181d8d1f41363c08d7154d5a91848372">00119</a> <span class="keywordtype">char</span>* Encoding;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">// This variable is true if there was a parse error while parsing in</span>
<a name="l00122"></a>00122 <span class="comment">// chunks.</span>
<a name="l00123"></a><a class="code" href="a01921.html#332c3954f508ad1e0d6a2bd046de5b6b">00123</a> <span class="keywordtype">int</span> ParseError;
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">// Character message to parse</span>
<a name="l00126"></a><a class="code" href="a01921.html#d88a3eb7bc5420846627d5d1d30e3678">00126</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* InputString;
<a name="l00127"></a><a class="code" href="a01921.html#d005a99f9507ce81e450ce96fa889bb3">00127</a> <span class="keywordtype">int</span> InputStringLength;
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">// Expat parser structure. Exists only during call to Parse().</span>
<a name="l00130"></a><a class="code" href="a01921.html#2bad2187431aa20f86a60ea7832930e9">00130</a> <span class="keywordtype">void</span>* Parser;
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="comment">// Create/Allocate the internal parser (can be overriden by subclasses).</span>
<a name="l00133"></a>00133 <span class="keyword">virtual</span> <span class="keywordtype">int</span> CreateParser();
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="comment">// Called by Parse() to read the stream and call ParseBuffer. Can</span>
<a name="l00136"></a>00136 <span class="comment">// be replaced by subclasses to change how input is read.</span>
<a name="l00137"></a>00137 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ParseXML();
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">// Called before each block of input is read from the stream to</span>
<a name="l00140"></a>00140 <span class="comment">// check if parsing is complete. Can be replaced by subclasses to</span>
<a name="l00141"></a>00141 <span class="comment">// change the terminating condition for parsing. Parsing always</span>
<a name="l00142"></a>00142 <span class="comment">// stops when the end of file is reached in the stream.</span>
<a name="l00143"></a>00143 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ParsingComplete();
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">// Called when a new element is opened in the XML source. Should be</span>
<a name="l00146"></a>00146 <span class="comment">// replaced by subclasses to handle each element.</span>
<a name="l00147"></a>00147 <span class="comment">// name = Name of new element.</span>
<a name="l00148"></a>00148 <span class="comment">// atts = Null-terminated array of attribute name/value pairs.</span>
<a name="l00149"></a>00149 <span class="comment">// Even indices are attribute names, and odd indices are values.</span>
<a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> StartElement(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keyword">const</span> <span class="keywordtype">char</span>** atts);
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="comment">// Called at the end of an element in the XML source opened when</span>
<a name="l00153"></a>00153 <span class="comment">// StartElement was called.</span>
<a name="l00154"></a>00154 <span class="keyword">virtual</span> <span class="keywordtype">void</span> EndElement(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>);
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="comment">// Called when there is character data to handle.</span>
<a name="l00157"></a>00157 <span class="keyword">virtual</span> <span class="keywordtype">void</span> CharacterDataHandler(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210eb708a412c0730a6b5f3215b36474a1e">data</a>, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21042c5d76c3275f5d17bc1b329d83ab003">length</a>);
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="comment">// Called by begin handlers to report any stray attribute values.</span>
<a name="l00160"></a>00160 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReportStrayAttribute(<span class="keyword">const</span> <span class="keywordtype">char</span>* element, <span class="keyword">const</span> <span class="keywordtype">char</span>* attr,
<a name="l00161"></a>00161 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>);
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="comment">// Called by begin handlers to report any missing attribute values.</span>
<a name="l00164"></a>00164 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReportMissingAttribute(<span class="keyword">const</span> <span class="keywordtype">char</span>* element, <span class="keyword">const</span> <span class="keywordtype">char</span>* attr);
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="comment">// Called by begin handlers to report bad attribute values.</span>
<a name="l00167"></a>00167 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReportBadAttribute(<span class="keyword">const</span> <span class="keywordtype">char</span>* element, <span class="keyword">const</span> <span class="keywordtype">char</span>* attr,
<a name="l00168"></a>00168 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>);
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="comment">// Called by StartElement to report unknown element type.</span>
<a name="l00171"></a>00171 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReportUnknownElement(<span class="keyword">const</span> <span class="keywordtype">char</span>* element);
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="comment">// Called by Parse to report an XML syntax error.</span>
<a name="l00174"></a>00174 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReportXmlParseError();
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="comment">// Get the current byte index from the beginning of the XML stream.</span>
<a name="l00177"></a>00177 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> GetXMLByteIndex();
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="comment">// Send the given buffer to the XML parser.</span>
<a name="l00180"></a>00180 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ParseBuffer(<span class="keyword">const</span> <span class="keywordtype">char</span>* buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count);
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="comment">// Send the given c-style string to the XML parser.</span>
<a name="l00183"></a>00183 <span class="keywordtype">int</span> ParseBuffer(<span class="keyword">const</span> <span class="keywordtype">char</span>* buffer);
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="comment">// Utility for convenience of subclasses. Wraps isspace C library</span>
<a name="l00186"></a>00186 <span class="comment">// routine.</span>
<a name="l00187"></a>00187 <span class="keyword">static</span> <span class="keywordtype">int</span> IsSpace(<span class="keywordtype">char</span> c);
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="comment">//BTX</span>
<a name="l00190"></a>00190 <span class="keyword">friend</span> <span class="keywordtype">void</span> <a class="code" href="a03236.html#803cbcb437529b0dcc0d26accaae5fdb">vtkXMLParserStartElement</a>(<span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span>**);
<a name="l00191"></a>00191 <span class="keyword">friend</span> <span class="keywordtype">void</span> <a class="code" href="a03236.html#91db1f4cec3bcddf2d4e9439e1d5bd35">vtkXMLParserEndElement</a>(<span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span>*);
<a name="l00192"></a>00192 <span class="keyword">friend</span> <span class="keywordtype">void</span> <a class="code" href="a03236.html#40562000ecd47286815c28d7d428c694">vtkXMLParserCharacterDataHandler</a>(<span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keywordtype">int</span>);
<a name="l00193"></a>00193 <span class="comment">//ETX</span>
<a name="l00194"></a>00194
<a name="l00195"></a><a class="code" href="a01921.html#c437477f3be41d626adfc820bb447ddb">00195</a> <span class="keywordtype">int</span> IgnoreCharacterData;
<a name="l00196"></a>00196
<a name="l00197"></a>00197 <span class="keyword">private</span>:
<a name="l00198"></a>00198 <a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a>(<span class="keyword">const</span> <a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a>&); <span class="comment">// Not implemented.</span>
<a name="l00199"></a>00199 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a>&); <span class="comment">// Not implemented.</span>
<a name="l00200"></a>00200 };
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="comment">//----------------------------------------------------------------------------</span>
<a name="l00203"></a>00203 <span class="keyword">inline</span>
<a name="l00204"></a><a class="code" href="a03236.html#40562000ecd47286815c28d7d428c694">00204</a> <span class="keywordtype">void</span> <a class="code" href="a03236.html#40562000ecd47286815c28d7d428c694">vtkXMLParserCharacterDataHandler</a>(
<a name="l00205"></a>00205 <span class="keywordtype">void</span>* parser,
<a name="l00206"></a>00206 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210eb708a412c0730a6b5f3215b36474a1e">data</a>,
<a name="l00207"></a>00207 <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21042c5d76c3275f5d17bc1b329d83ab003">length</a>)
<a name="l00208"></a>00208 {
<a name="l00209"></a>00209 <span class="comment">// Character data handler that is registered with the XML_Parser.</span>
<a name="l00210"></a>00210 <span class="comment">// This just casts the user data to a vtkXMLParser and calls</span>
<a name="l00211"></a>00211 <span class="comment">// CharacterDataHandler.</span>
<a name="l00212"></a>00212 <span class="keyword">static_cast<</span><a class="code" href="a01921.html" title="Parse XML to handle element tags and attributes.">vtkXMLParser</a>*<span class="keyword">></span>(parser)->CharacterDataHandler(data, length);
<a name="l00213"></a>00213 }
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:41 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
5028
