MapReader.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
#ifndef MAPREADER_H_
#define MAPREADER_H_
 
#include <iostream>
#include <fstream>
 
#include <map>
 
#include <drain/RegExp.h>
 
// using namespace std;
 
 
namespace drain
{
 
// consider changing back *m => &m ?
 
 
template <class K, class V>
class MapReader
{
public:
 
    std::string trimChars;
 
    // If "limited", does not allow adding new entries but changes only.
    bool limited;
 
 
    MapReader() : limited(false), m(defaultMap) {};
 
    MapReader(std::map<K,V> &target) : limited(false), m(&target) {
 
        trimChars = " \t";
        // WAS lazy hyphen in the leading characters
        //std::string regExpString = "^[ \t]*([a-zA-Z][a-zA-Z0-9_]*)[ \t]*=(.*)$";
 
        // Indices for the essential patterns in the following regexps
        //KEY = 1;
        //VALUE = 3;
 
        // Mpeura 2009/07
        //configLineParser.setExpression("^[ \t]*([a-zA-Z][a-zA-Z0-9_\\.]*)[ \t]*(=(.*))?$");
        //commandLineParser.setExpression("^\\-\\-?([a-zA-Z][a-zA-Z0-9_\\.]*)(=(.*))?$");  // Must preserve position 1 and 3!
        setKeySyntax("[a-zA-Z][a-zA-Z0-9_\\.]*");
 
        //std::string regExpString = "^([a-z]*)$";
        //setRegExp(regExpString);
        //cout << lineParser.test("ksm=kks") << endl;
    };
 
    virtual ~MapReader(){};
 
    void setMap(std::map<K,V> &target){
        m = &target;
    }
 
    void setKeySyntax(const std::string & regExp){
        configLineParser.setExpression(std::string("^[ \t]*(")+regExp+")[ \t]*(=(.*))?$");
        commandLineParser.setExpression(std::string("^\\-\\-?(")+regExp+")(=(.*))?$");  // Must preserve position 1 and 3!
    }
 
    //std::string regexpString;
    //drain::RegExp commandLineOptionParser;
 
    void trim(std::string &s){
        std::string::size_type pos1 = s.find_first_not_of(trimChars);
        std::string::size_type pos2 = s.find_last_not_of(trimChars);
        if (pos1 != std::string::npos)
            s = s.substr(pos1,pos2-pos1 + 1);
        else
            s = "";
    }
 
 
    // PAH
    /*
    bool setRegExp(const std::string &regExpString){
        return ( configLineParser.setExpression(regExpString) );
    }
     */
 
    void read(const std::string &filename){ // replace with "readFile" or drain::InputFile()
        std::ifstream ifstr;
        ifstr.open(filename.c_str());
        read(ifstr);
        ifstr.close();
    }
 
    void read(std::istream &istr = std::cin){
        std::string line;
        while (getline(istr,line)){
            //cout << "MapReader::read istr: " << line << '\n';
            readConfigEntry(line);
        }
    }
 
    void readConfigEntry(const std::string &line){ //const char *line){
        readEntry(line,configLineParser);
    }
 
    void readCommandLineEntry(const std::string &s){ //const char *line){
        readEntry(s,commandLineParser);
    }
 
    void readPendingCommandLineArgument(const std::string &s){ 
        value = s;
        trim(value);
        (*m)[key] = value;
        argumentRegistered = true;
    }
 
 
    void readEntry(const std::string &line, drain::RegExp &regExp){ //const char *line){
 
        regExp.execute(line);
 
        const std::vector<std::string> &result = regExp.result;
 
        //std::string::size_type s = result.size();
 
        /*
        cout << "readEntry, size=" << s << '\n';
        for (unsigned int i = 0; i < s; ++i) {
            cout << i << ' ' << result[i] << '\n';
        }
         */
        //cout << "VALUE=" << VALUE << result[VALUE] << '\n';
        //cout << "KEY=" << KEY << result[KEY] << '\n';
        //cout << "***** readEntry, size=" << s << '\n'; 
 
 
        // If matches --xxxxxxx
        if (!result.empty()){
 
            key = result[1];
            trim(key);
 
            /*
            if ((limited)&&(m->find(key) != m->end())){
                throw "Closed map has not key " + key;
            }
             */
 
            if (!result[2].empty()){// At least '=' found
                value = result[3];
                trim(value);
                (*m)[key] = value;
                argumentRegistered = true;
            }
            else {
                value = "";
                argumentRegistered = false;  // user is hinted to use readPendingArgument now.
            }
        }
        else { // loose argument
            key="";
            value = line;
            trim(value);
            argumentRegistered = true;
        }
 
 
 
    }
 
    void read(int argc, char **argv){
        for (int i = 1; i < argc; ++i) {
            readCommandLineEntry(argv[i]);
        }
 
    }
 
 
 
    inline const std::string &getKey(){return key;};
    inline const std::string &getValue(){return value;};
 
    //inline bool pendingArgument(){return !hasArgument;};
    inline bool hasArgument(){return argumentRegistered;};
 
protected:
    std::map<K,V> *m;
    std::map<K,V> defaultMap;
 
    // For configuration file options
    drain::RegExp configLineParser;
 
    // For command line options
    drain::RegExp commandLineParser;
 
    std::string key;
    std::string value;
 
    // change to "pending argument" etc
    bool argumentRegistered;
    //int KEY;
    //int VALUE;
 
};
 
} //namespace
 
#endif /*MAPREADER_H_*/
 
// Drain