API Docs for SAX and DOM                 PlatformUtils.hpp Go to the documentation of this file. /* * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2003 The Apache Software Foundation. All rights * 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/>. */ /* * $Id: PlatformUtils.hpp,v 1.24 2004/01/29 11:48:46 cargilld Exp $ */ #if !defined(PLATFORMUTILS_HPP) #define PLATFORMUTILS_HPP #include <xercesc/util/XMLException.hpp> #include <xercesc/util/PanicHandler.hpp> XERCES_CPP_NAMESPACE_BEGIN class XMLMsgLoader; class XMLNetAccessor; class XMLTransService; class MemoryManager; class XMLMutex; // // For internal use only // // This class provides a simple abstract API via which lazily evaluated // data can be cleaned up. // class XMLDeleter { public : virtual ~XMLDeleter(); protected : XMLDeleter(); private : XMLDeleter(const XMLDeleter&); XMLDeleter& operator=(const XMLDeleter&); }; class XMLPlatformUtils { public : static XMLNetAccessor* fgNetAccessor; static XMLTransService* fgTransService; static PanicHandler* fgUserPanicHandler; static PanicHandler* fgDefaultPanicHandler; static MemoryManager* fgMemoryManager; static MemoryManager* fgArrayMemoryManager; static XMLMutex* fgAtomicMutex; static void Initialize(const char* const locale = XMLUni::fgXercescDefaultLocale , const char* const nlsHome = 0 , PanicHandler* const panicHandler = 0 , MemoryManager* const memoryManager = 0); static void Terminate(); static void panic ( const PanicHandler::PanicReasons reason ); static unsigned int curFilePos(FileHandle theFile , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static void closeFile(FileHandle theFile , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static unsigned int fileSize(FileHandle theFile , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static FileHandle openFile(const char* const fileName , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static FileHandle openFile(const XMLCh* const fileName , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static FileHandle openFileToWrite(const char* const fileName , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static FileHandle openFileToWrite(const XMLCh* const fileName , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static FileHandle openStdInHandle(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static unsigned int readFileBuffer ( FileHandle theFile , const unsigned int toRead , XMLByte* const toFill , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager ); static void writeBufferToFile ( FileHandle const theFile , long toWrite , const XMLByte* const toFlush , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager ); static void resetFile(FileHandle theFile , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static XMLCh* getFullPath ( const XMLCh* const srcPath , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager ); static XMLCh* getCurrentDirectory ( MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager ); static inline bool isAnySlash(XMLCh c); static void removeDotSlash(XMLCh* const srcPath , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static void removeDotDotSlash(XMLCh* const srcPath , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static bool isRelative(const XMLCh* const toCheck , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager ); static XMLCh* weavePaths ( const XMLCh* const basePath , const XMLCh* const relativePath , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager ); static unsigned long getCurrentMillis(); static void closeMutex(void* const mtxHandle); static void lockMutex(void* const mtxHandle); static void* makeMutex(); static void unlockMutex(void* const mtxHandle); static XMLMsgLoader* loadMsgSet(const XMLCh* const msgDomain); static void* compareAndSwap ( void** toFill , const void* const newValue , const void* const toCompare ); static int atomicIncrement(int& location); static int atomicDecrement(int& location); static void recognizeNEL(bool state , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); static bool isNELRecognized(); static void strictIANAEncoding(const bool state); static bool isStrictIANAEncoding(); static inline size_t alignPointerForNewBlockAllocation(size_t ptrSize); private : // ----------------------------------------------------------------------- // Unimplemented constructors and operators // ----------------------------------------------------------------------- XMLPlatformUtils(); static XMLMsgLoader* loadAMsgSet(const XMLCh* const msgDomain); static XMLNetAccessor* makeNetAccessor(); static XMLTransService* makeTransService(); static void platformInit(); static void platformTerm(); static int searchSlashDotDotSlash(XMLCh* const srcPath); static bool fgMemMgrAdopted; }; MakeXMLException(XMLPlatformUtilsException, ) // --------------------------------------------------------------------------- // XMLPlatformUtils: alignPointerForNewBlockAllocation // --------------------------------------------------------------------------- // Calculate alignment required by platform for a new // block allocation. We use this in our custom allocators // to ensure that returned blocks are properly aligned. // Note that, although this will take a pointer and return the position // at which it should be placed for correct alignment, in our code // we normally use size_t parameters to discover what the alignment // of header blocks should be. Thus, if this is to be // used for the former purpose, to make compilers happy // some casting will be necessary - neilg. // // Note: XML_PLATFORM_NEW_BLOCK_ALIGNMENT may be specified on a // per-architecture basis to dictate the alignment requirements // of the architecture. In the absense of this specification, // this routine guesses at the correct alignment value. // // A XML_PLATFORM_NEW_BLOCK_ALIGNMENT value of zero is illegal. // If a platform requires absolutely no alignment, a value // of 1 should be specified ("align pointers on 1 byte boundaries"). // inline size_t XMLPlatformUtils::alignPointerForNewBlockAllocation(size_t ptrSize) { // Macro XML_PLATFORM_NEW_BLOCK_ALIGNMENT may be defined // as needed to dictate alignment requirements on a // per-architecture basis. In the absense of that we // take an educated guess. #ifdef XML_PLATFORM_NEW_BLOCK_ALIGNMENT size_t alignment = XML_PLATFORM_NEW_BLOCK_ALIGNMENT; #else size_t alignment = (sizeof(void*) >= sizeof(double)) ? sizeof(void*) : sizeof(double); #endif // Calculate current alignment of pointer size_t current = ptrSize % alignment; // Adjust pointer alignment as needed return (current == 0) ? ptrSize : (ptrSize + alignment - current); } // --------------------------------------------------------------------------- // XMLDeleter: Public Destructor // --------------------------------------------------------------------------- inline XMLDeleter::~XMLDeleter() { } // --------------------------------------------------------------------------- // XMLDeleter: Hidden constructors and operators // --------------------------------------------------------------------------- inline XMLDeleter::XMLDeleter() { } XERCES_CPP_NAMESPACE_END #endif

Copyright © 2004 The Apache Software Foundation. All Rights Reserved.