msganalyzer.h

Go to the documentation of this file.

//==========================================================================
//  MSGANALYZER.H - part of
//
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================
 
/*--------------------------------------------------------------*
  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_MSGANALYZER_H
#define __OMNETPP_NEDXML_MSGANALYZER_H
 
#include <iostream>
#include <sstream>
#include <string>
#include <vector>
#include <map>
#include <set>
 
#include "errorstore.h"
#include "msgelements.h"
#include "msgtypetable.h"
#include "msgcompileroptions.h"
 
namespace omnetpp {
namespace nedxml {
 
class NEDXML_API MsgAnalyzer
{
  public:
    typedef std::set<std::string> StringSet;
    typedef std::vector<std::string> StringVector;
    typedef MsgTypeTable::Property Property;
    typedef MsgTypeTable::Properties Properties;
    typedef MsgTypeTable::FieldInfo FieldInfo;
    typedef MsgTypeTable::ClassInfo ClassInfo;
    typedef MsgTypeTable::EnumItem EnumItem;
 
  public:
    static const StringSet RESERVED_WORDS;
 
  protected:
    ErrorStore *errors;
    MsgTypeTable *typeTable;
    const MsgCompilerOptions& opts;
 
  protected:
    void extractFields(ClassInfo& classInfo);
    void analyzeClassOrStruct(ClassInfo& classInfo, const std::string& namespaceName);
    void analyzeFields(ClassInfo& classInfo, const std::string& namespaceName);
    void analyzeField(ClassInfo& classInfo, FieldInfo *field, const std::string& namespaceName);
    void analyzeInheritedField(ClassInfo& classInfo, FieldInfo *field);
    std::string prefixWithNamespace(const std::string& name, const std::string& namespaceName);
    Properties extractProperties(ASTNode *node);
    bool hasSuperclass(ClassInfo& classInfo, const std::string& superclassQName);
    FieldInfo *findField(ClassInfo& classInfo, const std::string& name);
    FieldInfo *findSuperclassField(ClassInfo& classInfo, const std::string& fieldName);
    bool hasProperty(const Properties& p, const char *name)  {return p.get(name) != nullptr;}
    bool getPropertyAsBool(const Properties& p, const char *name, bool defval);
    std::string getProperty(const Properties& p, const char *name, const std::string& defval = std::string());
    std::string getMethodProperty(const Properties& props, const char *propName, bool existingClass);
    std::string decorateType(const std::string& typeName, bool isConst, bool isPointer, bool isRef);
    std::string makeRelative(const std::string& qname, const std::string& namespaceName);
    std::string lookupExistingClassName(const std::string& name, const std::string& contextNamespace,  ClassInfo *contextClass=nullptr);
    void validateProperty(const Property& property, const char *usage);
 
  public:
    MsgAnalyzer(const MsgCompilerOptions& opts, MsgTypeTable *typeTable, ErrorStore *errors);
    ~MsgAnalyzer() {}
    ClassInfo extractClassInfo(ASTNode *node, const std::string& namespaceName, bool isImported); // accepts StructElement, ClassElement, MessageElement, PacketElement
    void ensureAnalyzed(ClassInfo& classInfo);
    void ensureFieldsAnalyzed(ClassInfo& classInfo);
    ClassInfo extractEnumInfo(ASTNode *node, const std::string& namespaceName);
    Property extractProperty(PropertyElement *propertyElem);
    void validateFileProperty(const Property& property);
    void analyzeCplusplusBlockTarget(CplusplusElement *cppElem, const std::string& currentNamespace);
 
  public:
    static constexpr const char* ATT_NAME = "name";
    static constexpr const char* ATT_EXTENDS_NAME = "extends-name";
 
    static constexpr const char* PROP_PROPERTY = "property";
    static constexpr const char* PROP_ABSTRACT = "abstract";
    static constexpr const char* PROP_ACTUALLY = "actually";
    static constexpr const char* PROP_PRIMITIVE = "primitive";
    static constexpr const char* PROP_OPAQUE = "opaque";
    static constexpr const char* PROP_BYVALUE = "byValue";
    static constexpr const char* PROP_SUPPORTSPTR = "supportsPtr";
    static constexpr const char* PROP_SUBCLASSABLE = "subclassable";
    static constexpr const char* PROP_POLYMORPHIC = "polymorphic";
    static constexpr const char* PROP_CLASS = "class";
    static constexpr const char* PROP_BASETYPE = "baseType";
    static constexpr const char* PROP_DEFAULTVALUE = "defaultValue";
    static constexpr const char* PROP_CPPTYPE = "cppType";
    static constexpr const char* PROP_DATAMEMBERTYPE = "datamemberType";
    static constexpr const char* PROP_ARGTYPE = "argType";
    static constexpr const char* PROP_RETURNTYPE = "returnType";
    static constexpr const char* PROP_TOSTRING = "toString";
    static constexpr const char* PROP_FROMSTRING = "fromString";
    static constexpr const char* PROP_TOVALUE = "toValue";
    static constexpr const char* PROP_FROMVALUE = "fromValue";
    static constexpr const char* PROP_GETTERCONVERSION = "getterConversion";
    static constexpr const char* PROP_CLONE = "clone";
    static constexpr const char* PROP_EXISTINGCLASS = "existingClass";
    static constexpr const char* PROP_DESCRIPTOR = "descriptor";
    static constexpr const char* PROP_CASTFUNCTION = "castFunction";
    static constexpr const char* PROP_OMITGETVERB = "omitGetVerb";
    static constexpr const char* PROP_FIELDNAMESUFFIX = "fieldNameSuffix";
    static constexpr const char* PROP_BEFORECHANGE = "beforeChange";
    static constexpr const char* PROP_IMPLEMENTS = "implements";
    static constexpr const char* PROP_NOPACK = "nopack";
    static constexpr const char* PROP_OWNED = "owned";
    static constexpr const char* PROP_EDITABLE = "editable";
    static constexpr const char* PROP_REPLACEABLE = "replaceable";
    static constexpr const char* PROP_RESIZABLE = "resizable";
    static constexpr const char* PROP_READONLY = "readonly";
    static constexpr const char* PROP_OVERRIDEGETTER = "overrideGetter";
    static constexpr const char* PROP_OVERRIDESETTER = "overrideSetter";
    static constexpr const char* PROP_ENUM = "enum";
    static constexpr const char* PROP_SIZETYPE = "sizeType";
    static constexpr const char* PROP_SETTER = "setter";
    static constexpr const char* PROP_GETTER = "getter";
    static constexpr const char* PROP_GETTERFORUPDATE = "getterForUpdate";
    static constexpr const char* PROP_SIZESETTER = "sizeSetter";
    static constexpr const char* PROP_SIZEGETTER = "sizeGetter";
    static constexpr const char* PROP_INSERTER = "inserter";
    static constexpr const char* PROP_APPENDER = "appender";
    static constexpr const char* PROP_ERASER = "eraser";
    static constexpr const char* PROP_REMOVER = "remover";
    static constexpr const char* PROP_ALLOWREPLACE = "allowReplace";
    static constexpr const char* PROP_STR = "str";
    static constexpr const char* PROP_CUSTOMIZE = "customize";
    static constexpr const char* PROP_OVERWRITEPREVIOUSDEFINITION = "overwritePreviousDefinition";
    static constexpr const char* PROP_CUSTOM = "custom";
    static constexpr const char* PROP_CUSTOMIMPL = "customImpl";
};
 
}  // namespace nedxml
}  // namespace omnetpp
 
 
#endif