GUIDirectory.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef GUI_DIRECTORY__H_
#define GUI_DIRECTORY__H_
 
#include "GUIDirInfo.h"
 
 
class CGUIDirectory
{
public:
 
    typedef eC_TListDoubleLinked<eC_String> StringList_t;
 
    enum Filter_t
    {
        DIRECTORIES = 0x001, 
        FILES = 0x002, 
        NOSYMLINK = 0x004, 
        READABLE = 0x008, 
        WRITABLE = 0x010, 
        EXECUTABLE = 0x020, 
        HIDDEN = 0x040,  
        SYSTEM = 0x080,  
        SYMLINK = 0x100, 
        ALL = 0x200 
    };
 
    enum SortFlag_t
    {
        NAME = 0x00, 
        TIME = 0x01, 
        SIZE = 0x02, 
        TYPE = 0x04  
    };
 
    CGUIDirectory(const eC_String& kPath = "", const eC_String& kNameFilter = "");
 
    CGUIDirectory(const eC_String &kPath, const StringList_t& kNameFilter,
         eC_UInt uiFilter = ALL, SortFlag_t eSort = NAME,
         eC_Bool bSortCaseInsensitive = true);
 
    CGUIDirectory(const CGUIDirectory& kDirectory);
 
    CGUIDirectory& operator= (const CGUIDirectory& kDirectory);
 
    virtual ~CGUIDirectory();
 
    eC_String GetAbsPath() const;
 
    eC_Bool ChangeDirectory(const eC_String& kDirName);
 
    eC_Bool ChangeToParentDir();
 
    void RefreshList();
 
    inline eC_UInt CountFiles() {ListFiles(); return m_kDirInfoList.GetQuantity();}
 
    eC_String GetDirName() const;
 
    StringList_t GetEntryList ();
 
    inline const CGUIDirInfo::DirInfoPtrList_t& GetEntryInfoList ()
    {
        ListFiles();
        return m_kDirInfoList;
    }
 
    StringList_t GetEntryFileNameList ();
 
    virtual eC_Bool CheckExist() const = 0;
 
    eC_UInt GetFilterAttr() const
    {
        return m_uiFilter;
    }
 
    virtual eC_Bool IsAbsPath() const;
 
    virtual eC_Bool IsReadable() const = 0;
 
    virtual eC_Bool IsRoot() const = 0;
 
    void MakePathAbs();
 
    virtual eC_Bool CreateSubDir(const eC_String& kDirName) = 0;
 
    inline StringList_t GetNameFilters() const
    {
        return m_kNameFilters;
    }
 
    void SetNameFilters(const eC_String& kNameFilter);
 
    void SetNameFilters(const StringList_t& kNameFilter);
 
    virtual eC_Bool RemoveFile(const eC_String& kFileName) = 0;
 
    virtual eC_Bool RenameFile(const eC_String &kOldName, const eC_String & kNewName) = 0;
 
    virtual eC_Bool RemoveSubDir(const eC_String& kDirName, eC_Bool bRecursive = false) = 0;
 
    void SetFilter (eC_UInt uiFilter);
 
    void SetSortFlag (SortFlag_t eSort);
 
    inline SortFlag_t GetSortFlag () const
    {
        return m_eSortFlag;
    }
 
    void SetSortCaseInSensitive(eC_Bool bSortCaseInsensitive);
 
    inline eC_Bool GetSortCaseInSensitive() const
    {
        return m_bSortCaseInsensitive;
    }
 
    void RevertSortList();
 
    const CGUIDirInfo* GetDirInfo(const eC_String& kFilePath);
 
    inline void SetListSpecialFileFlag(eC_Bool bListSpecialFile) {m_bListSpecialFile = bListSpecialFile;}
 
protected:
 
    virtual void ListFiles() = 0;
 
    void SortSubList(CGUIDirInfo::DirInfoPtrList_t& kList);
 
    void SortDirInfoList();
 
    void FreeDirInfoList();
 
    void FilterList();
 
    eC_String m_kDirPath;
 
    StringList_t m_kNameFilters;
 
    eC_UInt m_uiFilter;
 
    SortFlag_t m_eSortFlag;
 
    eC_Bool m_bSortCaseInsensitive;
 
    eC_Bool m_bSortDirsFirst;
 
    CGUIDirInfo::DirInfoPtrList_t m_kDirInfoList;
 
    CGUIDirInfo::DirInfoPtrList_t m_kDirectoriesList;
 
    CGUIDirInfo::DirInfoPtrList_t m_kFilesList;
 
    eC_Bool m_bListNeedRecreation;
 
    eC_Bool m_bListSpecialFile;
 
    eC_String m_kCurrentWorkingDir;
 
private:
    eC_String UpperString(const eC_String& kOrgStr) const;
 
    template<class T>
    void QuickSort(eC_TArray<T>& kArray, eC_Int iFirst, eC_Int iLast, CGUIDirInfo::DirInfoPtrList_t& kList);
 
};
 
#endif