[ONOS-3880, 3881] Yang Listener for Module and Sub-Module
Change-Id: Iee75c3e04af9b66ebc38acb3396aa4c54af5a268
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/ParsableDataType.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/ParsableDataType.java
index 50addeb..41d790d 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/ParsableDataType.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/ParsableDataType.java
@@ -130,7 +130,186 @@
REVISION_DATA,
/**
+ * Identifies the YANG revision date parsed data.
+ */
+ REVISION_DATE_DATA,
+
+ /**
* Identifies the YANG namespace parsed data.
*/
- NAMESPACE_DATA
-}
+ NAMESPACE_DATA,
+
+ /**
+ * Identifies the YANG contact parsed data.
+ */
+ CONTACT_DATA,
+
+ /**
+ * Identifies the YANG config parsed data.
+ */
+ CONFIG_DATA,
+
+ /**
+ * Identifies the YANG description parsed data.
+ */
+ DESCRIPTION_DATA,
+
+ /**
+ * Identifies the YANG key parsed data.
+ */
+ KEY_DATA,
+
+ /**
+ * Identifies the YANG mandatory parsed data.
+ */
+ MANDATORY_DATA,
+
+ /**
+ * Identifies the YANG max element parsed data.
+ */
+ MAX_ELEMENT_DATA,
+
+ /**
+ * Identifies the YANG min element parsed data.
+ */
+ MIN_ELEMENT_DATA,
+
+ /**
+ * Identifies the YANG presence element parsed data.
+ */
+ PRESENCE_DATA,
+
+ /**
+ * Identifies the YANG reference element parsed data.
+ */
+ REFERENCE_DATA,
+
+ /**
+ * Identifies the YANG status element parsed data.
+ */
+ STATUS_DATA,
+
+ /**
+ * Identifies the YANG units element parsed data.
+ */
+ UNITS_DATA,
+
+ /**
+ * Identifies the YANG version element parsed data.
+ */
+ VERSION_DATA,
+
+ /**
+ * Identifies the YANG base element parsed data.
+ */
+ YANGBASE_DATA,
+
+ /**
+ * Identifies the YANG prefix element parsed data.
+ */
+ PREFIX_DATA,
+
+ /**
+ * Identifies the YANG default element parsed data.
+ */
+ DEFAULT_DATA,
+
+ /**
+ * Identifies the YANG organization parsed data.
+ */
+ ORGANIZATION_DATA;
+
+ /**
+ * Returns the YANG construct keyword corresponding to enum values.
+ *
+ * @param parsableDataType enum value for parsable data type.
+ * @return YANG construct keyword.
+ */
+ public static String getParsableDataType(ParsableDataType parsableDataType) {
+
+ switch (parsableDataType) {
+ case MODULE_DATA:
+ return "module";
+ case SUB_MODULE_DATA:
+ return "submodule";
+ case TYPEDEF_DATA:
+ return "typedef";
+ case TYPE_DATA:
+ return "type";
+ case CHOICE_DATA:
+ return "choice";
+ case CASE_DATA:
+ return "case";
+ case ENUMERATION_DATA:
+ return "enumeration";
+ case GROUPING_DATA:
+ return "grouping";
+ case USES_DATA:
+ return "uses";
+ case AUGMENT_DATA:
+ return "augment";
+ case CONTAINER_DATA:
+ return "container";
+ case LIST_DATA:
+ return "list";
+ case BELONGS_TO_DATA:
+ return "belongs-to";
+ case BIT_DATA:
+ return "bit";
+ case BITS_DATA:
+ return "bits";
+ case ENUM_DATA:
+ return "enum";
+ case IMPORT_DATA:
+ return "import";
+ case INCLUDE_DATA:
+ return "include";
+ case LEAF_DATA:
+ return "leaf";
+ case LEAF_LIST_DATA:
+ return "leaf-list";
+ case MUST_DATA:
+ return "must";
+ case REVISION_DATA:
+ return "revision";
+ case REVISION_DATE_DATA:
+ return "revision-date";
+ case NAMESPACE_DATA:
+ return "namespace";
+ case CONTACT_DATA:
+ return "contact";
+ case CONFIG_DATA:
+ return "config";
+ case DESCRIPTION_DATA:
+ return "description";
+ case KEY_DATA:
+ return "key";
+ case MANDATORY_DATA:
+ return "mandatory";
+ case MAX_ELEMENT_DATA:
+ return "max-elements";
+ case MIN_ELEMENT_DATA:
+ return "min-elements";
+ case PRESENCE_DATA:
+ return "presence";
+ case REFERENCE_DATA:
+ return "reference";
+ case STATUS_DATA:
+ return "status";
+ case UNITS_DATA:
+ return "units";
+ case VERSION_DATA:
+ return "version";
+ case YANGBASE_DATA:
+ return "yangbase";
+ case PREFIX_DATA:
+ return "prefix";
+ case ORGANIZATION_DATA:
+ return "organization";
+ case DEFAULT_DATA:
+ return "default";
+ default:
+ return "yang";
+ }
+ }
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/exceptions/ParserException.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/exceptions/ParserException.java
index 737048c..306828c 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/exceptions/ParserException.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/exceptions/ParserException.java
@@ -19,13 +19,12 @@
/**
* Base class for exceptions in parser operations.
*/
-public class ParserException extends Exception {
+public class ParserException extends RuntimeException {
private static final long serialVersionUID = 20160211L;
private int lineNumber;
private int charPositionInLine;
private String fileName;
- private String msg;
/**
* Create a new parser exception.
@@ -90,15 +89,6 @@
}
/**
- * Returns msg detail of exception in string.
- *
- * @return msg detail of exception in string
- */
- public String getMsg() {
- return this.msg;
- }
-
- /**
* Sets line number of YANG file.
*
* @param line line number of YANG file
@@ -117,15 +107,6 @@
}
/**
- * Sets the detail of exception in string.
- *
- * @param msg the detail of exception in string
- */
- public void setMsg(String msg) {
- this.msg = msg;
- }
-
- /**
* Sets file name in parser exception.
*
* @param fileName YANG file name
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/YangUtilsParserManager.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/YangUtilsParserManager.java
index 0878191..dcab33a 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/YangUtilsParserManager.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/YangUtilsParserManager.java
@@ -69,16 +69,12 @@
// Add customized error listener to catch errors during parsing.
parser.addErrorListener(parseTreeErrorListener);
- // Begin parsing YANG file and generate parse tree.
- ParseTree tree = parser.yangfile();
+ ParseTree tree;
- /**
- * Throws an parser Exception if exception flag is set i.e. exception has
- * occurred during parsing.
- */
- if (parseTreeErrorListener.isExceptionFlag()) {
- // Get the exception occurred during parsing.
- ParserException parserException = parseTreeErrorListener.getParserException();
+ try {
+ // Begin parsing YANG file and generate parse tree.
+ tree = parser.yangfile();
+ } catch (ParserException parserException) {
parserException.setFileName(yangFile);
throw parserException;
}
@@ -93,18 +89,17 @@
* Walk parse tree, provide call backs to methods in listener and
* build data model tree.
*/
- walker.walk(treeWalker, tree);
-
- // Throws an parser exception which has occurred during listener walk.
- if (treeWalker.getErrorInformation().isErrorFlag()) {
- // Create object of listener exception
- ParserException listenerException = new ParserException();
- listenerException.setMsg(treeWalker.getErrorInformation().getErrorMsg());
+ try {
+ walker.walk(treeWalker, tree);
+ } catch (ParserException listenerException) {
+ // TODO free incomplete data model tree.
listenerException.setFileName(yangFile);
throw listenerException;
+ } finally {
+ // TODO free parsable stack
}
// Returns the Root Node of the constructed data model tree.
return treeWalker.getRootNode();
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/BaseFileListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/BaseFileListener.java
index 355c268..f53a767 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/BaseFileListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/BaseFileListener.java
@@ -16,8 +16,17 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.datamodel.YangNode;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -48,7 +57,11 @@
* @param ctx context object of the grammar rule.
*/
public static void processYangFileEntry(TreeWalkListener listener, GeneratedYangParser.YangfileContext ctx) {
- // TODO method implementation
+
+ // Check if stack is empty.
+ ListenerValidation.checkStackIsEmpty(listener, ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.YANGBASE_DATA, "", ListenerErrorLocation.ENTRY);
+
}
/**
@@ -59,6 +72,25 @@
* @param ctx context object of the grammar rule.
*/
public static void processYangFileExit(TreeWalkListener listener, GeneratedYangParser.YangfileContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.YANGBASE_DATA, "", ListenerErrorLocation.EXIT);
+
+ // Data Model tree root node is set.
+ if (listener.getParsedDataStack().peek() instanceof YangModule
+ | listener.getParsedDataStack().peek() instanceof YangSubModule) {
+ listener.setRootNode((YangNode) listener.getParsedDataStack().pop());
+ } else {
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_CHILD,
+ ParsableDataType.YANGBASE_DATA, "",
+ ListenerErrorLocation.EXIT));
+ }
+
+ // Check if stack is empty.
+ ListenerValidation.checkStackIsEmpty(listener, ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.YANGBASE_DATA, "", ListenerErrorLocation.EXIT);
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/BelongsToListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/BelongsToListener.java
index efb997e..c8266dc 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/BelongsToListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/BelongsToListener.java
@@ -16,8 +16,17 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangBelongsTo;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -64,7 +73,18 @@
*/
public static void processBelongsToEntry(TreeWalkListener listener,
GeneratedYangParser.BelongstoStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.BELONGS_TO_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.ENTRY);
+
+ YangBelongsTo belongstoNode = new YangBelongsTo();
+ belongstoNode.setBelongsToModuleName(String.valueOf(ctx.IDENTIFIER().getText()));
+
+ // Push belongsto into the stack.
+ listener.getParsedDataStack().push(belongstoNode);
}
/**
@@ -76,6 +96,47 @@
*/
public static void processBelongsToExit(TreeWalkListener listener,
GeneratedYangParser.BelongstoStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.BELONGS_TO_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.EXIT);
+
+ Parsable tmpBelongstoNode = listener.getParsedDataStack().peek();
+ if (tmpBelongstoNode instanceof YangBelongsTo) {
+ listener.getParsedDataStack().pop();
+
+ // Check for stack to be empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.BELONGS_TO_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.EXIT);
+
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case SUB_MODULE_DATA: {
+ YangSubModule subModule = (YangSubModule) tmpNode;
+ subModule.setBelongsTo((YangBelongsTo) tmpBelongstoNode);
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.BELONGS_TO_DATA,
+ String.valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
+ } else {
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.MISSING_CURRENT_HOLDER,
+ ParsableDataType.BELONGS_TO_DATA,
+ String.valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ContactListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ContactListener.java
index 3ad513c..48174b5 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ContactListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ContactListener.java
@@ -16,8 +16,17 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -28,8 +37,7 @@
* [contact-stmt stmtsep]
* [description-stmt stmtsep]
* [reference-stmt stmtsep]
- * organization-stmt = organization-keyword sep string
- * optsep stmtend
+ * contact-stmt = contact-keyword sep string optsep stmtend
*
* ANTLR grammar rule
* meta_stmts : organization_stmt? contact_stmt? description_stmt? reference_stmt?
@@ -57,7 +65,7 @@
* | description_stmt? organization_stmt? contact_stmt? reference_stmt?
* | description_stmt? organization_stmt? reference_stmt? contact_stmt?
* ;
- * organization_stmt : ORGANIZATION_KEYWORD string STMTEND;
+ * contact_stmt : CONTACT_KEYWORD string STMTEND;
*/
/**
@@ -81,6 +89,32 @@
* @param ctx context object of the grammar rule.
*/
public static void processContactEntry(TreeWalkListener listener, GeneratedYangParser.ContactStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.CONTACT_DATA,
+ String.valueOf(ctx.string().getText()), ListenerErrorLocation.ENTRY);
+
+ // Obtain the node of the stack.
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case MODULE_DATA: {
+ YangModule module = (YangModule) tmpNode;
+ module.setContact(String.valueOf(ctx.string().getText()));
+ break;
+ }
+ case SUB_MODULE_DATA: {
+ YangSubModule subModule = (YangSubModule) tmpNode;
+ subModule.setContact(String.valueOf(ctx.string().getText()));
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.CONTACT_DATA,
+ String.valueOf(ctx.string().getText()),
+ ListenerErrorLocation.ENTRY));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ImportListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ImportListener.java
index ef53b3d..4740699 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ImportListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ImportListener.java
@@ -16,8 +16,18 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangImport;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -62,7 +72,18 @@
* @param ctx context object of the grammar rule.
*/
public static void processImportEntry(TreeWalkListener listener, GeneratedYangParser.ImportStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.IMPORT_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.ENTRY);
+
+ YangImport importNode = new YangImport();
+ importNode.setModuleName(String.valueOf(ctx.IDENTIFIER().getText()));
+
+ // Push import node to the stack.
+ listener.getParsedDataStack().push(importNode);
}
/**
@@ -73,6 +94,52 @@
* @param ctx context object of the grammar rule.
*/
public static void processImportExit(TreeWalkListener listener, GeneratedYangParser.ImportStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.IMPORT_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.EXIT);
+
+ Parsable tmpImportNode = listener.getParsedDataStack().peek();
+ if (tmpImportNode instanceof YangImport) {
+ listener.getParsedDataStack().pop();
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.IMPORT_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.EXIT);
+
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case MODULE_DATA: {
+ YangModule module = (YangModule) tmpNode;
+ module.addImportedInfo((YangImport) tmpImportNode);
+ break;
+ }
+ case SUB_MODULE_DATA: {
+ YangSubModule subModule = (YangSubModule) tmpNode;
+ subModule.addImportedInfo((YangImport) tmpImportNode);
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.IMPORT_DATA,
+ String.valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
+ } else {
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.MISSING_CURRENT_HOLDER,
+ ParsableDataType.IMPORT_DATA, String
+ .valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/IncludeListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/IncludeListener.java
index bc78e7d..c4678b8 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/IncludeListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/IncludeListener.java
@@ -16,8 +16,18 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangInclude;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -37,7 +47,7 @@
* linkage_stmts : (import_stmt
* | include_stmt)*;
* include_stmt : INCLUDE_KEYWORD IDENTIFIER (STMTEND | LEFT_CURLY_BRACE
- * revision_date_stmt_body? RIGHT_CURLY_BRACE);
+ * revision_date_stmt? RIGHT_CURLY_BRACE);
*/
/**
@@ -61,7 +71,17 @@
* @param ctx context object of the grammar rule.
*/
public static void processIncludeEntry(TreeWalkListener listener, GeneratedYangParser.IncludeStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.INCLUDE_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.ENTRY);
+
+ YangInclude includeNode = new YangInclude();
+ includeNode.setSubModuleName(String.valueOf(ctx.IDENTIFIER().getText()));
+
+ listener.getParsedDataStack().push(includeNode);
}
/**
@@ -72,6 +92,52 @@
* @param ctx context object of the grammar rule.
*/
public static void processIncludeExit(TreeWalkListener listener, GeneratedYangParser.IncludeStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.INCLUDE_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.EXIT);
+
+ Parsable tmpIncludeNode = listener.getParsedDataStack().peek();
+ if (tmpIncludeNode instanceof YangInclude) {
+ listener.getParsedDataStack().pop();
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.INCLUDE_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.EXIT);
+
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case MODULE_DATA: {
+ YangModule module = (YangModule) tmpNode;
+ module.addIncludedInfo((YangInclude) tmpIncludeNode);
+ break;
+ }
+ case SUB_MODULE_DATA: {
+ YangSubModule subModule = (YangSubModule) tmpNode;
+ subModule.addIncludedInfo((YangInclude) tmpIncludeNode);
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.INCLUDE_DATA,
+ String.valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
+ } else {
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.MISSING_CURRENT_HOLDER,
+ ParsableDataType.INCLUDE_DATA, String
+ .valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ModuleListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ModuleListener.java
index c83b30d..cf6309a 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ModuleListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ModuleListener.java
@@ -16,8 +16,15 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -58,7 +65,16 @@
* @param ctx context object of the grammar rule.
*/
public static void processModuleEntry(TreeWalkListener listener, GeneratedYangParser.ModuleStatementContext ctx) {
- // TODO method implementation
+
+ // Check if stack is empty.
+ ListenerValidation
+ .checkStackIsEmpty(listener, ListenerErrorType.INVALID_HOLDER, ParsableDataType.MODULE_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()), ListenerErrorLocation.ENTRY);
+
+ YangModule yangModule = new YangModule();
+ yangModule.setName(ctx.IDENTIFIER().getText());
+
+ listener.getParsedDataStack().push(yangModule);
}
/**
@@ -69,6 +85,21 @@
* @param ctx context object of the grammar rule.
*/
public static void processModuleExit(TreeWalkListener listener, GeneratedYangParser.ModuleStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.MODULE_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.EXIT);
+
+ if (!(listener.getParsedDataStack().peek() instanceof YangModule)) {
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.MISSING_CURRENT_HOLDER,
+ ParsableDataType.MODULE_DATA, String
+ .valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/NamespaceListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/NamespaceListener.java
index 6f694e1..8386788 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/NamespaceListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/NamespaceListener.java
@@ -16,8 +16,19 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.datamodel.YangNameSpace;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
+
+import java.net.URI;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -63,6 +74,53 @@
*/
public static void processNamespaceEntry(TreeWalkListener listener,
GeneratedYangParser.NamespaceStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.NAMESPACE_DATA,
+ String.valueOf(ctx.string().getText()), ListenerErrorLocation.ENTRY);
+
+ if (!validateUriValue(String.valueOf(ctx.string().getText()))) {
+ ParserException parserException = new ParserException("Invalid namespace URI");
+ parserException.setLine(ctx.string().STRING(0).getSymbol().getLine());
+ parserException.setCharPosition(ctx.string().STRING(0).getSymbol().getCharPositionInLine());
+ throw parserException;
+ }
+
+ // Obtain the node of the stack.
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case MODULE_DATA: {
+ YangModule module = (YangModule) tmpNode;
+ YangNameSpace uri = new YangNameSpace();
+ uri.setUri(String.valueOf(ctx.string().getText()));
+ module.setNameSpace(uri);
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.NAMESPACE_DATA,
+ String.valueOf(ctx.string().getText()),
+ ListenerErrorLocation.ENTRY));
+ }
}
-}
+
+ /**
+ * Validate input URI.
+ *
+ * @param uri input namespace URI
+ * @return validation result
+ */
+ private static boolean validateUriValue(String uri) {
+ uri = uri.replace("\"", "");
+ final URI tmpUri;
+ try {
+ tmpUri = URI.create(uri);
+ } catch (Exception e1) {
+ return false;
+ }
+ return true;
+ }
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/OrganizationListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/OrganizationListener.java
index e81f15f..edae08e 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/OrganizationListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/OrganizationListener.java
@@ -16,8 +16,17 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -28,7 +37,8 @@
* [contact-stmt stmtsep]
* [description-stmt stmtsep]
* [reference-stmt stmtsep]
- * contact-stmt = contact-keyword sep string optsep stmtend
+ * organization-stmt = organization-keyword sep string
+ * optsep stmtend
*
* ANTLR grammar rule
* meta_stmts : organization_stmt? contact_stmt? description_stmt? reference_stmt?
@@ -56,7 +66,7 @@
* | description_stmt? organization_stmt? contact_stmt? reference_stmt?
* | description_stmt? organization_stmt? reference_stmt? contact_stmt?
* ;
- * contact_stmt : CONTACT_KEYWORD string STMTEND;
+ * organization_stmt : ORGANIZATION_KEYWORD string STMTEND;
*/
/**
@@ -81,6 +91,32 @@
*/
public static void processOrganizationEntry(TreeWalkListener listener,
GeneratedYangParser.OrganizationStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.ORGANIZATION_DATA,
+ String.valueOf(ctx.string().getText()), ListenerErrorLocation.ENTRY);
+
+ // Obtain the node of the stack.
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case MODULE_DATA: {
+ YangModule module = (YangModule) tmpNode;
+ module.setOrganization(String.valueOf(ctx.string().getText()));
+ break;
+ }
+ case SUB_MODULE_DATA: {
+ YangSubModule subModule = (YangSubModule) tmpNode;
+ subModule.setOrganization(String.valueOf(ctx.string().getText()));
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.ORGANIZATION_DATA,
+ String.valueOf(ctx.string().getText()),
+ ListenerErrorLocation.ENTRY));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/PrefixListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/PrefixListener.java
index b02d6f4..26bc82c 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/PrefixListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/PrefixListener.java
@@ -16,8 +16,18 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangBelongsTo;
+import org.onosproject.yangutils.datamodel.YangImport;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -63,6 +73,39 @@
* @param ctx context object of the grammar rule.
*/
public static void processPrefixEntry(TreeWalkListener listener, GeneratedYangParser.PrefixStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.PREFIX_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.ENTRY);
+
+ // Obtain the node of the stack.
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case MODULE_DATA: {
+ YangModule module = (YangModule) tmpNode;
+ module.setPrefix(ctx.IDENTIFIER().getText());
+ break;
+ }
+ case IMPORT_DATA: {
+ YangImport importNode = (YangImport) tmpNode;
+ importNode.setPrefixId(ctx.IDENTIFIER().getText());
+ break;
+ }
+ case BELONGS_TO_DATA: {
+ YangBelongsTo belongstoNode = (YangBelongsTo) tmpNode;
+ belongstoNode.setPrefix(ctx.IDENTIFIER().getText());
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.PREFIX_DATA, String
+ .valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.ENTRY));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RevisionDateListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RevisionDateListener.java
index c3233ef..3f60aef 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RevisionDateListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RevisionDateListener.java
@@ -16,8 +16,17 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangImport;
+import org.onosproject.yangutils.datamodel.YangInclude;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -69,6 +78,34 @@
*/
public static void processRevisionDateEntry(TreeWalkListener listener,
GeneratedYangParser.RevisionDateStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.REVISION_DATE_DATA,
+ String.valueOf(ctx.DATE_ARG().getText()),
+ ListenerErrorLocation.ENTRY);
+
+ // Obtain the node of the stack.
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case IMPORT_DATA: {
+ YangImport importNode = (YangImport) tmpNode;
+ importNode.setRevision(String.valueOf(ctx.DATE_ARG().getText()));
+ break;
+ }
+ case INCLUDE_DATA: {
+ YangInclude includeNode = (YangInclude) tmpNode;
+ includeNode.setRevision(String.valueOf(ctx.DATE_ARG().getText()));
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.REVISION_DATE_DATA,
+ String.valueOf(ctx.DATE_ARG().getText()),
+ ListenerErrorLocation.ENTRY));
+ }
}
-}
+ // TODO Implement the DATE_ARG validation as per RFC 6020.
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RevisionListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RevisionListener.java
index c473c83..0da2f01 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RevisionListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RevisionListener.java
@@ -16,8 +16,18 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.datamodel.YangRevision;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -59,17 +69,25 @@
private RevisionListener() {
}
- /**
- * It is called when parser receives an input matching the grammar
- * rule (revision), perform validations and update the data model
- * tree.
- *
- * @param listener Listener's object.
- * @param ctx context object of the grammar rule.
- */
- public static void processRevisionEntry(TreeWalkListener listener, GeneratedYangParser.RevisionStatementContext
- ctx) {
- // TODO method implementation
+ public static void processRevisionEntry(TreeWalkListener listener,
+ GeneratedYangParser.RevisionStatementContext ctx) {
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.REVISION_DATA,
+ String.valueOf(ctx.DATE_ARG().getText()),
+ ListenerErrorLocation.ENTRY);
+
+ // Validate for reverse chronological order of revision & for revision value.
+ if (!validateRevision(listener, ctx)) {
+ return;
+ // TODO to be implemented.
+ }
+
+ YangRevision revisionNode = new YangRevision();
+ revisionNode.setRevDate(String.valueOf(ctx.DATE_ARG().getText()));
+
+ listener.getParsedDataStack().push(revisionNode);
}
/**
@@ -79,8 +97,66 @@
* @param listener Listener's object.
* @param ctx context object of the grammar rule.
*/
- public static void processRevisionExit(TreeWalkListener listener, GeneratedYangParser.RevisionStatementContext
- ctx) {
- // TODO method implementation
+ public static void processRevisionExit(TreeWalkListener listener,
+ GeneratedYangParser.RevisionStatementContext ctx) {
+
+ // Check for stack to be non empty.
+ ListenerValidation
+ .checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER, ParsableDataType.REVISION_DATA,
+ String.valueOf(ctx.DATE_ARG().getText()), ListenerErrorLocation.EXIT);
+
+ Parsable tmpRevisionNode = listener.getParsedDataStack().peek();
+ if (tmpRevisionNode instanceof YangRevision) {
+ listener.getParsedDataStack().pop();
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.REVISION_DATA,
+ String.valueOf(ctx.DATE_ARG().getText()),
+ ListenerErrorLocation.EXIT);
+
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case MODULE_DATA: {
+ YangModule module = (YangModule) tmpNode;
+ module.setRevision((YangRevision) tmpRevisionNode);
+ break;
+ }
+ case SUB_MODULE_DATA: {
+ YangSubModule subModule = (YangSubModule) tmpNode;
+ subModule.setRevision((YangRevision) tmpRevisionNode);
+ break;
+ }
+ default:
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.REVISION_DATA,
+ String.valueOf(ctx.DATE_ARG()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
+ } else {
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.MISSING_CURRENT_HOLDER,
+ ParsableDataType.REVISION_DATA, String
+ .valueOf(ctx.DATE_ARG()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
}
-}
+
+ /**
+ * Validate revision.
+ *
+ * @param listener Listener's object.
+ * @param ctx context object of the grammar rule.
+ * @return validation result
+ */
+ private static boolean validateRevision(TreeWalkListener listener,
+ GeneratedYangParser.RevisionStatementContext ctx) {
+ // TODO to be implemented
+ return true;
+ }
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/SubModuleListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/SubModuleListener.java
index 25f2764..3f6fc40 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/SubModuleListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/SubModuleListener.java
@@ -16,8 +16,15 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -60,7 +67,16 @@
*/
public static void processSubModuleEntry(TreeWalkListener listener,
GeneratedYangParser.SubModuleStatementContext ctx) {
- // TODO method implementation
+
+ // Check if stack is empty.
+ ListenerValidation
+ .checkStackIsEmpty(listener, ListenerErrorType.INVALID_HOLDER, ParsableDataType.SUB_MODULE_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()), ListenerErrorLocation.ENTRY);
+
+ YangSubModule yangSubModule = new YangSubModule();
+ yangSubModule.setName(ctx.IDENTIFIER().getText());
+
+ listener.getParsedDataStack().push(yangSubModule);
}
/**
@@ -72,6 +88,21 @@
*/
public static void processSubModuleExit(TreeWalkListener listener,
GeneratedYangParser.SubModuleStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation.checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER,
+ ParsableDataType.SUB_MODULE_DATA,
+ String.valueOf(ctx.IDENTIFIER().getText()),
+ ListenerErrorLocation.EXIT);
+
+ if (!(listener.getParsedDataStack().peek() instanceof YangSubModule)) {
+ throw new ParserException(
+ ListenerErrorMessageConstruction
+ .constructListenerErrorMessage(ListenerErrorType.MISSING_CURRENT_HOLDER,
+ ParsableDataType.SUB_MODULE_DATA,
+ String.valueOf(ctx.IDENTIFIER()
+ .getText()),
+ ListenerErrorLocation.EXIT));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/VersionListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/VersionListener.java
index 02afdcf..ae9389f 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/VersionListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/listeners/VersionListener.java
@@ -16,8 +16,17 @@
package org.onosproject.yangutils.parser.impl.listeners;
+import org.onosproject.yangutils.datamodel.YangModule;
+import org.onosproject.yangutils.datamodel.YangSubModule;
+import org.onosproject.yangutils.parser.Parsable;
+import org.onosproject.yangutils.parser.ParsableDataType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType;
+import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation;
/*
* Reference: RFC6020 and YANG ANTLR Grammar
@@ -73,6 +82,48 @@
*/
public static void processVersionEntry(TreeWalkListener listener,
GeneratedYangParser.YangVersionStatementContext ctx) {
- // TODO method implementation
+
+ // Check for stack to be non empty.
+ ListenerValidation
+ .checkStackIsNotEmpty(listener, ListenerErrorType.MISSING_HOLDER, ParsableDataType.VERSION_DATA,
+ String.valueOf(ctx.INTEGER().getText()), ListenerErrorLocation.ENTRY);
+
+ Integer version = Integer.valueOf(ctx.INTEGER().getText());
+ if (!isVersionValid(version)) {
+ ParserException parserException = new ParserException("Input version not supported");
+ parserException.setLine(ctx.INTEGER().getSymbol().getLine());
+ parserException.setCharPosition(ctx.INTEGER().getSymbol().getCharPositionInLine());
+ throw parserException;
+ }
+
+ // Obtain the node of the stack.
+ Parsable tmpNode = listener.getParsedDataStack().peek();
+ switch (tmpNode.getParsableDataType()) {
+ case MODULE_DATA: {
+ YangModule module = (YangModule) tmpNode;
+ module.setVersion((byte) 1);
+ break;
+ }
+ case SUB_MODULE_DATA: {
+ YangSubModule subModule = (YangSubModule) tmpNode;
+ subModule.setVersion((byte) 1);
+ break;
+ }
+ default:
+ throw new ParserException(ListenerErrorMessageConstruction.
+ constructListenerErrorMessage(ListenerErrorType.INVALID_HOLDER,
+ ParsableDataType.VERSION_DATA, String.valueOf(ctx.INTEGER().getText()),
+ ListenerErrorLocation.ENTRY));
+ }
}
-}
+
+ /**
+ * Validates whether the value of YANG version.
+ *
+ * @param version input yang version
+ * @return validation result
+ */
+ private static boolean isVersionValid(Integer version) {
+ return version == 1;
+ }
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerError.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerError.java
index d4c8504..c5c3c8b 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerError.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerError.java
@@ -21,12 +21,18 @@
*/
public class ListenerError {
- // Maintains the state of Exception.
+ // Maintains the state of exception.
private boolean errorFlag = false;
- // Maintains the reason of Exception.
+ // Maintains the reason of exception.
private String errorMsg;
+ // Maintains the line number of exception.
+ private int lineNumber;
+
+ // Maintains the character position in lin of exception.
+ private int charPositionInLine;
+
/**
* Returns error flag.
*
@@ -37,18 +43,36 @@
}
/**
- * Returns error message.
+ * Returns reason for error.
*
- * @return error msg.
+ * @return error message
*/
public String getErrorMsg() {
return errorMsg;
}
/**
+ * Returns error line number.
+ *
+ * @return error line number.
+ */
+ public int getLineNumber() {
+ return lineNumber;
+ }
+
+ /**
+ * Returns error position in line.
+ *
+ * @return error character position in line.
+ */
+ public int getCharPositionInLine() {
+ return charPositionInLine;
+ }
+
+ /**
* Set error flag.
*
- * @param errorFlag error existence flag
+ * @param errorFlag error existence flag.
*/
public void setErrorFlag(boolean errorFlag) {
this.errorFlag = errorFlag;
@@ -62,4 +86,22 @@
public void setErrorMsg(String errorMsg) {
this.errorMsg = errorMsg;
}
+
+ /**
+ * Set error line number.
+ *
+ * @param lineNumber line number of error.
+ */
+ public void setLineNumber(int lineNumber) {
+ this.lineNumber = lineNumber;
+ }
+
+ /**
+ * Set error character position in line.
+ *
+ * @param charPositionInLine error character position in line.
+ */
+ public void setCharPositionInLine(int charPositionInLine) {
+ this.charPositionInLine = charPositionInLine;
+ }
}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorLocation.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorLocation.java
new file mode 100644
index 0000000..b989407
--- /dev/null
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorLocation.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.yangutils.parser.impl.parserutils;
+
+/**
+ * Maintains listener error location.
+ */
+public enum ListenerErrorLocation {
+ /**
+ * Represents that the error location is before processing.
+ */
+ ENTRY(),
+
+ /**
+ * Represents that the error location is before processing.
+ */
+ EXIT();
+
+ /**
+ * Returns the message corresponding to listener error location.
+ *
+ * @param errorLocation enum value for type of error.
+ * @return message corresponding to listener error location.
+ */
+ public static String getErrorLocationMessage(ListenerErrorLocation errorLocation) {
+
+ switch (errorLocation) {
+ case ENTRY:
+ return "before";
+ case EXIT:
+ return "after";
+ default:
+ return "during";
+ }
+ }
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java
new file mode 100644
index 0000000..1de8f44
--- /dev/null
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorMessageConstruction.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.yangutils.parser.impl.parserutils;
+
+import org.onosproject.yangutils.parser.ParsableDataType;
+
+/**
+ * It's a utility to help construct detailed error message.
+ */
+public final class ListenerErrorMessageConstruction {
+
+ /**
+ * Private constructor.
+ */
+ private ListenerErrorMessageConstruction() {
+ }
+
+ /**
+ * Constructs message for error with extended information and returns the same.
+ *
+ * @param errorType error type needs to be set in error message.
+ * @param parsableDataType type of parsable data in which error occurred.
+ * @param parsableDataTypeName identifier/string of parsable data type in which error occurred.
+ * @param errorLocation location where error occurred.
+ * @param extendedErrorInformation extended error information.
+ * @return constructed error message.
+ */
+ public static String constructExtendedListenerErrorMessage(ListenerErrorType errorType,
+ ParsableDataType parsableDataType,
+ String parsableDataTypeName,
+ ListenerErrorLocation errorLocation,
+ String extendedErrorInformation) {
+ String newErrorMessage;
+ newErrorMessage = constructListenerErrorMessage(errorType, parsableDataType, parsableDataTypeName,
+ errorLocation) + "\n" + "Error Information: " + extendedErrorInformation;
+ return newErrorMessage;
+ }
+
+ /**
+ * Constructs message for error during listener based tree walk and returns the same.
+ *
+ * @param errorType error type needs to be set in error message.
+ * @param parsableDataType type of parsable data in which error occurred.
+ * @param parsableDataTypeName identifier/string of parsable data type in which error occurred.
+ * @param errorLocation location where error occurred.
+ * @return constructed error message.
+ */
+ public static String constructListenerErrorMessage(ListenerErrorType errorType,
+ ParsableDataType parsableDataType,
+ String parsableDataTypeName,
+ ListenerErrorLocation errorLocation) {
+
+ String errorMessage;
+
+ errorMessage = "Internal parser error detected: " + ListenerErrorType.getErrorType(errorType) + " "
+ + ParsableDataType.getParsableDataType(parsableDataType);
+
+
+ if (!parsableDataTypeName.isEmpty()) {
+ errorMessage = errorMessage + " \"" + parsableDataTypeName + "\" ";
+ } else {
+ errorMessage = errorMessage + " ";
+
+ }
+ errorMessage = errorMessage + ListenerErrorLocation.getErrorLocationMessage(errorLocation) + " processing.";
+ return errorMessage;
+ }
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorType.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorType.java
new file mode 100644
index 0000000..13925bc
--- /dev/null
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerErrorType.java
@@ -0,0 +1,78 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.yangutils.parser.impl.parserutils;
+
+/**
+ * Maintains listener error type.
+ */
+public enum ListenerErrorType {
+ /**
+ * Represents the parent holder in parsable stack for given YANG construct is invalid.
+ */
+ INVALID_HOLDER(),
+
+ /**
+ * Represents the parent holder in parsable stack for given YANG construct is missing.
+ */
+ MISSING_HOLDER(),
+
+ /**
+ * Represents the current holder in parsable stack for given YANG construct is missing.
+ */
+ MISSING_CURRENT_HOLDER(),
+
+ /**
+ * Represents that the child in parsable stack for given YANG construct is invalid.
+ */
+ INVALID_CHILD(),
+
+ /**
+ * Represents that the cardinality for given YANG construct is invalid.
+ */
+ INVALID_CARDINALITY(),
+
+ /**
+ * Represents that some of earlier parsed data is not handled correctly.
+ */
+ UNHANDLED_PARSED_DATA();
+
+ /**
+ * Returns the message corresponding to listener error type.
+ *
+ * @param errorType enum value for type of error.
+ * @return message corresponding to listener error type.
+ */
+ public static String getErrorType(ListenerErrorType errorType) {
+
+ switch (errorType) {
+ case INVALID_HOLDER:
+ return "Invalid holder for";
+ case MISSING_HOLDER:
+ return "Missing holder at";
+ case MISSING_CURRENT_HOLDER:
+ return "Missing";
+ case INVALID_CHILD:
+ return "Invalid child in";
+ case INVALID_CARDINALITY:
+ return "Invalid cardinality in";
+ case UNHANDLED_PARSED_DATA:
+ return "Unhandled parsed data at";
+ default:
+ return "Problem in";
+ }
+ }
+}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerValidation.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerValidation.java
index 6ecded3..4399cc5 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerValidation.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerValidation.java
@@ -16,39 +16,66 @@
package org.onosproject.yangutils.parser.impl.parserutils;
+import org.onosproject.yangutils.parser.ParsableDataType;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
import org.onosproject.yangutils.parser.impl.TreeWalkListener;
/**
- * Its a utility to carry out listener validation.
+ * It's a utility to carry out listener validation.
*/
public final class ListenerValidation {
/**
- * Creates a new belongto listener.
+ * Creates a new listener validation.
*/
private ListenerValidation() {
}
/**
- * Checks if error is set or parsed data stack is empty.
+ * Checks parsed data stack is not empty.
*
* @param listener Listener's object.
- * @param errNode parsable node for which validation needs to be done.
- * @return validation result.
+ * @param errorType error type needs to be set in error message.
+ * @param parsableDataType type of parsable data in which error occurred.
+ * @param parsableDataTypeName name of parsable data type in which error occurred.
+ * @param errorLocation location where error occurred.
*/
- public static boolean preValidation(TreeWalkListener listener, String errNode) {
-
- // Check whether error found while walking YANG file, if yes return true.
- if (listener.getErrorInformation().isErrorFlag()) {
- return true;
- }
-
- // If stack is empty it indicates error condition
+ public static void checkStackIsNotEmpty(TreeWalkListener listener, ListenerErrorType errorType,
+ ParsableDataType parsableDataType, String parsableDataTypeName,
+ ListenerErrorLocation errorLocation) {
if (listener.getParsedDataStack().empty()) {
- listener.getErrorInformation().setErrorFlag(true);
- listener.getErrorInformation().setErrorMsg("Parsable stack empty at" + errNode + "entry");
- return true;
+ /*
+ * If stack is empty it indicates error condition, value of parsableDataTypeName will be null in case there
+ * is no name attached to parsable data type.
+ */
+ String message = ListenerErrorMessageConstruction.constructListenerErrorMessage(errorType, parsableDataType,
+ parsableDataTypeName, errorLocation);
+ throw new ParserException(message);
}
- return false;
+ }
+
+ /**
+ * Checks parsed data stack is empty.
+ *
+ * @param listener Listener's object.
+ * @param errorType error type needs to be set in error message.
+ * @param parsableDataType type of parsable data in which error occurred.
+ * @param parsableDataTypeName name of parsable data type in which error occurred.
+ * @param errorLocation location where error occurred.
+ */
+
+ public static void checkStackIsEmpty(TreeWalkListener listener, ListenerErrorType errorType,
+ ParsableDataType parsableDataType, String parsableDataTypeName,
+ ListenerErrorLocation errorLocation) {
+
+ if (!listener.getParsedDataStack().empty()) {
+ /*
+ * If stack is empty it indicates error condition, value of parsableDataTypeName will be null in case there
+ * is no name attached to parsable data type.
+ */
+ String message = ListenerErrorMessageConstruction.constructListenerErrorMessage(errorType, parsableDataType,
+ parsableDataTypeName, errorLocation);
+ throw new ParserException(message);
+ }
}
}
\ No newline at end of file
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ParseTreeErrorListener.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ParseTreeErrorListener.java
index d3926df..a507e3a 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ParseTreeErrorListener.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ParseTreeErrorListener.java
@@ -29,37 +29,13 @@
*/
public class ParseTreeErrorListener extends BaseErrorListener {
- // Exception of type parser exceptions are catched during parsing.
- private ParserException parserException = new ParserException();
-
- // Flag to indicate presence of exception.
- private boolean exceptionFlag = false;
-
- /**
- * Returns the status of exception flag.
- *
- * @return flag which contains the status of exception.
- */
- public boolean isExceptionFlag() {
- return exceptionFlag;
- }
-
- /**
- * Returns the parser exception object populated with line, character
- * position and message.
- *
- * @return object of parser exception.
- */
- public ParserException getParserException() {
- return parserException;
- }
-
@Override
public void syntaxError(Recognizer<?, ?> recognizer, Object offendingSymbol, int line, int charPositionInLine,
String msg, RecognitionException e) {
+
+ ParserException parserException = new ParserException(msg);
parserException.setLine(line);
parserException.setCharPosition(charPositionInLine);
- parserException.setMsg(msg);
- exceptionFlag = true;
+ throw parserException;
}
}
\ No newline at end of file