cdispstr.h

//==========================================================================
//   CDISPSTR.H  - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  Declaration of the following classes:
//    cDisplayString : utility class for display string manipulation
//
//==========================================================================

/*--------------------------------------------------------------*
  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 __CDISPSTR_H
#define __CDISPSTR_H

#include "cobject.h"


#define MAXARGS 16


class SIM_API cDisplayString
{
  private:
    struct Tag {
       char *name;
       int numargs;
       char *args[MAXARGS];
    };
    char *buffer;       // holds pieces of display string (sliced with zeroes)
    char *bufferend;    // points to last byte of buffer allocated
    Tag *tags;          // table of tags
    int numtags;        // number of tags

    mutable char *dispstr; // cached copy of assembled display string
    mutable bool needsassemble; // if dispstr is up-to-date

    // needed to notify Envir
    cObject *object;     // a cModule or cGate pointer
    enum {NONE, CONNECTION, MODULE, MODULEBACKGROUND} role; // what

  private:
    // helper functions
    bool parse();
    void assemble() const;
    int gettagindex(const char *tagname) const;
    void cleartags();
    bool isinbuffer(char *s) {return s>=buffer && s<=bufferend;}
    static void strcatescaped(char *d, const char *s);

  private:
    // internal: called when the stored display string changes, and notifies Envir in turn.
    void notify();

  public:
    // internal:
    void setRoleToConnection(cGate *gate) {object=gate; role=CONNECTION;}
    void setRoleToModule(cModule *submodule) {object=submodule; role=MODULE;}
    void setRoleToModuleBackground(cModule *module) {object=module; role=MODULEBACKGROUND;}

  public:

    cDisplayString();

    cDisplayString(const char *dispstr);

    cDisplayString(const cDisplayString& ds);

    ~cDisplayString();

    cDisplayString& operator=(const cDisplayString& ds) {parse(ds.getString()); return *this;}

    cDisplayString& operator=(const char *s)  {parse(s); return *this;}

    operator const char *() const  {return getString();}


    const char *getString() const;

    bool parse(const char *displaystr);


    bool existsTag(const char *tagname) const;

    int getNumArgs(const char *tagname) const;

    const char *getTagArg(const char *tagname, int index) const;

    bool setTagArg(const char *tagname, int index, const char *value);

    bool removeTag(const char *tagname);


    int getNumTags() const;

    const char *getTagName(int tagindex) const;

    int getNumArgs(int tagindex) const;

    const char *getTagArg(int tagindex, int index) const;

    bool setTagArg(int tagindex, int index, const char *value);

    int insertTag(const char *tagname, int atindex=0);

    bool removeTag(int tagindex);
};


#endif

---