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): ______________________________________.
 */


#ifndef PTLIB_DIRECTORY_H
#define PTLIB_DIRECTORY_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/bitwise_enum.h>


#ifdef Fifo
#undef Fifo
#endif

#ifdef _WIN32
#define PDIR_SEPARATOR '\\'
#define PPATH_SEPARATOR ';'  // As used in PATH environment variable
const PINDEX P_MAX_PATH = _MAX_PATH;
typedef PCaselessString PFilePathString;
#else
#define PDIR_SEPARATOR '/'
#define PPATH_SEPARATOR ':'  // As used in PATH environment variable
#define P_MAX_PATH    (_POSIX_PATH_MAX)
typedef PString PFilePathString;
#endif


// File System

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

  public:
    P_DECLARE_BITWISE_ENUM_EX(FileTypes, 10,
      (
        NoFileType, // Should not happen!

        RegularFile,      
        SymbolicLink,     
        SubDirectory,     
        ParentDirectory,  
        CurrentDirectory, 
        CharDevice,       
        BlockDevice,      
        Fifo,             
        SocketDevice,     
        UnknownFileType   
      ),
      AllFiles = 0x3ff,    
      DefaultSearch = RegularFile | SymbolicLink | SubDirectory  
    );

    FileTypes type;

    PTime created;

    PTime modified;

    PTime accessed;

    PUInt64 size;

    P_DECLARE_BITWISE_ENUM_EX(Permissions,9,
      (
        // Note the following bits are as per unixish / C standard lib values, do not change!
        NoPermissions, 
        WorldExecute,  
        WorldWrite,    
        WorldRead,     
        GroupExecute,  
        GroupWrite,    
        GroupRead,     
        UserExecute,   
        UserWrite,     
        UserRead       
      ),
      AllPermissions = 0x1ff,                                               
      DefaultPerms = UserRead|UserWrite|GroupRead|WorldRead,                
      DefaultDirPerms = DefaultPerms|UserExecute|GroupExecute|WorldExecute  
    );

    Permissions 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.
      bool recurse = false
    ) const;
    static bool Create(
      const PString & p,   
      int perm = PFileInfo::DefaultDirPerms,    // Permission on new directory.
      bool recurse = false
    );

    bool Remove();

    static bool Remove(
      const PString & path   
    );

    static PDirectory GetTemporary();

    virtual bool Open(
      PFileInfo::FileTypes scanMask = PFileInfo::DefaultSearch    
    );
      
    virtual bool Restart(
      PFileInfo::FileTypes scanMask = PFileInfo::DefaultSearch    
    );
      
    virtual bool Next();
      
    virtual void Close();

    virtual PFilePathString GetEntryName() const;

    virtual bool IsSubDir() const;

    virtual bool GetInfo(
      PFileInfo & info    
    ) const;

    struct Entry : PFileInfo {
      PString m_name;
    };
    typedef std::vector<Entry> Entries;

    P_DECLARE_ENUM(Sorting,
      Unsorted,
      SortByType,
      SortByName,
      SortBySize,
      SortByCreated,
      SortByModified,
      SortByAccessed,
      SortByPermission
    );

    bool GetEntries(
      Entries & entries,          
      Sorting sortBy = Unsorted   
    );
    bool GetEntries(
      Entries & entries,             
      const PCaselessString & sortBy 
    );


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

    // Member variables
    PFileInfo::FileTypes m_scanMask;

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

};


#endif // PTLIB_DIRECTORY_H


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