GUIFileSysWrap.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_FILE_SYS_WRAP_H__
#define GUI_FILE_SYS_WRAP_H__
 
#include <time.h>
#include "GUIDirInfo.h"
#include "GUIDirectory.h"
#include "eC_File.h"
 
#include "GUIComponentManager.h"
 
#define GETFILESYS CGUIFileSysWrap::GetInstance()
 
 
class CGUIFileSysWrap
{
public:
    // Guiliani supports two different separators. Backslash (\‍) and Slash (/). The constants defined here enables consistent access out of FileSysWrappers.
    static const eC_String ms_DirSepWin; 
    static const eC_String ms_DirSepPOSIX;  
 
public:
    static CGUIFileSysWrap& GetInstance();
 
    CGUIFileSysWrap() {}
 
    virtual ~CGUIFileSysWrap();
 
    virtual eC_String GetExecutablePath() = 0;
 
    inline eC_String GetCurrentPath() const {return m_kCurrentPath;}
 
    virtual const CGUIDirInfo::DirInfoPtrList_t& GetDrives() = 0;
 
    virtual eC_String GetHomePath() const = 0;
 
    virtual const eC_String& GetRootPath() const = 0;
 
    const eC_String& GetWinDirSeparator() const {return ms_DirSepWin;}
 
    const eC_String& GetPOSIXDirSeparator() const {return ms_DirSepPOSIX;}
 
    virtual const eC_String &GetDirSeparator() const = 0;
 
    virtual eC_Bool SetCurrentPath(const eC_String& kPath) = 0;
 
    virtual CGUIDirectory* DirAlloc(
        const eC_String &kPath = "",
        const eC_String& kNameFilter = "") const = 0;
 
    virtual CGUIDirectory* DirAlloc(
        const eC_String &kPath,
        const CGUIDirectory::StringList_t& kNameFilter,
        eC_UInt uiFilter = CGUIDirectory::ALL,
        CGUIDirectory::SortFlag_t eSort = CGUIDirectory::NAME,
        eC_Bool bCaseInsensitive = true) const = 0;
 
    void SeparateString(
        const eC_String& kOrgStr,
        eC_String& kLeftStr,
        eC_String &kRightStr,
        const eC_String& kSeparator,
        eC_Bool bFromLeft) const;
 
    virtual eC_String MakePlatformPath(const eC_String& kOrgPath) const = 0;
 
    virtual eC_Bool MakeNormalizedPlatformPath(
        const eC_String& kOrgPath,
        eC_String& kResultPath) const;
 
    eC_Bool MakeAbsolutePath(
        const eC_String& kRelPath,
        eC_String& kAbsPath) const;
 
    virtual eC_Bool CreateRelativePath(
        const eC_String& kFromPath,
        const eC_String& kToPath,
        eC_String& kResultPath) const;
 
    virtual eC_String MakeDirectoryPath(const eC_String& kPath) const;
 
    virtual eC_Bool IsStrAbsolute(const eC_String& kStr) const = 0;
 
    void DeInit();
 
    virtual eC_Bool IsDrive(const eC_String& kDirStr) const = 0;
 
    virtual eC_Bool CpFile(
        eC_String kSource,
        eC_String kDest,
        eC_Bool bOverwrite = false,
        eC_Bool bCopyEvenIfIdentical = true) = 0;
 
 
    eC_String GetPath(const eC_String& rkFileName) const;
 
 
    eC_String GetFileName(const eC_String& rkFileName) const;
 
 
    eC_String GetFileBaseName(const eC_String& rkFileName) const;
 
 
    eC_String GetFileSuffix(const eC_String& rkFileName) const;
 
    virtual eC_File* OpenPlatformFile(
        const eC_String& kPath,
        eC_Flag uiMode = eC_File::FS_WRITEACCESS | eC_File::FS_READACCESS) const;
 
    virtual eC_Bool CheckIfFileOrDirectoryExists(const eC_String& kPath) const = 0;
 
    virtual eC_Bool CheckIfFileExists(const eC_String& kPath) const = 0;
 
    virtual eC_Bool CheckIfDirectoryExists(const eC_String& kPath) const = 0;
 
    virtual time_t GetFileDateTime(const eC_String& kPath) const;
 
    virtual long GetFileSize(const eC_String& kPath) const;
 
    virtual eC_Bool RemoveFile(const eC_String& kPath) const = 0;
 
protected:
    eC_String m_kCurrentPath;
 
    CGUIDirInfo::DirInfoPtrList_t m_kDrivesList;
 
private:
    eC_Int CountNumberOfSeparators(const eC_UTF8* pPath) const;
};
 
#endif