Newer
Older
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache\@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
* Business Machines, Inc., http://www.ibm.com . For more information
* on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
*/
// ---------------------------------------------------------------------------
// Includes
// ---------------------------------------------------------------------------
#include <util/Janitor.hpp>
#include <util/PlatformUtils.hpp>
#include <util/RuntimeException.hpp>
#include <util/XMLExceptMsgs.hpp>
#include <util/XMLString.hpp>
#include <util/XMLUniDefs.hpp>
#ifdef _DEBUG
#ifdef _MSC_VER
#include <crtdbg.h>
#else
#include <assert.h>
#endif
#endif
//
// These control which transcoding service is used by the Win32 version.
// They allow this to be controlled from the build process by just defining
// one of these values.
//
#include <util/Transcoders/ICU/ICUTransService.hpp>
#include <util/Transcoders/Win32/Win32TransService.hpp>
//
// These control which message loading service is used by the Win32 version.
// They allow this to be controlled from the build process by just defining
// one of these values.
//
#include <util/MsgLoaders/InMemory/InMemMsgLoader.hpp>
#include <util/MsgLoaders/Win32/Win32MsgLoader.hpp>
//
// These control which network access service is used by the Win32 version.
// They allow this to be controlled from the build process by just defining
// one of these values.
//
#if defined (XML_USE_NETACCESSOR_LIBWWW)
#include <util/NetAccessors/libWWW/LibWWWNetAccessor.hpp>
#elif defined (XML_USE_NETACCESSOR_WINSOCK)
#include <util/NetAccessors/WinSock/WinSockNetAccessor.hpp>
// ---------------------------------------------------------------------------
// Local data
//
// gOnNT
// We figure out during init if we are on NT or not. If we are, then
// we can avoid a lot of transcoding in our system services stuff.
// ---------------------------------------------------------------------------
static bool gOnNT;
// ---------------------------------------------------------------------------
// XMLPlatformUtils: The panic method
// ---------------------------------------------------------------------------
void XMLPlatformUtils::panic(const PanicReasons reason)
{
const char* reasonStr = "Unknown reason";
if (reason == Panic_NoTransService)
reasonStr = "Could not load a transcoding service";
else if (reason == Panic_NoDefTranscoder)
reasonStr = "Could not load a local code page transcoder";
else if (reason == Panic_CantFindLib)
reasonStr = "Could not find the xerces-c DLL";
else if (reason == Panic_UnknownMsgDomain)
reasonStr = "Unknown message domain";
else if (reason == Panic_CantLoadMsgDomain)
reasonStr = "Cannot load message domain";
else if (reason == Panic_SynchronizationErr)
reasonStr = "A system synchronization error occurred";
else if (reason == Panic_SystemInit)
reasonStr = "Failed to complete platfrom dependent initialization";
//
// We just do a popup and exit. Replace this code to do whatever
// you need to do.
//
MessageBoxA
(
0
, "Xerces Panic Error"
, reasonStr
, MB_OK | MB_ICONSTOP
);
exit(-1);
}
// ---------------------------------------------------------------------------
// XMLPlatformUtils: File Methods
// ---------------------------------------------------------------------------
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
//
// Functions to look for Unicode forward and back slashes.
// This operation is complicated by the fact that some Japanese and Korean
// encodings use the same encoding for both '\' and their currency symbol
// (Yen or Won). In these encodings, which is meant is context dependent.
// Unicode converters choose the currency symbols. But in the context
// of a Windows file name, '\' is generally what was intended.
//
// So we make a leap of faith, and assume that if we get a Yen or Won
// here, in the context of a file name, that it originated in one of
// these encodings, and is really supposed to be a '\'.
//
static bool isBackSlash(XMLCh c) {
return c == chBackSlash ||
c == chYenSign ||
c == chWonSign;
}
static bool isAnySlash(XMLCh c) {
return c == chBackSlash ||
c == chForwardSlash ||
c == chYenSign ||
c == chWonSign;
}
unsigned int XMLPlatformUtils::curFilePos(FileHandle theFile)
{
// Get the current position
const unsigned int curPos = ::SetFilePointer(theFile, 0, 0, FILE_CURRENT);
if (curPos == 0xFFFFFFFF)
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotGetCurPos);
return curPos;
}
void XMLPlatformUtils::closeFile(FileHandle theFile)
{
if (!::CloseHandle(theFile))
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotCloseFile);
unsigned int XMLPlatformUtils::fileSize(FileHandle theFile)
{
// Get the current position
const unsigned int curPos = ::SetFilePointer(theFile, 0, 0, FILE_CURRENT);
if (curPos == 0xFFFFFFFF)
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotGetCurPos);
// Seek to the end and save that value for return
const unsigned int retVal = ::SetFilePointer(theFile, 0, 0, FILE_END);
if (retVal == 0xFFFFFFFF)
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotSeekToEnd);
// And put the pointer back
if (::SetFilePointer(theFile, curPos, 0, FILE_BEGIN) == 0xFFFFFFFF)
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotSeekToPos);
return retVal;
}
FileHandle XMLPlatformUtils::openFile(const char* const fileName)
{
FileHandle retVal = ::CreateFileA
(
fileName
, GENERIC_READ
, FILE_SHARE_READ
, 0
, OPEN_EXISTING
, FILE_FLAG_SEQUENTIAL_SCAN
, 0
);
if (retVal == INVALID_HANDLE_VALUE)
return 0;
return retVal;
}
FileHandle XMLPlatformUtils::openFile(const XMLCh* const fileName)
{
// Watch for obvious wierdness
if (!fileName)
return 0;
// Ok, this might look stupid but its a semi-expedient way to deal
// with a thorny problem. Shift-JIS and some other Asian encodings
// are fundamentally broken and map both the backslash and the Yen
// sign to the same code point. Transcoders have to pick one or the
// other to map '\' to Unicode and tend to choose the Yen sign.
//
// Unicode Yen or Won signs as directory separators will fail.
//
// So, we will check this path name for Yen or won signs and, if they are
// there, we'll replace them with slashes.
//
// A further twist: we replace Yen and Won with forward slashes rather
// than back slashes. Either form of slash will work as a directory
// separator. On Win 95 and 98, though, Unicode back-slashes may
// fail to transode back to 8-bit 0x5C with some Unicode converters
// to some of the problematic code pages. Forward slashes always
// transcode correctly back to 8 bit char * form.
//
XMLCh *tmpUName = 0;
const XMLCh *nameToOpen = fileName;
const XMLCh* srcPtr = fileName;
while (*srcPtr)
if (*srcPtr == chYenSign ||
*srcPtr == chWonSign)
break;
srcPtr++;
}
//
// If we found a yen, then we have to create a temp file name. Else
// go with the file name as is and save the overhead.
//
if (*srcPtr)
{
tmpUName = XMLString::replicate(fileName);
XMLCh* tmpPtr = tmpUName;
while (*tmpPtr)
if (*tmpPtr == chYenSign ||
*tmpPtr == chWonSign)
*tmpPtr = chForwardSlash;
tmpPtr++;
nameToOpen = tmpUName;
}
FileHandle retVal = 0;
if (gOnNT)
{
retVal = ::CreateFileW
nameToOpen
, GENERIC_READ
, FILE_SHARE_READ
, 0
, OPEN_EXISTING
, FILE_FLAG_SEQUENTIAL_SCAN
, 0
//
// We are Win 95 / 98. Take the Unicode file name back to (char *)
// so that we can open it.
//
char* tmpName = XMLString::transcode(nameToOpen);
tmpName
, GENERIC_READ
, FILE_SHARE_READ
, 0
, OPEN_EXISTING
, FILE_FLAG_SEQUENTIAL_SCAN
, 0
if (tmpUName)
delete [] tmpUName;
return retVal;
}
FileHandle XMLPlatformUtils::openStdInHandle()
{
//
// Get the standard input handle. Duplicate it and return that copy
// since the outside world cannot tell the difference and will shut
// down this handle when its done with it. If we gave out the orignal,
// shutting it would prevent any further output.
//
HANDLE stdInOrg = ::GetStdHandle(STD_INPUT_HANDLE);
if (stdInOrg == INVALID_HANDLE_VALUE)
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotOpenFile);
HANDLE retHandle;
if (!::DuplicateHandle
(
::GetCurrentProcess()
, stdInOrg
, ::GetCurrentProcess()
, &retHandle
, 0
, FALSE
, DUPLICATE_SAME_ACCESS))
{
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotDupHandle);
}
return retHandle;
}
unsigned int
XMLPlatformUtils::readFileBuffer( FileHandle theFile
, const unsigned int toRead
, XMLByte* const toFill)
{
Unknown (roddey)
committed
unsigned long bytesRead = 0;
Unknown (roddey)
committed
{
//
// Check specially for a broken pipe error. If we get this, it just
// means no more data from the pipe, so return zero.
//
if (::GetLastError() != ERROR_BROKEN_PIPE)
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotReadFromFile);
Unknown (roddey)
committed
}
return (unsigned int)bytesRead;
}
void XMLPlatformUtils::resetFile(FileHandle theFile)
{
// Seek to the start of the file
if (::SetFilePointer(theFile, 0, 0, FILE_BEGIN) == 0xFFFFFFFF)
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_CouldNotResetFile);
}
// ---------------------------------------------------------------------------
// XMLPlatformUtils: File system methods
// ---------------------------------------------------------------------------
Unknown (roddey)
committed
XMLCh* XMLPlatformUtils::getFullPath(const XMLCh* const srcPath)
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
{
//
// If we are on NT, then use wide character APIs, else use ASCII APIs.
// We have to do it manually since we are only built in ASCII mode from
// the standpoint of the APIs.
//
if (gOnNT)
{
// Use a local buffer that is big enough for the largest legal path
const unsigned int bufSize = 1024;
XMLCh tmpPath[bufSize + 1];
XMLCh* namePart = 0;
if (!::GetFullPathNameW(srcPath, bufSize, tmpPath, &namePart))
return 0;
// Return a copy of the path
return XMLString::replicate(tmpPath);
}
else
{
// Transcode the incoming string
char* tmpSrcPath = XMLString::transcode(srcPath);
ArrayJanitor<char> janSrcPath(tmpSrcPath);
// Use a local buffer that is big enough for the largest legal path
const unsigned int bufSize = 511;
char tmpPath[511 + 1];
char* namePart = 0;
if (!::GetFullPathNameA(tmpSrcPath, bufSize, tmpPath, &namePart))
return 0;
// Return a transcoded copy of the path
return XMLString::transcode(tmpPath);
}
}
bool XMLPlatformUtils::isRelative(const XMLCh* const toCheck)
{
// Check for pathological case of empty path
if (!toCheck[0])
return false;
//
// If its starts with a drive, then it cannot be relative. Note that
// we checked the drive not being empty above, so worst case its one
// char long and the check of the 1st char will fail because its really
// a null character.
//
if (toCheck[1] == chColon)
{
if (((toCheck[0] >= chLatin_A) && (toCheck[0] <= chLatin_Z))
|| ((toCheck[0] >= chLatin_a) && (toCheck[0] <= chLatin_z)))
{
return false;
}
}
//
// If it starts with a double slash, then it cannot be relative since
// it's a remote file.
if (isBackSlash(toCheck[0]) && isBackSlash(toCheck[1]))
return false;
// Else assume its a relative path
return true;
}
Unknown (roddey)
committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
XMLCh* XMLPlatformUtils::weavePaths(const XMLCh* const basePath
, const XMLCh* const relativePath)
{
// Create a buffer as large as both parts and empty it
XMLCh* tmpBuf = new XMLCh[XMLString::stringLen(basePath)
+ XMLString::stringLen(relativePath)
+ 2];
*tmpBuf = 0;
//
// If we have no base path, then just take the relative path as
// is.
//
if (!basePath)
{
XMLString::copyString(tmpBuf, relativePath);
return tmpBuf;
}
if (!*basePath)
{
XMLString::copyString(tmpBuf, relativePath);
return tmpBuf;
}
const XMLCh* basePtr = basePath + (XMLString::stringLen(basePath) - 1);
while ((basePtr >= basePath) && ((isAnySlash(*basePtr) == false)))
Unknown (roddey)
committed
{
Unknown (roddey)
committed
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
}
// There is no relevant base path, so just take the relative part
if (basePtr < basePath)
{
XMLString::copyString(tmpBuf, relativePath);
return tmpBuf;
}
// After this, make sure the buffer gets handled if we exit early
ArrayJanitor<XMLCh> janBuf(tmpBuf);
//
// We have some path part, so we need to check to see if we ahve to
// weave any of the parts together.
//
const XMLCh* pathPtr = relativePath;
while (true)
{
// If it does not start with some period, then we are done
if (*pathPtr != chPeriod)
break;
unsigned int periodCount = 1;
pathPtr++;
if (*pathPtr == chPeriod)
{
pathPtr++;
periodCount++;
}
// Has to be followed by a \ or / or the null to mean anything
if (isAnySlash(*pathPtr) == false && *pathPtr)
Unknown (roddey)
committed
{
break;
}
if (*pathPtr)
pathPtr++;
// If its one period, just eat it, else move backwards in the base
if (periodCount == 2)
{
basePtr--;
while ((basePtr >= basePath) && (isAnySlash(*basePtr) == false))
Unknown (roddey)
committed
{
basePtr--;
}
// The base cannot provide enough levels, so its in error/
Unknown (roddey)
committed
if (basePtr < basePath)
ThrowXML(XMLPlatformUtilsException, XMLExcepts::File_BasePathUnderflow);
Unknown (roddey)
committed
}
}
// Copy the base part up to the base pointer
XMLCh* bufPtr = tmpBuf;
const XMLCh* tmpPtr = basePath;
while (tmpPtr <= basePtr)
*bufPtr++ = *tmpPtr++;
// And then copy on the rest of our path
XMLString::copyString(bufPtr, pathPtr);
// Orphan the buffer and return it
janBuf.orphan();
return tmpBuf;
}
// ---------------------------------------------------------------------------
// XMLPlatformUtils: Timing Methods
// ---------------------------------------------------------------------------
unsigned long XMLPlatformUtils::getCurrentMillis()
{
return (unsigned long)::GetTickCount();
}
// ---------------------------------------------------------------------------
// Mutex methods
// ---------------------------------------------------------------------------
void XMLPlatformUtils::closeMutex(void* const mtxHandle)
{
Unknown (roddey)
committed
::DeleteCriticalSection((LPCRITICAL_SECTION)mtxHandle);
delete mtxHandle;
}
void XMLPlatformUtils::lockMutex(void* const mtxHandle)
{
Unknown (roddey)
committed
::EnterCriticalSection((LPCRITICAL_SECTION)mtxHandle);
Unknown (roddey)
committed
CRITICAL_SECTION* newCS = new CRITICAL_SECTION;
InitializeCriticalSection(newCS);
return newCS;
}
void XMLPlatformUtils::unlockMutex(void* const mtxHandle)
{
Unknown (roddey)
committed
::LeaveCriticalSection((LPCRITICAL_SECTION)mtxHandle);
}
// ---------------------------------------------------------------------------
// Miscellaneous synchronization methods
// ---------------------------------------------------------------------------
void*
XMLPlatformUtils::compareAndSwap( void** toFill
, const void* const newValue
, const void* const toCompare)
{
//
// InterlockedCompareExchange is only supported on Windows 98,
// Windows NT 4.0, and newer -- not on Windows 95...
// If you are willing to give up Win95 support change this to #if 0
// otherwise we are back to using assembler.
// (But only if building with compilers that support inline assembler.)
#if defined(_MSC_VER) || defined(__BCPLUSPLUS__)
void* result;
__asm
{
mov eax, toCompare;
mov ebx, newValue;
mov ecx, toFill
lock cmpxchg [ecx], ebx;
mov result, eax;
return result;
#else
//
// Note we have to cast off the constness of some of these because
// the system APIs are not C++ aware in all cases.
//
Andy Heninger
committed
return (void *) ::InterlockedCompareExchange
Andy Heninger
committed
(long *)toFill
, (long)newValue
, (long)toCompare
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
#endif
}
// ---------------------------------------------------------------------------
// Atomic increment and decrement methods
// ---------------------------------------------------------------------------
int XMLPlatformUtils::atomicIncrement(int &location)
{
return ::InterlockedIncrement(&(long &)location);
}
int XMLPlatformUtils::atomicDecrement(int &location)
{
return ::InterlockedDecrement(&(long &)location);
}
// ---------------------------------------------------------------------------
// XMLPlatformUtils: Private Static Methods
// ---------------------------------------------------------------------------
//
// This method is called by the platform independent part of this class
// during initialization. We have to create the type of net accessor that
// we want to use. If none, then just return zero.
//
XMLNetAccessor* XMLPlatformUtils::makeNetAccessor()
{
#if defined (XML_USE_NETACCESSOR_LIBWWW)
return new LibWWWNetAccessor();
#elif defined (XML_USE_NETACCESSOR_WINSOCK)
return new WinSockNetAccessor();
}
//
// This method is called by the platform independent part of this class
// when client code asks to have one of the supported message sets loaded.
// In our case, we use the ICU based message loader mechanism.
//
XMLMsgLoader* XMLPlatformUtils::loadAMsgSet(const XMLCh* const msgDomain)
{
#if defined (XML_USE_INMEMORY_MSGLOADER)
return new InMemMsgLoader(msgDomain);
#elif defined (XML_USE_WIN32_MSGLOADER)
return new Win32MsgLoader(msgDomain);
#else
#endif
}
//
// This method is called very early in the bootstrapping process. This guy
// must create a transcoding service and return it. It cannot use any string
// methods, any transcoding services, throw any exceptions, etc... It just
// makes a transcoding service and returns it, or returns zero on failure.
//
XMLTransService* XMLPlatformUtils::makeTransService()
{
//
// Since we are going to use the ICU service, we have to tell it where
// its converter files are. If the ICU_DATA environment variable is set,
// then its been told. Otherwise, we tell it our default value relative
// to our DLL.
//
#if defined (XML_USE_ICU_TRANSCODER)
return new ICUTransService;
#elif defined (XML_USE_WIN32_TRANSCODER)
return new Win32TransService;
#else
#error You must provide a transcoding service implementation
#endif
}
//
// This method handles the Win32 per-platform basic init functions. The
// primary jobs here are getting the path to our DLL and to get the
// stdout and stderr file handles setup.
//
void XMLPlatformUtils::platformInit()
{
// Enable this code for memeory leak testing
// Send all reports to STDOUT
_CrtSetReportMode( _CRT_WARN, _CRTDBG_MODE_FILE );
_CrtSetReportFile( _CRT_WARN, _CRTDBG_FILE_STDOUT );
_CrtSetReportMode( _CRT_ERROR, _CRTDBG_MODE_FILE );
_CrtSetReportFile( _CRT_ERROR, _CRTDBG_FILE_STDOUT );
_CrtSetReportMode( _CRT_ASSERT, _CRTDBG_MODE_FILE );
_CrtSetReportFile( _CRT_ASSERT, _CRTDBG_FILE_STDOUT );
int tmpDbgFlag;
tmpDbgFlag = _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG);
tmpDbgFlag |= _CRTDBG_LEAK_CHECK_DF;
_CrtSetDbgFlag(tmpDbgFlag);
#endif
// Figure out if we are on NT and save that flag for later use
OSVERSIONINFO OSVer;
OSVer.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
::GetVersionEx(&OSVer);
gOnNT = (OSVer.dwPlatformId == VER_PLATFORM_WIN32_NT);
}
void XMLPlatformUtils::platformTerm()
{
// We don't have any temrination requirements for win32 at this time
}