file.h

Go to the documentation of this file.

/*
 * file.h
 *
 * Operating System file I/O channel class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 */


#ifndef PTLIB_FILE_H
#define PTLIB_FILE_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#ifndef _WIN32
#include <sys/stat.h>
#endif

#include <ptlib/bitwise_enum.h>


// Binary Files

class PFile : public PChannel
{
  PCLASSINFO(PFile, PChannel);

  public:
    PFile();

    enum OpenMode {
      ReadOnly,   
      WriteOnly,  
      ReadWrite   
    };

    P_DECLARE_BITWISE_ENUM_EX(OpenOptions, 7,
        (NoOptions,       
         MustExist,       
         Create,          
         Truncate,        
         Exclusive,       
         Temporary,       
         DenySharedRead,  
         DenySharedWrite  
        ),
        ModeDefault = -1  
    );

    PFile(
      OpenMode mode,          
      OpenOptions opts = ModeDefault  
    );

    PFile(
      const PFilePath & name,    
      OpenMode mode = ReadWrite, 
      OpenOptions opts = ModeDefault     
    );

    ~PFile();


    Comparison Compare(
      const PObject & obj   
    ) const;


    virtual PString GetName() const;

    virtual PBoolean Read(
      void * buf,   
      PINDEX len    
    );

    virtual PBoolean Write(
      const void * buf, 
      PINDEX len        
    );

    virtual PBoolean Close();


    static bool Exists(
      const PFilePath & name  
    );

    bool Exists() const;

    static bool Access(
      const PFilePath & name, 
      OpenMode mode         
    );

    bool Access(
      OpenMode mode         
    );

    static bool Touch(
      const PFilePath & name,       
      const PTime & accessTime = 0  
    );
    static bool Touch(
      const PFilePath & name,   
      const PTime & accessTime, 
      const PTime & modTime     
    );

    bool Touch(
      const PTime & accessTime = 0 
    );
    bool Touch(
      const PTime & accessTime,    
      const PTime & modTime        
    );

    static bool Remove(
      const PFilePath & name,   
      bool force = false        
    );
    static bool Remove(
      const PString & name,   
      bool force = false      
    );

    bool Remove(
      bool force = false      
    );

    static bool Rename(
      const PFilePath & oldname,  
      const PString & newname,    
      bool force = false          
    );

    bool Rename(
      const PString & newname,  
      bool force = false        
    );

    static bool Copy(
      const PFilePath & oldname,  
      const PFilePath & newname,  
      bool force = false,         
      bool recurse = false        
    );

    bool Copy(
      const PFilePath & newname,  
      bool force = false,         
      bool recurse = false        
    );

    static bool Move(
      const PFilePath & oldname,  
      const PFilePath & newname,  
      bool force = false,         
      bool recurse = false        
    );

    bool Move(
      const PFilePath & newname,  
      bool force = false,         
      bool recurse = false        
    );

    const PFilePath & GetFilePath() const;

    void SetFilePath(
      const PString & path    
    );


    bool Open(
      OpenMode mode = ReadWrite,        
      OpenOptions opts = ModeDefault    
    );

    bool Open(
      OpenMode mode,                      
      OpenOptions opts,                   
      PFileInfo::Permissions permissions  
    );

    bool Open(
      const PFilePath & name,         
      OpenMode mode = ReadWrite,      
      OpenOptions opts = ModeDefault  
    );

    bool Open(
      const PFilePath & name,             
      OpenMode mode,                      
      OpenOptions opts,                   
      PFileInfo::Permissions permissions  
    );

    virtual off_t GetLength() const;
      
    virtual PBoolean SetLength(
      off_t len   // New length of file.
    );

    enum FilePositionOrigin {
      Start = SEEK_SET,    
      Current = SEEK_CUR,  
      End = SEEK_END       
    };

    virtual PBoolean SetPosition(
      off_t pos,                         
      FilePositionOrigin origin = Start  
    );

    virtual off_t GetPosition() const;

    bool IsEndOfFile() const;
      
    static bool GetInfo(
      const PFilePath & name,  
      PFileInfo & info         
    );

    bool GetInfo(
      PFileInfo & info 
    );

    static bool SetPermissions(
      const PFilePath & name,             
      PFileInfo::Permissions permissions  
    );
    bool SetPermissions(
      PFileInfo::Permissions permissions  
    );

    struct RotateInfo
    {
      static const PString & DefaultTimestamp();
      explicit RotateInfo(
        const PDirectory & dir = PDirectory(),
        const PString & prefix = PString::Empty(), // If empty, uses PProcess::Current().GetName()
        const PString & suffix = PString::Empty(),
        const PString & timestamp = DefaultTimestamp(),
        off_t maxSize = 1000000000, // A gigabyte
        off_t minFree = -10 // Percent
      );
      RotateInfo(const RotateInfo & other);
      RotateInfo & operator=(const RotateInfo & other);
      virtual ~RotateInfo() { }

      bool CanRotate() const;

      bool Rotate(
        PFile & activeFile,
        bool force = false, 
        const PTime & now = PTime()
      );

      virtual void OnCloseFile(
        PFile & file,               
        const PFilePath & rotatedTo 
      );

      virtual bool OnOpenFile(
        PFile & file                
      );

      virtual void OnMessage(
        bool error,           
        const PString & msg   
      );

      P_DECLARE_STREAMABLE_ENUM(Period,
        SizeOnly,
        Hourly,
        Daily,
        Weekly,
        Monthly
      );

      PDirectory      m_directory;    
      PFilePathString m_prefix;       
      PString         m_timestamp;    
      int             m_timeZone;     
      PFilePathString m_suffix;       
      off_t           m_maxSize;      
      off_t           m_freeDisk;     
      Period          m_period;       
      unsigned        m_maxFileCount; 
      PTimeInterval   m_maxFileAge;   

      PTime           m_lastTime;
    };

  protected:
    virtual bool InternalOpen(OpenMode mode, OpenOptions opts, PFileInfo::Permissions permissions);

    // Member variables

    PFilePath m_path;         
    bool      m_removeOnClose; 


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/file.h"
#else
#include "unix/ptlib/file.h"
#endif
};


#endif // PTLIB_FILE_H


// End Of File ///////////////////////////////////////////////////////////////