rwList.h

Go to the documentation of this file.

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

#pragma once

#include <vlutil/vlList.h>
#include "readerWriter/readerWriter.h"
#include "readerWriter/readerWriterDefines.h"
#include <boost/function.hpp>

#include <set>

class DtListItem;

class DT_DLL_readerWriter DtRwList : public DtReaderWriter, public DtList
{
public:
   struct RwObjectAdder
   {
      RwObjectAdder(DtRwList* list) : myList(list) {}
      void operator()(DtReaderWriter* rwObject)
      {
         myList->add(rwObject);
      }
      DtRwList* myList;
   };

   DtRwList();

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


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

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

   virtual ~DtRwList() override;

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

   virtual DtListItem* add(DtReaderWriter* data);

   virtual DtListItem* addWithAlternateName(DtReaderWriter* data, const DtString& name);

   virtual DtListItem* addToStart(DtReaderWriter* data);

   virtual DtListItem* addToEnd(DtReaderWriter* data);

   virtual void* remove(DtReaderWriter* data, DtListItem* item);

   virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths,
           const DtVariableBindingsList &variableBindings) override = 0;

   virtual DtlObjPtr getLocalData(DtlObjPtr args);

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

   virtual void getSelf(const DtEnvironmentSP, const DtEnvValueSP root,
                        const SearchPaths &searchPaths = SearchPaths(),
                        const DtVariableBindingsList &bindings =
                            DtVariableBindingsList()) override;


   virtual DtListItem* addBefore (DtReaderWriter* data, const DtString& before);
   virtual DtListItem* addBefore (DtReaderWriter* data, const DtSymbolString& before);


   virtual DtListItem* addAfter(DtReaderWriter* data, const DtString& after);
   virtual DtListItem* addAfter(DtReaderWriter* data, const DtSymbolString& after);
   
   virtual DtListItem* addBefore (DtReaderWriter* data, DtReaderWriter* before);

   virtual DtListItem* addAfter(DtReaderWriter* data, DtReaderWriter* after);
   
   virtual void removeAll();

   virtual void removeAndDeleteAll();

   virtual void reset() override;

   virtual const char *readerWriterType() const override;

   bool operator==(const DtRwList& rhs) const;
   bool operator!=(const DtRwList& rhs) const { return !(*this == rhs); };

   virtual void putData(DtEnvironmentSP, DtEnvValueSP parent) const override;
   virtual void getData(const DtEnvironmentSP, const DtEnvValueSP value,
                        const DtReaderWriter::SearchPaths &searchPaths =
                            DtReaderWriter::SearchPaths(),
                        const DtVariableBindingsList &bindings =
                            DtVariableBindingsList()) override;

   static const char* theXmlType();

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

   virtual std::set<DtString> supportedXmlTypes() const;

   //Populates list by looking up all known xml types.
   virtual void populateList(
      boost::function<void (DtReaderWriter*)> addFunction, 
      DtEnvironmentSP env, DtEnvValueSP node,
      const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& bindings);

   virtual void populateListByType(
      boost::function<void (DtReaderWriter*)> addFunction, 
      DtEnvironmentSP env, DtEnvValueSP node, const DtString& bindingType,
      const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& bindings);

protected:
   virtual DtListItem* addBefore (DtReaderWriter* data, DtListItem* before);

   virtual DtListItem* addAfter(DtReaderWriter* data, DtListItem* after);

};