XQuilla/docs/simple-api/InputSource_8hpp_source.html

208 lines
20 KiB
HTML
Raw Normal View History

2020-02-17 21:19:57 +00:00
<!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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<h1>InputSource.hpp</h1><a href="InputSource_8hpp.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"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00003"></a>00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00004"></a>00004 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00005"></a>00005 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00006"></a>00006 <span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span>
<a name="l00007"></a>00007 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"> * </span>
<a name="l00009"></a>00009 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00010"></a>00010 <span class="comment"> * </span>
<a name="l00011"></a>00011 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00012"></a>00012 <span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<a name="l00013"></a>00013 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00014"></a>00014 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00015"></a>00015 <span class="comment"> * limitations under the License.</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">/*</span>
<a name="l00019"></a>00019 <span class="comment"> * $Id: InputSource.hpp 527149 2007-04-10 14:56:39Z amassari $</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#if !defined(XERCESC_INCLUDE_GUARD_INPUTSOURCE_HPP)</span>
<a name="l00023"></a><a class="code" href="InputSource_8hpp.html#af8eff9aef823b4594290aa79d332a723">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define XERCESC_INCLUDE_GUARD_INPUTSOURCE_HPP</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;<a class="code" href="PlatformUtils_8hpp.html">xercesc/util/PlatformUtils.hpp</a>&gt;</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 XERCES_CPP_NAMESPACE_BEGIN
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">class </span>BinInputStream;
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00062"></a><a class="code" href="classxercesc_1_1InputSource.html">00062</a> <span class="keyword">class </span>SAX_EXPORT <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a> : <span class="keyword">public</span> <a class="code" href="classxercesc_1_1XMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete...">XMemory</a>
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 <span class="keyword">public</span>:
<a name="l00065"></a>00065 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00066"></a>00066 <span class="comment">// All constructors are hidden, just the destructor is available</span>
<a name="l00067"></a>00067 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00074"></a>00074 <span class="comment"></span> <span class="keyword">virtual</span> ~<a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>();
<a name="l00076"></a>00076
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00091"></a>00091 <span class="comment"></span> <span class="keyword">virtual</span> BinInputStream* makeStream() <span class="keyword">const</span> = 0;
<a name="l00092"></a>00092
<a name="l00094"></a>00094
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00108"></a>00108 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh* getEncoding() <span class="keyword">const</span>;
<a name="l00109"></a>00109
<a name="l00110"></a>00110
<a name="l00117"></a>00117 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh* getPublicId() <span class="keyword">const</span>;
<a name="l00118"></a>00118
<a name="l00119"></a>00119
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh* getSystemId() <span class="keyword">const</span>;
<a name="l00129"></a>00129
<a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getIssueFatalErrorIfNotFound() <span class="keyword">const</span>;
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* getMemoryManager() <span class="keyword">const</span>;
<a name="l00141"></a>00141
<a name="l00143"></a>00143
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00160"></a>00160 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEncoding(<span class="keyword">const</span> XMLCh* <span class="keyword">const</span> encodingStr);
<a name="l00161"></a>00161
<a name="l00162"></a>00162
<a name="l00174"></a>00174 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setPublicId(<span class="keyword">const</span> XMLCh* <span class="keyword">const</span> publicId);
<a name="l00175"></a>00175
<a name="l00192"></a>00192 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSystemId(<span class="keyword">const</span> XMLCh* <span class="keyword">const</span> systemId);
<a name="l00193"></a>00193
<a name="l00203"></a>00203 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setIssueFatalErrorIfNotFound(<span class="keyword">const</span> <span class="keywordtype">bool</span> flag);
<a name="l00204"></a>00204
<a name="l00206"></a>00206
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="keyword">protected</span> :
<a name="l00209"></a>00209 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00210"></a>00210 <span class="comment">// Hidden constructors</span>
<a name="l00211"></a>00211 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00215"></a>00215 <span class="comment"></span> <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>(<a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = XMLPlatformUtils::fgMemoryManager);
<a name="l00216"></a>00216
<a name="l00222"></a>00222 <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>(<span class="keyword">const</span> XMLCh* <span class="keyword">const</span> systemId,
<a name="l00223"></a>00223 <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = XMLPlatformUtils::fgMemoryManager);
<a name="l00224"></a>00224
<a name="l00231"></a>00231 <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>
<a name="l00232"></a>00232 (
<a name="l00233"></a>00233 <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> systemId
<a name="l00234"></a>00234 , <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> publicId
<a name="l00235"></a>00235 , <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = XMLPlatformUtils::fgMemoryManager
<a name="l00236"></a>00236 );
<a name="l00237"></a>00237
<a name="l00243"></a>00243 <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> systemId,
<a name="l00244"></a>00244 <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = XMLPlatformUtils::fgMemoryManager);
<a name="l00245"></a>00245
<a name="l00252"></a>00252 <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>
<a name="l00253"></a>00253 (
<a name="l00254"></a>00254 <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> systemId
<a name="l00255"></a>00255 , <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> publicId
<a name="l00256"></a>00256 , <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> manager = XMLPlatformUtils::fgMemoryManager
<a name="l00257"></a>00257 );
<a name="l00258"></a>00258
<a name="l00260"></a>00260
<a name="l00261"></a>00261
<a name="l00262"></a>00262
<a name="l00263"></a>00263
<a name="l00264"></a>00264
<a name="l00265"></a>00265 <span class="keyword">private</span>:
<a name="l00266"></a>00266 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00267"></a>00267 <span class="comment">// Unimplemented constructors and operators</span>
<a name="l00268"></a>00268 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00269"></a>00269 <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>&amp;);
<a name="l00270"></a>00270 <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a>&amp;);
<a name="l00271"></a>00271
<a name="l00272"></a>00272
<a name="l00273"></a>00273 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00274"></a>00274 <span class="comment">// Private data members</span>
<a name="l00275"></a>00275 <span class="comment">//</span>
<a name="l00276"></a>00276 <span class="comment">// fEncoding</span>
<a name="l00277"></a>00277 <span class="comment">// This is the encoding to use. Usually this is null, which means</span>
<a name="l00278"></a>00278 <span class="comment">// to use the information found in the file itself. But, if set,</span>
<a name="l00279"></a>00279 <span class="comment">// this encoding will be used without question.</span>
<a name="l00280"></a>00280 <span class="comment">//</span>
<a name="l00281"></a>00281 <span class="comment">// fPublicId</span>
<a name="l00282"></a>00282 <span class="comment">// This is the optional public id for the input source. It can be</span>
<a name="l00283"></a>00283 <span class="comment">// null if none is desired.</span>
<a name="l00284"></a>00284 <span class="comment">//</span>
<a name="l00285"></a>00285 <span class="comment">// fSystemId</span>
<a name="l00286"></a>00286 <span class="comment">// This is the system id for the input source. This is what is</span>
<a name="l00287"></a>00287 <span class="comment">// actually used to open the source.</span>
<a name="l00288"></a>00288 <span class="comment">//</span>
<a name="l00289"></a>00289 <span class="comment">// fFatalErrorIfNotFound</span>
<a name="l00290"></a>00290 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00291"></a>00291 <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <span class="keyword">const</span> fMemoryManager;
<a name="l00292"></a>00292 XMLCh* fEncoding;
<a name="l00293"></a>00293 XMLCh* fPublicId;
<a name="l00294"></a>00294 XMLCh* fSystemId;
<a name="l00295"></a>00295 <span class="keywordtype">bool</span> fFatalErrorIfNotFound;
<a name="l00296"></a>00296 };
<a name="l00297"></a>00297
<a name="l00298"></a>00298
<a name="l00299"></a>00299 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00300"></a>00300 <span class="comment">// InputSource: Getter methods</span>
<a name="l00301"></a>00301 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00302"></a><a class="code" href="classxercesc_1_1InputSource.html#a6f150d285d4ce368ce7a6f94f65f2957">00302</a> <span class="keyword">inline</span> <span class="keyword">const</span> XMLCh* InputSource::getEncoding()<span class="keyword"> const</span>
<a name="l00303"></a>00303 <span class="keyword"></span>{
<a name="l00304"></a>00304 <span class="keywordflow">return</span> fEncoding;
<a name="l00305"></a>00305 }
<a name="l00306"></a>00306
<a name="l00307"></a><a class="code" href="classxercesc_1_1InputSource.html#a192a9028168663eb4fb1e905e41837d8">00307</a> <span class="keyword">inline</span> <span class="keyword">const</span> XMLCh* <a class="code" href="classxercesc_1_1InputSource.html#a192a9028168663eb4fb1e905e41837d8" title="Get the public identifier for this input source.">InputSource::getPublicId</a>()<span class="keyword"> const</span>
<a name="l00308"></a>00308 <span class="keyword"></span>{
<a name="l00309"></a>00309 <span class="keywordflow">return</span> fPublicId;
<a name="l00310"></a>00310 }
<a name="l00311"></a>00311
<a name="l00312"></a><a class="code" href="classxercesc_1_1InputSource.html#a95ae54667532f3cbc9ec4a734541d0f5">00312</a> <span class="keyword">inline</span> <span class="keyword">const</span> XMLCh* <a class="code" href="classxercesc_1_1InputSource.html#a95ae54667532f3cbc9ec4a734541d0f5" title="Get the system identifier for this input source.">InputSource::getSystemId</a>()<span class="keyword"> const</span>
<a name="l00313"></a>00313 <span class="keyword"></span>{
<a name="l00314"></a>00314 <span class="keywordflow">return</span> fSystemId;
<a name="l00315"></a>00315 }
<a name="l00316"></a>00316
<a name="l00317"></a><a class="code" href="classxercesc_1_1InputSource.html#a3184b9e26e147b88d0eae9b09f39910d">00317</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classxercesc_1_1InputSource.html#a3184b9e26e147b88d0eae9b09f39910d" title="Get the flag that indicates if the parser should issue fatal error if this input...">InputSource::getIssueFatalErrorIfNotFound</a>()<span class="keyword"> const</span>
<a name="l00318"></a>00318 <span class="keyword"></span>{
<a name="l00319"></a>00319 <span class="keywordflow">return</span> fFatalErrorIfNotFound;
<a name="l00320"></a>00320 }
<a name="l00321"></a>00321
<a name="l00322"></a><a class="code" href="classxercesc_1_1InputSource.html#aaf614d39640bc2a92e89dcfd28ec7109">00322</a> <span class="keyword">inline</span> <a class="code" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a>* <a class="code" href="classxercesc_1_1InputSource.html#aaf614d39640bc2a92e89dcfd28ec7109">InputSource::getMemoryManager</a>()<span class="keyword"> const</span>
<a name="l00323"></a>00323 <span class="keyword"></span>{
<a name="l00324"></a>00324 <span class="keywordflow">return</span> fMemoryManager;
<a name="l00325"></a>00325 }
<a name="l00326"></a>00326
<a name="l00327"></a>00327 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00328"></a>00328 <span class="comment">// InputSource: Setter methods</span>
<a name="l00329"></a>00329 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00330"></a><a class="code" href="classxercesc_1_1InputSource.html#a30493e827beb6798632d40f81be064c7">00330</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classxercesc_1_1InputSource.html#a30493e827beb6798632d40f81be064c7" title="Indicates if the parser should issue fatal error if this input source is not found...">InputSource::setIssueFatalErrorIfNotFound</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> flag)
<a name="l00331"></a>00331 {
<a name="l00332"></a>00332 fFatalErrorIfNotFound = flag;
<a name="l00333"></a>00333 }
<a name="l00334"></a>00334
<a name="l00335"></a>00335 XERCES_CPP_NAMESPACE_END
<a name="l00336"></a>00336
<a name="l00337"></a>00337 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 13 14:59:31 2009 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>