oaFile.h

Go to the documentation of this file.

// *****************************************************************************
// oaFile.h
//
// This file contains the definitions for the utility classes which implement
// an interface on top of a file system component. The oaFSComponent class
// implements a file system component, which may be either a file (oaFile) or a
// directory (oaDir). The oaFile utility class isa oaFSComponent which
// implements an interface for managing a disk file. The oaDir utility class isa
// oaFSComponent which implements a class for managing a directory.
//
// The oaDirIter utility class implements a general iterator for iterating the
// names of items in a directory. The oaDirIter may be customized by specifying
// the type of objects returned to be restricted to files (oacFilesDirIterMode),
// restricted to directories (oacDirsDirIterMode), or unrestricted
// (oacAllDirIterMode). Additionally, the user may optionally specify a string
// wildcard for name filtering. Note that the oaDirIter only returns names of
// file system objects, and has no direct connection with the oaFSComponent
// class objects.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaFile_P)
#define oaFile_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaString.h"

#if defined(OA_WINDOWS)
#include <WinSock2.h>
#include <Windows.h>
#else
#include <dlfcn.h>
#include <dirent.h>
#include <fcntl.h>
#endif

#if defined(HPUX)
#include <dl.h>
#endif



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// oaFSComponent
// *****************************************************************************
class OA_BASE_DLL_API oaFSComponent {
public:
                            oaFSComponent(const oaString &nameIn);
    virtual inline          ~oaFSComponent();

    void                    destroy();
    void                    rename(const oaString &newName);

    virtual oaBoolean       exists() const;
    oaBoolean               isFile() const;
    oaBoolean               isDir() const;
    oaBoolean               isReadable() const;
    oaBoolean               isWritable() const;
    oaBoolean               isInCWD() const;
    oaBoolean               isNFSFileSystem() const;
    oaBoolean               isAFSFileSystem() const;
    oaBoolean               isSameDiskFile(const oaFSComponent &file) const;
    oaBoolean               isSymbolicLink() const;

    const oaString          &getName() const;
    void                    getFullName(oaString &pathName) const;
    oaUInt4                 getRefCount() const;

protected:
    oaString                name;
#if defined(OA_WINDOWS)
    HANDLE                  handle;
#else
    oaInt4                  fd;
#endif
};



// *****************************************************************************
// oaFile
// *****************************************************************************
class OA_BASE_DLL_API oaFile : public oaFSComponent {
public:
                            oaFile(const oaString &nameIn);
    virtual                 ~oaFile();

    void                    open(oaChar modeIn);
    void                    close();
    void                    flush();

    oaUInt4                 read(void       *data,
                                 oaUInt4    numBytes);
    oaUInt4                 write(void      *data,
                                  oaUInt4   numBytes);

    virtual oaBoolean       exists() const;
    oaBoolean               isOpen() const;
    oaBoolean               isNonEmpty() const;

    oaChar                  getMode() const;
    oaUInt8                 getSize() const;
    oaTime                  getLastWriteTime() const;
    oaTime                  getCreateTime() const;

    static void             copyFile(const oaString &srcPath,
                                     const oaString &dstPath);
protected:
    oaChar                  mode;

private:
#if !defined(OA_WINDOWS)
    static const mode_t     permFlags;
#endif
};



// *****************************************************************************
// oaDir
// *****************************************************************************
class OA_BASE_DLL_API oaDir : public oaFSComponent {
public:
                            oaDir(const oaString &nameIn);
    virtual inline          ~oaDir();

    void                    create() const;

    virtual oaBoolean       exists() const;
    oaBoolean               isEmpty() const;

    oaBoolean               isCWD() const;

private:
#if !defined(OA_WINDOWS)
    static const mode_t     permFlags;
#endif
};




// *****************************************************************************
// enum oaDirIterMode
// *****************************************************************************
enum oaDirIterModeEnum {
    oacFilesDirIterMode = 0,
    oacDirsDirIterMode  = 1,
    oacAllDirIterMode   = 2
};



// *****************************************************************************
// oaDirIter
// *****************************************************************************
class OA_BASE_DLL_API oaDirIter {
public:
                            oaDirIter(const oaString    &dirPathIn,
                                      oaDirIterModeEnum modeIn = oacAllDirIterMode);
                            oaDirIter(const oaString    &dirPathIn,
                                      const oaString    &wildcardNameIn,
                                      oaDirIterModeEnum modeIn = oacAllDirIterMode);
                            ~oaDirIter();

    oaBoolean               getNext(oaString &name);

    void                    reset();

private:
#if defined(OA_WINDOWS)
    // Note that we define a handle as a void* in order to avoid a dependency
    // on Windows.h in the public headers. The handle will be cast to the
    // correct type of HANDLE when used in the private implementation.
    void                    *handle;
    char                    *dirPath;
    oaDirIterModeEnum       mode;
    oaBoolean               first;

#else
    DIR                     *dir;
    char                    *dirPath;
    oaUInt4                 dirPathLen;
    oaByte                  *readdirBuf;
    oaString                wildcardName;
    oaDirIterModeEnum       mode;
#endif
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.