//-----------------------------------------------------------------------------
// File          : XmlVariables.h
// Author        : Ryan Herbst  <rherbst@slac.stanford.edu>
// Created       : 06/05/2012
// Project       : General Purpose
//-----------------------------------------------------------------------------
// Description :
// Extract and store variables from XML string.
//
// !!!!!!!!!!!! Warning !!!!!!!!!!!!!!!!!!!
// Objects of this class must not be created and destroyed in a multi-thread
// environment. This class calls xml library init and cleanup functions. 
//
//-----------------------------------------------------------------------------
// This file is part of 'SLAC Generic DAQ Software'.
// It is subject to the license terms in the LICENSE.txt file found in the 
// top-level directory of this distribution and at: 
//    https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. 
// No part of 'SLAC Generic DAQ Software', including this file, 
// may be copied, modified, propagated, or distributed except according to 
// the terms contained in the LICENSE.txt file.
// Proprietary and confidential to SLAC.
//-----------------------------------------------------------------------------
// Modification history :
// 04/12/2011: created
//-----------------------------------------------------------------------------
#ifndef __XML_VARIABLES_H__
#define __XML_VARIABLES_H__

#include <string>
#include <map>
#include <libxml/tree.h>
#include <stdint.h>
using namespace std;

#ifdef __CINT__
#define uint32_t unsigned int
#endif

// Define variable holder
typedef map<string,string> VariableHolder;

//! Class to contain generic register data.
class XmlVariables {

      // Strip whitespace
      string removeWhite ( string str );

      // Process level
      void xmlLevel( xmlNode *node, string curr );

      // Variable list
      VariableHolder vars_;

   public:

      // Generate XML for a given level knowing the previous and next values
      static string genXmlString ( string prevName, string currName, string currValue, string nextName );

      //! Constructor
      XmlVariables ( );

      //! Deconstructor
      ~XmlVariables ( );

      //! Clear variable list
      void clear();

      //! Parse XML string
      /*! 
       * \param type Type of variable to parse, config or status
       * \param xml XML String
      */
      bool parse ( string type, const char *xml );

      //! Parse XML file
      /*! 
       * \param type Type of variable to parse, config or status
       * \param file XML file
      */
      bool parseFile ( string type, string file );

      //! Get a variable value
      /*! 
       * \param var Variable name
      */
      string get ( string var );

      //! Get a variable value as integer
      /*! 
       * \param var Variable name
      */
      uint32_t getInt ( string var );

      //! Get a variable value as double
      /*! 
       * \param var Variable name
      */
      double getDouble ( string var );

      //! Return variable list
      /*! 
       * \param prefix List prefix
      */
      string getList ( string prefix );

      //! Return variable list as XML
      string getXml ( );

      //! Return a single variable as XML
      string getXml (string variable);

      //! Return a string to set a variable as XML
      static string setXml (string variable, string value);
};

#endif