File.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/File.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_File_h
#define __PCL_File_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/ByteArray.h>
#include <pcl/Exception.h>
#include <pcl/FileInfo.h>
#include <pcl/StringList.h>
 
#ifndef __PCL_FILE_DONT_REMOVE_PREVIOUS_DECLARATION
 
/*
 * Remove conflicting identifiers from Win32 SDK headers.
 */
 
#ifdef CreateFile
#undef CreateFile
#endif
 
#ifdef CopyFile
#undef CopyFile
#endif
 
#ifdef MoveFile
#undef MoveFile
#endif
 
#ifdef CreateDirectory
#undef CreateDirectory
#endif
 
#ifdef RemoveDirectory
#undef RemoveDirectory
#endif
 
#endif // !__PCL_FILE_DONT_REMOVE_PREVIOUS_DECLARATION
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
// ----------------------------------------------------------------------------
 
namespace FileMode
{
   enum mask_type
   {
      Zero        = 0x00000000,
 
      /*
       * Access mode
       */
      Read        = 0x00000001,
      Write       = 0x00000002,
      AccessMode  = 0x0000000F,
 
      /*
       * Share mode (Windows only)
       */
      ShareRead   = 0x00000010,
      ShareWrite  = 0x00000020,
      ShareMode   = 0x000000F0,
 
      /*
       * Open/create mode
       */
      Open        = 0x00000100,
      Create      = 0x00000200,
      OpenMode    = 0x00000F00
   };
}
 
using FileModes = Flags<FileMode::mask_type>;
 
// ----------------------------------------------------------------------------
 
namespace SeekMode
{
   enum value_type
   {
      FromBegin,     // Move relative to the beginning of the file
      FromCurrent,   // Move from current position
      FromEnd,       // Move relative to the end of the file
      NumberOfSeekModes
   };
}
 
// ----------------------------------------------------------------------------
 
struct FindFileInfo
{
   String         name;          
   FileAttributes attributes;    
   fsize_type     size;          
   int            numberOfLinks; 
   int            userId;        
   int            groupId;       
   FileTime       created;       
   FileTime       lastAccessed;  
   FileTime       lastModified;  
 
   bool IsDirectory() const
   {
      return attributes.IsFlagSet( FileAttribute::Directory );
   }
 
   bool IsArchive() const
   {
      return attributes.IsFlagSet( FileAttribute::Archive );
   }
 
   bool IsCompressed() const
   {
      return attributes.IsFlagSet( FileAttribute::Compressed );
   }
 
   bool IsEncrypted() const
   {
      return attributes.IsFlagSet( FileAttribute::Encrypted );
   }
 
   bool IsHidden() const
   {
      return attributes.IsFlagSet( FileAttribute::Hidden );
   }
 
   bool IsReadOnly() const
   {
      return attributes.IsFlagSet( FileAttribute::ReadOnly );
   }
 
   bool IsSystem() const
   {
      return attributes.IsFlagSet( FileAttribute::System );
   }
 
   bool IsTemporary() const
   {
      return attributes.IsFlagSet( FileAttribute::Temporary );
   }
 
   bool IsEmpty() const
   {
      return size == 0;
   }
};
 
// ----------------------------------------------------------------------------
 
namespace ReadTextOption
{
   enum mask_type
   {
      RemoveEmptyLines   = 0x0001,
      TrimTrailingSpaces = 0x0002,
      TrimLeadingSpaces  = 0x0004,
      TrimSpaces         = TrimTrailingSpaces | TrimLeadingSpaces
   };
}
 
using ReadTextOptions = Flags<ReadTextOption::mask_type>;
 
// ----------------------------------------------------------------------------
 
struct UniqueFileChecks
{
   bool exists = false;
   bool overwrite = false;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS File
{
public:
 
   using handle = void*;
 
   using seek_mode = SeekMode::value_type;
 
   class PCL_CLASS Error : public pcl::Error
   {
   public:
 
      Error( const String& filePath, const String& message )
         : pcl::Error( message )
         , m_filePath( filePath )
      {
      }
 
      Error( const Error& ) = default;
 
      String ExceptionClass() const override
      {
         return "File I/O Error";
      }
 
      virtual String FilePath() const
      {
         return m_filePath;
      }
 
      virtual String ErrorMessage() const
      {
         return m_message;
      }
 
      String Message() const override
      {
         String filePath = FilePath();
         String message = m_message;
         if ( !filePath.IsEmpty() )
         {
            message += ": ";
            message += filePath;
         }
         return message;
      }
 
   private:
 
      String m_filePath;
   };
 
   class PCL_CLASS Find
   {
   public:
 
      Find() = default;
 
      Find( const String& path )
      {
         Begin( path );
      }
 
      ~Find()
      {
         End();
      }
 
      Find( const Find& ) = delete;
 
      Find& operator =( const Find& ) = delete;
 
      void Begin( const String& path );
 
      bool NextItem( FindFileInfo& info );
 
      void End();
 
      String SearchPath() const
      {
         return m_searchPath;
      }
 
   private:
 
      FindFileInfo m_info;
      String       m_searchPath;
#ifndef __PCL_WINDOWS
      String       m_searchDir;
      String       m_searchName;
#endif
      void*        m_handle = nullptr;
   };
 
   class PCL_CLASS Progress
   {
   public:
 
      Progress( fsize_type total, const String& initialText = String(), fsize_type initialValue = 0 )
         : m_total( Max( fsize_type( 0 ), total ) )
         , m_current( Range( initialValue, fsize_type( 0 ), m_total ) )
         , m_text( initialText )
      {
      }
 
      virtual ~Progress()
      {
      }
 
      fsize_type Total() const
      {
         return m_total;
      }
 
      fsize_type Value() const
      {
         return m_current;
      }
 
      const String& Text() const
      {
         return m_text;
      }
 
      void SetValue( fsize_type current )
      {
         if ( current >= m_current )
         {
            m_current = current;
 
            if ( !ValueChanged() )
            {
               m_abort = true;
               throw ProcessAborted();
            }
         }
      }
 
      void Add( fsize_type delta )
      {
         if ( delta >= 0 )
         {
            m_current += delta;
 
            if ( !ValueChanged() )
            {
               m_abort = true;
               throw ProcessAborted();
            }
         }
      }
 
      void SetText( const String& text )
      {
         m_text = text;
 
         if ( !TextChanged() )
         {
            m_abort = true;
            throw ProcessAborted();
         }
      }
 
      bool IsAborted() const
      {
         return m_abort;
      }
 
   protected:
 
      fsize_type m_total;
      fsize_type m_current;
      String     m_text;
      bool       m_abort = false;
 
      virtual bool ValueChanged() = 0;
 
      virtual bool TextChanged() = 0;
   };
 
   // -------------------------------------------------------------------------
 
   File()
   {
      Initialize();
   }
 
   File( const String& path, FileModes mode )
   {
      PCL_PRECONDITION( !path.IsEmpty() )
      Initialize();
      Open( path, mode );
   }
 
   File( File&& x )
      : m_fileHandle( x.m_fileHandle )
      , m_filePath( std::move( x.m_filePath ) )
      , m_fileMode( x.m_fileMode )
   {
      x.m_fileHandle = s_invalidHandle;
      x.m_fileMode = FileMode::Zero;
   }
 
   File& operator =( File&& x )
   {
      if ( &x != this )
      {
         if ( IsOpen() )
            Close();
         m_fileHandle = x.m_fileHandle;
         m_filePath = std::move( x.m_filePath );
         m_fileMode = x.m_fileMode;
         x.m_fileHandle = s_invalidHandle;
         x.m_fileMode = FileMode::Zero;
      }
      return *this;
   }
 
   virtual ~File()
   {
      if ( IsOpen() )
         Close();
   }
 
   File( const File& ) = delete;
 
   File& operator =( const File& ) = delete;
 
   bool IsOpen() const
   {
      return IsValidHandle( m_fileHandle );
   }
 
   const String& FilePath() const
   {
      return m_filePath;
   }
 
   const String& FileName() const
   {
      return FilePath();
   }
 
   FileModes Mode() const
   {
      return m_fileMode;
   }
 
   virtual bool CanRead() const
   {
      return m_fileMode.IsFlagSet( FileMode::Read );
   }
 
   virtual bool CanWrite() const
   {
      return m_fileMode.IsFlagSet( FileMode::Write );
   }
 
   virtual fpos_type Position() const;
 
   virtual void SetPosition( fpos_type pos );
 
   fpos_type Seek( fpos_type dist, seek_mode mode = SeekMode::FromCurrent );
 
   fpos_type SeekEnd()
   {
      return Seek( 0, SeekMode::FromEnd );
   }
 
   void Rewind()
   {
      SetPosition( 0 );
   }
 
   bool IsEOF() const
   {
      return Position() >= Size();
   }
 
   virtual fsize_type Size() const;
 
   virtual void Resize( fsize_type length );
 
   virtual void Read( void* buffer, fsize_type len );
 
   template <typename T>
   void Read( T& x )
   {
      Read( (void*)&x, sizeof( T ) );
   }
 
   template <typename T>
   void ReadArray( T* a, size_type n )
   {
      Read( (void*)a, n*sizeof( T ) );
   }
 
   template <typename T>
   void ReadI32( T& x )
   {
      int32 i; Read( i ); x = T( i );
   }
 
   template <typename T>
   void ReadUI32( T& x )
   {
      uint32 i; Read( i ); x = T( i );
   }
 
   template <typename T>
   void ReadI64( T& x )
   {
      int64 i; Read( i ); x = T( i );
   }
 
   template <typename T>
   void ReadUI64( T& x )
   {
      uint64 i; Read( i ); x = T( i );
   }
 
   virtual void Write( const void* buffer, fsize_type len );
 
   template <typename T>
   void Write( const T& x )
   {
      Write( (const void*)&x, sizeof( T ) );
   }
 
   template <typename T>
   void WriteArray( const T* a, size_type n )
   {
      Write( (const void*)a, n*sizeof( T ) );
   }
 
   template <typename T>
   void WriteI32( const T& x )
   {
      Write( int32( x ) );
   }
 
   template <typename T>
   void WriteUI32( const T& x )
   {
      Write( uint32( x ) );
   }
 
   template <typename T>
   void WriteI64( const T& x )
   {
      Write( int64( x ) );
   }
 
   template <typename T>
   void WriteUI64( const T& x )
   {
      Write( uint64( x ) );
   }
 
   void Read( bool& b )
   {
      unsigned i; ReadUI32( i ); b = i != 0;
   }
 
   void Write( const bool& b )
   {
      WriteUI32( b ? 1 : 0 );
   }
 
   void Read( IsoString& s );
 
   void Read( String& s );
 
   void Write( const char* i, const char* j );
 
   void Write( const char* s )
   {
      Write( s, s + IsoCharTraits::Length( s ) );
   }
 
   void Write( const IsoString& s )
   {
      Write( s.Begin(), s.End() );
   }
 
   void Write( const char16_type* i, const char16_type* j );
 
   void Write( const char16_type* s )
   {
      Write( s, s + CharTraits::Length( s ) );
   }
 
   void Write( const String& s )
   {
      Write( s.Begin(), s.End() );
   }
 
#ifndef __PCL_NO_FLAGS_FILE_IO
 
   template <typename E>
   static void Read( Flags<E>& f )
   {
      Read( f.m_flags );
   }
 
   template <typename E>
   static void ReadUI32( Flags<E>& f )
   {
      ReadUI32( f.m_flags );
   }
 
   template <typename E>
   static void Write( Flags<E> f )
   {
      Write( f.m_flags );
   }
 
   template <typename E>
   static void WriteUI32( Flags<E> f )
   {
      WriteUI32( f.m_flags );
   }
 
#endif
 
   void OutText( const char* i, const char* j )
   {
      if ( i < j )
         Write( (const void*)i, fsize_type( j - i ) );
   }
 
   void OutText( const char* s )
   {
      OutText( s, s + IsoCharTraits::Length( s ) );
   }
 
   void OutText( const IsoString& s )
   {
      OutText( s.Begin(), s.End() );
   }
 
   void OutText( const char16_type* i, const char16_type* j )
   {
      if ( i < j )
         Write( (const void*)i, fsize_type( j - i ) << 1 );
   }
 
   void OutText( const char16_type* s )
   {
      OutText( s, s + CharTraits::Length( s ) );
   }
 
   void OutText( const String& s )
   {
      OutText( s.Begin(), s.End() );
   }
 
   void OutTextLn( const char* i, const char* j )
   {
      OutText( i, j ); Write( '\n' );
   }
 
   void OutTextLn( const char* s )
   {
      OutText( s ); Write( '\n' );
   }
 
   void OutTextLn()
   {
      Write( '\n' );
   }
 
   void OutTextLn( const IsoString& s )
   {
      OutText( s ); Write( '\n' );
   }
 
   void OutTextLn( const char16_type* i, const char16_type* j )
   {
      OutText( i, j ); Write( char16_type( '\n' ) );
   }
 
   void OutTextLn( const char16_type* s )
   {
      OutText( s ); Write( char16_type( '\n' ) );
   }
 
   void OutTextLn( const String& s )
   {
      OutText( s ); Write( char16_type( '\n' ) );
   }
 
   void Flush();
 
   virtual void Open( const String& path, FileModes mode = FileMode::Read|FileMode::Open );
 
   virtual void OpenForReading( const String& path )
   {
      Open( path, FileMode::Read|FileMode::Open|FileMode::ShareRead );
   }
 
   static File OpenFileForReading( const String& path )
   {
      File f;
      f.OpenForReading( path );
      return f;
   }
 
   virtual void OpenForReadWrite( const String& path )
   {
      Open( path, FileMode::Read|FileMode::Write|FileMode::Open );
   }
 
   static File OpenFileForReadWrite( const String& path )
   {
      File f;
      f.OpenForReadWrite( path );
      return f;
   }
 
   virtual void Create( const String& path )
   {
      Open( path, FileMode::Read|FileMode::Write|FileMode::Create );
   }
 
   static File CreateFile( const String& path )
   {
      File f;
      f.Create( path );
      return f;
   }
 
   virtual void CreateForWriting( const String& path )
   {
      Open( path, FileMode::Write|FileMode::Create );
   }
 
   static File CreateFileForWriting( const String& path )
   {
      File f;
      f.CreateForWriting( path );
      return f;
   }
 
   void OpenOrCreate( const String& path )
   {
      Open( path, FileMode::Read|FileMode::Write|FileMode::Open|FileMode::Create );
   }
 
   static File OpenOrCreateFile( const String& path )
   {
      File f;
      f.OpenOrCreate( path );
      return f;
   }
 
   virtual void Close();
 
   static void Remove( const String& filePath );
 
   static void CreateDirectory( const String& dirPath, bool createIntermediateDirectories = true );
 
   static void RemoveDirectory( const String& dirPath );
 
   static void Move( const String& filePath, const String& newFilePath );
 
   static bool Exists( const String& filePath );
 
   static bool DirectoryExists( const String& dirPath );
 
   static UniqueFileChecks EnsureNewUniqueFile( String& filePath, bool canOverwrite = false );
 
   static UniqueFileChecks EnsureNewUniqueDirectory( String& dirPath );
 
   static bool IsReadOnly( const String& filePath );
 
   static void SetReadOnly( const String& filePath, bool rdOnly = true );
 
   static void SetReadWrite( const String& filePath )
   {
      SetReadOnly( filePath, false );
   }
 
   static ByteArray ReadFile( const String& filePath );
 
   static void WriteFile( const String& filePath, const ByteArray& contents );
 
   static void WriteFile( const String& filePath, const ByteArray& contents, size_type start, size_type size );
 
   static void WriteFile( const String& filePath, const void* data, size_type size );
 
   static IsoString ReadTextFile( const String& filePath );
 
   static void WriteTextFile( const String& filePath, const IsoString& text );
 
   static void SetPermissions( const String& targetPath, FileAttributes permissions );
 
   static void CopyTimesAndPermissions( const String& targetPath, const String& sourcePath );
 
#ifndef __PCL_WINDOWS
   static void CopyLink( const String& targetLinkPath, const String& sourceLinkPath );
#endif // !__PCL_WINDOWS
 
   static void CopyFile( const String& targetFilePath, const String& sourceFilePath, File::Progress* progress = nullptr );
 
   static void MoveFile( const String& targetFilePath, const String& sourceFilePath, File::Progress* progress = nullptr );
 
   static bool SameDevice( const String& path1, const String& path2 );
 
   static bool SameFile( const String& path1, const String& path2 );
 
   static IsoStringList ReadLines( const String& filePath,
                                   ReadTextOptions options = ReadTextOptions() );
 
   static size_type ScanLines( const String& filePath,
                               bool (*callback)( char*, void* ), void* data = nullptr,
                               ReadTextOptions options = ReadTextOptions() );
 
   static String FullPath( const String& path );
 
   static IsoString FileURI( const String& path );
 
   static String SystemTempDirectory();
 
   static String SystemCacheDirectory();
 
   static String HomeDirectory();
 
   static String WindowsPathToUnix( const String& path );
 
   static String UnixPathToWindows( const String& path );
 
   static String UniqueFileName( const String& directory = String(), int n = 12,
                                 const String& prefix = String(), const String& postfix = String() );
 
   static uint64 GetAvailableSpace( const String& dirPath, uint64* totalBytes = nullptr, uint64* freeBytes = nullptr );
 
   static size_type FindDrive( const String& path );
 
   static size_type FindName( const String& path );
 
   static size_type FindExtension( const String& path );
 
   static size_type FindSuffix( const String& path )
   {
      return FindExtension( path );
   }
 
   static size_type FindCompleteSuffix( const String& path );
 
   static String ExtractDrive( const String& path ); // always empty string on X
 
   static String ExtractDirectory( const String& path );
 
   static String ExtractName( const String& path );
 
   static String ExtractExtension( const String& path );
 
   static String ExtractSuffix( const String& path )
   {
      return ExtractExtension( path );
   }
 
   static String ExtractCompleteSuffix( const String& path );
 
   static String ExtractNameAndExtension( const String& path );
 
   static String ExtractNameAndSuffix( const String& path )
   {
      return ExtractNameAndExtension( path );
   }
 
   static String ChangeExtension( const String& filePath, const String& ext );
 
   static String AppendToName( const String& filePath, const String& postfix );
 
   static String PrependToName( const String& filePath, const String& prefix );
 
   static String SizeAsString( fsize_type sizeInBytes, int precision = 3, bool alsoShowBytes = false );
 
protected:
 
   handle    m_fileHandle;
   String    m_filePath;
   FileModes m_fileMode;
 
   static const handle s_invalidHandle;
 
   void Initialize();
   virtual bool IsValidHandle( handle h ) const;
};
 
// ----------------------------------------------------------------------------
 
}  // pcl
 
#endif   // __PCL_File_h
 
// ----------------------------------------------------------------------------
// EOF pcl/File.h - Released 2024-06-18T15:48:54Z