xml.hpp

Go to the documentation of this file.

/*
---------------------------------------------------------------------------

    This file is part of uHAL.

    uHAL is a hardware access library and programming framework
    originally developed for upgrades of the Level-1 trigger of the CMS
    experiment at CERN.

    uHAL 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 3 of the License, or
    (at your option) any later version.

    uHAL 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.

    You should have received a copy of the GNU General Public License
    along with uHAL.  If not, see <http://www.gnu.org/licenses/>.


      Andrew Rose, Imperial College, London
      email: awr01 <AT> imperial.ac.uk

      Marc Magrans de Abril, CERN
      email: marc.magrans.de.abril <AT> cern.ch

      Tom Williams, Rutherford Appleton Laboratory, Oxfordshire
      email: tom.williams <AT> cern.ch

---------------------------------------------------------------------------
*/


#ifndef _uhal_utilities_xml_hpp_
#define _uhal_utilities_xml_hpp_


#include <stdint.h>
#include <string>
#include <vector>

#include <boost/filesystem/path.hpp>

#include "uhal/log/exception.hpp"


// Forward declarations
namespace pugi
{
  class xml_node;
  struct xml_parse_result;
}


namespace uhal
{
  namespace exception
  {
    UHAL_DEFINE_EXCEPTION_CLASS ( StringNumberWillNotFitInto32BitNumber , "Exception class to handle the case where the string will not fit into a 32-bit number." )
  }

  namespace utilities
  {


    void PugiXMLParseResultPrettifier ( const pugi::xml_parse_result& aLoadResult , const boost::filesystem::path& aPath , const std::vector<uint8_t>& aFile );


    template < bool DebugInfo >
    bool GetXMLattribute ( const pugi::xml_node& aNode , const char* aAttrName , std::string& aTarget );


    template < bool DebugInfo >
    bool GetXMLattribute ( const pugi::xml_node& aNode , const char* aAttrName , const char* aTarget );


    template < bool DebugInfo >
    bool GetXMLattribute ( const pugi::xml_node& aNode , const char* aAttrName , int32_t& aTarget );


    template < bool DebugInfo >
    bool GetXMLattribute ( const pugi::xml_node& aNode , const char* aAttrName , uint32_t& aTarget );


    template < bool DebugInfo >
    bool GetXMLattribute ( const pugi::xml_node& aNode , const char* aAttrName , double& aTarget );


    template < bool DebugInfo >
    bool GetXMLattribute ( const pugi::xml_node& aNode , const char* aAttrName , float& aTarget );


    template < bool DebugInfo >
    bool GetXMLattribute ( const pugi::xml_node& aNode , const char* aAttrName , bool& aTarget );

  }
}


#endif