vrfGuiApplicationSettings.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>

#include <boost/function.hpp>

#include <vrvUtil/DtVirtualBaseClass.h>

#include <boost/archive/xml_iarchive.hpp>
#include <boost/archive/xml_oarchive.hpp>
#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/list.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/serialization/string.hpp>

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtVrfGuiApplicationSetting
   {
   public:
      DtVrfGuiApplicationSetting(makVrv::DtDe* = 0);
      DtVrfGuiApplicationSetting(const DtVrfGuiApplicationSetting&);
      virtual ~DtVrfGuiApplicationSetting();

      virtual DtVrfGuiApplicationSetting* clone() const = 0;

      virtual std::string classType() const = 0;

      template <typename T> static std::string theClassType()
      {
         return T().classType();
      }

      template <typename T> static DtVrfGuiApplicationSetting* create(makVrv::DtDe& de)
      {
         return new T(&de);
      }

      virtual void write(boost::archive::xml_oarchive& out, const unsigned int) = 0;
      virtual void read(boost::archive::xml_iarchive& in, const unsigned int) = 0;

      virtual int dataVersion() { return 1; };

   protected:
      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         if (Archive::is_loading::value)
         {
            int dVersion = version;

            if (version > 1)
            {
               *((boost::archive::xml_iarchive*)&ar) >> boost::serialization::make_nvp("version", dVersion);
            }

            read(*(boost::archive::xml_iarchive*)&ar, dVersion);
         }
         else
         {
            int dVersion = dataVersion();

            *((boost::archive::xml_oarchive*)&ar) << boost::serialization::make_nvp("version", dVersion);
            write(*(boost::archive::xml_oarchive*)&ar, dVersion);
         }
      }

   protected:
      makVrv::DtDe* myDe;
   };

   typedef DtVrfGuiApplicationSetting* (*DtApplicationSettingCreatorFcn)(makVrv::DtDe&);

   class DT_DLL_VRFGUICORE DtVrfGuiSettingsFactory
   {
   protected:
      typedef std::map<std::string, DtApplicationSettingCreatorFcn> SettingsCreatorMap;

   public:
      DtVrfGuiSettingsFactory();
      virtual ~DtVrfGuiSettingsFactory();

      static void cleanup();

   public:
      static bool addSettingCreator(const std::string& name, DtApplicationSettingCreatorFcn f);
      static DtVrfGuiApplicationSetting* createSetting(const std::string& name, makVrv::DtDe&);

   protected:
      static std::map<std::string, DtApplicationSettingCreatorFcn>* theSettingsCreators;
   };

   #define REGISTER_APPLICATION_SETTING(AppSetting) static bool AppSetting##_Registered = \
   DtVrfGuiSettingsFactory::addSettingCreator(DtVrfGuiApplicationSetting::theClassType<AppSetting>(), \
      DtVrfGuiApplicationSetting::create<AppSetting>);

   class DT_DLL_VRFGUICORE DtVrfGuiApplicationSettings : public makVrv::DtVirtualBaseClass
   {
      typedef std::map<std::string, DtVrfGuiApplicationSetting*> VrfGuiSettings;

   public:
      DtVrfGuiApplicationSettings( makVrv::DtDe& );
      
      virtual ~DtVrfGuiApplicationSettings();
            
      static DtVrfGuiApplicationSettings& instance( makVrv::DtDe& de );
   
   public:
      virtual void loadSettings(const std::string& settingsFile);
      virtual void saveSettings();
      virtual void saveSettings(const std::string& settingsFile);

      virtual std::string iconsPath() const;

   public:
      virtual DtVrfGuiApplicationSetting* addSetting(const std::string&, const DtVrfGuiApplicationSetting&);

      virtual DtVrfGuiApplicationSetting* settingFor(const std::string&);

      virtual void removeSetting(const std::string&);

      const VrfGuiSettings& settings() const
      {
         return mySettings;
      }

      void setAutoSave(bool b)
      {
         myAutoSave = b;
      }

      bool autoSave() const
      {
         return myAutoSave;
      }

      virtual void clearSettings();

   protected:
      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         VrfGuiSettings::const_iterator iter = mySettings.begin();
         
         if (Archive::is_loading::value)
         {
            int size = 0;
            std::string classType;
            std::string name;

            ar & BOOST_SERIALIZATION_NVP(size);

            for (int i = 0; i < size; i++)
            {
               ar & BOOST_SERIALIZATION_NVP(name);
               ar & BOOST_SERIALIZATION_NVP(classType);
               DtVrfGuiApplicationSetting* iface = DtVrfGuiSettingsFactory::createSetting(classType, myDe);

               if (iface)
               {
                  DtVrfGuiApplicationSetting& guiSetting = *iface;
                  ar & BOOST_SERIALIZATION_NVP(guiSetting);
                  mySettings[name] = iface;
               }
            }

         }
         else
         {
            int size = mySettings.size();
            ar & BOOST_SERIALIZATION_NVP(size);
            VrfGuiSettings::const_iterator iter = mySettings.begin();

            while (iter != mySettings.end())
            {
               std::string name = iter->first;

               ar & BOOST_SERIALIZATION_NVP(name);
               std::string classType = iter->second->classType();
               ar & BOOST_SERIALIZATION_NVP(classType);

               DtVrfGuiApplicationSetting& guiSetting = *iter->second;
               ar & BOOST_SERIALIZATION_NVP(guiSetting);

               ++iter;
            }
         }
      }

   protected:
      makVrv::DtDe&  myDe;
      VrfGuiSettings mySettings;
      std::string    mySettingsFile;
      bool           myAutoSave;
   };
}

BOOST_CLASS_VERSION(makVrf::DtVrfGuiApplicationSetting,2)