CascadeFSObject.h

Go to the documentation of this file.

//
// CascadeFSObject.h - header file for class CascadeFSObject
//
// This is the base class for CascadeFile and CascadeDirectory.  A
// CascadeDirectory is a container for objects of type CascadeFSObject.
//
// Copyright (c) 2002, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEFSOBJECT_H
#define _ROKU_INCLUDE_CASCADE_UTIL_CASCADEFSOBJECT_H

#include <cascade/CascadeObject.h>
#include <cascade/util/CascadeString.h>
#include <sys/types.h>
#include <regex.h>
#include <sys/stat.h>

class CascadeFSObject : public CascadeObject
{
public:
    typedef enum FSCopyError
    {
        eFSCopyNoErr,
        eFSCopyCanceled,
        eFSCopyUnknownErr,
        eFSCopyDestExists,
        eFSCopyCantOpenSrc,
        eFSCopyCantCreateDest,
        eFSCopyCantOpenDest,
        eFSCopyReadSrcFailed,
        eFSCopyWriteDstFailed,
        eFSCopyDestIsSrc,
        eFSCopyDestInsideSrc,
        eFSCopyInsufficientSpace,
        eFSCopyBadParam,
        eFSCopyPermissionErr
    };

public:
    CascadeFSObject();

    CascadeFSObject( const char *pName );

    virtual ~CascadeFSObject();

public:
    virtual CascadeString GetName( void ) const;

    virtual bool SetName( const char *inName );

    virtual CascadeString GetFullPath( void ) const;

    virtual CascadeString GetFilenameExtension( void ) const;

    virtual CascadeFSObject * GetParent( void ) const;

    virtual bool IsDirectory( void ) const = 0;

    virtual bool Exists( void ) const;

    static bool Exists( const CascadeString &inPath );

    static bool IsDirectory( const CascadeString &inPath );

    virtual bool IsRoot( void ) const;

protected:
    void * m_pFSObjInternal;
    CascadeString   m_fullPath;

public:
    class Selector
    {
    public:
        typedef enum
        {
            eInvalid = 0,
            eFiles = 1,
            eDirectories = 2,
            eBoth = 3
        } SelectorTypeFilter;
    public:
        Selector() { mFilter = eBoth; }

        virtual ~Selector() {}

        virtual bool Match( CascadeFSObject &inObject ) = 0;

        inline void SetSelectorTypeFilter( SelectorTypeFilter inFilter ) 
            { mFilter = inFilter; }
    protected:
        SelectorTypeFilter mFilter;
    };
    
    class RegexpSelector : public Selector
    {
    public:
        RegexpSelector() { mpRegEx = new regex_t; mbCompiled = false; }

        virtual ~RegexpSelector();

    public:
        virtual bool Compile( const CascadeString &inExpression, int inCFlags = 0 );

        virtual bool Match(CascadeFSObject &inObject);
    private:
        regex_t *mpRegEx;
        bool mbCompiled;
    };

    class PermissionsSelector : public Selector
    {
    public:
        PermissionsSelector() {m_PermissionBits = 0;}

        virtual ~PermissionsSelector(){}

    public:
                virtual void SetPermissions(u32 inPermFlags);

        virtual bool Match(CascadeFSObject &inObject);
    private:
                u32 m_PermissionBits;
    };

    class TypeSelector : public Selector
    {
    public:
        TypeSelector() { mFilter = CascadeFSObject::Selector::eDirectories; }
        inline virtual bool Match(CascadeFSObject &inObject) {
            return ( mFilter == eBoth ||
                     ( (mFilter == eDirectories) == inObject.IsDirectory() ) ); }
    };
    
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEFSOBJECT_H

// LOG
//      04-02-03    mjkobb  created
//      12-May-03       pellis  added PermissionsSelector selector
//                                              to support checking if a file is any of rwx.
//  07-28-03    mjkobb  Declare functions that are const as const
//  07-31-03    mjkobb  Added TypeSelector
// 10-Aug-03    mjkobb  Added static IsDirector() and Exists(), added
//                      FSCopyError
// 18-Aug-03    mjkobb  Added eFSCopyPermissionErr
//  21-Aug-03   dwoodward   don't return const CascadeStrings... causing problems!
//  22-Oct-03   dsletten    made RegexpSelector::Compile() take a *const* CascadeString ref

---