XMLParser.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2005, Copyright University Corporation for Atmospheric Research
 **
 ** This program is free software; you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation; either version 2 of the License, or
 ** (at your option) any later version.
 **
 ** This program is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ** GNU General Public License for more details.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/

#ifndef NIDAS_CORE_XMLPARSER_H
#define NIDAS_CORE_XMLPARSER_H

#include "XMLException.h"

#include <nidas/util/ThreadSupport.h>
#include <nidas/util/IOException.h>

#include <xercesc/dom/DOMImplementation.hpp>
#include <xercesc/dom/DOMErrorHandler.hpp>
#include <xercesc/dom/DOMDocument.hpp>
#include <xercesc/sax/InputSource.hpp>

#if XERCES_VERSION_MAJOR < 3
#include <xercesc/dom/DOMBuilder.hpp>
#else
#include <xercesc/dom/DOMLSParser.hpp>
#endif

#include <string>
#include <map>
#include <list>

namespace nidas { namespace core {

class XMLImplementation {
public:
    static xercesc::DOMImplementation *getImplementation()
        throw(nidas::core::XMLException);
    static void terminate();

private:
    static xercesc::DOMImplementation *_impl;
    static nidas::util::Mutex _lock;
};
    
class XMLErrorHandler : public xercesc::DOMErrorHandler
{
public:
    // -----------------------
    //  Constructors and Destructor
    // ----------------------
    XMLErrorHandler();
    ~XMLErrorHandler();

    // --------------------------
    //  Implementation of the DOM ErrorHandler interface
    // -------------------------
    bool handleError(const xercesc::DOMError& domError);

    void resetErrors();

    int getWarningCount() const { return _warningMessages.size(); }

    const std::list<std::string>& getWarningMessages() const
        { return _warningMessages; }

    const XMLException* getXMLException() const { return _xmlException; }

private :

    // -----------------------------
    //  Unimplemented constructors and operators
    // ----------------------------
    XMLErrorHandler(const XMLErrorHandler&);

    void operator=(const XMLErrorHandler&);

    std::list<std::string> _warningMessages;

    XMLException* _xmlException;

};

xercesc::DOMDocument* parseXMLConfigFile(const std::string& xmlFileName)
    throw(nidas::core::XMLException);

class XMLParser {
public:

    XMLParser() throw(nidas::core::XMLException);

    virtual ~XMLParser();

    void setDOMValidation(bool val);

    void setDOMValidateIfSchema(bool val);

    void setDOMNamespaces(bool val);

    void setXercesSchema(bool val);

    void setXercesSchemaFullChecking(bool val);

    void setDOMDatatypeNormalization(bool val);

    void setXercesUserAdoptsDOMDocument(bool val);

    void setXercesHandleMultipleImports(bool val);

    void setXercesDoXInclude(bool val);

    xercesc::DOMDocument* parse(const std::string& xmlFile,bool verbose=true)
        throw(nidas::core::XMLException);

    xercesc::DOMDocument* parse(xercesc::InputSource& source)
        throw(nidas::core::XMLException);

protected:
    
    xercesc::DOMImplementation *_impl;

#if XERCES_VERSION_MAJOR < 3
    xercesc::DOMBuilder *_parser;
#else
    xercesc::DOMLSParser *_parser;
#endif
    XMLErrorHandler _errorHandler;

private:

    XMLParser(const XMLParser&);

    XMLParser& operator=(const XMLParser&);
};

class XMLCachingParser : public XMLParser {
public:

    static XMLCachingParser* getInstance()
        throw(nidas::core::XMLException);

    static void destroyInstance();

    xercesc::DOMDocument* parse(const std::string& xmlFile)
        throw(nidas::core::XMLException,nidas::util::IOException);

    /*
    xercesc::DOMDocument* parse(xercesc::InputSource& source)
        throw(nidas::core::XMLException)
    {
        return XMLParser::parse(source);
    }
    */

    static time_t getFileModTime(const std::string&  name) throw(nidas::util::IOException);

protected:
    XMLCachingParser() throw(nidas::core::XMLException);
    ~XMLCachingParser();

protected:
    static XMLCachingParser* _instance;
    static nidas::util::Mutex _instanceLock;

    std::map<std::string,time_t> _modTimeCache;
    std::map<std::string,xercesc::DOMDocument*> _docCache;

    nidas::util::Mutex _cacheLock;

private:
    XMLCachingParser(const XMLCachingParser&);

    XMLCachingParser& operator=(const XMLCachingParser&);
};

}}  // namespace nidas namespace core

#endif