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   //! CREATES a file if it doesn't already exists or empties
  57   //! an existing file.
  58   //! After 'Build', the file is open.
  59   //! If no name was given, ProgramError is raised.
  60   Standard_EXPORT void Build (const OSD_OpenMode Mode, const OSD_Protection& Protect);
  61
  62   //! Opens a File with specific attributes
  63   //! This works only on already existing file.
  64   //! If no name was given, ProgramError is raised.
  65   Standard_EXPORT void Open (const OSD_OpenMode Mode, const OSD_Protection& Protect);
  66
  67   //! Appends data to an existing file.
  68   //! If file doesn't exist, creates it first.
  69   //! After 'Append', the file is open.
  70   //! If no name was given, ProgramError is raised.
  71   Standard_EXPORT void Append (const OSD_OpenMode Mode, const OSD_Protection& Protect);
  72
  73   //! Attempts to read Nbyte bytes from the file associated with
  74   //! the object file.
  75   //! Upon successful completion, Read returns the number of
  76   //! bytes actually read and placed in the Buffer. This number
  77   //! may be less than Nbyte if the number of bytes left in the file
  78   //! is less than Nbyte bytes. In this case only number of read
  79   //! bytes will be placed in the buffer.
  80   Standard_EXPORT void Read (TCollection_AsciiString& Buffer, const Standard_Integer Nbyte);
  81
  82   //! Reads bytes from the data pointed to by the object file
  83   //! into the buffer <Buffer>.
  84   //! Data is read until <NByte-1> bytes have been read,
  85   //! until     a newline character is read and transferred into
  86   //! <Buffer>, or until an EOF (End-of-File) condition is
  87   //! encountered.
  88   //! Upon successful completion, Read returns the number of
  89   //! bytes actually read into <NByteRead> and placed into the
  90   //! Buffer <Buffer>.
  91   Standard_EXPORT void ReadLine (TCollection_AsciiString& Buffer, const Standard_Integer NByte, Standard_Integer& NbyteRead);
  92
  93   //! Attempts to read Nbyte bytes from the files associated with
  94   //! the object File.
  95   //! Upon successful completion, Read returns the number of
  96   //! bytes actually read and placed in the Buffer. This number
  97   //! may be less than Nbyte if the number of bytes left in the file
  98   //! is less than Nbyte bytes. For this reason the output
  99   //! parameter Readbyte will contain the number of read bytes.
 100   Standard_EXPORT void Read (Standard_Address& Buffer, const Standard_Integer Nbyte, Standard_Integer& Readbyte);
 101
 102   //! Attempts to write Nbyte bytes from the AsciiString to the file
 103   //! associated to the object File.
 104   Standard_EXPORT void Write (const TCollection_AsciiString& Buffer, const Standard_Integer Nbyte);
 105
 106   //! Attempts to write Nbyte bytes from the buffer pointed
 107   //! to by Buffer to the file associated to the object File.
 108   Standard_EXPORT void Write (const Standard_Address Buffer, const Standard_Integer Nbyte);
 109
 110   //! Sets the seek pointer associated with the open file
 111   Standard_EXPORT void Seek (const Standard_Integer Offset, const OSD_FromWhere Whence);
 112
 113   //! Closes the file (and deletes a descriptor)
 114   Standard_EXPORT void Close();
 115
 116   //! Returns TRUE if the seek pointer is at end of file.
 117   Standard_EXPORT Standard_Boolean IsAtEnd();
 118
 119   //! Returns the kind of file. A file can be a
 120   //! file, a directory or a link.
 121   Standard_EXPORT OSD_KindFile KindOfFile() const;
 122
 123   //! Makes a temporary File
 124   //! This returned file is already open !
 125   //! This file is non-persistent and will be automatically
 126   //! removed when its process finishes.
 127   Standard_EXPORT static OSD_File BuildTemporary();
 128
 129   //! Locks current file
 130   Standard_EXPORT void SetLock (const OSD_LockType Lock);
 131
 132   //! Unlocks current file
 133   Standard_EXPORT void UnLock();
 134
 135   //! Returns the current lock state
 136   Standard_EXPORT OSD_LockType GetLock();
 137
 138   //! Returns TRUE if this file is locked.
 139   Standard_EXPORT Standard_Boolean IsLocked();
 140
 141   //! Returns actual number of bytes of <me>.
 142   Standard_EXPORT Standard_Size Size();
 143
 144   //! Prints a file on selected printer.
 145   Standard_EXPORT void Print (const OSD_Printer& WhichPrinter);
 146
 147   //! Returns TRUE if <me> is open.
 148   Standard_EXPORT Standard_Boolean IsOpen() const;
 149
 150   //! returns TRUE if the file exists and if the user
 151   //! has the autorization to read it.
 152   Standard_EXPORT Standard_Boolean IsReadable();
 153
 154   //! returns TRUE if the file can be read and overwritten.
 155   Standard_EXPORT Standard_Boolean IsWriteable();
 156
 157   //! returns TRUE if the file can be executed.
 158   Standard_EXPORT Standard_Boolean IsExecutable();
 159
 160   //! Enables to emulate unix "tail -f" command.
 161   //! If a line is available in the file <me> returns it.
 162   //! Otherwise attemps to read again aNbTries times in the file
 163   //! waiting aDelay seconds between each read.
 164   //! If meanwhile the file increases returns the next line, otherwise
 165   //! returns FALSE.
 166   Standard_EXPORT Standard_Boolean ReadLastLine (TCollection_AsciiString& aLine, const Standard_Integer aDelay, const Standard_Integer aNbTries);
 167
 168   //! find an editor on the system and edit the given file
 169   Standard_EXPORT Standard_Boolean Edit();
 170
 171
 172
 173
 174 protected:
 175
 176
 177
 178   Standard_Integer myIO;
 179   Standard_Address myFILE;
 180   Standard_Integer myFileChannel;
 181   Standard_Address myFileHandle;
 182
 183
 184 private:
 185
 186
 187
 188   Standard_Boolean ImperativeFlag;
 189   OSD_LockType myLock;
 190   OSD_OpenMode myMode;
 191
 192
 193 };
 194
 195
 196
 197
 198
 199
 200
 201 #endif // _OSD_File_HeaderFile