baseConfigVar.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
******************************************************************************/



#ifndef baseConfigVar_H_
#define baseConfigVar_H_


#include <mtl/env.h>
#include <list>
#include <set>


#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

namespace DtCmdLine
{
   class Arg;
   class CmdLine;
}

// Forward declarations
class DtVariableGroup;
class DtString;


class DT_DLL_MTL DtBaseConfigVariable
{
public:

   typedef std::set<DtString> TypeSet;

   enum DtVariableScope
   {
      DtScopeInternal,
      DtScopeConfigFile,
      DtScopeCommandLine,
      DtScopeBoth
   };

   DtBaseConfigVariable(DtVariableGroup* settings,
      DtVariableScope aScope, const DtString& aDescription);

   virtual ~DtBaseConfigVariable();

   inline DtVariableScope scope() const 
   { 
      return myScope; 
   }

   inline const DtString& description() const
   {
      return myDescription;
   }

   inline bool inConfigFile() const 
   { 
      return scope() == DtScopeConfigFile || scope() == DtScopeBoth;
   }

   inline bool inCommandLine() const
   {
      return scope() == DtScopeCommandLine || scope() == DtScopeBoth;
   }

   inline bool isSet() const { return mySetFlag; }

   //@name Abstract Interface

   virtual const DtString& name() const = 0;

   virtual bool isRequired() const = 0;

   virtual void getCommandLineArg(DtCmdLine::CmdLine& cmdLine) = 0;

   virtual void updateFromCommandLineArg() = 0;   

   virtual void getEnvironmentSchemaType(DtEnvironment env,
      TypeSet& usedTypes) const = 0;

   virtual DtEnvValueSP getEnvironmentValue(DtEnvironment env) = 0;

   virtual void updateFromEnvironment(DtEnvironment env) = 0;

   virtual DtString type() const = 0;


   static DtEnvValueSP createSchemaDeclaration(DtEnvironment env,
      const DtString& name,const DtString& type);

   static DtEnvValueSP createSimpleSchemaType(DtEnvironment env,
      const DtString& typeName, 
      const DtString& xsType );

   static DtEnvValueSP createComplexSchemaType(DtEnvironment env,
      const DtString& typeName,bool ordered, 
      const std::list<DtBaseConfigVariable*>& members);


protected:

   DtVariableScope myScope;

   bool mySetFlag;

   DtCmdLine::Arg* myArg;

   DtString myDescription;
};


#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif


#endif