DtOsgEarthFileParser.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2019 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once


#include <vrvOsgEarth/vrvOsgEarth.h>
#include <osgEarth/Config>
#include <vrvUtil/DtUnicode.h>

namespace osgEarth
{
   namespace Util
   {
      class XmlNode;
      class XmlElement;
      class XmlText;
      class XmlDocument;
   }
}

namespace makVrv
{
   class DT_DLL_VRVOSGEARTH DtOsgEarthFile
   {
   public:
      typedef std::vector<osgEarth::Util::XmlText*> XmlTextList;
      typedef std::vector<DtOsgEarthFile*> ExternalFileList;

      class DT_DLL_VRVOSGEARTH XmlElementKey
      {
      public:

         XmlElementKey();

         XmlElementKey(const char* type);

         XmlElementKey(const char* type, int index);

         XmlElementKey(const std::string& type);

         XmlElementKey(const std::string& type, int index);

         bool isValid() const;

         std::string type() const;

         int index() const;

         void setType(const std::string& type);

         void setIndex(int index);

         bool operator < (const XmlElementKey&) const;

         bool operator == (const XmlElementKey&) const;

      protected:
         std::string myType;
         int myIndex;
      };

      DtOsgEarthFile(const DtUnicode& fileName);

      virtual ~DtOsgEarthFile();

      void load();

      void parseTextAndElements();

      void update(const XmlElementKey& key, const osgEarth::Config& config);

      void updateName(const XmlElementKey& key, const std::string& newName);

      void modify(const XmlElementKey& key, const osgEarth::Config& config);

      void add(const XmlElementKey& key, const osgEarth::Config& config);

      void remove(const XmlElementKey& key);

      void move(const XmlElementKey& key, int newIndex);

      void addTextNode(const XmlElementKey& key, const std::string& text);

      osgEarth::Util::XmlElement* findChildElement(osgEarth::Util::XmlElement* element, const XmlElementKey& key);

      osgEarth::Util::XmlElement* findParentElement(osgEarth::Util::XmlElement* element, const XmlElementKey& key);

      void updateConfig(size_t startPos, osgEarth::Util::XmlElement* element, const osgEarth::Config& config);

      void modifyConfig(size_t startPos, osgEarth::Util::XmlElement* element, const osgEarth::Config& config);

      void updateXmlText(size_t startPos, osgEarth::Util::XmlElement* element, const std::string& text);

      osgEarth::Util::XmlText* findXmlTextNode(osgEarth::Util::XmlElement* element);

      void modifyTextNode(osgEarth::XmlElement* element, const std::string& text);

      std::set<std::string> getUniqueChildKeysOfConfig(const osgEarth::Config& config) const;

      std::set<std::string> getUniqueChildKeysOfElement(const osgEarth::Util::XmlElement* element) const;

      std::string findNameOfConfig(const osgEarth::Config& config);

      virtual bool checkExternalReference(const std::string& text);

      virtual bool findUrl(const std::string& text, std::string& url);

      virtual void parseExternalReference(const std::string& text);

      DtUnicode fileName() const;

      const ExternalFileList& externalFileList() const;

      virtual const DtOsgEarthFile* findOsgEarthFileByFileName(const DtUnicode& fileName) const;

      std::vector< std::pair<std::string, std::string> > getXmlElementNodes() const;

      virtual XmlElementKey getXmlElementKey(const osgEarth::XmlElement* parent, const osgEarth::XmlElement* element) const;

      virtual osgEarth::XmlElement* root();

      virtual bool findXmlElementKey(const std::string& type, const std::string& name, DtOsgEarthFile::XmlElementKey& key)const;

      virtual bool findXmlElementKey(osgEarth::Util::XmlElement* element, const std::string& type, const std::string& name,
         DtOsgEarthFile::XmlElementKey& key, int currentDepth = 0, int maxDepth = 2)const;

      virtual void setFileName(const DtUnicode& fileName);

      virtual void save();

      virtual void save(const DtUnicode& fileName);

      virtual std::string getXmlElementType(const osgEarth::Util::XmlElement* element) const;

      virtual int getXmlElementIndex(const osgEarth::Util::XmlElement* parent, const osgEarth::Util::XmlElement* element) const;

      virtual std::string getXmlElementName(const osgEarth::Util::XmlElement* element) const;

      DtOsgEarthFile* findOsgEarthFile(const std::string& type, const std::string& name);

   protected:

      virtual void processXmlNode(const osgEarth::Util::XmlNode* node);

      virtual void processXmlElement(const osgEarth::Util::XmlElement* element);

      virtual void processXmlText(const osgEarth::Util::XmlText* text);

      void addOrModifyConfig(size_t startPos, osgEarth::XmlElement* element, const osgEarth::Config& config, int index);

      void addOrModifySimpleConfig(size_t startPos, osgEarth::Util::XmlElement* element, const std::string& key, const std::string& value, int index);

      void addOrModifyNonSimpleConfig(size_t startPos, osgEarth::Util::XmlElement* element, const osgEarth::Config& config, int index);

      virtual bool modifyXmlAttribute(size_t startPos, osgEarth::Util::XmlElement* element, const std::string& key, const std::string& newValue);

      virtual bool removeXmlAttribute(size_t startPos, osgEarth::Util::XmlElement* element, const std::string& key);

      virtual bool removeXmlElement(size_t startPos, osgEarth::Util::XmlElement* parent, const std::string& key, int index);

      virtual bool moveXmlElement(size_t startPos, osgEarth::Util::XmlElement* parent, const std::string& key, int index, int newIndex);

      virtual bool modifyXmlSimpleElement(size_t startPos, osgEarth::Util::XmlElement* element, const std::string& key, const std::string& newValue, int index);

      virtual bool addXmlAttribute(size_t startPos, osgEarth::Util::XmlElement* element, const std::string& key, const std::string& newValue);

      virtual bool addXmlSimpleElement(size_t startPos, osgEarth::Util::XmlElement* element, const std::string& key, const std::string& newValue, int index);

      virtual bool addXmlNonSimpleElement(size_t startPos, osgEarth::Util::XmlElement* element, const osgEarth::Config& config, int index);

      virtual bool addXmlTextNode(size_t startPos, osgEarth::Util::XmlElement* element, const std::string& text);

      virtual std::string getConfigString(const osgEarth::Config& config);

      virtual std::string getXmlAttributeString(const std::string& key, const std::string& value);

      virtual std::string getSimpleConfigString(const std::string& key, const std::string& value);

      virtual void updateAttribute(osgEarth::Util::XmlElement* element, const std::string& key, const std::string& newValue);

      virtual void removeAttribute(osgEarth::Util::XmlElement* element, const std::string& key);

      virtual void removeElement(osgEarth::Util::XmlElement* element, const std::string& key, int index);

      virtual void updateSimpleElement(osgEarth::Util::XmlElement* element, const std::string& key, const std::string& newValue, int index);

      virtual void addAttribute(osgEarth::Util::XmlElement* element, const std::string& key, const std::string& value);

      virtual void addSimpleElement(osgEarth::Util::XmlElement* element, const std::string& key, const std::string& newValue);

      virtual void addNonSimpleElement(osgEarth::Util::XmlElement* element, osgEarth::Util::XmlElement* child);

      virtual void addTextNode(osgEarth::Util::XmlElement* element, const std::string& text);

      virtual bool hasAttribute(const osgEarth::Util::XmlElement* element, const std::string& key);

      virtual osgEarth::XmlElement* findSubElement(const osgEarth::Util::XmlElement* element, const std::string& key, int index);

      virtual int findSubElementMaximumIndex(const osgEarth::XmlElement* element, const std::string& key);

      virtual bool hasChild(const osgEarth::Config& config, const std::string& key, int index);

      virtual size_t findStartPos(size_t startPos, const osgEarth::Util::XmlElement* element, const XmlElementKey& key);

      virtual std::string getElementStartPattern(const std::string& key) const;

      virtual std::string getElementEndPattern(const osgEarth::Util::XmlElement* element) const;

      virtual std::string getElementEndPattern(const std::string& key) const;

      virtual std::string getAttributeStartPattern(const std::string& key) const;

      virtual bool getAttributeValue(size_t startPos, size_t endPos, const std::string& key, std::string& value) const;

      virtual bool getElementValue(size_t startPos, size_t endPos, const std::string& key, std::string& value) const;

      std::string formatValue(const std::string& value) const;

      virtual bool isReservedKeyWord(const std::string& key) const;

      virtual bool ifElementHasChild(osgEarth::Util::XmlElement* root, const std::string& type, const std::string& name, int currentDepth = 0, int maxDepth = 2);

   private:
      DtOsgEarthFile();
      DtOsgEarthFile(const DtOsgEarthFile&);
      DtOsgEarthFile &operator=(const DtOsgEarthFile&);

   protected:
      osgEarth::Util::XmlElement* myRoot;
      ExternalFileList myExternalFileList;
      std::string myModifiedText;
      std::string myOriginalText;
      DtUnicode myFileName;
   };

   class DT_DLL_VRVOSGEARTH DtOsgEarthFileParser
   {
   public:

      DtOsgEarthFileParser();

      virtual ~DtOsgEarthFileParser();

      virtual void parse(const DtUnicode& fileName);

      virtual void addConfig(const std::string& parentType, const std::string& parentName, const osgEarth::Config& config);

      virtual void removeConfig(const std::string& type, const std::string& name);

      virtual void moveConfig(const std::string& type, const std::string& name, int newIndex);

      virtual void updateConfig(const std::string& name, const std::string& type, const osgEarth::Config& config);

      virtual void updateName(const std::string& oldName, const std::string& type, const std::string& newName);

      virtual void modifyConfig(const std::string& name, const osgEarth::Config& config);

      virtual DtOsgEarthFile* rootFile();

      virtual const DtOsgEarthFile* findOsgEarthFile(const DtUnicode& fileName) const;

      virtual bool hasExternalFiles() const;

      virtual void save(const DtUnicode& fileName);

      virtual void setRootFileName(const DtUnicode& fileName);

   protected:
      DtOsgEarthFile * myRootFile;

   private:
      DtOsgEarthFileParser(const DtOsgEarthFileParser&);
      DtOsgEarthFileParser &operator=(const DtOsgEarthFileParser&);
   };
}