ccontextswitcher.h

//==========================================================================
//  CCONTEXTSWITCHER.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================
 
/*--------------------------------------------------------------*
  Copyright (C) 1992-2017 Andras Varga
  Copyright (C) 2006-2017 OpenSim Ltd.
 
  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/
 
#ifndef __OMNETPP_CCONTEXTSWITCHER_H
#define __OMNETPP_CCONTEXTSWITCHER_H
 
#include <type_traits> // is_integer
#include <limits>   // numeric_limits
#include <cstring>  // for strlen, etc.
#include <cstdarg>  // for va_list
#include <cstdio>   // for sprintf
#include <cstdlib>  // for gcvt
#include <typeinfo>  // for type_info
#include <string>    // for std::string
#include "platdep/platmisc.h" // for gcvt, etc
#include "simkerneldefs.h"
#include "errmsg.h"
 
namespace omnetpp {
 
class cObject;
class cComponent;
 
// logically belongs to csimulation.h but must be here because of declaration order
enum ContextType {CTX_NONE, CTX_BUILD, CTX_INITIALIZE, CTX_EVENT, CTX_SCHEDULER, CTX_REFRESHDISPLAY, CTX_FINISH, CTX_CLEANUP};
 
 
#define Enter_Method(...)  omnetpp::cMethodCallContextSwitcher __ctx(this); __ctx.methodCall(__VA_ARGS__)
 
#define Enter_Method_Silent(...)  omnetpp::cMethodCallContextSwitcher __ctx(this); __ctx.methodCallSilent(__VA_ARGS__)
 
class SIM_API cContextSwitcher
{
  protected:
    cComponent *callerContext;
  public:
    cContextSwitcher(const cComponent *newContext);
 
    ~cContextSwitcher();
 
    cComponent *getCallerContext() const { return callerContext; }
};
 
class SIM_API cMethodCallContextSwitcher : public cContextSwitcher
{
  private:
    static int depth;
 
  public:
    //TODO store previous frame, __FILE__, __LINE__, __FUNCTION__ too, at least in debug builds?
    cMethodCallContextSwitcher(const cComponent *newContext);
 
    ~cMethodCallContextSwitcher();
 
    _OPP_GNU_ATTRIBUTE(format(printf, 2, 3))
    void methodCall(const char *methodFmt,...);
    _OPP_GNU_ATTRIBUTE(format(printf, 2, 3))
    void methodCallSilent(const char *methodFm,...);
    void methodCallSilent();
 
    static int getDepth() {return depth;}
};
 
class SIM_API cContextTypeSwitcher
{
  private:
    ContextType savedContextType;
 
  public:
    cContextTypeSwitcher(ContextType contexttype);
 
    ~cContextTypeSwitcher();
};
 
 
}  // namespace omnetpp
 
#endif