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): ______________________________________.
 *
 * $Revision: 24177 $
 * $Author: rjongbloed $
 * $Date: 2010-04-05 21:52:04 +1000 (Mon, 05 Apr 2010) $
 */


#ifndef PTLIB_DIRECTORY_H
#define PTLIB_DIRECTORY_H

#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;

    PBoolean 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;

    PBoolean IsRoot() const;

    PDirectory GetRoot() const;

    PStringArray GetPath() const;

    PINLINE static PBoolean IsSeparator(
      char ch    
    );

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

    PBoolean Exists() const;

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

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

    PBoolean Remove();

    static PBoolean Remove(
      const PString & path   
    );

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

    virtual PFilePathString GetEntryName() const;

    virtual PBoolean IsSubDir() const;

    virtual PBoolean 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 // PTLIB_DIRECTORY_H


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