Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yangutils.parser.impl.listeners; |
| 18 | |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 19 | import org.onosproject.yangutils.datamodel.YangContainer; |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 20 | import org.onosproject.yangutils.datamodel.YangList; |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 21 | import org.onosproject.yangutils.datamodel.YangModule; |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.datamodel.YangNode; |
| 23 | import org.onosproject.yangutils.datamodel.YangNodeType; |
| 24 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 25 | import org.onosproject.yangutils.parser.Parsable; |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 26 | import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser; |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 27 | import org.onosproject.yangutils.parser.exceptions.ParserException; |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 28 | import org.onosproject.yangutils.parser.impl.TreeWalkListener; |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 29 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerCollisionDetector.detectCollidingChildUtil; |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 30 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.ENTRY; |
| 31 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.EXIT; |
| 32 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructExtendedListenerErrorMessage; |
| 33 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructListenerErrorMessage; |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 34 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.INVALID_HOLDER; |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 35 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.MISSING_CURRENT_HOLDER; |
| 36 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.MISSING_HOLDER; |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 37 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.UNHANDLED_PARSED_DATA; |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 38 | import org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation; |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 39 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.checkStackIsNotEmpty; |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 40 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.validateCardinality; |
| 41 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.validateCardinalityNonNull; |
| 42 | import static org.onosproject.yangutils.utils.YangConstructType.CONFIG_DATA; |
| 43 | import static org.onosproject.yangutils.utils.YangConstructType.DATA_DEF_DATA; |
| 44 | import static org.onosproject.yangutils.utils.YangConstructType.DESCRIPTION_DATA; |
| 45 | import static org.onosproject.yangutils.utils.YangConstructType.KEY_DATA; |
| 46 | import static org.onosproject.yangutils.utils.YangConstructType.LIST_DATA; |
| 47 | import static org.onosproject.yangutils.utils.YangConstructType.MAX_ELEMENT_DATA; |
| 48 | import static org.onosproject.yangutils.utils.YangConstructType.MIN_ELEMENT_DATA; |
| 49 | import static org.onosproject.yangutils.utils.YangConstructType.REFERENCE_DATA; |
| 50 | import static org.onosproject.yangutils.utils.YangConstructType.STATUS_DATA; |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 51 | |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 52 | /* |
| 53 | * Reference: RFC6020 and YANG ANTLR Grammar |
| 54 | * |
| 55 | * ABNF grammar as per RFC6020 |
| 56 | * list-stmt = list-keyword sep identifier-arg-str optsep |
| 57 | * "{" stmtsep |
| 58 | * ;; these stmts can appear in any order |
| 59 | * [when-stmt stmtsep] |
| 60 | * *(if-feature-stmt stmtsep) |
| 61 | * *(must-stmt stmtsep) |
| 62 | * [key-stmt stmtsep] |
| 63 | * *(unique-stmt stmtsep) |
| 64 | * [config-stmt stmtsep] |
| 65 | * [min-elements-stmt stmtsep] |
| 66 | * [max-elements-stmt stmtsep] |
| 67 | * [ordered-by-stmt stmtsep] |
| 68 | * [status-stmt stmtsep] |
| 69 | * [description-stmt stmtsep] |
| 70 | * [reference-stmt stmtsep] |
| 71 | * *((typedef-stmt / |
| 72 | * grouping-stmt) stmtsep) |
| 73 | * 1*(data-def-stmt stmtsep) |
| 74 | * "}" |
| 75 | * |
| 76 | * ANTLR grammar rule |
| 77 | * listStatement : LIST_KEYWORD IDENTIFIER LEFT_CURLY_BRACE (whenStatement | ifFeatureStatement | mustStatement | |
| 78 | * keyStatement | uniqueStatement | configStatement | minElementsStatement | maxElementsStatement | |
| 79 | * orderedByStatement | statusStatement | descriptionStatement | referenceStatement | typedefStatement | |
| 80 | * groupingStatement| dataDefStatement)* RIGHT_CURLY_BRACE; |
| 81 | */ |
| 82 | |
| 83 | /** |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 84 | * Implements listener based call back function corresponding to the "list" rule |
| 85 | * defined in ANTLR grammar file for corresponding ABNF rule in RFC 6020. |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 86 | */ |
| 87 | public final class ListListener { |
| 88 | |
| 89 | /** |
| 90 | * Creates a new list listener. |
| 91 | */ |
| 92 | private ListListener() { |
| 93 | } |
| 94 | |
| 95 | /** |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 96 | * It is called when parser receives an input matching the grammar rule |
| 97 | * (list), performs validation and updates the data model tree. |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 98 | * |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 99 | * @param listener listener's object |
| 100 | * @param ctx context object of the grammar rule |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 101 | */ |
| 102 | public static void processListEntry(TreeWalkListener listener, |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 103 | GeneratedYangParser.ListStatementContext ctx) { |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 104 | |
| 105 | YangNode curNode; |
| 106 | |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 107 | checkStackIsNotEmpty(listener, MISSING_HOLDER, LIST_DATA, ctx.IDENTIFIER().getText(), ENTRY); |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 108 | |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 109 | // Validate sub statement cardinality. |
| 110 | validateSubStatementsCardinality(ctx); |
| 111 | |
| 112 | // Check for identifier collision |
| 113 | int line = ctx.IDENTIFIER().getSymbol().getLine(); |
| 114 | int charPositionInLine = ctx.IDENTIFIER().getSymbol().getCharPositionInLine(); |
| 115 | String identifierName = ctx.IDENTIFIER().getText(); |
| 116 | detectCollidingChildUtil(listener, line, charPositionInLine, identifierName, LIST_DATA); |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 117 | |
| 118 | YangList yangList = new YangList(YangNodeType.LIST_NODE); |
| 119 | yangList.setName(ctx.IDENTIFIER().getText()); |
| 120 | |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 121 | /* |
| 122 | * If "config" is not specified, the default is the same as the parent |
| 123 | * schema node's "config" value. |
| 124 | */ |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 125 | if (ctx.configStatement().isEmpty()) { |
| 126 | boolean parentConfig = ListenerValidation.getParentNodeConfig(listener); |
| 127 | yangList.setConfig(parentConfig); |
| 128 | } |
| 129 | |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 130 | Parsable curData = listener.getParsedDataStack().peek(); |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 131 | if ((curData instanceof YangModule) || (curData instanceof YangContainer) |
| 132 | || (curData instanceof YangList)) { |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 133 | curNode = (YangNode) curData; |
| 134 | try { |
| 135 | curNode.addChild(yangList); |
| 136 | } catch (DataModelException e) { |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 137 | throw new ParserException(constructExtendedListenerErrorMessage(UNHANDLED_PARSED_DATA, |
| 138 | LIST_DATA, ctx.IDENTIFIER().getText(), ENTRY, e.getMessage())); |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 139 | } |
| 140 | listener.getParsedDataStack().push(yangList); |
| 141 | } else { |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 142 | throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, LIST_DATA, |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 143 | ctx.IDENTIFIER().getText(), ENTRY)); |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 144 | } |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 145 | } |
| 146 | |
| 147 | /** |
| 148 | * It is called when parser exits from grammar rule (list), it performs |
| 149 | * validation and updates the data model tree. |
| 150 | * |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 151 | * @param listener listener's object |
| 152 | * @param ctx context object of the grammar rule |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 153 | */ |
| 154 | public static void processListExit(TreeWalkListener listener, |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 155 | GeneratedYangParser.ListStatementContext ctx) { |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 156 | |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 157 | checkStackIsNotEmpty(listener, MISSING_HOLDER, LIST_DATA, ctx.IDENTIFIER().getText(), EXIT); |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 158 | |
| 159 | if (listener.getParsedDataStack().peek() instanceof YangList) { |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 160 | YangList yangList = (YangList) listener.getParsedDataStack().peek(); |
| 161 | try { |
| 162 | yangList.validateDataOnExit(); |
| 163 | } catch (DataModelException e) { |
| 164 | throw new ParserException(constructExtendedListenerErrorMessage(UNHANDLED_PARSED_DATA, |
| 165 | LIST_DATA, ctx.IDENTIFIER().getText(), EXIT, e.getMessage())); |
| 166 | } |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 167 | listener.getParsedDataStack().pop(); |
| 168 | } else { |
Vidyashree Rama | f67c4ba | 2016-02-24 12:28:22 +0530 | [diff] [blame] | 169 | throw new ParserException(constructListenerErrorMessage(MISSING_CURRENT_HOLDER, LIST_DATA, |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 170 | ctx.IDENTIFIER().getText(), EXIT)); |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 171 | } |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Validates the cardinality of list sub-statements as per grammar. |
| 176 | * |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 177 | * @param ctx context object of the grammar rule |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 178 | */ |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 179 | private static void validateSubStatementsCardinality(GeneratedYangParser.ListStatementContext ctx) { |
Vidyashree Rama | b24ca90 | 2016-02-13 21:47:58 +0530 | [diff] [blame] | 180 | |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 181 | validateCardinality(ctx.keyStatement(), KEY_DATA, LIST_DATA, ctx.IDENTIFIER().getText()); |
| 182 | validateCardinality(ctx.configStatement(), CONFIG_DATA, LIST_DATA, ctx.IDENTIFIER().getText()); |
| 183 | validateCardinality(ctx.maxElementsStatement(), MAX_ELEMENT_DATA, LIST_DATA, ctx.IDENTIFIER().getText()); |
| 184 | validateCardinality(ctx.minElementsStatement(), MIN_ELEMENT_DATA, LIST_DATA, ctx.IDENTIFIER().getText()); |
| 185 | validateCardinality(ctx.descriptionStatement(), DESCRIPTION_DATA, LIST_DATA, ctx.IDENTIFIER().getText()); |
| 186 | validateCardinality(ctx.referenceStatement(), REFERENCE_DATA, LIST_DATA, ctx.IDENTIFIER().getText()); |
| 187 | validateCardinality(ctx.statusStatement(), STATUS_DATA, LIST_DATA, ctx.IDENTIFIER().getText()); |
| 188 | validateCardinalityNonNull(ctx.dataDefStatement(), DATA_DEF_DATA, LIST_DATA, ctx.IDENTIFIER().getText()); |
| 189 | //TODO when, typedef, grouping, unique |
Vidyashree Rama | fe971cb | 2016-02-12 18:44:12 +0530 | [diff] [blame] | 190 | } |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame^] | 191 | } |