VR-Forces 4.1.1 Class Documentation
rwFile.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 1999 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 /*******************************************************************************
6 ** $RCSfile: rwFile.h,v $ $Revision: 1.26 $ $State: Exp $
7 *******************************************************************************/
8 
11 
17 
18 #ifndef DtReaderWriterFile_H_
19 #define DtReaderWriterFile_H_
20 
21 #include "vrfutil/rdrWritr.h"
22 #include "vrfutil/rwString.h"
23 #include <vlutil/vlFilename.h>
24 #include <mtl/lispEnv.h>
25 
26 typedef std::map<DtlObj*, std::string> DtlObjStringMap;
27 
28 class DtReaderWriterRegistry;
29 class DtFilename;
30 
38 #include "vrfutil/vrfutilDefines.h"
39 class DT_DLL_vrfutil DtReaderWriterFile : public DtReaderWriter
40 {
41 public:
43  DtReaderWriterFile();
44 
46  DtReaderWriterFile(const DtString& name,
47  DtReaderWriterRegistry* parentRegistry = NULL);
48 
49  DtReaderWriterFile(const DtSymbolString& name,
50  DtReaderWriterRegistry* parentRegistry = NULL);
51 
53  DtReaderWriterFile(const DtString& name, const DtReaderWriterFile& orig,
54  DtReaderWriterRegistry* parentRegistry = NULL);
55 
56  DtReaderWriterFile(const DtSymbolString& name, const DtReaderWriterFile& orig,
57  DtReaderWriterRegistry* parentRegistry = NULL);
58 
60  DtReaderWriterFile& operator=(const DtReaderWriterFile& orig);
61  DtReaderWriterFile& operator=(const DtFilename& orig);
62 
64  virtual ~DtReaderWriterFile();
65 
67  DtReaderWriterFile* clone(const DtString& name,
68  DtReaderWriterRegistry* parentRegistry = NULL);
69 
70  DtReaderWriterFile* clone(const DtSymbolString& name,
71  DtReaderWriterRegistry* parentRegistry = NULL);
72 
75  virtual void getSelf(DtlObjPtr args, const DtFilename& searchPath,
76  const DtVariableBindingsList& variableBindings);
77 
79  virtual void saveFile(const DtFilename& filename);
80  virtual void loadFile(const DtFilename& searchPath,
81  const DtVariableBindingsList& variableBindings, DtlObjStringMap* commentMap = NULL);
82 
85  virtual void putSelf(FILE* fp, int indentLevel,
86  bool writeUnspecified, const DtFilename& path);
87 
89  virtual void setObjectToReadAndWrite(DtReaderWriter* object);
91  virtual const DtReaderWriter& objectToReadAndWrite() const;
92 
94  static const DtFilename& appPath();
95 
103  virtual void setFilename(const DtString& filename);
104 
109  virtual void setFilename(const DtString& filename, const DtString& unsubstitutedFilename);
110 
114  virtual const DtString& filename() const;
115 
117  virtual DtString unsubstitutedFilename() const;
118 
120  virtual void setUnsubstitudedFilename(const DtString& f);
121 
123  virtual const DtFilename& filenameLastReadIn() const;
124 
129  virtual void setFileReadOnly(bool readOnly = true);
130  virtual bool fileReadOnly() const;
131 
135  virtual const char* readerWriterType() const;
136 
138  virtual void substitute(const DtVariableBindingsList& variableBindings);
139 
140 protected:
141 
145  bool getFilenameToWrite(const DtFilename& path, const DtFilename& filename,
146  DtFilename& filenameToWrite) const;
147 
148 protected:
149  DtRwString myFilename;
150  DtReaderWriter* myObjectToReadAndWrite;
151  bool myFileReadOnly;
152  DtFilename myFilenameLastReadIn;
153  DtString myVariableSubstitutedFilename;
154  };
155 
156 #endif
157 
Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)