---

PlatformUtils.hpp

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2001 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.1 2002/05/11 21:08:08 bhavani Exp $
 */


#if !defined(PLATFORMUTILS_HPP)
#define PLATFORMUTILS_HPP

#include <xercesc/util/XercesDefs.hpp>
#include <xercesc/util/XMLException.hpp>

class XMLMsgLoader;
class XMLNetAccessor;
class XMLTransService;


//
//  For internal use only
//
//  This class provides a simple abstract API via which lazily evaluated
//  data can be cleaned up.
//
class XMLUTIL_EXPORT XMLDeleter
{
public :
    virtual ~XMLDeleter();

protected :
    XMLDeleter();

private :
    XMLDeleter(const XMLDeleter&);
    void operator=(const XMLDeleter&);
};


class XMLUTIL_EXPORT XMLPlatformUtils
{
public :
    enum PanicReasons
    {
        Panic_NoTransService
        , Panic_NoDefTranscoder
        , Panic_CantFindLib
        , Panic_UnknownMsgDomain
        , Panic_CantLoadMsgDomain
        , Panic_SynchronizationErr
        , Panic_SystemInit

        , PanicReasons_Count
    };


    static XMLNetAccessor*      fgNetAccessor;

    static XMLTransService*     fgTransService;




    static void Initialize();

    static void Terminate();

    static void panic
    (
        const   PanicReasons    reason
    );


    static unsigned int curFilePos(FileHandle theFile);

    static void closeFile(FileHandle theFile);

    static unsigned int fileSize(FileHandle theFile);

    static FileHandle openFile(const char* const fileName);

    static FileHandle openFile(const XMLCh* const fileName);

    static FileHandle openStdInHandle();

    static unsigned int readFileBuffer
    (
                FileHandle      theFile
        , const unsigned int    toRead
        ,       XMLByte* const  toFill
    );

    static void resetFile(FileHandle theFile);



    static XMLCh* getFullPath(const XMLCh* const srcPath);

    static bool isRelative(const XMLCh* const toCheck);

    static XMLCh* weavePaths
    (
        const   XMLCh* const    basePath
        , const XMLCh* const    relativePath
    );

    static XMLCh* buildLocalPath
    (
        const  XMLCh* const     cacheDirPath
        , const  XMLCh* const     hostName
        , const XMLCh* const    filePath
    );

    static bool findFile(const XMLCh* const filePath);

    static unsigned int createDirectory(const XMLCh* const basePath, const XMLCh* const pathName);

    static bool URLCacheGetEnv(const char* urlEntityCaching);

    static XMLCh* URLCacheDirGetEnv(const char* urlEntityCacheDir);



    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);

    static bool isNELRecognized();


private :

    static XMLMsgLoader* loadAMsgSet(const XMLCh* const msgDomain);

    static XMLNetAccessor* makeNetAccessor();

    static XMLTransService* makeTransService();

    static void platformInit();

    static void platformTerm();

};


MakeXMLException(XMLPlatformUtilsException, XMLUTIL_EXPORT)



// ---------------------------------------------------------------------------
//  XMLDeleter: Public Destructor
// ---------------------------------------------------------------------------
inline XMLDeleter::~XMLDeleter()
{
}

// ---------------------------------------------------------------------------
//  XMLDeleter: Hidden constructors and operators
// ---------------------------------------------------------------------------
inline XMLDeleter::XMLDeleter()
{
}

#endif

---