2cc055f91a57e7916598fc5ea437f650114dc247
[occt.git] / src / OSD / OSD_File.hxx
1 // Created on: 1992-02-17
2 // Created by: Stephan GARNAUD
3 // Copyright (c) 1992-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _OSD_File_HeaderFile
18 #define _OSD_File_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Boolean.hxx>
25 #include <OSD_LockType.hxx>
26 #include <OSD_OpenMode.hxx>
27 #include <Standard_Integer.hxx>
28 #include <Standard_Address.hxx>
29 #include <OSD_FileNode.hxx>
30 #include <OSD_FromWhere.hxx>
31 #include <OSD_KindFile.hxx>
32 #include <Standard_Size.hxx>
33 class Standard_ProgramError;
34 class OSD_Path;
35 class OSD_Protection;
36 class TCollection_AsciiString;
37 class OSD_Printer;
38
39
40 //! Basic tools to manage files
41 //! Warning: 'ProgramError' is raised when somebody wants to use the methods
42 //! Read, Write, Seek, Close when File is not open.
43 class OSD_File  : public OSD_FileNode
44 {
45 public:
46
47   DEFINE_STANDARD_ALLOC
48
49   
50   //! Creates File object.
51   Standard_EXPORT OSD_File();
52   
53   //! Instantiates the object file, storing its name
54   Standard_EXPORT OSD_File(const OSD_Path& Name);
55
56   //! Unlocks and closes a file, deletes a descriptor and destructs a file object.
57   Standard_EXPORT ~OSD_File();
58   
59   //! CREATES a file if it doesn't already exists or empties
60   //! an existing file.
61   //! After 'Build', the file is open.
62   //! If no name was given, ProgramError is raised.
63   Standard_EXPORT void Build (const OSD_OpenMode Mode, const OSD_Protection& Protect);
64   
65   //! Opens a File with specific attributes
66   //! This works only on already existing file.
67   //! If no name was given, ProgramError is raised.
68   Standard_EXPORT void Open (const OSD_OpenMode Mode, const OSD_Protection& Protect);
69   
70   //! Appends data to an existing file.
71   //! If file doesn't exist, creates it first.
72   //! After 'Append', the file is open.
73   //! If no name was given, ProgramError is raised.
74   Standard_EXPORT void Append (const OSD_OpenMode Mode, const OSD_Protection& Protect);
75   
76   //! Attempts to read Nbyte bytes from the file associated with
77   //! the object file.
78   //! Upon successful completion, Read returns the number of
79   //! bytes actually read and placed in the Buffer. This number
80   //! may be less than Nbyte if the number of bytes left in the file
81   //! is less than Nbyte bytes. In this case only number of read
82   //! bytes will be placed in the buffer.
83   Standard_EXPORT void Read (TCollection_AsciiString& Buffer, const Standard_Integer Nbyte);
84   
85   //! Reads bytes from the data pointed to by the object file
86   //! into the buffer <Buffer>.
87   //! Data is read until <NByte-1> bytes have been read,
88   //! until     a newline character is read and transferred into
89   //! <Buffer>, or until an EOF (End-of-File) condition is
90   //! encountered.
91   //! Upon successful completion, Read returns the number of
92   //! bytes actually read into <NByteRead> and placed into the
93   //! Buffer <Buffer>.
94   Standard_EXPORT void ReadLine (TCollection_AsciiString& Buffer, const Standard_Integer NByte, Standard_Integer& NbyteRead);
95   
96   //! Attempts to read Nbyte bytes from the files associated with
97   //! the object File.
98   //! Upon successful completion, Read returns the number of
99   //! bytes actually read and placed in the Buffer. This number
100   //! may be less than Nbyte if the number of bytes left in the file
101   //! is less than Nbyte bytes. For this reason the output
102   //! parameter Readbyte will contain the number of read bytes.
103   Standard_EXPORT void Read (Standard_Address& Buffer, const Standard_Integer Nbyte, Standard_Integer& Readbyte);
104   
105   //! Attempts to write Nbyte bytes from the AsciiString to the file
106   //! associated to the object File.
107   Standard_EXPORT void Write (const TCollection_AsciiString& Buffer, const Standard_Integer Nbyte);
108   
109   //! Attempts to write Nbyte bytes from the buffer pointed
110   //! to by Buffer to the file associated to the object File.
111   Standard_EXPORT void Write (const Standard_Address Buffer, const Standard_Integer Nbyte);
112   
113   //! Sets the seek pointer associated with the open file
114   Standard_EXPORT void Seek (const Standard_Integer Offset, const OSD_FromWhere Whence);
115   
116   //! Closes the file (and deletes a descriptor)
117   Standard_EXPORT void Close();
118   
119   //! Returns TRUE if the seek pointer is at end of file.
120   Standard_EXPORT Standard_Boolean IsAtEnd();
121   
122   //! Returns the kind of file. A file can be a
123   //! file, a directory or a link.
124   Standard_EXPORT OSD_KindFile KindOfFile() const;
125   
126   //! Makes a temporary File
127   //! This returned file is already open !
128   //! This file is non-persistent and will be automatically
129   //! removed when its process finishes.
130   Standard_EXPORT static OSD_File BuildTemporary();
131   
132   //! Locks current file
133   Standard_EXPORT void SetLock (const OSD_LockType Lock);
134   
135   //! Unlocks current file
136   Standard_EXPORT void UnLock();
137   
138   //! Returns the current lock state
139   Standard_EXPORT OSD_LockType GetLock();
140   
141   //! Returns TRUE if this file is locked.
142   Standard_EXPORT Standard_Boolean IsLocked();
143   
144   //! Returns actual number of bytes of <me>.
145   Standard_EXPORT Standard_Size Size();
146   
147   //! Prints a file on selected printer.
148   Standard_EXPORT void Print (const OSD_Printer& WhichPrinter);
149   
150   //! Returns TRUE if <me> is open.
151   Standard_EXPORT Standard_Boolean IsOpen() const;
152   
153   //! returns TRUE if the file exists and if the user
154   //! has the autorization to read it.
155   Standard_EXPORT Standard_Boolean IsReadable();
156   
157   //! returns TRUE if the file can be read and overwritten.
158   Standard_EXPORT Standard_Boolean IsWriteable();
159   
160   //! returns TRUE if the file can be executed.
161   Standard_EXPORT Standard_Boolean IsExecutable();
162   
163   //! Enables to emulate unix "tail -f" command.
164   //! If a line is available in the file <me> returns it.
165   //! Otherwise attemps to read again aNbTries times in the file
166   //! waiting aDelay seconds between each read.
167   //! If meanwhile the file increases returns the next line, otherwise
168   //! returns FALSE.
169   Standard_EXPORT Standard_Boolean ReadLastLine (TCollection_AsciiString& aLine, const Standard_Integer aDelay, const Standard_Integer aNbTries);
170   
171   //! find an editor on the system and edit the given file
172   Standard_EXPORT Standard_Boolean Edit();
173
174
175
176
177 protected:
178
179
180
181   Standard_Integer myIO;
182   Standard_Address myFILE;
183   Standard_Integer myFileChannel;
184   Standard_Address myFileHandle;
185
186
187 private:
188
189
190
191   Standard_Boolean ImperativeFlag;
192   OSD_LockType myLock;
193   OSD_OpenMode myMode;
194
195
196 };
197
198
199
200
201
202
203
204 #endif // _OSD_File_HeaderFile