include/vrfutil/rdrWritr.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: rdrWritr.h,v $ $Revision: 1.24 $ $State: Exp $
*******************************************************************************/


#ifndef DtReaderWriter_H_
#define DtReaderWriter_H_

#include "stdio.h"
#include <mtl/mtl.h>
#include <vlutil/vlString.h>
#include "vrfutil/rwRegistry.h"
#include "vrfutil/putSelfCbInfo.h"
#include "vrfutil/getSelfCbInfo.h"
#include <vlutil/vlMachineTypes.h>
#include "tdbutil/symStr.h"
#include <vlutil/vlFilename.h>
#include <list>
#include "vrfutil/readerWriterFactory.h"
#include "vrfutil/vrfutilDefines.h"

class DtRwVariableBindings;

class DT_DLL_vrfutil DtReaderWriter
{
public:

   typedef std::vector<DtSymbolString> aliasContainer;
   typedef std::vector<DtSymbolString>::iterator aliasIter;
   typedef std::vector<DtSymbolString>::const_iterator aliasConstIter;

   DtReaderWriter();

   DtReaderWriter(const DtString& name, DtReaderWriterRegistry* 
      parentRegistry = NULL, bool readonly = false);
   DtReaderWriter(const DtSymbolString& name, DtReaderWriterRegistry* 
      parentRegistry = NULL, bool readonly = false);

   DtReaderWriter(const DtString& name, const DtReaderWriter& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   DtReaderWriter(const DtSymbolString& name, const DtReaderWriter& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   const DtReaderWriter& operator=(const DtReaderWriter& orig);

   virtual ~DtReaderWriter();

   virtual void putSelf(FILE* fp, int indentLevel = 0, 
      bool writeUnspecified = false, const DtFilename& path = 
      DtFilename::nullFilename());

   virtual void getSelf(DtlObjPtr args, 
      const DtFilename& searchPath = DtFilename::nullFilename(), 
      const DtVariableBindingsList& variableBindings = nullVariableReference());

   virtual void writeSelf(FILE* fp, int indentLevel = 0, 
      bool writeUnspecified = false, 
      const DtFilename& path = DtFilename::nullFilename());

   virtual DtSymbolString name() const;

   static void putIndent(FILE* fp, int indentLevel);

   static const DtVariableBindingsList& nullVariableReference();


   virtual void setValueSpecified(bool specified, bool recurse = false);
   virtual bool valueSpecified() const;

   virtual void addAlias(const DtSymbolString& alias);

   virtual bool hasAlias(const DtSymbolString& alias);

   virtual void setReadonly(bool flag);

   virtual bool isReadonly() const;


   virtual bool isVariableReference() const;
   virtual void setIsVariableReference(bool value);


   virtual DtSymbolString variableName() const;
   virtual void setVariableName(const DtSymbolString variableName);

   virtual bool variableIsBound() const;
   virtual void unbindVariable();

   static void setPostGetSelfCallback(DtGetSelfCallbackFcn fcn, void* usrData);

   static void setPrePutSelfCallback(DtPutSelfCallbackFcn fcn, void* usrData);


   const DtReaderWriterRegistry& registry() const;
   DtReaderWriterRegistry& registry();

   virtual void setName(const DtString&);

   virtual const char* readerWriterType() const;

   

   virtual void bindVariables(DtVariableBindingsList variableBindings);

   typedef std::pair<DtSymbolString, DtString> DtVariableNameType;
   virtual std::list<DtVariableNameType> unboundVariables() const;
   
   static const DtFilename& appPath();

   bool invalid() const;

   virtual bool hasChild(const DtReaderWriter* p) const;

   static DtReaderWriterFactory* factory();

protected:
   virtual void bindToRwAsVariable(const DtReaderWriter* rw);

   virtual void bindLocalVariables(const DtVariableBindingsList& variableBindings);


   virtual void putData(FILE *fp, int indentLevel = 0);
   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

protected:

   const DtSymbolString myName;
   DtReaderWriterRegistry myRegistry;
   bool myValueSpecified;
   bool myReadOnlyFlag;
   bool myIsVariableReference;
   DtSymbolString myVariableName;
   bool myVariableIsBound;

   aliasContainer myAliases;

   static DtString theUnspecifiedValue;

   static DtGetSelfCallbackInfo thePostGetSelfCallback;
   static DtPutSelfCallbackInfo thePrePutSelfCallback;
   static const DtVariableBindingsList theEmptyVariableBindingsList;

   static DtReaderWriterFactory theFactory;

   bool  myInvalid;
};

inline const DtReaderWriterRegistry& DtReaderWriter::registry() const
{
   return myRegistry;
}

inline DtReaderWriterRegistry& DtReaderWriter::registry()
{
   return myRegistry;
}

inline bool DtReaderWriter::invalid() const
{
   return myInvalid;
}

#endif