freXMLStreamObject.h

Go to the documentation of this file.

/*=========================================================================

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freXMLStreamObject.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __freXMLStreamObject_h
#define __freXMLStreamObject_h

//This is to avoid the warnings produced by itk/stl and ease the search for errors
//in the creation report
#pragma warning( disable : 4786)

#include "expat.h"
#include <fstream>
#include <map>
#include <vector>
#include <string>

#include "freElementals.h"
#include "freConstXMLTags.h"

#include "itkMacro.h"

namespace FREE
{

//Macro for generation of a controller ID
#define freXMLTagMacro( Name, Value )\
  namespace XMLTags {\
                static const char* const Name = Value;\
        }

class XMLStreamObject
{
public:
  virtual const char *GetNameOfClass() const
        {return "XMLStreamObject";};

  static const std::string cXML_Text;

  typedef std::pair<std::string,std::string> AttributeType;
  typedef std::map<std::string,std::string> AttributesType;
        //uses vector for saving, to avoid automatic sort feature of stl::map
  typedef std::vector<AttributeType> AttributesSaveListType;

  void LoadFromString(const std::string& rsData);

  std::string SaveToString() const;

  void SaveToFile(const std::string& sFileName, const std::string& sXSLT = "", const std::string& sEncoding = "ISO-8859-1") const;

  void LoadFromFile(const std::string& sFileName);

  virtual void Reset();

  virtual const std::string GetXMLTag() const;

  void SetXMLTag(const std::string& sTag) { m_sXMLTag = sTag; };

  virtual XMLStreamObject& operator = (const XMLStreamObject& rXMLStreamObject);

  XMLStreamObject(const std::string& sXMLTag);

  XMLStreamObject(const XMLStreamObject& rXMLStreamObject);

  virtual ~XMLStreamObject();

protected:
  virtual void SubElementLoadProcessing(const std::string& rsXMLSubTag, const std::string& rsXMLSubElement, const std::string& rsXMLSubData);

  virtual void AttributesLoadProcessing(const AttributesType& rAttributes);

  virtual void SaveAttributes(AttributesSaveListType& rAttributes) const;

  std::string SaveToString(const unsigned int& iDepth) const;

  virtual std::string SaveData(const unsigned int& iDepth, bool& bHasSubElements) const;

  virtual void FinalizeLoading() const {/*reimplement in derived classes if needed.*/};

  virtual bool CheckValidLoading() const;

  virtual void SetNeededSubElements();

  void AddNeededSubElement(const std::string& sSubElementTag);

        static std::string CreateSimpleElement(const std::string& sTag, const std::string& sValue);

        static void AddSubElement(std::string& sData, const std::string& sTag, const std::string& sValue, const unsigned int& iParentalDepth);

        static void AddSubElement(std::string& sData, const std::string& sTag, const std::string& sValue, const AttributesType& rAttributes, const unsigned int& iParentalDepth);

        static void AddSubElement(std::string& sData, const XMLStreamObject* pSubElement, const unsigned int& iParentalDepth);
        static void AddSubElement(std::string& sData, const std::string& sSubElement, const unsigned int& iParentalDepth);

        static void AddIndentation(std::string& sData, const unsigned int& iDepth);

private:
  static void CB_Static_StartElement(void* parser, const char *name,
                                     const char **pAttributes);

  static void CB_Static_EndElement(void* parser, const char *name);

  static void CB_Static_CharacterDataHandler(void* parser, const char* data,
                                             int length);

  void CB_StartElement(const char * name,const char **pAttributes);

  void CB_EndElement(const char *name);

  void CB_CharacterDataHandler(const char *inData, int inLength);

  void ResetRequirements();

  void ResetLoadingHelpers();

  static AttributesType ConvertExpatAttrToMap(const char** pAttributes);

  static std::string ConvertAttributesToString(const AttributesSaveListType& rAttributes);

  std::string ExtractSubElementXmlString();

  std::string ExtractSubElementContentString();

  void NotifyFoundSubElement(const std::string& sSubElementTag);

  void CommitSubElement();

  STLStringVector m_NeededSubElements;

  std::string m_sActSubElementTag;

  AttributesType m_ActSubElementAttributes;

  const std::string* m_psLoadData;

  unsigned int m_iActSubElementLevel; 

  long m_lElementStartPos;
  long m_lElementStopPos;
  long m_lContentStartPos;
  long m_lContentStopPos;

  std::string m_sXMLTag;

  XML_Parser m_Parser;
};

}//end of namespace FREE

#endif

---