rwVariableBindings.h

Go to the documentation of this file.

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



#pragma once

#include "readerWriter/readerWriterDefines.h"
#include "readerWriter/readerWriter.h"
#include <list>
#include <vlutil/vlSmartPointers.h>

class DT_DLL_readerWriter DtRwVariableBindings : public DtReaderWriter
{
private:
   DtRwVariableBindings();

public:
   DtRwVariableBindings(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwVariableBindings(const DtString& name, const DtRwVariableBindings& orig,
      DtReaderWriterRegistry* parentRegistry = 0, bool copyVariables = true);
   DtRwVariableBindings(const DtRwVariableBindings& orig,
      DtReaderWriterRegistry* parentRegistry = 0, bool copyVariables = true);
   DtRwVariableBindings& operator=(const DtRwVariableBindings& orig);
   virtual ~DtRwVariableBindings() override;
      
   virtual void getSelf(
       DtlObjPtr args,
       const std::vector<DtFilename> &searchPaths = std::vector<DtFilename>(),
       const DtVariableBindingsList &variableBindings =
           nullVariableReference()) override;

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


   virtual const DtReaderWriter* findVariableBinding(const DtString& rwTypeString,
      const DtString& variableName, const std::map<DtString, DtString>& variableSubstitutions = std::map<DtString, DtString>()) const;
   virtual DtReaderWriter* findVariableBinding(const DtString& rwTypeString,
      const DtString& variableName, const std::map<DtString, DtString>& variableSubstitutions = std::map<DtString, DtString>());


   virtual const DtReaderWriter* findVariableBinding(const DtString& variableName,
      const std::map<DtString, DtString>& variableSubstitutions = std::map<DtString, DtString>()) const;
   virtual DtReaderWriter* findVariableBinding(const DtString& variableName,
      const std::map<DtString, DtString>& variableSubstitutions = std::map<DtString, DtString>());

   template <typename RW_Type>
   const RW_Type* findAndCastVariableBinding(const DtString& variableName) const
   {
      const DtReaderWriter* rw = findVariableBinding(variableName);
      if (rw)
      {
         return dynamic_cast<const RW_Type*>(rw);
      }
      return 0;
   }

   static DtRwVariableBindings* createBinding(const std::list<DtReaderWriter::DtVariableNameType> &);

   virtual DtReaderWriter* addVariableBinding(const DtSymbolString& name, const char* type);

   virtual void addVariable(DtReaderWriter*);

   virtual void removeVariable(DtReaderWriter*);

   virtual void removeVariable(const DtReaderWriter*);

   virtual void clearVariables();

   virtual const char *readerWriterType() const override;

   virtual int getSize() const;

   virtual char* encode(char*) const;

   virtual const char* decode(const char*);

   bool operator==(const DtRwVariableBindings&) const;
   bool operator!=(const DtRwVariableBindings&) const;

   virtual DtString prettyPrint() const override;

   //  When looking to find a variable, any variable that has the substitutions key name will be found as that, and bound to the name that is given as the substitute
   virtual void setVariableSubstitutions(const std::map<DtString, DtString>&);
   virtual const std::map<DtString, DtString>& variableSubstitutions() const;

   virtual void merge(const DtRwVariableBindings&);

protected:
   virtual const DtReaderWriter* internalFindVariableBinding(const DtString& rwTypeString,
      const DtString& variableName, const std::map<DtString, DtString>& variableSubstitutions = std::map<DtString, DtString>()) const;

   virtual void copyVariables(const DtRwVariableBindings& other);

   virtual bool keywordMatches(const DtSymbolString& lhs, const DtString& rhs,
      const std::map<DtString, DtString>& variableSubstitutions) const;

protected:
   std::map<DtString, DtString> myVariableSubstitutions;
};

typedef std::shared_ptr<DtRwVariableBindings> DtVariableBindingsSharedPtr;

DT_DLL_readerWriter bool substituteVariablesInString(DtString& string, 
                                                const std::list<const DtRwVariableBindings*>&);