Program Listing for File ConfigParser.cpp

Return to documentation for file (necsim/ConfigParser.cpp)

//This file is part of necsim project which is released under MIT license.
//See file **LICENSE.txt** or visit https://opensource.org/licenses/MIT) for full license details.
//
#include "ConfigParser.h"
#include <boost/filesystem/operations.hpp>
#include "custom_exceptions.h"
#include "Logging.h"
namespace necsim
{
    void importArgs(const unsigned int &argc, char* argv[], vector<string> &comargs)
    {
        for(unsigned int i = 0; i < argc; i++)
        {
            comargs.emplace_back(argv[i]);
        }
        // check size is correct
        if(comargs.size() != argc)
        {
            writeError("ERROR_MAIN_010: Incorrect command line parsing.");
        }
    }

    string SectionOption::getOption(string refval)
    {
        for(unsigned int i = 0; i < refs.size(); i++)
        {
            if(refs[i] == refval)
            {
                return (val[i]);
            }
        }
#ifdef DEBUG
        stringstream ss;
        ss << "Reference " << refval << " not found in keyoption." << endl;
        writeInfo(ss.str());
#endif
        return ("null");
    }

    ostream &operator<<(ostream &os, const SectionOption &k)
    {
        os << k.section << "\n" << k.val.size() << "\n" << k.refs.size() << "\n";
        for(const auto &i : k.val)
        {
            os << i << "\n";
        }
        for(const auto &ref : k.refs)
        {
            os << ref << "\n";
        }
        return os;
    }

    istream &operator>>(istream &is, SectionOption &k)
    {
        // os << m.num_rows<<" , "<<m.num_cols<<" , "<<endl;
        unsigned int valsize, refsize;
        is >> k.section >> valsize >> refsize;
        is.ignore();
        string tmp;
        for(unsigned int i = 0; i < valsize; i++)
        {
            getline(is, tmp);
            k.val.push_back(tmp);
        }
        for(unsigned int i = 0; i < refsize; i++)
        {
            getline(is, tmp);
            k.refs.push_back(tmp);
        }
        return is;
    }

    void ConfigParser::setConfig(const string &file, bool main, bool full_parse)
    {
        if(!configSet)
        {
            isMain = main;
            config_file = file;
            configSet = true;
            isFullParser = full_parse;
        }
        else
        {
            throw ConfigException("Attempt to set config file twice.");
        }
    }

    void ConfigParser::parseConfig()
    {
        ifstream is_file;
        if(!boost::filesystem::exists(config_file))
        {
            stringstream ss;
            ss << "No config file found at " << config_file << ". Check file exists." << endl;
            throw ConfigException(ss.str());
        }
        try
        {
            is_file.open(config_file);
        }
        catch(...)
        {
            throw ConfigException(
                    "ERROR_CONF_004c: Could not open the config file. Check file exists and is readable.");
        }
        parseConfig(is_file);
        if(is_file.eof())
        {
            is_file.close();
        }
        else
        {
            throw ConfigException("ERROR_CONF_002: End of file not reached. Check input file formatting.");
        }
    }

    void ConfigParser::parseConfig(istream &istream1)
    {
        if(!istream1.fail() || !istream1.good())
        {
            string line;
            // Get the first line of the file.
            while(getline(istream1, line))
            {
                istringstream is_line(line);
                string key;
                string val;
                // Skip all whitespace
                is_line >> skipws;
                // start a new section
                if(line[0] == '[')
                {
                    SectionOption tempSections;
                    // get the section name
                    string section;
                    if(getline(is_line, section, ']'))
                    {
                        section = section.erase(0, 1);
                        tempSections.section = section;
                    }
                    // read each line
                    while(getline(istream1, line))
                    {
                        // end the section when a new one starts.
                        if(line[0] == '[' || line.size() == 0)
                        {
                            break;
                        }
                        istringstream is_line2(line); // update the input-line stream
                        if(getline(is_line2, key, '='))
                        {

                            key.erase(std::remove(key.begin(), key.end(), ' '), key.end());
                            is_line2 >> skipws;
                        }
                        if(!is_line2)
                        {
                            throw ConfigException("ERROR_CONF_001: Read error in config file.");
                        }
                        if(getline(is_line2, val))
                        {
                            //                          This line has been removed to allow for white spaces in file names and paths
                            //                          val.erase(std::remove(val.begin(), val.end(), ' '), val.end());
                            while(val[0] == ' ')
                            {
                                val.erase(val.begin(), val.begin() + 1);
                            }
                        }
                        if(!is_line2)
                        {
                            throw ConfigException("ERROR_CONF_001: Read error in config file.");
                        }
                        tempSections.refs.push_back(key);
                        tempSections.val.push_back(val);
                    }
                    configs.push_back(tempSections);
                }
            }
        }
        else
        {
            throw ConfigException("ERROR_CONF_004b: Could not open the config file " + config_file
                                  + ". Check file exists and is readable.");
        }
    }

    vector<SectionOption> ConfigParser::getSectionOptions()
    {
        return configs;
    }

    void ConfigParser::setSectionOption(string section, string reference, string value)
    {
        SectionOption* section_option = nullptr;
        for(auto &option : configs)
        {
            if(option.section == section)
            {
                section_option = &option;
                break;
            }
        }
        if(!section_option)
        {
            SectionOption tmp;
            tmp.section = section;
            configs.emplace_back(tmp);
            section_option = &configs.back();
        }
        section_option->refs.emplace_back(reference);
        section_option->val.emplace_back(value);
    }

    SectionOption ConfigParser::operator[](unsigned long index)
    {
        return configs[index];
    }

    unsigned long ConfigParser::getSectionOptionsSize()
    {
        return configs.size();
    }

    vector<string> ConfigParser::getSections()
    {
        vector<string> toret;
        for(auto &config : configs)
        {
            toret.push_back(config.section);
        }
        return toret;
    }

    bool ConfigParser::hasSection(const string &sec)
    {
        for(auto &config : configs)
        {
            if(config.section == sec)
            {
                return true;
            }
        }
        return false;
    }

    vector<string> ConfigParser::getSectionValues(string sec)
    {
        for(auto &config : configs)
        {
            if(config.section == sec)
            {
                return config.val;
            }
        }
        throw ConfigException("Section not found in config file: " + sec);
    }

    string ConfigParser::getSectionOptions(string section, string ref)
    {
        for(auto &config : configs)
        {
            if(config.section == section)
            {
                for(unsigned int j = 0; j < config.refs.size(); j++)
                {
                    if(config.refs[j] == ref)
                    {
                        return config.val[j];
                    }
                }
            }
        }
#ifdef DEBUG
        writeWarning("No reference found for " + section + ", ");
#endif
        return "null";
    }

    string ConfigParser::getSectionOptions(string section, string ref, string def)
    {
        for(auto &config : configs)
        {
            if(config.section == section)
            {
                for(unsigned int j = 0; j < config.refs.size(); j++)
                {
                    if(config.refs[j] == ref)
                    {
                        return config.val[j];
                    }
                }
            }
        }
        return def;
    }

    int ConfigParser::importConfig(vector<string> &comargs)
    {
        // Check that the previous arguments have already been imported.
        if(isMain)
        {
            if(comargs.size() != 3)
            {
                throw ConfigException("ERROR_CONF_003: Number of command line arguments not correct before import.");
            }
        }
        ifstream is_file;
        try
        {
            is_file.open(config_file);
        }
        catch(...)
        {
            throw ConfigException(
                    "ERROR_CONF_004a: Could not open the config file. Check file exists and is readable.");
        }
        if(!is_file.fail())
        {
            string line;
            while(getline(is_file, line))
            {
                istringstream is_line(line);
                string key;
                is_line >> skipws;
                if(line[0] == '[')
                {
                    continue;
                }
                if(getline(is_line, key, '='))
                {
                    // Could implement proper data parsing based on the key object.
                    is_line >> skipws;
                    string value;
                    if(getline(is_line, value))
                    {
                        value.erase(std::remove(value.begin(), value.end(), ' '), value.end());
                        if(!is_line)
                        {
                            stringstream os;
                            os << value << endl;
                            writeWarning(os.str());
                            throw ConfigException("ERROR_CONF_001: Read error in config file.");
                        }
                        auto* tmp = new char[value.length() + 1];
                        strcpy(tmp, value.c_str());
                        comargs.emplace_back(tmp);
                    }
                }
            }
        }
        else
        {
            throw ConfigException(
                    "ERROR_CONF_004d: Could not open the config file. Check file exists and is readable.");
        }
        if(is_file.eof())
        {
            is_file.close();
        }
        else
        {
            throw ConfigException("ERROR_CONF_002: End of file not reached. Check input file formating.");
        }
        if(isMain)
        {
            // remove the file name from the command line arguments to maintain the vector format.
            comargs.erase(comargs.begin() + 2);
        }
        return static_cast<int>(comargs.size());
    }

    ostream &operator<<(ostream &os, const ConfigParser &c)
    {
        os << c.config_file << "\n" << c.configSet << "\n" << c.isMain << "\n" << c.isFullParser << "\n"
           << c.configs.size() << "\n";
        for(const auto &config : c.configs)
        {
            os << config;
        }
        return os;
    }

    istream &operator>>(istream &is, ConfigParser &c)
    {
        unsigned int configsize;
        is.ignore();
        getline(is, c.config_file);
        is >> c.configSet >> c.isMain >> c.isFullParser >> configsize;
        SectionOption tmpoption;
        if(configsize > 10000)
        {
            throw runtime_error("Config size extremely large, check file: " + to_string(configsize));
        }
        if(configsize > 0)
        {
            for(unsigned int i = 0; i < configsize; i++)
            {
                is >> tmpoption;
                c.configs.push_back(tmpoption);
            }
        }
        //      os << "end config" << endl;
        return is;
    }
}