pdirect.h

Go to the documentation of this file.

/*
 * pdirect.h
 *
 * File system directory 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): ______________________________________.
 *
 * $Log: pdirect.h,v $
 * Revision 1.43  2005/11/25 03:43:47  csoutheren
 * Fixed function argument comments to be compatible with Doxygen
 *
 * Revision 1.42  2004/09/17 03:51:15  csoutheren
 * More fixes for PDirectory problem
 *
 * Revision 1.42  2004/09/15 05:11:39  csoutheren
 * Fixed problem with PDirectory destructor not calling Close()
 * Thanks to Paul Long
 *
 * Revision 1.41  2003/09/17 05:41:58  csoutheren
 * Removed recursive includes
 *
 * Revision 1.40  2003/09/17 01:18:02  csoutheren
 * Removed recursive include file system and removed all references
 * to deprecated coooperative threading support
 *
 * Revision 1.39  2003/06/06 15:04:17  dsandras
 *
 * Fixed compilation warning with gcc 3.3 by removing the PINLINE
 *
 * Revision 1.38  2002/11/20 00:13:43  robertj
 * Fixed some documentation
 *
 * Revision 1.37  2002/11/19 12:07:02  robertj
 * Added function to get root directory.
 *
 * Revision 1.36  2002/11/19 10:34:59  robertj
 * Added function to extract a path as an array of directories components.
 *
 * Revision 1.35  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.34  2001/05/22 12:49:32  robertj
 * Did some seriously wierd rewrite of platform headers to eliminate the
 *   stupid GNU compiler warning about braces not matching.
 *
 * Revision 1.33  2001/02/13 06:55:21  robertj
 * Fixed problem with operator= in PDirectory class, part of larger change previously made.
 *
 * Revision 1.32  2000/06/26 11:17:19  robertj
 * Nucleus++ port (incomplete).
 *
 * Revision 1.31  2000/04/03 18:41:27  robertj
 * Fixed BeOS compatibility problem with openlog() function.
 *
 * Revision 1.30  1999/03/09 02:59:50  robertj
 * Changed comments to doc++ compatible documentation.
 *
 * Revision 1.29  1999/02/16 08:11:09  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.28  1998/09/23 06:21:06  robertj
 * Added open source copyright license.
 *
 * Revision 1.27  1998/03/05 12:44:34  robertj
 * Added cluster size.
 *
 * Revision 1.26  1997/03/31 11:34:00  robertj
 * Fixed default permissions for directories , different from that for files.
 *
 * Revision 1.25  1997/01/12 04:22:21  robertj
 * Added function to get disk size and free space.
 *
 * Revision 1.24  1995/12/23 03:45:31  robertj
 * Added constructor for C string literals.
 *
 * Revision 1.23  1995/11/09 12:17:23  robertj
 * Added platform independent base type access classes.
 *
 * Revision 1.22  1995/10/14 15:02:22  robertj
 * Added function to get parent directory.
 *
 * Revision 1.21  1995/06/17 11:12:52  robertj
 * Documentation update.
 *
 * Revision 1.20  1995/03/14 12:42:00  robertj
 * Updated documentation to use HTML codes.
 *
 * Revision 1.19  1995/03/12  04:42:48  robertj
 * Updated documentation.
 * Changed return type of functions to the correct case string.
 *
 * Revision 1.18  1995/02/22  10:50:33  robertj
 * Changes required for compiling release (optimised) version.
 *
 * Revision 1.17  1995/01/06  10:42:25  robertj
 * Moved identifiers into different scope.
 * Changed file size to 64 bit integer.
 * Documentation
 *
 * Revision 1.16  1994/10/24  00:07:03  robertj
 * Changed PFilePath and PDirectory so descends from either PString or
 *     PCaselessString depending on the platform.
 *
 * Revision 1.15  1994/10/23  04:49:25  robertj
 * Chnaged PDirectory to descend of PString.
 * Added PDirectory Exists() function.
 *
 * Revision 1.14  1994/08/23  11:32:52  robertj
 * Oops
 *
 * Revision 1.13  1994/08/22  00:46:48  robertj
 * Added pragma fro GNU C++ compiler.
 *
 * Revision 1.12  1994/06/25  11:55:15  robertj
 * Unix version synchronisation.
 *
 * Revision 1.11  1994/04/20  12:17:44  robertj
 * Split name into PFilePath
 *
 * Revision 1.10  1994/04/11  14:16:27  robertj
 * Added function for determining if character is a valid directory separator.
 *
 * Revision 1.9  1994/04/01  14:14:57  robertj
 * Put platform independent file permissions and type codes back.
 *
 * Revision 1.7  1994/01/13  03:17:55  robertj
 * Added functions to get the name of the volume the directory is contained in
 *    and a function to determine if the directory is a root directory of the
 *    volume (ie is does not have a parent directory).
 *
 * Revision 1.6  1994/01/03  04:42:23  robertj
 * Mass changes to common container classes and interactors etc etc etc.
 *
 * Revision 1.5  1993/12/31  06:45:38  robertj
 * Made inlines optional for debugging purposes.
 *
 * Revision 1.4  1993/08/21  01:50:33  robertj
 * Made Clone() function optional, default will assert if called.
 *
 * Revision 1.3  1993/07/14  12:49:16  robertj
 * Fixed RCS keywords.
 *
 */


#ifndef _PDIRECTORY
#define _PDIRECTORY

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#ifdef Fifo
#undef Fifo
#endif

#ifdef _WIN32
#define PDIR_SEPARATOR '\\'
const PINDEX P_MAX_PATH = _MAX_PATH;
typedef PCaselessString PFilePathString;
#else
#define PDIR_SEPARATOR '/'
#define P_MAX_PATH    (_POSIX_PATH_MAX)
typedef PString PFilePathString;
#endif

// File System

class PFileInfo : public PObject
{
  PCLASSINFO(PFileInfo, PObject);

  public:
    enum FileTypes {
      RegularFile = 1,        
      SymbolicLink = 2,       
      SubDirectory = 4,       
      CharDevice = 8,         
      BlockDevice = 16,       
      Fifo = 32,              
      SocketDevice = 64,      
      UnknownFileType = 256,  
      AllFiles = 0x1ff        
    };

    FileTypes type;

    PTime created;

    PTime modified;

    PTime accessed;

    PUInt64 size;

    enum Permissions {
      WorldExecute = 1,   
      WorldWrite = 2,     
      WorldRead = 4,      
      GroupExecute = 8,   
      GroupWrite = 16,    
      GroupRead = 32,     
      UserExecute = 64,   
      UserWrite = 128,    
      UserRead = 256,     
      AllPermissions = 0x1ff,   
      DefaultPerms = UserRead|UserWrite|GroupRead|WorldRead,
      DefaultDirPerms = DefaultPerms|UserExecute|GroupExecute|WorldExecute
      
    };

    int permissions;

    BOOL hidden;
};


class PDirectory : public PFilePathString
{
  PCONTAINERINFO(PDirectory, PFilePathString);

  public:

    PDirectory();
      
    PDirectory(
      const char * cpathname      
    );

    PDirectory(
      const PString & pathname    
    );

    PDirectory & operator=(
      const PString & pathname    
    );

    PDirectory & operator=(
      const char * cpathname      
    );

    PDirectory GetParent() const;

    PFilePathString GetVolume() const;

    BOOL IsRoot() const;

    PDirectory GetRoot() const;

    PStringArray GetPath() const;

    PINLINE static BOOL IsSeparator(
      char ch    
    );

    BOOL GetVolumeSpace(
      PInt64 & total,     
      PInt64 & free,      
      DWORD & clusterSize 
    ) const;

    BOOL Exists() const;

    static BOOL Exists(
      const PString & path   
    );
      
    BOOL Change() const;

    static BOOL Change(
      const PString & path   
    );
      
    BOOL Create(
      int perm = PFileInfo::DefaultDirPerms    // Permission on new directory.
    ) const;
    static BOOL Create(
      const PString & p,   
      int perm = PFileInfo::DefaultDirPerms    
    );

    BOOL Remove();

    static BOOL Remove(
      const PString & path   
    );

    virtual BOOL Open(
      int scanMask = PFileInfo::AllFiles    
    );
      
    virtual BOOL Restart(
      int scanMask = PFileInfo::AllFiles    
    );
      
    BOOL Next();
      
    virtual void Close();

    virtual PFilePathString GetEntryName() const;

    virtual BOOL IsSubDir() const;

    virtual BOOL GetInfo(
      PFileInfo & info    
    ) const;


  protected:
    // New functions for class
    void Construct();
    void Destruct()
    { Close(); PFilePathString::Destruct(); }

    // Member variables
    int scanMask;

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

};

#endif

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

---