Context.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_CONTEXT_H_
#define DRAIN_CONTEXT_H_
 
 
#include <drain/Log.h>
 
//#include <map>
//#include "drain/util/Debug.h"
//#include "drain/util/ReferenceMap.h"
 
#include "drain/util/Cloner.h"
#include "drain/util/StatusFlags.h"
#include "drain/util/VariableMap.h" // statusMap
 
 
#include "CommandSequence.h"
#include "Loop.h"
 
 
namespace drain {
 
 
 
class Context {
 
public:
 
 
    Script routine;
 
    // Experimental
    Script addedCommands;
 
    // Experimental
    // Program addedProgram;
 
 
    // Experimental
    Loop::loopStack loops;
 
    Context(const std::string & basename = __FUNCTION__);
 
    Context(const Context & ctx);
 
 
    virtual
    ~Context(){
        //if (logFileStream.is_open())
        //  logFileStream.close();
    }
 
 
    inline
    long int getId() const {
        return id;
    }
 
    inline
    const std::string & getName() const {
        return name;
    }
 
    Log log;
 
 
    //std::string logFileSyntax;
    //std::ofstream logFileStream;
 
    StatusFlags statusFlags;
 
 
    virtual inline
    const drain::VariableMap & getStatusMap() const {
        return statusMap;
    };
 
    virtual inline
    drain::VariableMap & getStatusMap(){
        return statusMap;
    };
 
    virtual inline
    drain::VariableMap & getUpdatedStatusMap(){
        //Logger mout(this->log, __FILE__, __FUNCTION__);
        //mout.attention("Base class getStatusMap");
        updateStatus();
        return statusMap;
    };
 
 
    inline
    const Variable & getStatus(const std::string & key, bool update=true) const {
        if (update){
            updateStatus();
        }
        return statusMap[key];
        //return static_cast<T>(statusMap[key]);
    };
 
    // non-virtual
 
    template <class T>
    inline
    void setStatus(const std::string & key, const T & value){
        statusMap[key] = value;
    }
 
 
 
    virtual
    inline
    void report(StatusFlags & flags){
        if (statusFlags.value > 0){
            flags.set(statusFlags.value);
        }
    }
 
    //bool SCRIPT_DEFINED; // To correctly handle sequential input commands (and other script-triggering commands)
 
    inline
    bool isScriptDefined(){
        return !routine.empty();
    }
 
protected:
 
    const std::string basename;
 
    const long int id;
 
    const std::string name;
 
    void init();
 
    mutable
    drain::VariableMap statusMap;
 
    virtual
    void updateStatus() const;
 
private:
 
    static long int counter;
 
    //drain::VariableMap statusMap;
 
};
 
 
/*
// See Rack resources.sh
*/
class ContextKit {
 
public:
 
    inline
    ContextKit() : expandVariables(false) {
    };
 
    // virtual  drain::FlexVariableMap & getStatus();
 
    //
    bool expandVariables;
 
 
    std::string formatStr;
 
    // mutable drain::StringMapper statusFormatter;
 
};
 
class SmartContext : public Context, public ContextKit {
 
public:
 
    SmartContext(const std::string & basename = __FUNCTION__) : Context(basename){
        //linkStatusVariables();
    };
 
    SmartContext(const SmartContext & ctx) : Context(ctx), ContextKit(ctx){
        //linkStatusVariables();
    }
 
 
    //virtual drain::FlexVariableMap & getStatus();
 
private:
 
    //void linkStatusVariables();
 
};
 
 
typedef ClonerBase<Context> ContextClonerBase;
//class ContextClonerBase : public ClonerBase<Context>{
//};
 
/*
template <class C, class BC=Context>
class ContextCloner : public Cloner<BC,C> {
};
*/
 
class Contextual {
 
public:
 
    inline
    Contextual() : contextPtr(nullptr) {};
 
    inline
    Contextual(const Contextual & src) : contextPtr(src.contextPtr){ // or always null?
        //setExternalContext(src.getBaseContext()); ? not logical, consider C1 and C2(C1);
    };
 
    inline
    Contextual(Context & ctx){
        setExternalContext(ctx);
    };
 
 
    template <class C>
    void setContext(){
        contextPtr = & getCloner<C>().get();
    }
 
    inline
    void setExternalContext(Context & ctx){
        contextPtr = &ctx;
    };
 
    inline
    bool contextIsSet() const {
        return (contextPtr != nullptr);
    };
 
 
 
    template <class T=Context> // ,class BC> //
    T & getContext() const { // int logLevel = LOG_WARNING
        if (contextIsSet()){
            return (T &)*contextPtr;
        }
        else {
            //Logger mout(__FILE__, __FUNCTION__);
            //mout.log(logLevel) << "context not set" << mout.endl;
            return getCloner<T>().getSourceOrig();
        }
    }
 
    template <class T> // ,class BC>
    static
    Cloner<Context,T> & getCloner(){
        static Cloner<Context,T> cloner;
        return cloner;
    }
 
protected:
 
    // Note: common base class. The actual object may be a derived class.
    Context *contextPtr; 
 
};
 
template <class C>
class SuperContextual : public Contextual{
 
public:
 
    typedef drain::Cloner<Context,C> ctx_cloner_t;
 
    static inline
    C & baseCtx() {
        return getContextCloner().getSourceOrig();
    }
 
    // Static?
    static inline
    ctx_cloner_t & getContextCloner(){
        return getCloner<C>();
    }
 
protected:
 
 
};
 
 
} /* namespace drain */
 
#endif /* DRAIN_CONTEXT_H_ */
 
// Rack