envValue.h

Go to the documentation of this file.

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



#ifndef envValue_H__
#define envValue_H__

#if DT_ENV_THREAD_SAFE
#include <vlutil/vlThreadSafe.h>
#endif

#include <vlutil/vlSmartPointers.h>
#include <vlutil/vlString.h>
#include <list>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif


class DtEnvironment;
class DtEnvValue;

typedef DtBoost::shared_ptr<DtEnvValue> DtEnvValueSP;
typedef DtBoost::weak_ptr<DtEnvValue>   DtEnvValueWP;
typedef std::list<DtEnvValueSP>         DtEnvValueList;

#if DT_ENV_THREAD_SAFE
typedef DtThreadSafe<DtString> DtEnvValueType;
#else
typedef DtString DtEnvValueType;
typedef DtEnvValueList::iterator DtEnvValueIterator;
#endif

class DT_DLL_MTL DtEnvValue
{
public:
   friend class DT_DLL_MTL DtEnvironment;
   friend class DtEnvList;

#define RESERVED_VALUE(N) (1 << N)
   enum DtEnvValueFormat
   {
      Value     = 0,
      Listed    = 1,
      Named     = RESERVED_VALUE(1),
      Typed     = RESERVED_VALUE(2),
      Native    = RESERVED_VALUE(3),

      NamedListed      = Named | Listed,
      NamedTypedListed = Named | Typed | Listed
   };

   explicit DtEnvValue(const DtString& value);
   virtual ~DtEnvValue();

   virtual DtString value() const;

   virtual DtString unmodifiedValue() const;

   virtual void     setValue(const DtString& value);   

   virtual DtEnvValueSP parent() const;

   virtual void setParent(DtEnvValueSP parent);

   DtEnvValueFormat format() const;

protected:
   virtual void valueChanged();
   virtual void childChanged(DtEnvValue*);

   void addFormat(DtEnvValueFormat format);

   DtEnvValue(const DtString& value, DtEnvValueFormat format);
   virtual DtEnvValue* clone() const;

   DtEnvValueFormat myFormat;
   DtEnvValueType myValue;
   DtEnvValueType myUnmodifiedValue;
   DtEnvValueWP myParent;
};

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif


#endif