ParameterFile.h

Go to the documentation of this file.

/*  This file is part of Charon.

    Charon is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Charon 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Charon.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _ParameterFile_H
#define _ParameterFile_H

#include <vector>
#include <map>
#include <iostream>
#include <stdexcept>
#include "DllEx.h"

class charon_core_DLL_PUBLIC ParameterFile
{
private:
    void _set(std::string parameter, std::string value);

    inline void _toLower(std::string& input) const;

    //  @{

    std::vector<std::string> _parameterLines;

    std::map<std::string, std::string> _params;

    std::map<std::string, std::string> _setParams;

    //  @}

    //  @{

    bool _noFoundWarnings;

    bool _convertSlashes;

    char _delimiter;

    //  @}

public:
    class charon_core_DLL_PUBLIC IoError : public std::runtime_error {
    public:
        explicit IoError(const std::string& msg);
    };

    class charon_core_DLL_PUBLIC Unset : public std::invalid_argument {
    public:
        explicit Unset(const std::string& msg);
    };

    ParameterFile();

    ParameterFile(std::string fileName);

    ~ParameterFile();

    charon_DEPRECATED
    static std::string parName(std::string fullName);

    charon_DEPRECATED
    static std::string objName(std::string fullName);

    void setDelimiter(char delimiter);

    void setConvertSlashes(bool convertSlashes);

    bool isSet(std::string parameter) const;

    template<class T>
    void set(std::string parameter, const T& value = T());

    template<class T>
    void set(std::string parameter, const std::vector<T>& value);

    template<class T>
    T get(std::string parameter) const;

    template<class T>
    T get(std::string parameter, T defaultValue);

    template<class T>
    std::vector<T> getList(std::string parameter) const;

    template<class T>
    inline std::vector<T> getList(
            std::string parameter, std::string defaultValue);

    std::vector<std::string> getKeyList(std::string beginsWith = "") const;

    charon_DEPRECATED
    std::vector<std::string> getEveryParameter(const std::string& param) const;

    void showSetParams() const;

    void clear();

    void erase(std::string parameter);

    void resetSetParams();

    void setNotFoundWarningsOn(bool noFoundWarnings);

    bool save(std::string fileName) const;

    bool load(std::string fileName);

    void toStream(std::ostream &strm) const;

    void fromStream(std::istream& strm);
};

#endif // _ParameterFile_H