From ec6306ad1e746d47ed66af6274fb6710c70933a2 Mon Sep 17 00:00:00 2001 From: Andreas Stöckel Date: Tue, 3 Feb 2015 22:54:17 +0100 Subject: Fixed XML-Importer failing --- src/core/parser/ParserScope.cpp | 21 ++++++++++--- src/core/parser/ParserScope.hpp | 33 ++++++++++++++++++-- src/plugins/xml/XmlParser.cpp | 68 ++++++++++++++++++++++++++++++----------- 3 files changed, 98 insertions(+), 24 deletions(-) diff --git a/src/core/parser/ParserScope.cpp b/src/core/parser/ParserScope.cpp index 1937697..b97dabd 100644 --- a/src/core/parser/ParserScope.cpp +++ b/src/core/parser/ParserScope.cpp @@ -90,10 +90,23 @@ Rooted ParserScopeBase::select(RttiSet types, int maxDepth) return nodes[i]; } } - throw LoggableException{ - std::string( - "Expected be inside an element of one of the internal types ") + - Utils::join(types, "\", \"", "\"", "\"")}; + return nullptr; +} + +Rooted ParserScopeBase::selectOrThrow(RttiSet types, int maxDepth) +{ + Rooted res = select(types, maxDepth); + if (res == nullptr) { + std::vector typenames; + for (auto type : types) { + typenames.push_back(type->name); + } + throw LoggableException{std::string( + "Expected to be inside an element of one " + "of the internal types ") + + Utils::join(typenames, "\", \"", "\"", "\"")}; + } + return res; } /* Class DeferredResolution */ diff --git a/src/core/parser/ParserScope.hpp b/src/core/parser/ParserScope.hpp index dc1b1bf..7be3c4a 100644 --- a/src/core/parser/ParserScope.hpp +++ b/src/core/parser/ParserScope.hpp @@ -143,6 +143,33 @@ public: */ Rooted getLeaf() const; + /** + * Ascends in the stack starting with the leaf node, returns the first node + * that matches the type given in the RttiSet or nullptr if none matches. + * + * @param types is a set of Rtti types for which should be searched in the + * stack. + * @param maxDepth is the maximum number of stack entries the selection + * function may ascend. A negative value indicates no limitation. + * @return the matching node or nullptr if the node was not found. + */ + Rooted select(RttiSet types, int maxDepth = -1); + + /** + * Ascends in the stack starting with the leaf node, returns the first node + * that matches the given type or nullptr if none matches. + * + * @tparam T is the type that should be searched in the stack. + * @param maxDepth is the maximum number of stack entries the selection + * function may ascend. A negative value indicates no limitation. + * @return the matching node or nullptr if the node was not found. + */ + template + Rooted select(int maxDepth = -1) + { + return select(RttiSet{&typeOf()}, maxDepth).cast(); + } + /** * Ascends in the stack starting with the leaf node, returns the first node * that matches the type given in the RttiSet. Throws an exception if no @@ -154,7 +181,7 @@ public: * function may ascend. A negative value indicates no limitation. * @return the matching node. */ - Rooted select(RttiSet types, int maxDepth = -1); + Rooted selectOrThrow(RttiSet types, int maxDepth = -1); /** * Ascends in the stack starting with the leaf node, returns the first node @@ -166,9 +193,9 @@ public: * @return the matching node. */ template - Rooted select(int maxDepth = -1) + Rooted selectOrThrow(int maxDepth = -1) { - return select(RttiSet{&typeOf()}, maxDepth).cast(); + return selectOrThrow(RttiSet{&typeOf()}, maxDepth).cast(); } }; diff --git a/src/plugins/xml/XmlParser.cpp b/src/plugins/xml/XmlParser.cpp index f4e5caf..e56d528 100644 --- a/src/plugins/xml/XmlParser.cpp +++ b/src/plugins/xml/XmlParser.cpp @@ -86,12 +86,6 @@ public: project()->createTypesystem(args["name"].asString()); typesystem->setLocation(location()); - // Check whether this typesystem is a direct child of a domain - Handle parent = scope().select({&RttiTypes::Domain}); - if (parent != nullptr) { - parent.cast()->referenceTypesystem(typesystem); - } - // Push the typesystem onto the scope, set the POST_HEAD flag to true scope().push(typesystem); scope().setFlag(ParserFlag::POST_HEAD, false); @@ -105,7 +99,7 @@ public: } }; -class TypesystemStructHandler : public Handler { +class TypesystemEnumHandler : public Handler { public: using Handler::Handler; @@ -118,7 +112,7 @@ public: const std::string &parent = args["parent"].asString(); // Fetch the current typesystem and create the struct node - Rooted typesystem = scope().select(); + Rooted typesystem = scope().selectOrThrow(); Rooted structType = typesystem->createStructType(name); structType->setLocation(location()); @@ -134,14 +128,54 @@ public: } }); } + scope().push(structType); + } + + void end() override + { + scope().pop(); + } + + static Handler *create(const HandlerData &handlerData) + { + return new TypesystemEnumHandler{handlerData}; + } +}; + +class TypesystemStructHandler : public Handler { +public: + using Handler::Handler; + + void start(Variant::mapType &args) override + { + scope().setFlag(ParserFlag::POST_HEAD, true); - // Descend into the struct type + // Fetch the arguments used for creating this type + const std::string &name = args["name"].asString(); + const std::string &parent = args["parent"].asString(); + + // Fetch the current typesystem and create the struct node + Rooted typesystem = scope().selectOrThrow(); + Rooted structType = typesystem->createStructType(name); + structType->setLocation(location()); + + // Try to resolve the parent type and set it as parent structure + if (!parent.empty()) { + scope().resolve( + parent, structType, logger(), + [](Handle parent, Handle structType, + Logger &logger) { + if (parent != nullptr) { + structType.cast()->setParentStructure( + parent.cast(), logger); + } + }); + } scope().push(structType); } void end() override { - // Descend from the struct type scope().pop(); } @@ -164,7 +198,7 @@ public: const bool optional = !(defaultValue.isObject() && defaultValue.asObject() == nullptr); - Rooted structType = scope().select(); + Rooted structType = scope().selectOrThrow(); Rooted attribute = structType->createAttribute(name, defaultValue, optional, logger()); attribute->setLocation(location()); @@ -212,7 +246,7 @@ public: const std::string &type = args["type"].asString(); const Variant &value = args["value"]; - Rooted typesystem = scope().select(); + Rooted typesystem = scope().selectOrThrow(); Rooted constant = typesystem->createConstant(name, value); constant->setLocation(location()); @@ -266,7 +300,7 @@ public: const std::string &isa = args["isa"].asString(); - Rooted domain = scope().select(); + Rooted domain = scope().selectOrThrow(); Rooted structuredClass = domain->createStructuredClass( args["name"].asString(), args["cardinality"].asCardinality(), nullptr, nullptr, args["transparent"].asBool(), @@ -439,13 +473,14 @@ static const ParserState Typesystem = .elementHandler(TypesystemHandler::create) .arguments({Argument::String("name", "")}); static const ParserState TypesystemEnum = - ParserStateBuilder().createdNodeType(&RttiTypes::EnumType).parent( - &Typesystem); + ParserStateBuilder() + .createdNodeType(&RttiTypes::EnumType) + .elementHandler(TypesystemEnumHandler::create) + .parent(&Typesystem); static const ParserState TypesystemStruct = ParserStateBuilder() .parent(&Typesystem) .createdNodeType(&RttiTypes::StructType) - .elementHandler(TypesystemStructHandler::create) .arguments({Argument::String("name"), Argument::String("parent", "")}); static const ParserState TypesystemStructField = @@ -458,7 +493,6 @@ static const ParserState TypesystemConstant = ParserStateBuilder() .parent(&Typesystem) .createdNodeType(&RttiTypes::Constant) - .elementHandler(TypesystemConstantHandler::create) .arguments({Argument::String("name"), Argument::String("type"), Argument::Any("value")}); -- cgit v1.2.3 From 835cca85ee45dd1b6722d761999c07c33fb97cc9 Mon Sep 17 00:00:00 2001 From: Andreas Stöckel Date: Wed, 4 Feb 2015 01:45:41 +0100 Subject: Implemented parsing of enum types --- src/core/model/Typesystem.cpp | 79 ++++++++++++++++++++++++-------------- src/core/model/Typesystem.hpp | 74 ++++++++++++++++++++++++++--------- src/plugins/xml/XmlParser.cpp | 70 ++++++++++++++++++++------------- test/core/model/TypesystemTest.cpp | 1 + testdata/xmlparser/color.oxm | 4 +- testdata/xmlparser/generic.oxm | 33 +++++++++------- 6 files changed, 173 insertions(+), 88 deletions(-) diff --git a/src/core/model/Typesystem.cpp b/src/core/model/Typesystem.cpp index 7dd5613..a3c5b6d 100644 --- a/src/core/model/Typesystem.cpp +++ b/src/core/model/Typesystem.cpp @@ -67,10 +67,7 @@ bool Type::build(Variant &data, Logger &logger) const return build(data, logger, NullMagicCallback); } -bool Type::doCheckIsa(Handle type) const -{ - return false; -} +bool Type::doCheckIsa(Handle type) const { return false; } bool Type::checkIsa(Handle type) const { @@ -114,6 +111,11 @@ bool StringType::doBuild(Variant &data, Logger &logger, /* Class EnumType */ +EnumType::EnumType(Manager &mgr, std::string name, Handle system) + : Type(mgr, std::move(name), system, false), nextOrdinalValue(0) +{ +} + bool EnumType::doBuild(Variant &data, Logger &logger, const MagicCallback &magicCallback) const { @@ -145,32 +147,45 @@ bool EnumType::doBuild(Variant &data, Logger &logger, throw LoggableException{"Expected integer or identifier", data}; } -Rooted EnumType::createValidated( - Manager &mgr, std::string name, Handle system, - const std::vector &values, Logger &logger) -{ - // Map used to store the unique values of the enum - std::map unique_values; - - // The given vector may not be empty +bool EnumType::doValidate(Logger &logger) const{ + bool ok = true; if (values.empty()) { - logger.error("Enumeration constants may not be empty."); + logger.error("Enum type must have at least one entry", *this); + ok = false; } + return ok & validateName(logger); +} - // Iterate over the input vector, check the constant names for validity and - // uniqueness and insert them into the internal values map - for (size_t i = 0; i < values.size(); i++) { - if (!Utils::isIdentifier(values[i])) { - logger.error(std::string("\"") + values[i] + - "\" is no valid identifier."); - } +void EnumType::addEntry(const std::string &entry, Logger &logger) +{ + if (!Utils::isIdentifier(entry)) { + logger.error(std::string("\"") + entry + + "\" is not a valid identifier."); + return; + } - if (!(unique_values.insert(std::make_pair(values[i], i))).second) { - logger.error(std::string("The value ") + values[i] + - " was duplicated."); - } + if (!values.emplace(entry, nextOrdinalValue).second) { + logger.error(std::string("The enumeration entry ") +entry + + std::string(" was duplicated")); + return; + } + nextOrdinalValue++; +} + +void EnumType::addEntries(const std::vector &entries, Logger &logger) +{ + for (const std::string &entry: entries) { + addEntry(entry, logger); } - return new EnumType{mgr, name, system, unique_values}; +} + +Rooted EnumType::createValidated( + Manager &mgr, std::string name, Handle system, + const std::vector &entries, Logger &logger) +{ + Rooted type = new EnumType{mgr, name, system}; + type->addEntries(entries, logger); + return type; } std::string EnumType::nameOf(Ordinal i) const @@ -390,12 +405,15 @@ bool StructType::buildFromMap(Variant &data, Logger &logger, ok = false; logger.error(std::string("Invalid attribute key \"") + key + std::string("\""), - value); + data); } } // Copy the built array to the result and insert missing default values + // TODO: Nicer way of assigning a new variant value and keeping location? + SourceLocation loc = data.getLocation(); data = arr; + data.setLocation(loc); return insertDefaults(data, set, logger) && ok; } @@ -470,7 +488,6 @@ bool StructType::doCheckIsa(Handle type) const return false; } - Rooted StructType::createValidated( Manager &mgr, std::string name, Handle system, Handle parentStructure, const NodeVector &attributes, @@ -625,7 +642,6 @@ bool ArrayType::doCheckIsa(Handle type) const return t1->checkIsa(t2); } - /* Class UnknownType */ bool UnknownType::doBuild(Variant &, Logger &, const MagicCallback &) const @@ -706,6 +722,13 @@ Rooted Typesystem::createStructType(const std::string &name) return structType; } +Rooted Typesystem::createEnumType(const std::string &name) +{ + Rooted enumType{new EnumType(getManager(), name, this)}; + addType(enumType); + return enumType; +} + Rooted Typesystem::createConstant(const std::string &name, Variant value) { diff --git a/src/core/model/Typesystem.hpp b/src/core/model/Typesystem.hpp index 7581626..819f90d 100644 --- a/src/core/model/Typesystem.hpp +++ b/src/core/model/Typesystem.hpp @@ -371,26 +371,16 @@ public: private: /** - * Map containing the enumeration type values and the associated integer - * representation. + * Value holding the next ordinal value that is to be used when adding a new + * type. */ - const std::map values; + Ordinal nextOrdinalValue; /** - * Private constructor of the EnumType class used to create a new EnumType - * instance from a previously created name to value map. The parameters are - * not checked for validity. - * - * @param mgr is the underlying Manager instance. - * @param name is the name of the EnumType instance. Should be a valid - * identifier. - * @param values is a vector containing the enumeration type constants. + * Map containing the enumeration type values and the associated integer + * representation. */ - EnumType(Manager &mgr, std::string name, Handle system, - std::map values) - : Type(mgr, std::move(name), system, false), values(std::move(values)) - { - } + std::map values; protected: /** @@ -405,7 +395,46 @@ protected: bool doBuild(Variant &data, Logger &logger, const MagicCallback &magicCallback) const override; + /** + * Returns true if the internal value list is non-empty. + * + * @param logger is the logger instance to which validation errors are + * logged. + */ + bool doValidate(Logger &logger) const override; + public: + /** + * Constructor of the EnumType class. + * + * @param mgr is the underlying Manager instance. + * @param name is the name of the EnumType instance. Should be a valid + * identifier. + * @param system is the parent typesystem. + */ + EnumType(Manager &mgr, std::string name, Handle system); + + /** + * Adds a new entry to the enum. The enum element is validated, errors + * are logged in the given logger instance. + * + * @param entry is the name of the enum element that should be added. + * @param logger is the logger instance that should be used to write error + * messages. + */ + void addEntry(const std::string &entry, Logger &logger); + + /** + * Adds a new entry to the enum. The enum element is validated, errors + * are logged in the given logger instance. + * + * @param entires is a list containing the enum elements that should be + * added. + * @param logger is the logger instance that should be used to write error + * messages. + */ + void addEntries(const std::vector &entries, Logger &logger); + /** * Creates a new enum instance and validates the incomming value vector. * @@ -413,14 +442,14 @@ public: * @param name is the name of the EnumType instance. Should be a valid * identifier. * @param system is a reference to the parent Typesystem instance. - * @param values is a vector containing the enumeration type constants. + * @param entries is a vector containing the enumeration type constants. * The constants are checked for validity (must be a valid identifier) and * uniqueness (each value must exist exactly once). * @param logger is the Logger instance into which errors should be written. */ static Rooted createValidated( Manager &mgr, std::string name, Handle system, - const std::vector &values, Logger &logger); + const std::vector &entries, Logger &logger); /** * Creates a Variant containing a valid representation of a variable of this @@ -1134,6 +1163,15 @@ public: */ Rooted createStructType(const std::string &name); + /** + * Creates a new EnumType instance with the given name. Adds the new + * EnumType as member to the typesystem. + * + * @param name is the name of the structure that should be created. + * @return the new EnumType instance. + */ + Rooted createEnumType(const std::string &name); + /** * Creates a new Constant instance with the given name. Adds the new * Constant as member to the typesystem. diff --git a/src/plugins/xml/XmlParser.cpp b/src/plugins/xml/XmlParser.cpp index e56d528..92caf09 100644 --- a/src/plugins/xml/XmlParser.cpp +++ b/src/plugins/xml/XmlParser.cpp @@ -107,38 +107,50 @@ public: { scope().setFlag(ParserFlag::POST_HEAD, true); - // Fetch the arguments used for creating this type - const std::string &name = args["name"].asString(); - const std::string &parent = args["parent"].asString(); - - // Fetch the current typesystem and create the struct node + // Fetch the current typesystem and create the enum node Rooted typesystem = scope().selectOrThrow(); - Rooted structType = typesystem->createStructType(name); - structType->setLocation(location()); + Rooted enumType = + typesystem->createEnumType(args["name"].asString()); + enumType->setLocation(location()); - // Try to resolve the parent type and set it as parent structure - if (!parent.empty()) { - scope().resolve( - parent, structType, logger(), - [](Handle parent, Handle structType, - Logger &logger) { - if (parent != nullptr) { - structType.cast()->setParentStructure( - parent.cast(), logger); - } - }); - } - scope().push(structType); + scope().push(enumType); } + void end() override { scope().pop(); } + + static Handler *create(const HandlerData &handlerData) + { + return new TypesystemEnumHandler{handlerData}; + } +}; + +class TypesystemEnumEntryHandler : public Handler { +public: + using Handler::Handler; + + std::string entry; + + void start(Variant::mapType &args) override {} + void end() override { - scope().pop(); + Rooted enumType = scope().selectOrThrow(); + enumType->addEntry(entry, logger()); + } + + void data(const std::string &data, int field) override + { + if (field != 0) { + // TODO: This should be stored in the HandlerData + logger().error("Enum entry only has one field."); + return; + } + entry.append(data); } static Handler *create(const HandlerData &handlerData) { - return new TypesystemEnumHandler{handlerData}; + return new TypesystemEnumEntryHandler{handlerData}; } }; @@ -174,10 +186,7 @@ public: scope().push(structType); } - void end() override - { - scope().pop(); - } + void end() override { scope().pop(); } static Handler *create(const HandlerData &handlerData) { @@ -474,9 +483,15 @@ static const ParserState Typesystem = .arguments({Argument::String("name", "")}); static const ParserState TypesystemEnum = ParserStateBuilder() + .parent(&Typesystem) .createdNodeType(&RttiTypes::EnumType) .elementHandler(TypesystemEnumHandler::create) - .parent(&Typesystem); + .arguments({Argument::String("name")}); +static const ParserState TypesystemEnumEntry = + ParserStateBuilder() + .parent(&TypesystemEnum) + .elementHandler(TypesystemEnumEntryHandler::create) + .arguments({}); static const ParserState TypesystemStruct = ParserStateBuilder() .parent(&Typesystem) @@ -520,6 +535,7 @@ static const std::multimap XmlStates{ {"primitive", &DomainStructPrimitive}, {"typesystem", &Typesystem}, {"enum", &TypesystemEnum}, + {"entry", &TypesystemEnumEntry}, {"struct", &TypesystemStruct}, {"field", &TypesystemStructField}, {"constant", &TypesystemConstant}, diff --git a/test/core/model/TypesystemTest.cpp b/test/core/model/TypesystemTest.cpp index 2a2c81e..bf40356 100644 --- a/test/core/model/TypesystemTest.cpp +++ b/test/core/model/TypesystemTest.cpp @@ -400,6 +400,7 @@ TEST(EnumType, createValidated) logger.reset(); Rooted enumType{ EnumType::createValidated(mgr, "enum", nullptr, {}, logger)}; + ASSERT_FALSE(enumType->validate(logger)); ASSERT_EQ(Severity::ERROR, logger.getMaxEncounteredSeverity()); } diff --git a/testdata/xmlparser/color.oxm b/testdata/xmlparser/color.oxm index 8a12e7a..17adea4 100644 --- a/testdata/xmlparser/color.oxm +++ b/testdata/xmlparser/color.oxm @@ -1,5 +1,5 @@ - + @@ -15,4 +15,4 @@ - + diff --git a/testdata/xmlparser/generic.oxm b/testdata/xmlparser/generic.oxm index 820deea..a23d5f8 100644 --- a/testdata/xmlparser/generic.oxm +++ b/testdata/xmlparser/generic.oxm @@ -1,21 +1,28 @@ - - color.oxm - - + + ./color.oxm + + + none + dotted + dashed + solid + double + groove + ridge + inset + outset + - - - - + + + + - + +