Page MenuHomePhabricator (Chris)
Files F630030

Settings.h
No OneTemporary
Actions

Authored By
Unknown
Size
2 KB
Referenced Files
None
Subscribers
None

Settings.h
View Options

/*
* Copyright (C) 2011-2012 Me and My Shadow
*
* This file is part of Me and My Shadow.
*
* Me and My Shadow is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Me and My Shadow 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 Me and My Shadow. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef SETTINGS_H
#define SETTINGS_H
#include <iostream>
#include <string>
#include <sstream>
#include <map>
#include <fstream>
#include <ctime>
//The Settings class is used for loading/saving the config file and keeping track of the settings.
class Settings{
private:
//The name of the settingsfile.
const std::string fileName;
//Map containing all the settings.
//The key is the name of the setting.
std::map<std::string,std::string> settings;
//Method that will create the config file.
void createFile();
//Parse a given line and, if valid, add it to the settings map.
//line: The line to parse.
void parseLine(const std::string &line,int version);
//Validates a given line. (Check if it contains a '=')
//line: The line to validate.
//Returns: True if the line is valid.
bool validLine(const std::string &line);
//Remove comments from a given line.
//Comments start with '#' and continues to the end of the line.
//line: The line to uncomment.
void unComment(std::string &line);
//Checks if the line is empty.
//line: The line to check.
//Returns: True if the line is emtpy.
bool empty(const std::string &line);
public:
//Constructor.
//fileName: The name of the file to use.
Settings(const std::string& fileName);
//This method will open the settings file and walk through it line for line.
void parseFile(int version);
//This method will write the settings in the map to the settings file.
//Returns: True if there were no errors.
bool save();
//Gets the value that belongs to a given key.
//key: The name of teh setting.
//Returns: The value if the key exists and an empty string if the key doesn't exist.
std::string getValue(const std::string &key);
//Gets the value, as a bool, that belongs to a given key.
//key: The name of teh setting.
//Returns: The (bool)value if the key exists and false if the key doesn't exist.
bool getBoolValue(const std::string &key);
//This will set the value of a given key.
//NOTE: If the key doesn't exist it will be created.
//key: The key of the setting to change.
//value: The new value of the key.
void setValue(const std::string &key, const std::string &value);
};
#endif

File Metadata

Mime Type
text/x-c++
Expires
Sun, Nov 15, 8:29 AM (1 d, 21 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
130720
Default Alt Text
Settings.h (2 KB)

Event Timeline