1591 lines
98 KiB
HTML
1591 lines
98 KiB
HTML
<!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 DOM3 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&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 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 List</span></a></li>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navpath"><a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1XMLPlatformUtils.html">XMLPlatformUtils</a>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>xercesc::XMLPlatformUtils Class Reference</h1><!-- doxytag: class="xercesc::XMLPlatformUtils" -->Utilities that must be implemented in a platform-specific way.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="PlatformUtils_8hpp-source.html">PlatformUtils.hpp</a>></code>
|
|
<p>
|
|
|
|
<p>
|
|
<a href="classxercesc_1_1XMLPlatformUtils-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLSize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#b58a9f42877d00602bf61f22c7b9e0ad">alignPointerForNewBlockAllocation</a> (XMLSize_t ptrSize)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Aligns the specified pointer per platform block allocation requirements. <a href="#b58a9f42877d00602bf61f22c7b9e0ad"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Initialization and Panic methods</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d3db6200ab6c45e2b429dac7812f7cc1">Initialize</a> (const char *const locale=XMLUni::fgXercescDefaultLocale, const char *const nlsHome=0, PanicHandler *const panicHandler=0, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const memoryManager=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform per-process parser initialization. <a href="#d3db6200ab6c45e2b429dac7812f7cc1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#03aac67d80ce9bd88932023a59687a20">Initialize</a> (XMLSize_t initialDOMHeapAllocSize, XMLSize_t maxDOMHeapAllocSize, XMLSize_t maxDOMSubAllocationSize, const char *const locale=XMLUni::fgXercescDefaultLocale, const char *const nlsHome=0, PanicHandler *const panicHandler=0, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const memoryManager=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform per-process parser initialization. <a href="#03aac67d80ce9bd88932023a59687a20"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1">Terminate</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform per-process parser termination. <a href="#865c8490106f9a6323486c7b80a3fba1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#8285dff588a7a6a0945e695380ef12c7">panic</a> (const PanicHandler::PanicReasons reason)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The panic mechanism. <a href="#8285dff588a7a6a0945e695380ef12c7"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">File Methods</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLFileMgr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#9d1b793c68ba64d40dde775192feed66">makeFileMgr</a> (<a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a new file object appropriate for the platform. <a href="#9d1b793c68ba64d40dde775192feed66"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLFilePos </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#19af444c7c151bbc1c3bc1275268ba82">curFilePos</a> (FileHandle theFile, <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"> </td><td class="mdescRight">Get the current file position. <a href="#19af444c7c151bbc1c3bc1275268ba82"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#c55ab01e766b093e89b5d54f3fb137f3">closeFile</a> (FileHandle theFile, <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"> </td><td class="mdescRight">Closes the file handle. <a href="#c55ab01e766b093e89b5d54f3fb137f3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLFilePos </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#a094a889339ad1a5bcb1d7ad126213ae">fileSize</a> (FileHandle theFile, <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"> </td><td class="mdescRight">Returns the file size. <a href="#a094a889339ad1a5bcb1d7ad126213ae"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#542e2ad3f8a7b6a0cc2811da6e2d6668">openFile</a> (const char *const fileName, <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"> </td><td class="mdescRight">Opens the file. <a href="#542e2ad3f8a7b6a0cc2811da6e2d6668"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#8909bf64f58760dbb638c64441a0e86b">openFile</a> (const XMLCh *const fileName, <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"> </td><td class="mdescRight">Opens a named file. <a href="#8909bf64f58760dbb638c64441a0e86b"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#248f0c528f378e97bd9677a98ac6e280">openFileToWrite</a> (const char *const fileName, <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"> </td><td class="mdescRight">Open a named file to write. <a href="#248f0c528f378e97bd9677a98ac6e280"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#31c57f9e2460998d494ceb8d404c52f6">openFileToWrite</a> (const XMLCh *const fileName, <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"> </td><td class="mdescRight">Open a named file to write. <a href="#31c57f9e2460998d494ceb8d404c52f6"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#9931e001ce1ec647e629da1bb6ec8748">openStdInHandle</a> (<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"> </td><td class="mdescRight">Opens the standard input as a file. <a href="#9931e001ce1ec647e629da1bb6ec8748"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLSize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#b59a19cee3f8845c3af3b9ced4c3b9bc">readFileBuffer</a> (FileHandle theFile, const XMLSize_t toRead, XMLByte *const toFill, <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"> </td><td class="mdescRight">Reads the file buffer. <a href="#b59a19cee3f8845c3af3b9ced4c3b9bc"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#8f68c8a23e66005a8dceffaf24f5fe47">writeBufferToFile</a> (FileHandle const theFile, XMLSize_t toWrite, const XMLByte *const toFlush, <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"> </td><td class="mdescRight">Writes the buffer to the file. <a href="#8f68c8a23e66005a8dceffaf24f5fe47"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#ec4ea8fb00f109b207ffbe4ed33d3714">resetFile</a> (FileHandle theFile, <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"> </td><td class="mdescRight">Resets the file handle. <a href="#ec4ea8fb00f109b207ffbe4ed33d3714"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">File System Methods</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#dee1b55606f98d42446b75ba3330d578">getFullPath</a> (const XMLCh *const srcPath, <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"> </td><td class="mdescRight">Gets the full path from a relative path. <a href="#dee1b55606f98d42446b75ba3330d578"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#0a3cf7e45d7779ff70abd9cd04aca38a">getCurrentDirectory</a> (<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"> </td><td class="mdescRight">Gets the current working directory. <a href="#0a3cf7e45d7779ff70abd9cd04aca38a"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#5d11cab9d17eace29c57adaf9fffc993">isAnySlash</a> (XMLCh c)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a charater is a slash. <a href="#5d11cab9d17eace29c57adaf9fffc993"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d331e46bd8e98c658607b7c5ee5309bb">removeDotSlash</a> (XMLCh *const srcPath, <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"> </td><td class="mdescRight">Remove occurences of the pair of dot slash. <a href="#d331e46bd8e98c658607b7c5ee5309bb"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#82adca6243984fa993c76b7111ac3cc2">removeDotDotSlash</a> (XMLCh *const srcPath, <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"> </td><td class="mdescRight">Remove occurences of the dot dot slash. <a href="#82adca6243984fa993c76b7111ac3cc2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#f299e7bdd861ad61670fdc024e5497a7">isRelative</a> (const XMLCh *const toCheck, <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"> </td><td class="mdescRight">Determines if a path is relative or absolute. <a href="#f299e7bdd861ad61670fdc024e5497a7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#77a8cf5c5e50e631ee96249da8ea3a49">weavePaths</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="mdescLeft"> </td><td class="mdescRight">Utility to join two paths. <a href="#77a8cf5c5e50e631ee96249da8ea3a49"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Timing Methods</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#7a44e8540b03f08370471ff6fd0628b9">getCurrentMillis</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the system time in milliseconds. <a href="#7a44e8540b03f08370471ff6fd0628b9"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Mutex Methods</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLMutexMgr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#e0710880d6b6bafa2c914b2534d345f5">makeMutexMgr</a> (<a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Factory method for creating MutexMgr object. <a href="#e0710880d6b6bafa2c914b2534d345f5"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#289fea8517909a8cc6c8825e132d72b7">closeMutex</a> (void *const mtxHandle, <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"> </td><td class="mdescRight">Closes a mutex handle. <a href="#289fea8517909a8cc6c8825e132d72b7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#ad2309292f81a14bb0f0094dbf9af816">lockMutex</a> (void *const mtxHandle)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Locks a mutex handle. <a href="#ad2309292f81a14bb0f0094dbf9af816"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#b8e0a6bf3b909c8dff4cfb89e077fc20">makeMutex</a> (<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"> </td><td class="mdescRight">Make a new mutex. <a href="#b8e0a6bf3b909c8dff4cfb89e077fc20"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#1f4097f6fa527520b5fc62fb180ab096">unlockMutex</a> (void *const mtxHandle)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unlocks a mutex. <a href="#1f4097f6fa527520b5fc62fb180ab096"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">External Message Support</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLMsgLoader * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#e9764323981fa35b0565ae12e9158f4e">loadMsgSet</a> (const XMLCh *const msgDomain)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads the message set from among the available domains. <a href="#e9764323981fa35b0565ae12e9158f4e"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">NEL Character Handling</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2ca31a9fec4bdc937eef20d8f368af41">recognizeNEL</a> (bool state, <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"> </td><td class="mdescRight">This function enables the recognition of NEL(0x85) char and LSEP (0x2028) as newline chars which is disabled by default. <a href="#2ca31a9fec4bdc937eef20d8f368af41"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#26eb661a28e85d71071513267d745e6f">isNELRecognized</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of fgNEL flag. <a href="#26eb661a28e85d71071513267d745e6f"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Strict IANA Encoding Checking</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#824710f518eecb382ee27c5b5e7e4bf7">strictIANAEncoding</a> (const bool state)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function enables/disables strict IANA encoding names checking. <a href="#824710f518eecb382ee27c5b5e7e4bf7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#3acffa5db6af9518011b00e5a7530dce">isStrictIANAEncoding</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a strict IANA encoding name check is enabled or disabled. <a href="#3acffa5db6af9518011b00e5a7530dce"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Public Static Data</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLNetAccessor * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#6e4eda2fc24324bb88266ef99c79f66c">fgNetAccessor</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The network accessor. <a href="#6e4eda2fc24324bb88266ef99c79f66c"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLTransService * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#189b268974c4e937e22a1f6fc4ee7ab3">fgTransService</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The transcoding service. <a href="#189b268974c4e937e22a1f6fc4ee7ab3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static PanicHandler * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#26ff562f840d78b925e1ff4755b513e9">fgUserPanicHandler</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The Panic Handler. <a href="#26ff562f840d78b925e1ff4755b513e9"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static PanicHandler * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#dcd97086ea0267e69bad7a7401ed93a5">fgDefaultPanicHandler</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The Panic Handler. <a href="#dcd97086ea0267e69bad7a7401ed93a5"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">fgMemoryManager</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The configurable memory manager. <a href="#2521473ea52894e9313573d330a264b4"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLFileMgr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#57dbb6a237fbfbb4c3807a58cc07a50e">fgFileMgr</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLMutexMgr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#0b0f7c69af1a83bd042f83a0ac6e21f1">fgMutexMgr</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static XMLMutex * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#290cdb4f617a825e9217c5613ee97881">fgAtomicMutex</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Global mutex for fast or infrequent operations. <a href="#290cdb4f617a825e9217c5613ee97881"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#6c017906c604f8c6a349e1ccca17620c">fgXMLChBigEndian</a></td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Utilities that must be implemented in a platform-specific way.
|
|
<p>
|
|
This class contains methods that must be implemented in a platform specific manner. The actual implementations of these methods are available in the per-platform files indide <code>src/util/Platforms </code>. <hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="d3db6200ab6c45e2b429dac7812f7cc1"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::Initialize" ref="d3db6200ab6c45e2b429dac7812f7cc1" args="(const char *const locale=XMLUni::fgXercescDefaultLocale, const char *const nlsHome=0, PanicHandler *const panicHandler=0, MemoryManager *const memoryManager=0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::Initialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>locale</em> = <code>XMLUni::fgXercescDefaultLocale</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>nlsHome</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">PanicHandler *const </td>
|
|
<td class="paramname"> <em>panicHandler</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>memoryManager</em> = <code>0</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Perform per-process parser initialization.
|
|
<p>
|
|
Initialization <b>must</b> be called first in any client code.<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>locale</em> </td><td>The locale to use for messages.</td></tr>
|
|
</table>
|
|
</dl>
|
|
The locale is set iff the <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d3db6200ab6c45e2b429dac7812f7cc1" title="Perform per-process parser initialization.">Initialize()</a> is invoked for the very first time, to ensure that each and every message loader, in the process space, share the same locale.<p>
|
|
All subsequent invocations of <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d3db6200ab6c45e2b429dac7812f7cc1" title="Perform per-process parser initialization.">Initialize()</a>, with a different locale, have no effect on the message loaders, either instantiated, or to be instantiated.<p>
|
|
To set to a different locale, client application needs to <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1" title="Perform per-process parser termination.">Terminate()</a> (or multiple <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1" title="Perform per-process parser termination.">Terminate()</a> in the case where multiple <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d3db6200ab6c45e2b429dac7812f7cc1" title="Perform per-process parser initialization.">Initialize()</a> have been invoked before), followed by Initialize(new_locale).<p>
|
|
The default locale is "en_US".<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>nlsHome</em> </td><td>User specified location where MsgLoader retrieves error message files. the discussion above with regard to locale, applies to nlsHome as well.</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>panicHandler</em> </td><td>Application's panic handler, application owns this handler. Application shall make sure that the plugged panic handler persists through the call to <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1" title="Perform per-process parser termination.">XMLPlatformUtils::Terminate()</a>.</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>memoryManager</em> </td><td>Plugged-in memory manager which is owned by the application. Applications must make sure that the plugged-in memory manager persist through the call to <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1" title="Perform per-process parser termination.">XMLPlatformUtils::Terminate()</a> </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="03aac67d80ce9bd88932023a59687a20"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::Initialize" ref="03aac67d80ce9bd88932023a59687a20" args="(XMLSize_t initialDOMHeapAllocSize, XMLSize_t maxDOMHeapAllocSize, XMLSize_t maxDOMSubAllocationSize, const char *const locale=XMLUni::fgXercescDefaultLocale, const char *const nlsHome=0, PanicHandler *const panicHandler=0, MemoryManager *const memoryManager=0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::Initialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">XMLSize_t </td>
|
|
<td class="paramname"> <em>initialDOMHeapAllocSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XMLSize_t </td>
|
|
<td class="paramname"> <em>maxDOMHeapAllocSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XMLSize_t </td>
|
|
<td class="paramname"> <em>maxDOMSubAllocationSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>locale</em> = <code>XMLUni::fgXercescDefaultLocale</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>nlsHome</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">PanicHandler *const </td>
|
|
<td class="paramname"> <em>panicHandler</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>memoryManager</em> = <code>0</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Perform per-process parser initialization.
|
|
<p>
|
|
Initialization <b>must</b> be called first in any client code.<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>initialDOMHeapAllocSize</em> </td><td>The size of the first memory block allocated by the <a class="el" href="classxercesc_1_1DOMDocument.html" title="The DOMDocument interface represents the entire XML document.">DOMDocument</a> heap. Note that changing this parameter may result in poor performance and/or excessive memory usage. For the default value refer to dom/impl/DOMDocumentImpl.cpp.</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>maxDOMHeapAllocSize</em> </td><td>The maximum size of the memory block allocated by the <a class="el" href="classxercesc_1_1DOMDocument.html" title="The DOMDocument interface represents the entire XML document.">DOMDocument</a> heap. As the document grows, the allocated by the heap memory blocks grow from initialDOMHeapAllocSize to maxDOMHeapAllocSize. Note that changing this parameter may result in poor performance and/or excessive memory usage. For the default value refer to dom/impl/DOMDocumentImpl.cpp.</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>maxDOMSubAllocationSize</em> </td><td>The maximum size of the memory block requested that is handled by the <a class="el" href="classxercesc_1_1DOMDocument.html" title="The DOMDocument interface represents the entire XML document.">DOMDocument</a> heap. A request for a larger block is handled directly by the memory manager. Note that changing this parameter may result in poor performance and/or excessive memory usage. For the default value refer to dom/impl/DOMDocumentImpl.cpp.</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>The locale to use for messages.</td></tr>
|
|
</table>
|
|
</dl>
|
|
The locale is set iff the <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d3db6200ab6c45e2b429dac7812f7cc1" title="Perform per-process parser initialization.">Initialize()</a> is invoked for the very first time, to ensure that each and every message loader, in the process space, share the same locale.<p>
|
|
All subsequent invocations of <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d3db6200ab6c45e2b429dac7812f7cc1" title="Perform per-process parser initialization.">Initialize()</a>, with a different locale, have no effect on the message loaders, either instantiated, or to be instantiated.<p>
|
|
To set to a different locale, client application needs to <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1" title="Perform per-process parser termination.">Terminate()</a> (or multiple <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1" title="Perform per-process parser termination.">Terminate()</a> in the case where multiple <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d3db6200ab6c45e2b429dac7812f7cc1" title="Perform per-process parser initialization.">Initialize()</a> have been invoked before), followed by Initialize(new_locale).<p>
|
|
The default locale is "en_US".<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>nlsHome</em> </td><td>User specified location where MsgLoader retrieves error message files. the discussion above with regard to locale, applies to nlsHome as well.</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>panicHandler</em> </td><td>Application's panic handler, application owns this handler. Application shall make sure that the plugged panic handler persists through the call to <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1" title="Perform per-process parser termination.">XMLPlatformUtils::Terminate()</a>.</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>memoryManager</em> </td><td>Plugged-in memory manager which is owned by the application. Applications must make sure that the plugged-in memory manager persist through the call to <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#865c8490106f9a6323486c7b80a3fba1" title="Perform per-process parser termination.">XMLPlatformUtils::Terminate()</a> </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="865c8490106f9a6323486c7b80a3fba1"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::Terminate" ref="865c8490106f9a6323486c7b80a3fba1" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::Terminate </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Perform per-process parser termination.
|
|
<p>
|
|
The termination call is currently optional, to aid those dynamically loading the parser to clean up before exit, or to avoid spurious reports from leak detectors.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8285dff588a7a6a0945e695380ef12c7"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::panic" ref="8285dff588a7a6a0945e695380ef12c7" args="(const PanicHandler::PanicReasons reason)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::panic </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const PanicHandler::PanicReasons </td>
|
|
<td class="paramname"> <em>reason</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
The panic mechanism.
|
|
<p>
|
|
If, during initialization, we cannot even get far enough along to get transcoding up or get message loading working, we call this method.<p>
|
|
Each platform can implement it however they want. This method will delegate the panic handling to a user specified panic handler or in the absence of it, the default panic handler.<p>
|
|
In case the default panic handler does not support a particular platform, the platform specific panic hanlding shall be implemented here .<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>reason</em> </td><td>The enumeration that defines the cause of the failure </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="9d1b793c68ba64d40dde775192feed66"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::makeFileMgr" ref="9d1b793c68ba64d40dde775192feed66" args="(MemoryManager *const manager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLFileMgr* xercesc::XMLPlatformUtils::makeFileMgr </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Make a new file object appropriate for the platform.
|
|
<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>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="19af444c7c151bbc1c3bc1275268ba82"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::curFilePos" ref="19af444c7c151bbc1c3bc1275268ba82" args="(FileHandle theFile, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLFilePos xercesc::XMLPlatformUtils::curFilePos </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FileHandle </td>
|
|
<td class="paramname"> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get the current file position.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to deterine the current position within the passed file.<p>
|
|
Since the file API provided here only reads, if the host platform supports separate read/write positions, only the read position is of any interest, and hence should be the one returned.<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>theFile</em> </td><td>The file handle </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c55ab01e766b093e89b5d54f3fb137f3"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::closeFile" ref="c55ab01e766b093e89b5d54f3fb137f3" args="(FileHandle theFile, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::closeFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FileHandle </td>
|
|
<td class="paramname"> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Closes the file handle.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to close the passed file handle, and to destroy the passed file handle and any allocated data or system resources it contains.<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>theFile</em> </td><td>The file handle to close </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a094a889339ad1a5bcb1d7ad126213ae"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fileSize" ref="a094a889339ad1a5bcb1d7ad126213ae" args="(FileHandle theFile, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLFilePos xercesc::XMLPlatformUtils::fileSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FileHandle </td>
|
|
<td class="paramname"> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Returns the file size.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to determine the current size of the file represented by the passed handle.<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>theFile</em> </td><td>The file handle whose size you want </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the size of the file in bytes </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="542e2ad3f8a7b6a0cc2811da6e2d6668"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::openFile" ref="542e2ad3f8a7b6a0cc2811da6e2d6668" args="(const char *const fileName, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static FileHandle xercesc::XMLPlatformUtils::openFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Opens the file.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to open passed file. If it fails, a null handle pointer should be returned.<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>fileName</em> </td><td>The string containing the name of the file </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The file handle of the opened file </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8909bf64f58760dbb638c64441a0e86b"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::openFile" ref="8909bf64f58760dbb638c64441a0e86b" args="(const XMLCh *const fileName, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static FileHandle xercesc::XMLPlatformUtils::openFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Opens a named file.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to open the passed file. If it fails, a null handle pointer should be returned.<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>fileName</em> </td><td>The string containing the name of the file </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The file handle of the opened file </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="248f0c528f378e97bd9677a98ac6e280"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::openFileToWrite" ref="248f0c528f378e97bd9677a98ac6e280" args="(const char *const fileName, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static FileHandle xercesc::XMLPlatformUtils::openFileToWrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"> <em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Open a named file to write.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to open passed file. If it fails, a null handle pointer should be returned.<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>fileName</em> </td><td>The string containing the name of the file </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The file handle of the opened file </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="31c57f9e2460998d494ceb8d404c52f6"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::openFileToWrite" ref="31c57f9e2460998d494ceb8d404c52f6" args="(const XMLCh *const fileName, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static FileHandle xercesc::XMLPlatformUtils::openFileToWrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Open a named file to write.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to open the passed file. If it fails, a null handle pointer should be returned.<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>fileName</em> </td><td>The string containing the name of the file </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The file handle of the opened file </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="9931e001ce1ec647e629da1bb6ec8748"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::openStdInHandle" ref="9931e001ce1ec647e629da1bb6ec8748" args="(MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static FileHandle xercesc::XMLPlatformUtils::openStdInHandle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Opens the standard input as a file.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to open a handle to the standard input. It should be a copy of the standard input handle, since it will be closed later!<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>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The file handle of the standard input stream </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="b59a19cee3f8845c3af3b9ced4c3b9bc"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::readFileBuffer" ref="b59a19cee3f8845c3af3b9ced4c3b9bc" args="(FileHandle theFile, const XMLSize_t toRead, XMLByte *const toFill, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLSize_t xercesc::XMLPlatformUtils::readFileBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FileHandle </td>
|
|
<td class="paramname"> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const XMLSize_t </td>
|
|
<td class="paramname"> <em>toRead</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XMLByte *const </td>
|
|
<td class="paramname"> <em>toFill</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Reads the file buffer.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to read up to 'toRead' bytes of data from the passed file, and return those bytes in the 'toFill' buffer. It is not an error not to read the requested number of bytes. When the end of file is reached, zero should be returned.<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>theFile</em> </td><td>The file handle to be read from. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>toRead</em> </td><td>The maximum number of byte to read from the current position </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>toFill</em> </td><td>The byte buffer to fill </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the number of bytes read from the stream or file </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8f68c8a23e66005a8dceffaf24f5fe47"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::writeBufferToFile" ref="8f68c8a23e66005a8dceffaf24f5fe47" args="(FileHandle const theFile, XMLSize_t toWrite, const XMLByte *const toFlush, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::writeBufferToFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FileHandle const </td>
|
|
<td class="paramname"> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XMLSize_t </td>
|
|
<td class="paramname"> <em>toWrite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const XMLByte *const </td>
|
|
<td class="paramname"> <em>toFlush</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Writes the buffer to the file.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local file services to write up to 'toWrite' bytes of data to the passed file. Unless exception raised by local file services, 'toWrite' bytes of data is to be written to the passed file.<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>theFile</em> </td><td>The file handle to be written to. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>toWrite</em> </td><td>The maximum number of byte to write from the current position </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>toFlush</em> </td><td>The byte buffer to flush </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ec4ea8fb00f109b207ffbe4ed33d3714"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::resetFile" ref="ec4ea8fb00f109b207ffbe4ed33d3714" args="(FileHandle theFile, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::resetFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FileHandle </td>
|
|
<td class="paramname"> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Resets the file handle.
|
|
<p>
|
|
This must be implemented by the per-platform driver which will use local file services to reset the file position to the start of the the file.<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>theFile</em> </td><td>The file handle that you want to reset </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="dee1b55606f98d42446b75ba3330d578"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::getFullPath" ref="dee1b55606f98d42446b75ba3330d578" args="(const XMLCh *const srcPath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLCh* xercesc::XMLPlatformUtils::getFullPath </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>srcPath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Gets the full path from a relative path.
|
|
<p>
|
|
This must be implemented by the per-platform driver. It should complete a relative path using the 'current directory', or whatever the local equivalent of a current directory is. If the passed source path is actually fully qualified, then a straight copy of it will be returned.<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>srcPath</em> </td><td>The path of the file for which you want the full path</td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>Pointer to the memory manager to be used to allocate objects.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the fully qualified path of the file name including the file name. This is dyanmically allocated and must be deleted by the caller when its no longer needed! The memory returned will beallocated using the static memory manager, if user do not supply a memory manager. Users then need to make sure to use either the default or user specific memory manager to deallocate the memory. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="0a3cf7e45d7779ff70abd9cd04aca38a"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::getCurrentDirectory" ref="0a3cf7e45d7779ff70abd9cd04aca38a" args="(MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLCh* xercesc::XMLPlatformUtils::getCurrentDirectory </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Gets the current working directory.
|
|
<p>
|
|
This must be implemented by the per-platform driver. It returns the current working directory is. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the current working directory. This is dyanmically allocated and must be deleted by the caller when its no longer needed! The memory returned will be allocated using the static memory manager, if users do not supply a memory manager. Users then need to make sure to use either the default or user specific memory manager to deallocate the memory. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="5d11cab9d17eace29c57adaf9fffc993"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::isAnySlash" ref="5d11cab9d17eace29c57adaf9fffc993" args="(XMLCh c)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool xercesc::XMLPlatformUtils::isAnySlash </td>
|
|
<td>(</td>
|
|
<td class="paramtype">XMLCh </td>
|
|
<td class="paramname"> <em>c</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Check if a charater is a slash.
|
|
<p>
|
|
This must be implemented by the per-platform driver.<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>c</em> </td><td>the character to be examined</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the character examined is a slash false otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d331e46bd8e98c658607b7c5ee5309bb"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::removeDotSlash" ref="d331e46bd8e98c658607b7c5ee5309bb" args="(XMLCh *const srcPath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::removeDotSlash </td>
|
|
<td>(</td>
|
|
<td class="paramtype">XMLCh *const </td>
|
|
<td class="paramname"> <em>srcPath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Remove occurences of the pair of dot slash.
|
|
<p>
|
|
To remove the sequence, dot slash if it is part of the sequence, slash dot slash.<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>srcPath</em> </td><td>The path for which you want to remove the dot slash sequence. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="82adca6243984fa993c76b7111ac3cc2"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::removeDotDotSlash" ref="82adca6243984fa993c76b7111ac3cc2" args="(XMLCh *const srcPath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::removeDotDotSlash </td>
|
|
<td>(</td>
|
|
<td class="paramtype">XMLCh *const </td>
|
|
<td class="paramname"> <em>srcPath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Remove occurences of the dot dot slash.
|
|
<p>
|
|
To remove the sequence, slash dot dot slash and its preceding path segment if and only if the preceding path segment is not slash dot dot slash.<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>srcPath</em> </td><td>The path for which you want to remove the slash dot dot slash sequence and its preceding path segment. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f299e7bdd861ad61670fdc024e5497a7"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::isRelative" ref="f299e7bdd861ad61670fdc024e5497a7" args="(const XMLCh *const toCheck, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool xercesc::XMLPlatformUtils::isRelative </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>toCheck</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Determines if a path is relative or absolute.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should determine whether the passed path is relative or not. The concept of relative and absolute might be... well relative on different platforms. But, as long as the determination is made consistently and in coordination with the <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#77a8cf5c5e50e631ee96249da8ea3a49" title="Utility to join two paths.">weavePaths()</a> method, it should work for any platform.<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>toCheck</em> </td><td>The file name which you want to check </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns true if the filename appears to be relative </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="77a8cf5c5e50e631ee96249da8ea3a49"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::weavePaths" ref="77a8cf5c5e50e631ee96249da8ea3a49" args="(const XMLCh *const basePath, const XMLCh *const relativePath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLCh* xercesc::XMLPlatformUtils::weavePaths </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>basePath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <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 </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Utility to join two paths.
|
|
<p>
|
|
This must be implemented by the per-platform driver, and should weave the relative path part together with the base part and return a new path that represents this combination.<p>
|
|
If the relative part turns out to be fully qualified, it will be returned as is. If it is not, then it will be woven onto the passed base path, by removing one path component for each leading "../" (or whatever is the equivalent in the local system) in the relative path.<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>basePath</em> </td><td>The string containing the base path </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>relativePath</em> </td><td>The string containing the relative path </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns a string containing the 'woven' path. It should be dynamically allocated and becomes the responsibility of the caller to delete. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="7a44e8540b03f08370471ff6fd0628b9"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::getCurrentMillis" ref="7a44e8540b03f08370471ff6fd0628b9" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static unsigned long xercesc::XMLPlatformUtils::getCurrentMillis </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Gets the system time in milliseconds.
|
|
<p>
|
|
This must be implemented by the per-platform driver, which should use local services to return the current value of a running millisecond timer. Note that the value returned is only as accurate as the millisecond time of the underyling host system.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the system time as an unsigned long </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e0710880d6b6bafa2c914b2534d345f5"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::makeMutexMgr" ref="e0710880d6b6bafa2c914b2534d345f5" args="(MemoryManager *const manager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLMutexMgr* xercesc::XMLPlatformUtils::makeMutexMgr </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Factory method for creating MutexMgr object.
|
|
<p>
|
|
This factory method creates a mutexmgr that will be used on the particular platform.<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>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="289fea8517909a8cc6c8825e132d72b7"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::closeMutex" ref="289fea8517909a8cc6c8825e132d72b7" args="(void *const mtxHandle, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::closeMutex </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void *const </td>
|
|
<td class="paramname"> <em>mtxHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Closes a mutex handle.
|
|
<p>
|
|
Each per-platform driver must implement this. Only it knows what the actual content of the passed mutex handle is.<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>mtxHandle</em> </td><td>The mutex handle that you want to close </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> used to allocate the object </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ad2309292f81a14bb0f0094dbf9af816"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::lockMutex" ref="ad2309292f81a14bb0f0094dbf9af816" args="(void *const mtxHandle)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::lockMutex </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void *const </td>
|
|
<td class="paramname"> <em>mtxHandle</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Locks a mutex handle.
|
|
<p>
|
|
Each per-platform driver must implement this. Only it knows what the actual content of the passed mutex handle is.<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>mtxHandle</em> </td><td>The mutex handle that you want to lock </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="b8e0a6bf3b909c8dff4cfb89e077fc20"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::makeMutex" ref="b8e0a6bf3b909c8dff4cfb89e077fc20" args="(MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void* xercesc::XMLPlatformUtils::makeMutex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Make a new mutex.
|
|
<p>
|
|
Each per-platform driver must implement this. Only it knows what the actual content of the passed mutex handle is. The returned handle pointer will be eventually passed to <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#289fea8517909a8cc6c8825e132d72b7" title="Closes a mutex handle.">closeMutex()</a> which is also implemented by the platform driver.<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>manager</em> </td><td>The <a class="el" href="classxercesc_1_1MemoryManager.html" title="Configurable memory manager.">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1f4097f6fa527520b5fc62fb180ab096"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::unlockMutex" ref="1f4097f6fa527520b5fc62fb180ab096" args="(void *const mtxHandle)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::unlockMutex </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void *const </td>
|
|
<td class="paramname"> <em>mtxHandle</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Unlocks a mutex.
|
|
<p>
|
|
Each per-platform driver must implement this. Only it knows what the actual content of the passed mutex handle is.<p>
|
|
Note that, since the underlying system synchronization services are used, Xerces cannot guarantee that lock/unlock operations are correctly enforced on a per-thread basis or that incorrect nesting of lock/unlock operations will be caught.<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>mtxHandle</em> </td><td>The mutex handle that you want to unlock </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e9764323981fa35b0565ae12e9158f4e"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::loadMsgSet" ref="e9764323981fa35b0565ae12e9158f4e" args="(const XMLCh *const msgDomain)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLMsgLoader* xercesc::XMLPlatformUtils::loadMsgSet </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"> <em>msgDomain</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Loads the message set from among the available domains.
|
|
<p>
|
|
The returned object must be dynamically allocated and the caller becomes responsible for cleaning it up.<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>msgDomain</em> </td><td>The message domain which you want to load </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="2ca31a9fec4bdc937eef20d8f368af41"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::recognizeNEL" ref="2ca31a9fec4bdc937eef20d8f368af41" args="(bool state, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::recognizeNEL </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>state</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function enables the recognition of NEL(0x85) char and LSEP (0x2028) as newline chars which is disabled by default.
|
|
<p>
|
|
It is only called once per process. Once it is set, any subsequent calls will result in exception being thrown.<p>
|
|
Note: 1. Turning this option on will make the parser non compliant to XML 1.0. 2. This option has no effect to document conforming to XML 1.1 compliant, which always recognize these two chars (0x85 and 0x2028) as newline characters.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="26eb661a28e85d71071513267d745e6f"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::isNELRecognized" ref="26eb661a28e85d71071513267d745e6f" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool xercesc::XMLPlatformUtils::isNELRecognized </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Return the value of fgNEL flag.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="824710f518eecb382ee27c5b5e7e4bf7"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::strictIANAEncoding" ref="824710f518eecb382ee27c5b5e7e4bf7" args="(const bool state)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void xercesc::XMLPlatformUtils::strictIANAEncoding </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"> <em>state</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function enables/disables strict IANA encoding names checking.
|
|
<p>
|
|
The strict checking is disabled by default.<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>state</em> </td><td>If true, a strict IANA encoding name check is performed, otherwise, no checking. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="3acffa5db6af9518011b00e5a7530dce"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::isStrictIANAEncoding" ref="3acffa5db6af9518011b00e5a7530dce" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool xercesc::XMLPlatformUtils::isStrictIANAEncoding </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Returns whether a strict IANA encoding name check is enabled or disabled.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="b58a9f42877d00602bf61f22c7b9e0ad"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::alignPointerForNewBlockAllocation" ref="b58a9f42877d00602bf61f22c7b9e0ad" args="(XMLSize_t ptrSize)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static XMLSize_t xercesc::XMLPlatformUtils::alignPointerForNewBlockAllocation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">XMLSize_t </td>
|
|
<td class="paramname"> <em>ptrSize</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Aligns the specified pointer per platform block allocation requirements.
|
|
<p>
|
|
The results of this function may be altered by defining XML_PLATFORM_NEW_BLOCK_ALIGNMENT.
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Member Data Documentation</h2>
|
|
<a class="anchor" name="6e4eda2fc24324bb88266ef99c79f66c"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgNetAccessor" ref="6e4eda2fc24324bb88266ef99c79f66c" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">XMLNetAccessor* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#6e4eda2fc24324bb88266ef99c79f66c">xercesc::XMLPlatformUtils::fgNetAccessor</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
The network accessor.
|
|
<p>
|
|
This is provided by the per-platform driver, so each platform can choose what actual implementation it wants to use. The object must be dynamically allocated.<p>
|
|
<em>Note that you may optionally, if your platform driver does not install a network accessor, set it manually from your client code after calling <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#d3db6200ab6c45e2b429dac7812f7cc1" title="Perform per-process parser initialization.">Initialize()</a>. This works because this object is not required during initialization, and only comes into play during actual XML parsing.</em>
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="189b268974c4e937e22a1f6fc4ee7ab3"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgTransService" ref="189b268974c4e937e22a1f6fc4ee7ab3" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">XMLTransService* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#189b268974c4e937e22a1f6fc4ee7ab3">xercesc::XMLPlatformUtils::fgTransService</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
The transcoding service.
|
|
<p>
|
|
This is provided by the per platform driver, so each platform can choose what implemenation it wants to use. When the platform independent initialization code needs to get a transcoding service object, it will call <code>makeTransService()</code> to ask the per-platform code to create one. Only one transcoding service object is reqeusted per-process, so it is shared and synchronized among parser instances within that process.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="26ff562f840d78b925e1ff4755b513e9"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgUserPanicHandler" ref="26ff562f840d78b925e1ff4755b513e9" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PanicHandler* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#26ff562f840d78b925e1ff4755b513e9">xercesc::XMLPlatformUtils::fgUserPanicHandler</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
The Panic Handler.
|
|
<p>
|
|
This is the application provided panic handler.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="dcd97086ea0267e69bad7a7401ed93a5"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgDefaultPanicHandler" ref="dcd97086ea0267e69bad7a7401ed93a5" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PanicHandler* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#dcd97086ea0267e69bad7a7401ed93a5">xercesc::XMLPlatformUtils::fgDefaultPanicHandler</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
The Panic Handler.
|
|
<p>
|
|
This is the default panic handler.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="2521473ea52894e9313573d330a264b4"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgMemoryManager" ref="2521473ea52894e9313573d330a264b4" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a>* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
The configurable memory manager.
|
|
<p>
|
|
This is the pluggable memory manager. If it is not provided by an application, a default implementation is used.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="57dbb6a237fbfbb4c3807a58cc07a50e"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgFileMgr" ref="57dbb6a237fbfbb4c3807a58cc07a50e" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">XMLFileMgr* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#57dbb6a237fbfbb4c3807a58cc07a50e">xercesc::XMLPlatformUtils::fgFileMgr</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="0b0f7c69af1a83bd042f83a0ac6e21f1"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgMutexMgr" ref="0b0f7c69af1a83bd042f83a0ac6e21f1" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">XMLMutexMgr* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#0b0f7c69af1a83bd042f83a0ac6e21f1">xercesc::XMLPlatformUtils::fgMutexMgr</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="290cdb4f617a825e9217c5613ee97881"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgAtomicMutex" ref="290cdb4f617a825e9217c5613ee97881" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">XMLMutex* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#290cdb4f617a825e9217c5613ee97881">xercesc::XMLPlatformUtils::fgAtomicMutex</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Global mutex for fast or infrequent operations.
|
|
<p>
|
|
Use this mutex only for fast (e.g., increment an integer, check flag, etc.) or infrequent (e.g., once-off initialization) operations.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6c017906c604f8c6a349e1ccca17620c"></a><!-- doxytag: member="xercesc::XMLPlatformUtils::fgXMLChBigEndian" ref="6c017906c604f8c6a349e1ccca17620c" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#6c017906c604f8c6a349e1ccca17620c">xercesc::XMLPlatformUtils::fgXMLChBigEndian</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="PlatformUtils_8hpp-source.html">PlatformUtils.hpp</a></ul>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:54:54 2009 for XQilla DOM Level 3 API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
</body>
|
|
</html>
|