cenvir.h

//==========================================================================
//  CENVIR.H - part of
//
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  Declaration of the following classes:
//    cEnvir    : user interface class
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2005 Andras Varga

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __CENVIR_H
#define __CENVIR_H

#include <sstream>
#include <iostream>
#include "defs.h"

class cObject;
class cMessage;
class cGate;
class cModule;
class cSimpleModule;
class cStatistic;
class cRNG;
class cConfiguration;
class cXMLElement;
class TOmnetApp;
class cEnvir;

using std::endl;

//
// std::streambuf used by cEnvir's ostream base. It redirects writes to
// cEnvir::sputn(s,n). Flush is done at the end of each line, meanwhile
// writes are buffered in a stringbuf.
//
template <class E, class T = std::char_traits<E> >
    class basic_evbuf : public std::basic_stringbuf<E,T> {
public:
    basic_evbuf(cEnvir *ev) : _ev(ev) {}
    bool isempty() {return pptr()==pbase();}
protected:
    virtual int sync();
    virtual std::streamsize xsputn(const E *s, std::streamsize n) {
#if !defined(_MSC_VER) || _MSC_VER>1200
        std::streamsize r = std::basic_stringbuf<E,T>::xsputn(s,n);
#else
        // **HACK** The above line (calling the same function in the base class)
        // doesn't work with MSVC6.0: it gives a weird compilation error.
        // So as a workaround I copied here the body of the original xsputn()
        // function from the MSVC header, VC98/Include/streambuf.
        const E *_S = s;
        std::streamsize _N = n;
        std::streamsize _M, _Ns;
        for (_Ns = 0; 0 < _N; )
            if (pptr() != 0 && 0 < (_M = epptr() - pptr()))
                {if (_N < _M)
                    _M = _N;
                T::copy(pptr(), _S, _M);
                _S += _M, _Ns += _M, _N -= _M, pbump(_M); }
            else if (T::eq_int_type(T::eof(),
                overflow(T::to_int_type(*_S))))
                break;
            else
                ++_S, ++_Ns, --_N;
        std::streamsize r = _Ns;
#endif
        for(;n>0;n--,s++)
            if (*s=='\n')
               {sync();break;}
        return r;
    }
    cEnvir *_ev;
};

typedef basic_evbuf<char> evbuf;


ENVIR_API extern cEnvir ev;

ENVIR_API bool memoryIsLow();



class ENVIR_API cEnvir : public std::ostream
{
  public:
    // internal variables
    TOmnetApp *app;  // the application" instance
    bool disable_tracing;
    bool debug_on_errors;
  private:
    // further internal vars
    evbuf ev_buf;
    bool isgui;

  public:
    // internal: writes the first n characters of string s.
    // evbuf (the streambuf underlying cEnvir's ostream base class)
    // writes via this function.
    void sputn(const char *s, int n);

    // internal: flushes the internal stream buffer by terminating last line if needed
    // note: exploits the fact that evbuf does sync() on "\n"'s
    void flushlastline() {if (!ev_buf.isempty()) ev_buf.sputn("\n",1);}

  public:

    cEnvir();

    ~cEnvir();


    void setup(int ac, char *av[]);

    int run();

    void shutdown();


    void objectDeleted(cObject *object);

    void messageSent(cMessage *msg, cGate *directToGate=NULL);

    void moduleReparented(cModule *module, cModule *oldparent);

    void messageDelivered(cMessage *msg);

    void breakpointHit(const char *lbl, cSimpleModule *mod);

    void moduleMethodCalled(cModule *from, cModule *to, const char *method);

    void moduleCreated(cModule *newmodule);

    void moduleDeleted(cModule *module);

    void connectionCreated(cGate *srcgate);

    void connectionRemoved(cGate *srcgate);

    void displayStringChanged(cGate *gate);

    // TBD: how does module name change propagate to gui?
    void displayStringChanged(cModule *submodule);

    void backgroundDisplayStringChanged(cModule *parentmodule);


    std::string getParameter(int run_no, const char *parname);

    bool getParameterUseDefault(int run_no, const char *parname);

    bool isModuleLocal(cModule *parentmod, const char *modname, int index);

    cXMLElement *getXMLDocument(const char *filename, const char *path=NULL);

    unsigned extraStackForEnvir();

    cConfiguration *config();


    bool isGUI()  {return isgui;}

    bool disabled() {return disable_tracing;}

    void bubble(cModule *mod, const char *text);

    void printfmsg(const char *fmt,...);

    void printf(const char *fmt="\n",...);

    void puts(const char *s);

    cEnvir& flush();

    std::string gets(const char *prompt, const char *defaultreply=NULL);

    bool gets(const char *prompt, char *buf, int len=255);

    bool askYesNo(const char *msgfmt,...);


    int numRNGs();

    cRNG *rng(int k);

    void getRNGMappingFor(cModule *mod);


    void *registerOutputVector(const char *modulename, const char *vectorname, int tuple);

    void deregisterOutputVector(void *vechandle);

    bool recordInOutputVector(void *vechandle, simtime_t t, double value);

    bool recordInOutputVector(void *vechandle, simtime_t t, double value1, double value2);


    void recordScalar(cModule *module, const char *name, double value);


    std::ostream *getStreamForSnapshot();

    void releaseStreamForSnapshot(std::ostream *os);

    int argCount();

    char **argVector();

    unsigned long getUniqueNumber();

    bool idle();
};

template <class E, class T>
int basic_evbuf<E,T>::sync() {
    _ev->sputn(this->pbase(), this->pptr()-this->pbase());
    setp(this->pbase(),this->epptr());
    return 0;
}

#endif

---