mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

v2.2.2

Browse source
This commit is contained in:
King_DuckZ 2020-02-17 22:19:08 +01:00
parent 4bc0157dcd
commit 1613a190f0
2427 changed files with 125503 additions and 133080 deletions
Download patch file Download diff file Expand all files Collapse all files

250
docs/simple-api/classxercesc_1_1LocalFileInputSource.html
View file

@ -5,103 +5,88 @@
<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.5.5 -->
<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="classes.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="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</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 class="navpath"><a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1LocalFileInputSource.html">LocalFileInputSource</a>
</div>
</div>
<div class="contents">
<h1>xercesc::LocalFileInputSource Class Reference</h1><!-- doxytag: class="xercesc::LocalFileInputSource" --><!-- doxytag: inherits="xercesc::InputSource" -->This class is a derivative of the standard <a class="el" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a> class.
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>xercesc::LocalFileInputSource Class Reference</h1>This class is a derivative of the standard <a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="LocalFileInputSource_8hpp-source.html">LocalFileInputSource.hpp</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for xercesc::LocalFileInputSource:</div>
<div class="dynsection">
<p><center><img src="classxercesc_1_1LocalFileInputSource__inherit__graph.png" border="0" usemap="#xercesc_1_1LocalFileInputSource__inherit__map" alt="Inheritance graph"></center>
Inheritance diagram for xercesc::LocalFileInputSource:<p><center><img src="classxercesc_1_1LocalFileInputSource__inherit__graph.png" border="0" usemap="#xercesc_1_1LocalFileInputSource__inherit__map" alt="Inheritance graph"></center>
<map name="xercesc_1_1LocalFileInputSource__inherit__map">
<area shape="rect" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity." alt="" coords="32,82,176,106"><area shape="rect" href="classxercesc_1_1XMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete..." alt="" coords="39,7,169,31"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classxercesc_1_1LocalFileInputSource-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<area href="classxercesc_1_1InputSource.html" shape="rect" coords="32,81,179,105" alt="">
<area href="classxercesc_1_1XMemory.html" shape="rect" coords="40,7,171,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxercesc_1_1LocalFileInputSource-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#f68596ec4e95a0ce50fa6f7de611da63">LocalFileInputSource</a> (const XMLCh *const basePath, const XMLCh *const relativePath, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#z105_0">LocalFileInputSource</a> (const XMLCh *const basePath, const XMLCh *const relativePath, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A local file input source requires a path to the file to load. <a href="#f68596ec4e95a0ce50fa6f7de611da63"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#37c16c37af1412902ebbb8db81e4d053">LocalFileInputSource</a> (const XMLCh *const filePath, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A local file input source requires a path to the file to load. <a href="#z105_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#z105_1">LocalFileInputSource</a> (const XMLCh *const filePath, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This constructor takes a single parameter which is the fully qualified or relative path. <a href="#37c16c37af1412902ebbb8db81e4d053"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This constructor takes a single parameter which is the fully qualified or relative path. <a href="#z105_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#6f494df557d4e426fcade88f5d2fb5f9">~LocalFileInputSource</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#z107_0">~LocalFileInputSource</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Virtual methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual BinInputStream *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#2e4084fefbfa564f0033d245ea397282">makeStream</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual BinInputStream *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#z109_0">makeStream</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method will return a binary input stream derivative that will parse from the local file indicatedby the system id. <a href="#2e4084fefbfa564f0033d245ea397282"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method will return a binary input stream derivative that will parse from the local file indicatedby the system id. <a href="#z109_0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is a derivative of the standard <a class="el" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a> class.
This class is a derivative of the standard <a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> class.
<p>
It provides for the parser access to data which is referenced via a local file path, as apposed to remote file or URL. This is the most efficacious mechanism by which local files can be parsed, since the parse knows that it refers to a local file and will make no other attempts to interpret the passed path.<p>
The path provided can either be a fully qualified path or a relative path. If relative, it will be completed either relative to a passed base path or relative to the current working directory of the process.<p>
As with all <a class="el" href="classxercesc_1_1InputSource.html" title="A single input source for an XML entity.">InputSource</a> derivatives. The primary objective of an input source is to create an input stream via which the parser can spool in data from the referenced source. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="f68596ec4e95a0ce50fa6f7de611da63"></a><!-- doxytag: member="xercesc::LocalFileInputSource::LocalFileInputSource" ref="f68596ec4e95a0ce50fa6f7de611da63" args="(const XMLCh *const basePath, const XMLCh *const relativePath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
As with all <a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> derivatives. The primary objective of an input source is to create an input stream via which the parser can spool in data from the referenced source.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z105_0" doxytag="xercesc::LocalFileInputSource::LocalFileInputSource"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="memname">xercesc::LocalFileInputSource::LocalFileInputSource </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>basePath</em>, </td>
<td class="md" nowrap valign="top">xercesc::LocalFileInputSource::LocalFileInputSource </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const XMLCh *const &nbsp;</td>
<td class="mdname" nowrap> <em>basePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>relativePath</em>, </td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh *const &nbsp;</td>
<td class="mdname" nowrap> <em>relativePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
A local file input source requires a path to the file to load.
<p>
This can be provided either as a fully qualified path, a path relative to the current working directly, or a path relative to a provided base path.<p>
The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' <a class="el" href="classxercesc_1_1InputSource.html#d88b92735d82dcadf39496ca83357aec" title="Set the public identifier for this input source.">setPublicId()</a> method of course.<p>
The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' <a class="el" href="classxercesc_1_1InputSource.html#z101_1">setPublicId()</a> method of course.<p>
This constructor takes an explicit base path and a possibly relative path. If the relative path is seen to be fully qualified, it is used as is. Otherwise, it is made relative to the passed base path.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
@ -115,39 +100,47 @@ This constructor takes an explicit base path and a possibly relative path. If th
<tr><td valign="top"></td><td valign="top"><em>XMLException</em>&nbsp;</td><td>If the path is relative and doesn't properly resolve to a file. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="37c16c37af1412902ebbb8db81e4d053"></a><!-- doxytag: member="xercesc::LocalFileInputSource::LocalFileInputSource" ref="37c16c37af1412902ebbb8db81e4d053" args="(const XMLCh *const filePath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
</td>
</tr>
</table>
<a class="anchor" name="z105_1" doxytag="xercesc::LocalFileInputSource::LocalFileInputSource"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="memname">xercesc::LocalFileInputSource::LocalFileInputSource </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>filePath</em>, </td>
<td class="md" nowrap valign="top">xercesc::LocalFileInputSource::LocalFileInputSource </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const XMLCh *const &nbsp;</td>
<td class="mdname" nowrap> <em>filePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This constructor takes a single parameter which is the fully qualified or relative path.
<p>
If it is fully qualified, it is taken as is. If it is relative, then it is completed relative to the current working directory (or the equivalent on the local host machine.)<p>
The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' <a class="el" href="classxercesc_1_1InputSource.html#d88b92735d82dcadf39496ca83357aec" title="Set the public identifier for this input source.">setPublicId()</a> method of course.<p>
The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' <a class="el" href="classxercesc_1_1InputSource.html#z101_1">setPublicId()</a> method of course.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filePath</em>&nbsp;</td><td>The relative or fully qualified path.</td></tr>
@ -159,58 +152,73 @@ The completed path will become the system id of this input source. The construct
<tr><td valign="top"></td><td valign="top"><em>XMLException</em>&nbsp;</td><td>If the path is relative and doesn't properly resolve to a file. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6f494df557d4e426fcade88f5d2fb5f9"></a><!-- doxytag: member="xercesc::LocalFileInputSource::~LocalFileInputSource" ref="6f494df557d4e426fcade88f5d2fb5f9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
</td>
</tr>
</table>
<a class="anchor" name="z107_0" doxytag="xercesc::LocalFileInputSource::~LocalFileInputSource"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="memname">xercesc::LocalFileInputSource::~LocalFileInputSource </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
<td class="md" nowrap valign="top">xercesc::LocalFileInputSource::~<a class="el" href="classxercesc_1_1LocalFileInputSource.html">LocalFileInputSource</a> </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></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</div>
</div><p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2e4084fefbfa564f0033d245ea397282"></a><!-- doxytag: member="xercesc::LocalFileInputSource::makeStream" ref="2e4084fefbfa564f0033d245ea397282" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<a class="anchor" name="z109_0" doxytag="xercesc::LocalFileInputSource::makeStream"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="memname">virtual BinInputStream* xercesc::LocalFileInputSource::makeStream </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
<td class="md" nowrap valign="top">virtual BinInputStream* xercesc::LocalFileInputSource::makeStream </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> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This method will return a binary input stream derivative that will parse from the local file indicatedby the system id.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A dynamically allocated binary input stream derivative that can parse from the file indicated by the system id. </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>A dynamically allocated binary input stream derivative that can parse from the file indicated by the system id. </dd></dl>
<p>Implements <a class="el" href="classxercesc_1_1InputSource.html#9d3101df0ae8a72045f81a7028bc36d8">xercesc::InputSource</a>.</p>
</div>
</div><p>
<p>
Implements <a class="el" href="classxercesc_1_1InputSource.html#z97_0">xercesc::InputSource</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="LocalFileInputSource_8hpp-source.html">LocalFileInputSource.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:54:32 2009 for XQilla Simple API by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:42 2009 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
</body>
</html>