cdisplaystring.h

//==========================================================================
//   CDISPLAYSTRING.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-2008 Andras Varga
  Copyright (C) 2006-2008 OpenSim Ltd.

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

#ifndef __CDISPLAYSTRING_H
#define __CDISPLAYSTRING_H

#include "cobject.h"
#include "cgate.h"
#include "cmodule.h"

NAMESPACE_BEGIN


class SIM_API cDisplayString
{
  private:
    enum { MAXARGS = 16 };  // maximum number of arguments per tag

    // holds one tag
    struct Tag {
       char *name;
       int numargs;
       char *args[MAXARGS];
       Tag() {name=NULL; numargs=0;}
    };

    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 for notifications
    cComponent *ownercomponent;

  private:
    void copy(const cDisplayString& other) {parse(other.str());}

    // helper functions
    void doParse(const char *s);
    void doUpdateWith(const cDisplayString& ds);
    bool doSetTagArg(int tagindex, int index, const char *value);
    bool doSetTagArg(const char *tagname, int index, const char *value);
    int doInsertTag(const char *tagname, int atindex=0);
    bool doRemoveTag(int tagindex);

    void doParse();
    void assemble() const;
    void clearTags();
    bool pointsIntoBuffer(char *s) const {return s>=buffer && s<=bufferend;}
    static void strcatescaped(char *d, const char *s);

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

  public:
    // internal:
    void setHostObject(cComponent *o) {ownercomponent=o;}
    void dump() const;

  public:

    cDisplayString();

    cDisplayString(const char *dispstr);

    cDisplayString(const cDisplayString& ds);

    ~cDisplayString();

    cDisplayString& operator=(const cDisplayString& ds);

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

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


    const char *str() const;

    void set(const char *displaystr)  {parse(displaystr);}

    void parse(const char *displaystr);

    void updateWith(const cDisplayString& ds);

    void updateWith(const char *s);


    bool containsTag(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 setTagArg(const char *tagname, int index, long value);

    bool removeTag(const char *tagname);


    int getNumTags() const;

    const char *getTagName(int tagindex) const;

    int getTagIndex(const char *tagname) 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);
};


NAMESPACE_END


#endif