fsCResourceName.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        14/2/2014   9:49
*
*       File:           fsCResourceName.h
*
*       Author:         Mick Waites
*       
*       Purpose:        To avoid using hard coded strings for filenames. The
*                               stored filename may be automatically converted to
*                               automatically load a localised resource, for example.
*
*                               Also adds virtual pathing for saving files to 
*                               authorized locations - not windows install location
*
*
*********************************************************************/
 
#ifndef fsCResourceNamehdr
#define fsCResourceNamehdr
 
#include <functional>
 
#include "../fsStr.h"
#include "fsAppCore/src/fsCAppCoreMain.h"
 
class fsCAppSettings;
class fsIHardware;
 
 
class fsCResourceName
{
public:
 
        enum eResourceLocation
        {
                eRES_LOCATION_ASSETS = 0,
                eRES_LOCATION_USER_SETTINGS,
                eRES_LOCATION_LOG
        };
 
        static void chapterAdapterAdd(std::function<void(fsStr&, fsCResourceName::eResourceLocation)> pAdaptar);
        static void chapterAdapterClear();
 
        const fsStr& nameGet() const;
        eResourceLocation locationGet() const;
 
        
        static void init(fsCAppSettings* const pAppSettings, fsIHardware* const pHardware);
        static void savedDataFolderCreate();
        static fsStr savedDataFolderGet();
        static fsBool platformSpecificFileExists(const fsStr& pFileName, eResourceLocation pLocation, fsStr pTestDeviceStr);
        static void targetTestPlatformSet(fsStr const& pTestDeviceStr);
 
        fsCResourceName(const fsStr& pFileName, eResourceLocation pLocation);
        fsCResourceName();
        ~fsCResourceName();
 
protected:
 
private:
 
#if defined fsTileMap || defined fsSpriter
        void externalFilenamesTrim();
#endif
 
        fsStr mFileName;
        eResourceLocation mLocation;
};
 
#endif