configreader.h

Go to the documentation of this file.

/*   rambrain - a dynamical physical memory extender
 *   Copyright (C) 2015 M. Imgrund, A. Arth
 *   mimgrund (at) mpifr-bonn.mpg.de
 *   arth (at) usm.uni-muenchen.de
 *
 *   This program 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.
 *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef CONFIGREADER_H
#define CONFIGREADER_H

#include <string>
#include <fstream>
#include <istream>
#include <vector>

#include "common.h"
#include "regexmatcher.h"

using namespace std;

//Test classes
#ifdef BUILD_TESTS
class configReader_Unit_ParseProgramName_Test;
#endif

namespace rambrain
{

enum class swapPolicy {
    fixed,
    autoextendable,
    interactive
};


class configLineBase
{

public:
    configLineBase ( const string &name, const int matchType ) : name ( name ), matchType ( matchType ) {}
    virtual ~configLineBase() {}
    virtual void setValue ( const string &str ) = 0;

    const string name;
    const int matchType;

};


template<typename T>
class configLine : public configLineBase
{
public:
    configLine ( const string &name, const T &value, const int matchType ) : configLineBase ( name, matchType ), value ( value ) {}
    virtual ~configLine() {}

    virtual void setValue ( const string &str ) {
        value = str;
    }

    T value;
};

template<>
void configLine<global_bytesize>::setValue ( const string &str );

template<>
void configLine<bool>::setValue ( const string &str );

template<>
void configLine<swapPolicy>::setValue ( const string &str );


struct configuration {

    configuration();

    configLine<string> memoryManager, swap, swapfiles;
    configLine<global_bytesize> memory, swapMemory;
    configLine<bool> enableDMA;
    configLine<swapPolicy> policy;

    vector<configLineBase *> configOptions;
};


class configReader
{

public:
    configReader();

    bool readConfig();

    inline void setCustomConfigPath ( const string &path ) {
        customConfigPath = path;
    }

    inline configuration &getConfig() {
        if ( !readSuccess ) {
            readConfig();
        }
        return config;
    }

    inline bool readSuccessfully() const {
        return readSuccess;
    }
    inline void setReread() {
        readSuccess = false;
    }

private:
    bool reopenStreams();

    bool parseConfigFile ( istream &stream, vector<configLineBase *> &readLines );
    bool parseConfigBlock ( istream &stream, vector<configLineBase *> &readLines );

    string getApplicationName() const;

    string getHomeDir() const;

    void stripLeadingTrailingWhitespace ( string &str ) const;

    const string globalConfigPath = "/etc/rambrain.conf";
    string localConfigPath = "";
    string customConfigPath = "";

    const regexMatcher regex;

    ifstream streams[3];

    configuration config;

    bool readSuccess = false;

    //Test classes
#ifdef BUILD_TESTS
    friend class ::configReader_Unit_ParseProgramName_Test;
#endif

};

}

#endif // CONFIGREADER_H