Command.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 DRAINLET_H_
#define DRAINLET_H_
 
//#include <map>
//#include <set>
//#include "drain/util/Debug.h"
//#include "drain/util/ReferenceMap.h"
 
#include <drain/Log.h>
#include "drain/util/BeanLike.h"
#include "drain/util/ReferenceMap.h"
 
//#include "drain/util/Cloner.h"
#include "Context.h"
 
namespace drain {
 
 
class Command : public Contextual {
 
public:
 
 
    inline
    Command(): section(0){}; //
 
    // TODO: CHECK: base Contextual is explicitly default-constructed (contextPtr=nullptr) here,
    // same as before, rather than copying cmd's contextPtr. Commands are cloned per thread/context
    // (see AGENTS.md), so a fresh (unset) context that gets reassigned afterward may well be the
    // intended behavior here, but confirm.
    inline
    Command(const Command & cmd) : Contextual(), section(cmd.section), lastParameters(cmd.lastParameters){
        // setParameters(cmd.getParameters()); they do not exist yet!
    }
 
    virtual inline
    ~Command(){};
 
 
 
    virtual
    const std::string & getName() const = 0;
 
    virtual
    const std::string & getDescription() const = 0;
 
    virtual
    const ReferenceMap & getParameters() const = 0;
 
    static
    const SprinterLayout cmdArgLayout; 
 
 
    virtual
    void setParameters(const std::string & args) final;
 
    // TODO: make this a loop calling set(key,val) - but then no
    template <class T>
    void setParameters(const T & args){
        // TODO: set parameter X=Y ?
        ReferenceMap & parameters = getParameters();
        std::stringstream sstr;
        char separator = 0;
        for (const auto & entry: args){
            parameters[entry.first] = entry.second;
            // setParameter(entry.first, entry.second);
            if (separator)
                sstr << separator;
            else
                separator = ',';
            sstr << entry.first << '=' << entry.second;
        }
        lastParameters = sstr.str();
 
    }
 
 
    template <class T>
    void setParameter(const std::string & key, const T & value){
        getParameters()[key] = value;
        std::stringstream sstr;
        sstr << key << '=' << value;
        lastParameters = sstr.str();
    }
 
 
 
    // Could also need/replace   void setParameters(const std::map<std::string,T> & p)
 
    inline
    bool hasParameters() const {
 
        Logger mout(__FILE__, __FUNCTION__);
 
        const ReferenceMap & params = this->getParameters();
        //mout.warn(params );
 
        const ReferenceMap::const_iterator it = params.begin();
        if (it == params.end()) // empty
            return false;
        else
            return it->second.getType() != typeid(void);  // ???
    };
 
    /*
    virtual inline
    const std::string & getType() const {
        static const std::string empty;
        return empty;
    };
    */
 
 
 
    virtual inline
    void run(const std::string & params = "") final {
        setParameters(params);
        update();
        exec();
    }
 
 
    virtual
    void update(){
    }
 
    virtual inline
    void exec() const {};
 
 
    // Optional bit(s) marking the command type (compare with manual page sections)
    typedef int cmd_section_type;
    cmd_section_type section = 1; 
 
    inline
    Command & addSection(int i){ // drain::FlaggerBase<>::ivalue_t
        section |= i;
        return *this;
    }
 
    inline
    const std::string & getLastParameters() const {
        return lastParameters;
    };
 
 
    //virtual
    // void help(std::ostream & ostr = std::cout, bool DETAILED=false) const final;
 
    virtual
    void getRelatedCommands(std::ostream & ostr = std::cout) const;
 
 
 
    /*
    template <class C, class ...CC>
    Command & linkRelatedCommands(const C & cmd, const CC & ... cmds){
        relatedCommands.insert(cmd);
        linkRelatedCommands(cmds...);
        return *this;
    };
    */
 
    inline
    void linkRelated(const std::string & cmdKey) const {
        relatedCommands.insert(cmdKey);
    };
 
 
    virtual
    void parametersToStream(std::ostream & ostr, const std::string & indent= "  ") const;
 
    virtual inline
    void parameterKeysToStream(std::ostream & ostr) const {
        parameterKeysToStream(ostr, getParameters().getKeyList(), getParameters().separator);
    };
 
    void parameterKeysToStream(std::ostream & ostr, const std::list<std::string> & list, char sep=',') const;
 
 
protected:
 
    mutable
    std::set<std::string> relatedCommands; 
 
    // Terminal
    /*
    inline
    Command & linkRelatedCommands(){
        return *this;
    };
    */
 
    // Why protected?
    virtual
    ReferenceMap & getParameters() = 0;
 
    // Clumsy but useful
    std::string lastParameters; 
 
};
 
inline
std::ostream & operator<<(std::ostream & ostr, const Command &cmd){
    ostr << cmd.getName();
    if (cmd.hasParameters()){
        ostr << ' ' << cmd.getParameters(); //  << ' ';
    }
    return ostr;
}
 
// See new implementations in CommandBank, CommandUtils.
//typedef std::list<std::pair<Command &, std::string> > Script; // TODO: move
 
 
/*
template <class B>
class BeanerCommand : public Command {
 
public:
 
    typedef B bean_t;
 
    // Main
    virtual
    const bean_t & getBean() const = 0;
 
    // Main
    virtual
    bean_t & getBean() = 0;
 
 
 
 
    inline
    const std::string & getName() const final {
        return getBean().getName();
    };
 
    inline
    const std::string & getDescription() const final {
        return getBean().getDescription();
    };
 
    virtual inline
    const drain::ReferenceMap & getParameters() const final {
        return getBean().getParameters();
    };
 
protected:
 
    virtual inline
    drain::ReferenceMap & getParameters() final {
        return getBean().getParameters();
    };
 
};
*/
 
 
template <class B, class B2=B>
class BeanCommand : public Command {
// class BeanCommand : public BeanerCommand<B> { // public Command {
 
public:
 
    BeanCommand(){
    };
 
    BeanCommand(const std::string & name, const std::string & description) : bean(name, description){
    };
 
    BeanCommand(const BeanCommand & cmd) :  Command(cmd), bean(cmd.bean) {
        // WARNING: this may have undesired beaviour:
        // If B2 is (Bean &), also new instance of beanCmd.bean -> cmd.bean
    };
 
    BeanCommand(B & b) : bean(b) {
    };
 
    typedef B bean_t; 
 
// Consider private:
    B2 bean; 
 
 
    virtual inline
    const bean_t & getBean() const  { // final
        return bean;
    };
 
    virtual inline
    bean_t & getBean() { // final
        return bean;
    };
 
 
 
    inline
    const std::string & getName() const final {
        return getBean().getName();
    };
 
    inline
    const std::string & getDescription() const final {
        return getBean().getDescription();
    };
 
    virtual inline
    const drain::ReferenceMap & getParameters() const  { // final
        return getBean().getParameters();
    };
 
protected:
 
    virtual inline
    drain::ReferenceMap & getParameters() final {
        return getBean().getParameters();
    };
 
 
    /*
    virtual
    void setAllParameters(const std::string & args) override {
 
        Context & ctx = this->template getContext<>();
        drain::Logger mout(ctx.log, __FUNCTION__, this->bean.getName() );
 
        bean.setParameters(args,'=');
        //mout.note() = "updating";
        //this->update();
    }
    */
 
    //virtual
    /*
    void setParameters(const VariableMap & params){
        bean.setParameters(params);
        // this->update();
    }
    */
 
};
 
 
 
template <class B>
class BeanRefCommand : public drain::BeanCommand<B, B&> {
 
public:
 
    BeanRefCommand(B & bean) : drain::BeanCommand<B,B&>(bean){
    }
 
    BeanRefCommand(const B & bean) : drain::BeanCommand<B,B&>(bean){
    }
 
    BeanRefCommand(const BeanRefCommand<B> & beanRefCmd) : drain::BeanCommand<B,B&>(beanRefCmd.bean){
    }
 
 
};
 
 
 
 
 
class BasicCommand : public BeanCommand<BeanLike> {  // Todo consider BeanLike
 
public:
 
    BasicCommand(const std::string & name, const std::string & description);
 
    inline
    //BasicCommand(const BasicCommand & cmd): Command(cmd), name(cmd.name), description(cmd.description) {
    BasicCommand(const BasicCommand & cmd): BeanCommand<BeanLike>(cmd) {
        // remember to call importParameters()
    }
 
};
 
 
//typedef BeanCommand<BeanLike>  BasicCommand;
 
 
 
 
template <class T = std::string>
class SimpleCommand : public BasicCommand {
 
public:
 
    T value;
 
    SimpleCommand(const std::string & name, const std::string & description,
            const std::string & key="value", const T & initValue = T(), const std::string & unit = "") : BasicCommand(name, description) {
 
        getParameters().separator = '\0';
        getParameters().link(key, value = initValue, unit);
 
        if (key.empty()){
            Context & ctx = getContext<Context>();
            drain::Logger mout(ctx.log,__FILE__, __FUNCTION__);
            mout.warn("Empty value key in command ", name, " (", description, ")");
        }
 
 
    };
 
    template <class S>
    SimpleCommand(const std::string & name, const std::string & description,
            const std::string & key, std::initializer_list<S> l , const std::string & unit = "") : BasicCommand(name, description) {
        // parameters.separator = '\0';
        value = l;
        getParameters().link(key, value);
 
        if (key.empty()){
            Context & ctx = getContext<Context>();
            drain::Logger mout(ctx.log,__FILE__, __FUNCTION__);
            mout.warn("Empty value key in command ", name, " (", description, ")");
        }
    }
 
 
    SimpleCommand(const SimpleCommand & cmd):  BasicCommand(cmd) {
        getParameters().separator = '\0';
        getParameters().copyStruct(cmd.getParameters(), cmd, *this);
        /*
        parameters.separator = '\0';
        parameters.copyStruct(cmd.getParameters(), cmd, *this);
        */
    };
 
    /*
    void setParameters(const std::string & args){
        const std::string & key = parameters.begin()->first;
        Variable v(typeid(T));
        if (key.empty()){
            v = args;
        }
        else {
            const std::string assignment = key+"=";
            const size_t n = assignment.length();
            if (args.compare(0,n,key)==0){
                v = args.substr(n);
            }
            else
                v = args;
        }
        value = v;
    }
    */
 
 
 
};
 
 
/*
class DynamicCommand : public drain::Command {
 
public:
 
    virtual
    void exec() const {
        Context & ctx = getContext<Context>();
        drain::Logger mout(ctx.log,__FILE__, __FUNCTION__);
        mout.note("I am " , getName() , ", invoked as " , key );
    }
 
    virtual
    void setKey(const std::string & cmdKey) const {
        key = cmdKey;
    }
 
protected:
 
    mutable
    std::string key;
 
};
*/
 
 
 
 
} // drain::
 
#endif /* DRAINLET_H_ */