LocalStorage.h

Go to the documentation of this file.

/*
    This source file is part of Rigs of Rods
    Copyright 2005-2012 Pierre-Michel Ricordel
    Copyright 2007-2012 Thomas Fischer
    Copyright 2013-2020 Petr Ohlidal
 
    For more information, see http://www.rigsofrods.org/
 
    Rigs of Rods is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 3, as
    published by the Free Software Foundation.
 
    Rigs of Rods is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with Rigs of Rods. If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "Application.h"
#include "ImprovedConfigFile.h"
#include "RefCountingObject.h"
 
#include <angelscript.h>
 
namespace RoR {
 
 
class LocalStorage : public ImprovedConfigFile, public RefCountingObject<LocalStorage>
{
public:
    LocalStorage(std::string filename, const std::string& section_name, const std::string& rg_name /* = RGN_CACHE*/);
    virtual ~LocalStorage() override;
 
    void copyFrom(LocalStoragePtr other);
    void changeSection(const std::string& section);
 
    std::string get(std::string key);
    void set(std::string key, const std::string& value);
 
    int getInt(std::string key);
    void set(std::string key, const int value);
 
    float getFloat(std::string key);
    void set(std::string key, const float value);
 
    bool getBool(std::string key);
    void set(std::string key, const bool value);
 
    Ogre::Vector3 getVector3(std::string key);
    void set(std::string key, const Ogre::Vector3& value);
 
    Ogre::Quaternion getQuaternion(std::string key);
    void set(std::string key, const Ogre::Quaternion& value);
 
    Ogre::Radian getRadian(std::string key);
    void set(std::string key, const Ogre::Radian& value);
 
    Ogre::Degree getDegree(std::string key);
    void set(std::string key, const Ogre::Degree& value);
 
    void saveDict();
    // int extendDict();
    bool loadDict();
 
    // removes a key and its associated value
    void eraseKey(std::string key);
 
    // Returns true if the key is set
    bool exists(std::string key);
 
    // Deletes all keys
    void deleteAll();
 
    // parses a key
    void parseKey(std::string& inout_key, std::string& out_section);
 
    SettingsBySection getSettings() { return mSettingsPtr; }
    std::string getFilename() { return m_filename; }
    std::string getSection() { return sectionName; }
 
protected:
    std::string m_filename;
    std::string m_resource_group;
    bool saved; 
    std::string sectionName;
};
 
 
} // namespace RoR