readerWriterFile.h

Go to the documentation of this file.

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



#pragma once

#include "readerWriter/readerWriter.h"
#include "readerWriter/rwString.h"
#include <vlutil/vlFilename.h>
#include <mtl/mtlEnvironment.h>

typedef std::map<DtlObj*, std::string> DtlObjStringMap;

class DtReaderWriterRegistry;
class DtFilename;

#include "readerWriter/readerWriterDefines.h"
class DT_DLL_readerWriter DtReaderWriterFile : public DtReaderWriter
{
public:
   DtReaderWriterFile();

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

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

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

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

   DtReaderWriterFile& operator=(const DtReaderWriterFile& orig);
   DtReaderWriterFile& operator=(const DtFilename& orig);

   virtual ~DtReaderWriterFile() override;

   DtReaderWriterFile* clone(const DtString& name, 
                             DtReaderWriterRegistry* parentRegistry = NULL);

   DtReaderWriterFile* clone(const DtSymbolString& name, 
                             DtReaderWriterRegistry* parentRegistry = NULL);

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

   virtual bool saveFile(const DtFilename& filename);

   virtual bool loadFile(const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings, DtlObjStringMap* commentMap = NULL);

   virtual void putSelf(std::string &fp, int indentLevel, bool writeUnspecified,
                        const DtFilename &path) override;

   virtual void setObjectToReadAndWrite(DtReaderWriter* object);
   virtual const DtReaderWriter& objectToReadAndWrite() const;

   static const DtFilename& appPath();

   virtual void setFilename(const DtString& filename);

   virtual void setFilename(const DtString& filename, const DtString& unsubstitutedFilename);

   virtual const DtString& filename() const;

   virtual DtString unsubstitutedFilename() const;

   virtual void setUnsubstitudedFilename(const DtString& f);

   virtual const DtFilename& filenameLastReadIn() const;

   virtual void setFileReadOnly(bool readOnly = true);
   virtual bool fileReadOnly() const;

   virtual const char *readerWriterType() const override;

   virtual void substitute(const DtVariableBindingsList& variableBindings);

   bool operator==(const DtReaderWriterFile&) const;

   static DtFilename findHighestPriorityFile(const DtFilename& filename, 
      const DtReaderWriter::SearchPaths& searchPaths, bool warnOnNotFound = true);
   static FILE* loadHighestPriorityFile(const DtFilename& filename, 
      const DtReaderWriter::SearchPaths& searchPaths, bool warnOnNotFound = true);
   static FILE* loadHighestPriorityFile(const DtFilename& filename, 
      const DtReaderWriter::SearchPaths& searchPaths, DtFilename& successfulPath,
      bool warnOnNotFound = true);

   // Returns a filename that is a substitutable fragment for the given file
   static DtFilename createPathFragment(const DtFilename& filename,
      const DtReaderWriter::SearchPaths& searchPaths);

   // Finds all files with the given extension in the supplied path.
   // Non-recursive.
   static std::vector<DtFilename> findFilesByExtension(
      const DtString& path, const DtString& extension);

protected:

   bool getFilenameToWrite(const DtFilename& path, const DtFilename& filename,
      DtFilename& filenameToWrite) const;

protected:
   DtRwString       myFilename;
   DtReaderWriter*  myObjectToReadAndWrite;
   bool             myFileReadOnly;
   DtFilename       myFilenameLastReadIn;
   DtString         myVariableSubstitutedFilename;
};