rwPropertiesList.h

Go to the documentation of this file.

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


#pragma once

#include <readerWriter/rwProperties.h>
#include <readerWriter/rwProperty.h>
#include <readerWriter/propertyInterface.h>

class DT_DLL_readerWriter DtRwPropertiesList : public DtRwProperties
{
private:
   DtRwPropertiesList();

public:

   DtRwPropertiesList(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertiesList(const DtString& name, const DtPropertyInterface* prototype, 
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertiesList(const DtString& name, const DtRwPropertiesList& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   virtual ~DtRwPropertiesList();

   virtual bool addItem(DtPropertyInterface* item);

   virtual DtPropertyInterface* addItem();

   virtual void erase(DtPropertyInterface* item);

   virtual void erase(iterator pos);

   virtual const char* readerWriterType() const;

   static const char* theXmlType();

   virtual const char* xmlType() const
   {
      return theXmlType();
   }

   virtual char* encode(char*) const;

   virtual const char* decode(const char*);

   virtual bool isValidProperty(const DtPropertyInterface*) const;

   virtual int count() const;

   virtual void getSelf(DtlObjPtr args, 
      const DtReaderWriter::SearchPaths& searchPaths = DtReaderWriter::SearchPaths(), 
      const DtVariableBindingsList& variableBindings = nullVariableReference());

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

   virtual void setPrototype(const DtPropertyInterface*);

   virtual const DtPropertyInterface* prototype() const;

   virtual DtPropertyInterface* clonePrototype(DtReaderWriterRegistry* parent = 0);

   DtRwPropertiesList& operator=(const DtRwPropertiesList&);
   
   virtual void getSize(int& size) const;

   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict = true) const;

   bool operator==(const DtRwPropertiesList&) const;

   virtual bool matchPrototype(const DtReaderWriter*) const;

protected:
   virtual void writePrototype(const DtReaderWriter*, std::string& fp, int indentLevel, bool writeHeader = true) const;
   virtual void bindToRwAsVariable(const DtReaderWriter* rw);

   virtual void createListEntry(DtPropertyInterface* iFace, 
      DtlObjPtr variableItem, 
      const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);

   virtual DtPropertyInterface* createPrototype(DtlObjPtr);
   virtual DtlObjPtr variablesStart(DtlObjPtr args) const;

   virtual const char* decode(DtPropertyInterface*, const char*);

   virtual DtlObjPtr getData(DtlObjPtr variableList, 
      const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);

   virtual int hlaAlignment(const DtPropertyInterface* field) const;
   virtual void getData(const DtEnvironmentSP env, const DtEnvValueSP root,
      const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& varBindings);
   virtual void putData(DtEnvironmentSP, DtEnvValueSP value) const;

   virtual void assignPrototypeToChildren();

   virtual void setPrototypeIntoTarget(const DtPropertyInterface* prototype, DtReaderWriter* target);

   virtual void postWriteItem(std::string& fp, DtReaderWriter* rw, int indentLevel);
   virtual void preWriteItem(std::string& fp, DtReaderWriter* rw, int indentLevel);

   virtual bool matchPrototype(const DtReaderWriter* prototype, const DtReaderWriter* match) const;

   virtual void cloneAndAddProperty(const DtReaderWriter& rw);

protected:
   DtPropertyInterface* myPrototype;
   mutable DtRwPropertyInt myCount;
};