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): ______________________________________.
 *
 * $Revision: 27039 $
 * $Author: rjongbloed $
 * $Date: 2012-02-22 18:19:46 +1100 (Wed, 22 Feb 2012) $
 */


#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, 6,
        (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 PBoolean Exists(
      const PFilePath & name  
    );

    PBoolean Exists() const;

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

    PBoolean Access(
      OpenMode mode         
    );

    static PBoolean Remove(
      const PFilePath & name,   // Name of file to delete.
      PBoolean force = false      // Force deletion even if file is protected.
    );
    static PBoolean Remove(
      const PString & name,   // Name of file to delete.
      PBoolean force = false      // Force deletion even if file is protected.
    );

    PBoolean Remove(
      PBoolean force = false      // Force deletion even if file is protected.
    );

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

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

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

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

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

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

    const PFilePath & GetFilePath() const;

    void SetFilePath(
      const PString & path    
    );


    virtual PBoolean Open(
      OpenMode mode = ReadWrite,  // Mode in which to open the file.
      OpenOptions opts = ModeDefault      // Options for open operation.
    );

    virtual PBoolean Open(
      const PFilePath & name,    // Name of file to open.
      OpenMode mode = ReadWrite, // Mode in which to open the file.
      OpenOptions opts = ModeDefault     // <code>OpenOptions</code> enum# for open operation.
    );
      
    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;

    PBoolean IsEndOfFile() const;
      
    static PBoolean GetInfo(
      const PFilePath & name,  // Name of file to get the information on.
      PFileInfo & info
      // <code>PFileInfo</code> structure to receive the information.
    );

    PBoolean GetInfo(
      PFileInfo & info
      // <code>PFileInfo</code> structure to receive the information.
    );

    static PBoolean SetPermissions(
      const PFilePath & name,   // Name of file to change the permission of.
      int permissions           // New permissions mask for the file.
    );
    PBoolean SetPermissions(
      int permissions           // New permissions mask for the file.
    );

  protected:
    // Member variables

    PFilePath path;         
    PBoolean 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 ///////////////////////////////////////////////////////////////