astnode.h

Go to the documentation of this file.

//==========================================================================
// astnode.h  -
//
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
// Contents:
//   class ASTNode
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 2002-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_NEDXML_ASTNODE_H
#define __OMNETPP_NEDXML_ASTNODE_H

#ifdef _MSC_VER
// disable 4996: VC8.0 warnings on Unix syscalls
#pragma warning(disable: 4996)
#endif

#include <string>
#include "nedxmldefs.h"

namespace omnetpp {
namespace nedxml {


class NEDXML_API UserData
{
  public:
    UserData() {}

    virtual ~UserData() {}
};


struct SourceRegion
{
    SourceRegion() {startLine=startColumn=endLine=endColumn=0;}
    int startLine;
    int startColumn;
    int endLine;
    int endColumn;
};

class NEDXML_API ASTNode
{
  private:
    long id;
    std::string srcLoc;
    SourceRegion srcRegion;
    ASTNode *parent;
    ASTNode *firstChild;
    ASTNode *lastChild;
    ASTNode *prevSibling;
    ASTNode *nextSibling;
    UserData *userData;

    static long lastId;
    static long numCreated;
    static long numExisting;

  protected:
    static bool stringToBool(const char *s);
    static const char *boolToString(bool b);
    static int stringToEnum(const char *s, const char *vals[], int nums[], int n);
    static const char *enumToString(int b, const char *vals[], int nums[], int n);
    static void validateEnum(int b, const char *vals[], int nums[], int n);

  public:

    ASTNode();

    ASTNode(ASTNode *parent);

    virtual ~ASTNode();

    virtual ASTNode *dup() const = 0;

    virtual ASTNode *dupTree() const;


    virtual const char *getTagName() const = 0;

    virtual int getTagCode() const = 0;

    virtual long getId() const;

    virtual void setId(long id);

    virtual const char *getSourceLocation() const;

    virtual void setSourceLocation(const char *loc);

    virtual const SourceRegion& getSourceRegion() const;

    virtual void setSourceRegion(const SourceRegion& region);


    virtual void applyDefaults();

    virtual int getNumAttributes() const = 0;

    virtual const char *getAttributeName(int k) const = 0;

    virtual int lookupAttribute(const char *attr) const;

    virtual const char *getAttribute(int k) const = 0;

    virtual const char *getAttribute(const char *attr) const;

    virtual void setAttribute(int k, const char *value) = 0;

    virtual void setAttribute(const char *attr, const char *value);

    virtual const char *getAttributeDefault(int k) const = 0;

    virtual const char *getAttributeDefault(const char *attr) const;


    virtual ASTNode *getParent() const;

    virtual ASTNode *getFirstChild() const;

    virtual ASTNode *getLastChild() const;

    virtual ASTNode *getNextSibling() const;

    virtual ASTNode *getPrevSibling() const;

    virtual void appendChild(ASTNode *node);

    virtual void insertChildBefore(ASTNode *where, ASTNode *newnode);

    virtual ASTNode *removeChild(ASTNode *node);

    virtual ASTNode *getFirstChildWithTag(int tagcode) const;

    virtual ASTNode *getNextSiblingWithTag(int tagcode) const;

    virtual int getNumChildren() const;

    virtual int getNumChildrenWithTag(int tagcode) const;

    ASTNode *getFirstChildWithAttribute(int tagcode, const char *attr, const char *attrvalue=nullptr);

    ASTNode *getParentWithTag(int tagcode);


    static long getNumCreated() {return numCreated;}

    static long getNumExisting() {return numExisting;}


    virtual void setUserData(UserData *data);

    virtual UserData *getUserData() const;
};

typedef ASTNode NedElement;
typedef ASTNode MsgElement;

class NEDXML_API ASTNodeFactory
{
  public:
    virtual ~ASTNodeFactory() {}

    virtual ASTNode *createElementWithTag(const char *tagName) = 0;

    virtual ASTNode *createElementWithTag(int tagCode) = 0;
};

} // namespace nedxml
}  // namespace omnetpp


#endif