lgrConfigLoader.h

Go to the documentation of this file.

   /******************************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
******************************************************************************/


#ifndef lgrConfigLoader_H_
#define lgrConfigLoader_H_

#include "lgrApp.h"
#include <mtl/envObject.h>
#include <mtl/environment.h>
#include <vector>
#include <set>

namespace MAKLogger
{
   class DtAnyValue;
   template <typename T>
   class DtCollector;
   class DtCommand;
   class DtRuntimeCommandFactory;

   class DT_DLL_LGRAPP DtLoggerAppConfigLoader
   {
   public:

      DtLoggerAppConfigLoader(const DtRuntimeCommandFactory* factory,
         const DtString& filename );

      virtual ~DtLoggerAppConfigLoader();

      virtual bool isValid() const;

      virtual void saveChanges();

      virtual void getInitCommands(DtCollector<DtCommand> commandCollector) const;
      virtual void getStartupCommands(DtCollector<DtCommand> commandCollector) const;

      virtual const DtEnvValueSP getDefaultVariable(const DtString& name) const;

      virtual DtString getDefaultVariableValue(const DtString& name) const;

      virtual DtString getDefaultVariableType(const DtString& name) const;

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,const DtString& value,
         const DtString& type);

      virtual DtEnvValueSP setTemporaryDefaultVariable(const DtString& name,const DtString& value,
         const DtString& type);

      virtual DtEnvValueSP setDefaultVariableList(const DtString& name,
         const std::vector<DtString>& valList, const DtString& type);

      virtual DtEnvValueSP setTemporaryDefaultVariableList(const DtString& name,
         const std::vector<DtString>& valList, const DtString& type);

      virtual DtEnvValueSP addDefaultVariableToList(const DtString& name,
         const DtString& value, const DtString& type);

      virtual DtEnvValueSP addDefaultVariablesToList(const DtString& name,
         const std::set<DtString>& valList, const DtString& type);

      virtual void removeDefaultVariable(const DtString& name);

      virtual DtEnvValueSP removeDefaultVariableFromList(const DtString& name,
         const DtString& value, const DtString& type);

      virtual DtEnvValueSP removeDefaultVariablesFromList(const DtString& name,
         const std::set<DtString>& valList, const DtString& type);

      virtual void removeCommandsUsingDefaultVariable(const DtString& name);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,const DtString& value);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,bool value);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,int value);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,double value);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,std::vector<DtString>& value);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,std::vector<int>& value);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,std::vector<bool>& value);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,std::vector<double>& value);

      const DtEnvironment& environment() const;

   protected:

      virtual void getCommands(const DtString& stageName,
         DtCollector<DtCommand> commandCollector) const;

      virtual DtCommand generateCommand(DtEnvironment& commandObj) const;

      virtual DtAnyValue*  generateParameter(DtEnvironment& paramObj) const;

      bool commandHasVariable(DtEnvironment& commandEnv, const DtString& variableName) const;

      virtual bool parseFile(const DtString& filename);

      virtual DtEnvValueSP addVariableToEnvironment(const DtString& name, const DtString& varType,
         DtEnvironment& destinationEnvironment);

      virtual DtEnvValueSP addVariableValueToEnvironment(const DtString& name, const DtString& varType,
         const DtString& value, DtEnvironment& destinationEnvironment);

      virtual DtEnvValueSP setDefaultVariable(const DtString& name,const DtString& value,
         const DtString& type, DtEnvironment& destinationEnvironment);

      virtual DtEnvValueSP setDefaultVariableList(const DtString& name,
         const std::vector<DtString>& valList, const DtString& type, DtEnvironment& destinationEnvironment);

      virtual DtEnvValueSP addDefaultVariableToList(const DtString& name,
         const DtString& value, const DtString& type,
         DtEnvironment& destinationEnvironment);

      virtual DtEnvValueSP addDefaultVariablesToList(const DtString& name,
         const std::set<DtString>& valList, const DtString& type,
         DtEnvironment& destinationEnvironment);

      virtual const DtEnvValueSP getDefaultVariable(const DtString& name,
         const DtEnvironment& sourceEnvironment) const;

      virtual DtString getDefaultVariableValue(const DtString& name,
         const DtEnvironment& sourceEnvironment) const;

      virtual DtString getDefaultVariableType(const DtString& name,
         const DtEnvironment& sourceEnvironment) const;

      virtual void removeDefaultVariable(const DtString& name,
         DtEnvironment& sourceEnvironment);

      virtual DtEnvValueSP removeDefaultVariableFromList(const DtString& name,
         const DtString& value, const DtString& type,
         DtEnvironment& sourceEnvironment);

      virtual DtEnvValueSP removeDefaultVariablesFromList(const DtString& name,
         const std::set<DtString>& valList, const DtString& type,
         DtEnvironment& sourceEnvironment);

      virtual void removeCommandsUsingDefaultVariable(const DtString& name,
         DtEnvNamedList& commandList);



   protected:

      bool myValidConfiguration;
      const DtRuntimeCommandFactory* myRuntimeFactory;

      DtEnvironment myEnvironment;

      DtEnvironment myEnvironmentToSave;
      DtString myFileName;
   };

}

#endif