fsCVariableTable.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        2/12/2009   12:24
*
*       File:           fsCVariableTable.h
*
*       Author:         Martin King
*       
*       Purpose:        Dictionary of key value pairs
*
*********************************************************************/
 
#ifndef fsCVariableTablehdr
#define fsCVariableTablehdr
 
#include <map>
#include <vector>
 
#include "../fsStr.h"
 
class fsCResourceName;
 
typedef std::map<fsStr, fsStr> VarTableMap;
 
 
class fsCVariableTable
{
        friend class CVarTableComparer;
        friend class CStringsFile;
 
public:
 
        enum
        {
                eLOAD_RESULT_INVALID = 0,
 
                eLOAD_RESULT_SUCCESS_NO_CHECKSUM,
                eLOAD_RESULT_SUCCESS_WITH_CHECKSUM,
 
                eLOAD_RESULT_FAIL_FILESYSTEM_NOT_READY,
                eLOAD_RESULT_FAIL_FILE_NOT_FOUND,
                eLOAD_RESULT_FAIL_READ_ERROR,
                eLOAD_RESULT_FAIL_CHECKSUM_INVALID
        };
 
        const fsStr& fileNameGet() const { return mFileName; }
        std::vector<fsStr> partKeyCollectionGet(const fsStr& pPartKey) const;
        std::vector<fsStr> partValueCollectionGet(const fsStr& pPartVal) const;
 
        fsF32 f32Get(const fsStr& pKey) const;
        fsF32 f32GetWithDefault(const fsStr& pKey, fsF32 pDefault) const;
        fsS32 s32Get(const fsStr& pKey) const;
        fsS32 s32GetWithDefault(const fsStr& pKey, fsS32 pDefault) const;
        fsStr strGet(const fsStr& pKey) const;
        fsStr strGetWithDefault(const fsStr& pKey, const fsStr& pDefault) const;
        fsBool boolGet(const fsStr& pKey) const;
        fsBool boolGetWithDefault(const fsStr& pKey, fsBool pDefault) const;
 
        void removeKeysContaining(const fsStr& pPartialKey);
 
        fsBool keyExistsGet(const fsStr& pKey) const;
 
        void merge(fsCVariableTable* pIncoming);
 
        void s32Set(const fsStr& pKey, fsS32 pVal);
        void f32Set(const fsStr& pKey, fsF32 pVal);
        void strSet(const fsStr& pKey, const fsStr& pVal);
        void boolSet(const fsStr& pKey, fsBool pVal);
 
        fsS32 load(const fsCResourceName& pFileName);
        void save(const fsCResourceName& pFileName) const;
        fsS32 loadResultGet() const;
        fsBool successfullLoadGet() const;
 
        fsCVariableTable();
        virtual ~fsCVariableTable();
 
protected:
 
        static const fsStr mBoolTrueStr;
        static const fsStr mAltBoolTrueStr;
        static const fsStr mBoolFalseStr;
 
        static fsStr downcased(const fsStr& pKey);
 
        VarTableMap mEntries;
 
        fsS32 mLoadResult;
 
private:
 
        struct FncForEach
        {
                virtual void operator()(VarTableMap::value_type& entry)
                {
                }
        };
 
        void forEachLayer(FncForEach& pFnc);
 
        void bufferParse(fsStr& pDataBuffer);
        void bufferParseYaml(const fsStr& pDataBuffer);
 
        // Mirrors fsIGuiComponent::newGrammarFileNameResolve: swap the legacy
        // extension for ".yaml" and use it if present, otherwise fall back to
        // the legacy file untouched. Lets a title opt into YAML settings without
        // converting anything - the .txt loader keeps working unmodified.
        // pLocation is a fsCResourceName::eResourceLocation, taken as fsS32 so this
        // header can keep forward-declaring fsCResourceName rather than including it.
        static fsBool yamlFileNameResolve(const fsStr& pLegacyFileName, fsS32 pLocation,
                                          fsStr& pOutResolvedFileName);
 
        static fsBool stringCheck(fsChar pChar);
 
        static void whiteSpaceSkip(fsChar*& pChar);
        void copyToTerminator(fsChar*& pChar, fsBool pIsString, fsStr& pDest);
 
        fsStr mFileName;
};
 
#endif