fsIResourceNamePathAdjuster.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        19/2/2014   17:08
*
*       File:           fsIResourceNamePathAdjuster.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Interface for platform specific file path adjuster.
*
*********************************************************************/
 
#ifndef fsIResourceNamePathAdjusterhdr
#define fsIResourceNamePathAdjusterhdr
 
#include <set>
#include <fsCore/fsBaseTypes.h>
#include <fsCore/src/fsCResourceName.h>
 
class fsCAppSettings;
class fsIHardware;
 
class fsIResourceNamePathAdjuster
{
public:
 
        static const fsStr mPathSeparator;
        static const fsStr mLayersFolder;
 
        static const fsStr mMacFileNameModifier;
        static const fsStr mMobileFileNameModifier;
        static const fsStr mPhoneWideScreenFileNameModifier;
        static const fsStr mLocaleFolderName;
 
    static void cacheFlush();
        static fsStr savedDataFolderGet();
 
        static fsStr localisedLevelLayersFolderGet();
        
        void chapterAdapterClear();
        void chapterAdapterAdd(std::function<void(fsStr&, fsCResourceName::eResourceLocation)> pAdaptar);
        static fsStr buildFlavourFilenameGet();
 
        void savedDataFolderCreate();
        void modify(fsStr& pPath, fsCResourceName::eResourceLocation pLocation, fsStr pTestDeviceStr);
        void modify(fsStr& pPath, fsCResourceName::eResourceLocation pLocation);
        void testModeTagetDeviceSet(const fsStr& pTargetTestDevice);
 
        void init(fsCAppSettings* const pAppSettings, fsIHardware* const pHardware);
 
        virtual ~fsIResourceNamePathAdjuster();
 
protected:
 
        virtual void initDo() {}
        virtual void pathAdjustDo(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const{}
        virtual void audioExtensionAdjustDo(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const {}
        virtual void savedDataPathAdjustDo(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const {}
        virtual void savedDataFolderCreateDo() const = 0;
 
        fsIResourceNamePathAdjuster();
 
        static fsStr mTestMode;
        static fsIHardware* mHardware;
        static fsCAppSettings* mAppSettings;
 
private:
 
        void pathAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const;
 
        static fsBool isUnadjustedSettingsFile(const fsStr& pPath);
        void audioExtensionAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const;
        void savedDataPathAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const;
 
        void buildFlavourFilenameAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const;
        void platformFilenameAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const;
        void wideScreenMobileDevicePathAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const;
        void publisherFilenameAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const;
        void chapterFilenameAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation) const;
 
        fsStr platformFilenameGet() const;
 
        static void languageFilenameAdjust(fsStr& pPath, fsCResourceName::eResourceLocation pLocation);
 
 
        static const fsStr mLayoutFileExt;
 
        std::function<void(fsStr&, fsCResourceName::eResourceLocation)> mChapterAdapter;
        
    void filenameCache(const fsStr& pFilename);
 
#if !defined(fsRelease)       
    static std::set<fsStr> mFileCache;
#endif
};
 
#endif