1921 lines
98 KiB
HTML
1921 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.3.9.1 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
|
|
<h1>xercesc::XMLPlatformUtils Class Reference</h1>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>
|
|
<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">XMLSize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#e0">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="#e0"></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z29_0">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="#z29_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z29_1">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="#z29_1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z29_2">Terminate</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform per-process parser termination. <a href="#z29_2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z29_3">panic</a> (const PanicHandler::PanicReasons reason)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The panic mechanism. <a href="#z29_3"></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">XMLFileMgr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_0">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="#z31_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLFilePos </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_1">curFilePos</a> (FileHandle theFile, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current file position. <a href="#z31_1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_2">closeFile</a> (FileHandle theFile, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the file handle. <a href="#z31_2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLFilePos </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_3">fileSize</a> (FileHandle theFile, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the file size. <a href="#z31_3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_4">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the file. <a href="#z31_4"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_5">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens a named file. <a href="#z31_5"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_6">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a named file to write. <a href="#z31_6"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_7">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a named file to write. <a href="#z31_7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">FileHandle </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_8">openStdInHandle</a> (<a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the standard input as a file. <a href="#z31_8"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLSize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_9">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads the file buffer. <a href="#z31_9"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_10">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes the buffer to the file. <a href="#z31_10"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z31_11">resetFile</a> (FileHandle theFile, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the file handle. <a href="#z31_11"></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">XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z33_0">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the full path from a relative path. <a href="#z33_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z33_1">getCurrentDirectory</a> (<a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the current working directory. <a href="#z33_1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z33_2">isAnySlash</a> (XMLCh c)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a charater is a slash. <a href="#z33_2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z33_3">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove occurences of the pair of dot slash. <a href="#z33_3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z33_4">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove occurences of the dot dot slash. <a href="#z33_4"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z33_5">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if a path is relative or absolute. <a href="#z33_5"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z33_6">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Utility to join two paths. <a href="#z33_6"></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">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z35_0">getCurrentMillis</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the system time in milliseconds. <a href="#z35_0"></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">XMLMutexMgr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z37_0">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="#z37_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z37_1">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#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes a mutex handle. <a href="#z37_1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z37_2">lockMutex</a> (void *const mtxHandle)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Locks a mutex handle. <a href="#z37_2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z37_3">makeMutex</a> (<a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a new mutex. <a href="#z37_3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z37_4">unlockMutex</a> (void *const mtxHandle)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unlocks a mutex. <a href="#z37_4"></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">XMLMsgLoader * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z39_0">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="#z39_0"></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z41_0">recognizeNEL</a> (bool state, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">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="#z41_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z41_1">isNELRecognized</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of fgNEL flag. <a href="#z41_1"></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z43_0">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="#z43_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z43_1">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="#z43_1"></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">XMLNetAccessor * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_0">fgNetAccessor</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The network accessor. <a href="#z27_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLTransService * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_1">fgTransService</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The transcoding service. <a href="#z27_1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">PanicHandler * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_2">fgUserPanicHandler</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The Panic Handler. <a href="#z27_2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">PanicHandler * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_3">fgDefaultPanicHandler</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The Panic Handler. <a href="#z27_3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">fgMemoryManager</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The configurable memory manager. <a href="#z27_4"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLFileMgr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_5">fgFileMgr</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLMutexMgr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_6">fgMutexMgr</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">XMLMutex * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_7">fgAtomicMutex</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Global mutex for fast or infrequent operations. <a href="#z27_7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_8">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>.
|
|
<p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="e0" doxytag="xercesc::XMLPlatformUtils::alignPointerForNewBlockAllocation"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLSize_t xercesc::XMLPlatformUtils::alignPointerForNewBlockAllocation </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">XMLSize_t </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>ptrSize</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_2" doxytag="xercesc::XMLPlatformUtils::closeFile"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::closeFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">FileHandle </td>
|
|
<td class="mdname" nowrap> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z37_1" doxytag="xercesc::XMLPlatformUtils::closeMutex"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::closeMutex </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">void *const </td>
|
|
<td class="mdname" nowrap> <em>mtxHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> used to allocate the object </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_1" doxytag="xercesc::XMLPlatformUtils::curFilePos"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLFilePos xercesc::XMLPlatformUtils::curFilePos </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">FileHandle </td>
|
|
<td class="mdname" nowrap> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_3" doxytag="xercesc::XMLPlatformUtils::fileSize"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLFilePos xercesc::XMLPlatformUtils::fileSize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">FileHandle </td>
|
|
<td class="mdname" nowrap> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Returns the size of the file in bytes </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z33_1" doxytag="xercesc::XMLPlatformUtils::getCurrentDirectory"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLCh* xercesc::XMLPlatformUtils::getCurrentDirectory </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl 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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z35_0" doxytag="xercesc::XMLPlatformUtils::getCurrentMillis"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">unsigned long xercesc::XMLPlatformUtils::getCurrentMillis </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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 compact><dt><b>Returns:</b></dt><dd>Returns the system time as an unsigned long </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z33_0" doxytag="xercesc::XMLPlatformUtils::getFullPath"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLCh* xercesc::XMLPlatformUtils::getFullPath </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>srcPath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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 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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z29_1" doxytag="xercesc::XMLPlatformUtils::Initialize"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::Initialize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">XMLSize_t </td>
|
|
<td class="mdname" nowrap> <em>initialDOMHeapAllocSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>XMLSize_t </td>
|
|
<td class="mdname" nowrap> <em>maxDOMHeapAllocSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>XMLSize_t </td>
|
|
<td class="mdname" nowrap> <em>maxDOMSubAllocationSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const char *const </td>
|
|
<td class="mdname" nowrap> <em>locale</em> = <code>XMLUni::fgXercescDefaultLocale</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const char *const </td>
|
|
<td class="mdname" nowrap> <em>nlsHome</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>PanicHandler *const </td>
|
|
<td class="mdname" nowrap> <em>panicHandler</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>memoryManager</em> = <code>0</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">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">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">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#z29_0">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#z29_0">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#z29_2">Terminate()</a> (or multiple <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z29_2">Terminate()</a> in the case where multiple <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z29_0">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#z29_2">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#z29_2">XMLPlatformUtils::Terminate()</a> </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z29_0" doxytag="xercesc::XMLPlatformUtils::Initialize"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::Initialize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const char *const </td>
|
|
<td class="mdname" nowrap> <em>locale</em> = <code>XMLUni::fgXercescDefaultLocale</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const char *const </td>
|
|
<td class="mdname" nowrap> <em>nlsHome</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>PanicHandler *const </td>
|
|
<td class="mdname" nowrap> <em>panicHandler</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>memoryManager</em> = <code>0</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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#z29_0">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#z29_0">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#z29_2">Terminate()</a> (or multiple <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z29_2">Terminate()</a> in the case where multiple <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z29_0">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#z29_2">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#z29_2">XMLPlatformUtils::Terminate()</a> </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z33_2" doxytag="xercesc::XMLPlatformUtils::isAnySlash"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">bool xercesc::XMLPlatformUtils::isAnySlash </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">XMLCh </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>c</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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 compact><dt><b>Returns:</b></dt><dd>true if the character examined is a slash false otherwise </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z41_1" doxytag="xercesc::XMLPlatformUtils::isNELRecognized"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">bool xercesc::XMLPlatformUtils::isNELRecognized </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Return the value of fgNEL flag.
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z33_5" doxytag="xercesc::XMLPlatformUtils::isRelative"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">bool xercesc::XMLPlatformUtils::isRelative </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>toCheck</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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#z33_6">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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Returns true if the filename appears to be relative </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z43_1" doxytag="xercesc::XMLPlatformUtils::isStrictIANAEncoding"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">bool xercesc::XMLPlatformUtils::isStrictIANAEncoding </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns whether a strict IANA encoding name check is enabled or disabled.
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z39_0" doxytag="xercesc::XMLPlatformUtils::loadMsgSet"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLMsgLoader* xercesc::XMLPlatformUtils::loadMsgSet </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh *const </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>msgDomain</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z37_2" doxytag="xercesc::XMLPlatformUtils::lockMutex"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::lockMutex </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">void *const </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>mtxHandle</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_0" doxytag="xercesc::XMLPlatformUtils::makeFileMgr"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLFileMgr* xercesc::XMLPlatformUtils::makeFileMgr </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>manager</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z37_3" doxytag="xercesc::XMLPlatformUtils::makeMutex"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void* xercesc::XMLPlatformUtils::makeMutex </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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#z37_1">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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z37_0" doxytag="xercesc::XMLPlatformUtils::makeMutexMgr"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLMutexMgr* xercesc::XMLPlatformUtils::makeMutexMgr </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>manager</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_5" doxytag="xercesc::XMLPlatformUtils::openFile"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">FileHandle xercesc::XMLPlatformUtils::openFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The file handle of the opened file </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_4" doxytag="xercesc::XMLPlatformUtils::openFile"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">FileHandle xercesc::XMLPlatformUtils::openFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const char *const </td>
|
|
<td class="mdname" nowrap> <em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The file handle of the opened file </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_7" doxytag="xercesc::XMLPlatformUtils::openFileToWrite"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">FileHandle xercesc::XMLPlatformUtils::openFileToWrite </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The file handle of the opened file </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_6" doxytag="xercesc::XMLPlatformUtils::openFileToWrite"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">FileHandle xercesc::XMLPlatformUtils::openFileToWrite </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const char *const </td>
|
|
<td class="mdname" nowrap> <em>fileName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The file handle of the opened file </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_8" doxytag="xercesc::XMLPlatformUtils::openStdInHandle"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">FileHandle xercesc::XMLPlatformUtils::openStdInHandle </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The file handle of the standard input stream </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z29_3" doxytag="xercesc::XMLPlatformUtils::panic"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::panic </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const PanicHandler::PanicReasons </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>reason</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_9" doxytag="xercesc::XMLPlatformUtils::readFileBuffer"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLSize_t xercesc::XMLPlatformUtils::readFileBuffer </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">FileHandle </td>
|
|
<td class="mdname" nowrap> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLSize_t </td>
|
|
<td class="mdname" nowrap> <em>toRead</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>XMLByte *const </td>
|
|
<td class="mdname" nowrap> <em>toFill</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Returns the number of bytes read from the stream or file </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z41_0" doxytag="xercesc::XMLPlatformUtils::recognizeNEL"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::recognizeNEL </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">bool </td>
|
|
<td class="mdname" nowrap> <em>state</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z33_4" doxytag="xercesc::XMLPlatformUtils::removeDotDotSlash"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::removeDotDotSlash </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>srcPath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd></dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z33_3" doxytag="xercesc::XMLPlatformUtils::removeDotSlash"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::removeDotSlash </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>srcPath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd></dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_11" doxytag="xercesc::XMLPlatformUtils::resetFile"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::resetFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">FileHandle </td>
|
|
<td class="mdname" nowrap> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z43_0" doxytag="xercesc::XMLPlatformUtils::strictIANAEncoding"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::strictIANAEncoding </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const bool </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>state</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z29_2" doxytag="xercesc::XMLPlatformUtils::Terminate"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::Terminate </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z37_4" doxytag="xercesc::XMLPlatformUtils::unlockMutex"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::unlockMutex </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">void *const </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>mtxHandle</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z33_6" doxytag="xercesc::XMLPlatformUtils::weavePaths"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLCh* xercesc::XMLPlatformUtils::weavePaths </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>basePath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLCh *const </td>
|
|
<td class="mdname" nowrap> <em>relativePath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl 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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z31_10" doxytag="xercesc::XMLPlatformUtils::writeBufferToFile"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void xercesc::XMLPlatformUtils::writeBufferToFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">FileHandle const </td>
|
|
<td class="mdname" nowrap> <em>theFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>XMLSize_t </td>
|
|
<td class="mdname" nowrap> <em>toWrite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLByte *const </td>
|
|
<td class="mdname" nowrap> <em>toFlush</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const </td>
|
|
<td class="mdname" nowrap> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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">MemoryManager</a> to use to allocate objects </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Data Documentation</h2>
|
|
<a class="anchor" name="z27_7" doxytag="xercesc::XMLPlatformUtils::fgAtomicMutex"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLMutex* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_7">xercesc::XMLPlatformUtils::fgAtomicMutex</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z27_3" doxytag="xercesc::XMLPlatformUtils::fgDefaultPanicHandler"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">PanicHandler* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_3">xercesc::XMLPlatformUtils::fgDefaultPanicHandler</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The Panic Handler.
|
|
<p>
|
|
This is the default panic handler. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z27_5" doxytag="xercesc::XMLPlatformUtils::fgFileMgr"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLFileMgr* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_5">xercesc::XMLPlatformUtils::fgFileMgr</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z27_4" doxytag="xercesc::XMLPlatformUtils::fgMemoryManager"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a>* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_4">xercesc::XMLPlatformUtils::fgMemoryManager</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z27_6" doxytag="xercesc::XMLPlatformUtils::fgMutexMgr"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLMutexMgr* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_6">xercesc::XMLPlatformUtils::fgMutexMgr</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z27_0" doxytag="xercesc::XMLPlatformUtils::fgNetAccessor"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLNetAccessor* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_0">xercesc::XMLPlatformUtils::fgNetAccessor</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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#z29_0">Initialize()</a>. This works because this object is not required during initialization, and only comes into play during actual XML parsing.</em> </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z27_1" doxytag="xercesc::XMLPlatformUtils::fgTransService"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">XMLTransService* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_1">xercesc::XMLPlatformUtils::fgTransService</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z27_2" doxytag="xercesc::XMLPlatformUtils::fgUserPanicHandler"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">PanicHandler* <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_2">xercesc::XMLPlatformUtils::fgUserPanicHandler</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The Panic Handler.
|
|
<p>
|
|
This is the application provided panic handler. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z27_8" doxytag="xercesc::XMLPlatformUtils::fgXMLChBigEndian"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">bool <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z27_8">xercesc::XMLPlatformUtils::fgXMLChBigEndian</a><code> [static]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<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>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55: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.3.9.1 </small></address>
|
|
</body>
|
|
</html>
|