CommandInstaller.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 DRAIN_CMD_INSTALLER_H_
#define DRAIN_CMD_INSTALLER_H_
 
#include <drain/Log.h>
#include <map>
#include <set>
//#include "drain/util/Debug.h"
//#include "drain/util/ReferenceMap.h"
 
#include "drain/util/ReferenceMap.h"
 
//#include "Command.h"
//#include "CommandRegistry.h"
 
#include "CommandBank.h"
#include "CommandSections.h"
 
 
namespace drain {
 
//  in section S of the global command registry.
/*
template <class C> //, char PREFIX=0, int SECTIONS=1>
class CommandWrapper : public C {
public:
 
    CommandWrapper(const std::string & name, char alias = 0){
        getCommandBank().add<C>(name,alias); //.section = S;
    }
 
};
*/
 
 
 
//  in section S of the global command registry.
template <char PREFIX=0, class SECTION=GeneralSection>
class CommandInstaller { //: public CMD {
public:
 
    CommandBank & cmdBank;
 
    CommandInstaller(CommandBank & bank = getCommandBank()) : cmdBank(bank){
         getSection();
    };
 
    inline static
    const CommandSection & getSection(){
        return drain::Static::get<SECTION>();
    };
 
    static inline
    char getPrefix(){
        return PREFIX;
    }
 
    template <class CMD>
    Command & install(const std::string & name, char alias = 0){
        Command & cmd = cmdBank.add<CMD>(name,alias);
        cmd.section |= getSection().index; // keep TRIGGER
        return cmd;
    }
 
    template <class CMD>
    Command & install(char alias = 0){
        std::string name = CMD().getName();
        CommandBank::deriveCmdName(name, PREFIX);
        return install<CMD>(name, alias);
    }
 
 
    template <class CMD>
    Command & install(CMD & cmdExt, const std::string & name, char alias = 0){
        Command & cmd = cmdBank.addExternal(cmdExt, name,alias);// must give cmdExt, for copying
        cmd.section |= getSection().index; // keep TRIGGER
        return cmd;
    }
 
 
    template <class CMD>
    Command & install(CMD & cmdExt, char alias = 0){
        std::string name = cmdExt.getName();
        CommandBank::deriveCmdName(name, PREFIX);
        return install(cmdExt, name, alias);
    }
 
    // Deprecated method name - use plain install()
    /*
    template <class CMD>
    Command & installExternal(CMD & cmdExt, const std::string & name, char alias = 0){
        Command & cmd = cmdBank.addExternal(cmdExt, name,alias);// must give cmdExt, for copying
        cmd.section |= getSection().index; // keep TRIGGER
        return cmd;
    }
 
    // Deprecated method name - use plain install()
    template <class CMD>
    Command & installExternal(CMD & cmdExt, char alias = 0){
        std::string name = cmdExt.getName();
        CommandBank::deriveCmdName(name, PREFIX);
        return installExternal(cmdExt, name, alias);
    }
    */
 
    template <class CMD>
    static
    Command & installShared(const std::string & name, char alias = 0){
        Command & cmd = getCommandBank().add<CMD>(name,alias);
        cmd.section |= getSection().index; // keep TRIGGER
        return cmd;
    }
 
    template <class CMD>
    static
    Command & installShared(char alias = 0){
        std::string name = CMD().getName();
        CommandBank::deriveCmdName(name, PREFIX);
        return installShared<CMD>(name, alias);
    }
 
    /*
    template <class ...CC>
    static
    //void linkRelatedCommands(const std::string & cmd, const CC & ... cmds){
    void linkRelatedCommands(const Command & cmd, const CC & ... cmds){
        std::string name = cmd.getName();
        CommandBank::deriveCmdName(name, PREFIX);
 
        // relatedCommands.insert(&cmd);
        // linkRelatedCommands(cmds...);
        linkRelatedCommands(name, cmds...);
        // return *this;
    };
 
 
    template <class ...CC>
    static // inline
    void linkRelatedCommands(const std::string & name, const Command & cmd, const CC & ... cmds){
        //cmd.linkRelatedCommands(name);
        cmd.relatedCommands.insert(name);
        linkRelatedCommands(name, cmds...);
    }
 
    static inline
    void linkRelatedCommands(const std::string & name, const Command & cmd){
        cmd.relatedCommands.insert(name);
        // cmd.linkRelatedCommands(name);
    }
 
    // mutable
    // std::set<const Command *> relatedCommands;
 
    typedef std::set<const Command *> CmdSet;
 
    template <class ...TT>
    inline
    void createCmdSet(CmdSet & set,const TT & ... cmds){
        set.insert(cmds);
    }
        */
 
 
};
 
 
 
template <char PREFIX=0, class SECTION=GeneralSection>
class CommandModule : protected CommandInstaller<PREFIX, SECTION>{
 
public:
 
    typedef CommandModule<PREFIX, SECTION> module_t;
    //typedef CommandInstaller<PREFIX, SECTION> base_t;
 
    CommandModule(CommandBank & bank = getCommandBank()) : CommandInstaller<PREFIX, SECTION>(bank)
        {
 
    };
 
    template <class CMD, class CMD_NEW = CMD>
    Command & installDeprecating(const std::string & name, char alias = 0){
        Command & cmd = this->cmdBank.template add<CMD>(name,alias);
        cmd.section |= this->getSection().index; // keep TRIGGER
 
        cmd.section |= drain::Static::get<drain::DeprecatingSection>().index;
        //cmd_section_type TRIGGER = drain::Static::get<drain::TriggerSection>().index;
 
 
        std::string nameNew = CMD_NEW().getName();
        CommandBank::deriveCmdName(nameNew, PREFIX);
        cmd.relatedCommands.insert(nameNew);
 
        return cmd;
    }
 
    template <class CMD, class CMD_NEW = CMD>
    Command & installDeprecating(char alias = 0){
        std::string name = CMD().getName();
        CommandBank::deriveCmdName(name, PREFIX);
 
        return installDeprecating<CMD,CMD_NEW>(name, alias);
 
        /*
        // this->cmdBank.linkRelatedCommandList(cmdList);
        Command & cmd = this->template install<CMD>(name, alias);
 
        std::string nameNew = CMD_NEW().getName();
        CommandBank::deriveCmdName(nameNew, PREFIX);
 
        cmd.relatedCommands.insert(nameNew);
        return cmd;
        // return install<CMD>(name, alias);
         */
    }
 
 
 
    template <class ...TT>
    inline
    void linkRelatedCommands(TT & ... cmds){
        std::set<std::string> cmdList;
        linkRelatedCommandList(cmdList, cmds...); // infinite loop?
    }
 
    template <class ...TT>
    inline
    void linkRelatedCommandList(std::set<std::string> & cmdList, Command & cmd, TT & ... cmds){
        std::string name = cmd.getName();
        CommandBank::deriveCmdName(name, PREFIX);
        cmdList.insert(name);
        linkRelatedCommandList(cmdList, cmds...); // infinite loop?
    }
 
    template <class ...TT>
    inline
    void linkRelatedCommandList(std::set<std::string> & cmdList, const std::string & cmdName, TT & ... cmds){
        cmdList.insert(cmdName);
        linkRelatedCommandList(cmdList, cmds...); // infinite loop?
    }
 
 
    template <class ...TT>
    inline
    void linkRelatedCommandList(std::set<std::string> & cmdList){
        this->cmdBank.linkRelatedCommandList(cmdList); // infinite loop?
    }
 
 
 
};
 
}
 
 
#define DRAIN_CMD_INSTALL(prefix, cmd) drain::Command & cmd = install<prefix##cmd>
 
 
/* namespace drain */
 
#endif /* DRAINLET_H_ */
 
// Rack