DtSchemaManager.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2020 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 
 
 
#pragma once

#include <vrvCore/vrvCore.h> 
#include <vrvCore/DtSettingsBackup.h> 
#include <makArchives/DtSchema.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <string>
#include <set>

#include <vrvUtil/signalslib.h>

namespace makVrv 
{ 
   class DtDe;
   class DtSchemaManager;
   class DtSchemaManagerSignaler;

   class DT_DLL_VRVCORE DtSchemaSettingsBackup : public DtSettingsBackup
   {
   public:
      DtSchemaSettingsBackup();
      DtSchemaSettingsBackup(const DtSchemaSettingsBackup&);
      DtSchemaSettingsBackup(DtDe* de, DtSchemaManager*);

      virtual ~DtSchemaSettingsBackup();

   protected:
      virtual void restore(const DtSettingsBackup* from);

      virtual std::string backupClassType() const;

      virtual void saveSchema();

      virtual DtSettingsBackup* create() const;

      virtual void write(boost::archive::xml_oarchive& ar);

      virtual void read(boost::archive::xml_iarchive& ar);

   public:
      const makArchives::DtSchema& restoredSchema() const
      {
         return myRestoredSchema;
      }

   protected:
      DtDe*                 myDe;
      DtSchemaManager*      mySchemaManager;
      makArchives::DtSchema myRestoredSchema;
   };

   class DT_DLL_VRVCORE DtSchemaManager
   { 
   public:
      friend class DtSchemaManagerCreator;

      typedef std::set<int> PossibleSchemaValues;

      enum SchemaTypes
      {
         ModelDefinitionSchema,
         VisualDefinitionSchema
      };

      virtual ~DtSchemaManager();

      virtual void addSchemaEntry(const makArchives::DtSchemaEntry& schema);

      virtual bool removeSchemaEntry(const std::string&);
      
      virtual makArchives::DtSchemaEntry* findSchemaEntry(
         const std::string& schemaName);

      virtual const makArchives::DtSchemaEntry* findSchemaEntry(
         const std::string& schemaName) const;

      virtual void merge(const makArchives::DtSchema& schema);

      virtual void replace(const makArchives::DtSchema& schema);

      virtual void exportSchemas(const std::set<std::string>& schemaNames,
         const std::string& filename) const;

      virtual bool renameSchemaEntry(
         const std::string& oldName, const std::string& newName);

      const makArchives::DtSchema& schema() const;

      virtual std::string schemaName() const;

      virtual bool renameSchemaParameter(const std::string& schema,
         const std::string& oldName, const std::string& newName);

      virtual void addPossibleSchemaValue(int schema);

      virtual PossibleSchemaValues possibleSchemaValues() const;

      virtual void removePossibleSchemaValue(int schema);

      virtual void loadSchemas(bool saveAfterLoad = false);

      virtual bool loadSchema( const std::string& filepath, bool saveAfterLoad = false);

      virtual void saveSchema();

      virtual void saveSchemaAs(const std::string& filepath);

      virtual bool importSchema(const std::string& filepath,
         bool mergeSchema);

      virtual DtSchemaSettingsBackup& settingsBackup();

      virtual void backup();

   protected:

      DtSchemaManager(DtDe&);

      virtual void saveSchema(const makArchives::DtSchema& schema,
         const std::string& file) const;

   protected:
      DtDe& myDe;

      DtSchemaManagerSignaler& mySignaler;

      makArchives::DtSchema myModelDefinitionSchema;

      DtSchemaSettingsBackup* myModelDefinitionSchemaBackup;

      PossibleSchemaValues myPossibleSchemaValues;
   }; 

   class DT_DLL_VRVCORE DtSchemaManagerSignaler : public DtVirtualBaseClass
   {
   public:

      static DtSchemaManagerSignaler& instance(DtDe& de);

      virtual ~DtSchemaManagerSignaler();

      boost::signalslib::signal<void (const std::string&)> signal_schemaEntryAdded;

      boost::signalslib::signal<void (const std::string&)> signal_schemaEntryRemoved;

      boost::signalslib::signal<void (const std::string&)> signal_schemaEntryToBeRemoved;

      boost::signalslib::signal<void (const std::string&, const std::string&)>
         signal_schemaEntryRenamed;

      boost::signalslib::signal<
         void (const std::string&, const std::string&, const std::string)>
         signal_schemaParameterRenamed;

   protected:
      DtSchemaManagerSignaler();

   };

   class DT_DLL_VRVCORE DtSchemaManagerCreator : public DtVirtualBaseClass
   {
   public:
      DtSchemaManagerCreator();

      virtual ~DtSchemaManagerCreator();

      static DtSchemaManagerCreator& instance(DtDe& de);

      virtual DtSchemaManager* create(DtDe&);
   };
}