CascadeDirectory.h

Go to the documentation of this file.

//
// CascadeDirectory.h - header file for class CascadeDirectory
//
// Copyright (c) 2002, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRECTORY_H
#define _ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRECTORY_H

#include <cascade/util/CascadeFSObject.h>
#include <cascade/util/CascadeFile.h>
#include <cascade/util/CascadeString.h>
#include <cascade/util/CascadeArray.h>
#include <cascade/interthread/CascadeMutex.h>
#include <sys/types.h>

class CascadeDirectory : public CascadeFSObject
{
public:
    CascadeDirectory();

    CascadeDirectory( const char *pName );

    virtual ~CascadeDirectory();

public:

    static CascadeDirectory * GetCWD( void );

    virtual bool Create( mode_t inMode = 0666 );
        // FIXME: What if a full path
        // is specified and not all directories on the path exist?  It's easy
        // enough to make them, but perhaps that should signal an error?

    virtual bool Delete( bool inRecursive );

    virtual bool GetChildCount( u32 &outCount, 
                                bool inRecursive, 
                                bool inSkipInvisible ) const;
        //  with '.' are skipped if inSkipInvisible is true.  Any directory 

    virtual bool GetChildren( 
        CascadeTemplateArray<CascadeFSObject*>* &outChildren,
        bool inRecursive, 
        bool inSkipInvisible ) const;

    virtual bool GetMatchingChildCount( CascadeFSObject::Selector &inSelector, 
                                        bool inRecursive, 
                                        bool inSkipInvisible,
                                        u32 &outCount ) const;

    virtual bool GetMatchingChildren( 
        CascadeFSObject::Selector &inSelector,
        bool inRecursive,
        bool inSkipInvisible,
        CascadeTemplateArray<CascadeFSObject*>* &outChildren ) const;

    typedef bool (DirectoryEnumerationCallback)( CascadeFSObject *obj,
                                                 void *pClientData );

    virtual bool EnumerateMatchingChildren( 
        CascadeFSObject::Selector &inSelector,
        bool inRecursive,
        bool inSkipInvisible,
        DirectoryEnumerationCallback inCallback,
        void *inClientData ) const;
    
    virtual bool SetCWD( void ) const;

    typedef bool (DirCopyCallback)(u32 inTotal, 
                                   u32 inComplete, 
                                   const CascadeString &inCurrentName,
                                   void *pClientData );

    virtual bool CopyTo( CascadeDirectory &inDestination, 
                         bool inRecursive,
                         DirCopyCallback *inCallback,
                         void *inClientData,
                         CascadeFile::FileCopyCallback *inFileCallback,
                         void *inFileClientData,
                         FSCopyError &outError );


    virtual bool Contains( const CascadeFSObject *inObject, bool &outContains );

    virtual bool IsDirectory( void ) const { return true; }
private:
    void * m_pDirectoryInternal;
    static CascadeMutex s_dirScanMutex;
};


#endif // #ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRECTORY_H

// LOG
// 04-02-03 mjkobb  created
// 06-08-03 mjkobb  Added the option to skip invisible files in
//                  directory enumeration functions
// 07-28-03 mjkobb  Fix declarations of const functions to be const
// 08-11-03 mjkobb  Added CopyTo
// 05/16/05 mjkobb  Made inObject argument to Contains a const pointer.

---