Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014-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 | |
Gaurav Agrawal | 0cb696d | 2016-03-11 00:30:12 +0530 | [diff] [blame] | 19 | import org.onosproject.yangutils.datamodel.YangContainer; |
| 20 | import org.onosproject.yangutils.datamodel.YangDataTypes; |
| 21 | import org.onosproject.yangutils.datamodel.YangDerivedType; |
| 22 | import org.onosproject.yangutils.datamodel.YangList; |
| 23 | import org.onosproject.yangutils.datamodel.YangModule; |
| 24 | import org.onosproject.yangutils.datamodel.YangNode; |
| 25 | import org.onosproject.yangutils.datamodel.YangSubModule; |
| 26 | import org.onosproject.yangutils.datamodel.YangType; |
| 27 | import org.onosproject.yangutils.datamodel.YangTypeDef; |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame^] | 28 | import org.onosproject.yangutils.datamodel.YangInput; |
| 29 | import org.onosproject.yangutils.datamodel.YangOutput; |
| 30 | import org.onosproject.yangutils.datamodel.YangNotification; |
| 31 | import org.onosproject.yangutils.datamodel.YangRpc; |
Gaurav Agrawal | 0cb696d | 2016-03-11 00:30:12 +0530 | [diff] [blame] | 32 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 33 | import org.onosproject.yangutils.parser.Parsable; |
| 34 | import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser; |
| 35 | import org.onosproject.yangutils.parser.exceptions.ParserException; |
| 36 | import org.onosproject.yangutils.parser.impl.TreeWalkListener; |
| 37 | |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.datamodel.utils.GeneratedLanguage.JAVA_GENERATION; |
| 39 | import static org.onosproject.yangutils.datamodel.utils.YangDataModelFactory.getYangTypeDefNode; |
Gaurav Agrawal | 0cb696d | 2016-03-11 00:30:12 +0530 | [diff] [blame] | 40 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.ENTRY; |
| 41 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.EXIT; |
| 42 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructExtendedListenerErrorMessage; |
| 43 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructListenerErrorMessage; |
| 44 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.INVALID_CONTENT; |
| 45 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.INVALID_HOLDER; |
| 46 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.MISSING_CURRENT_HOLDER; |
| 47 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.MISSING_HOLDER; |
| 48 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.UNHANDLED_PARSED_DATA; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 49 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerUtil.getValidIdentifier; |
Gaurav Agrawal | 0cb696d | 2016-03-11 00:30:12 +0530 | [diff] [blame] | 50 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.checkStackIsNotEmpty; |
| 51 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.validateCardinalityEqualsOne; |
| 52 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.validateCardinalityMaxOne; |
| 53 | import static org.onosproject.yangutils.utils.YangConstructType.DEFAULT_DATA; |
| 54 | import static org.onosproject.yangutils.utils.YangConstructType.DESCRIPTION_DATA; |
| 55 | import static org.onosproject.yangutils.utils.YangConstructType.REFERENCE_DATA; |
| 56 | import static org.onosproject.yangutils.utils.YangConstructType.STATUS_DATA; |
| 57 | import static org.onosproject.yangutils.utils.YangConstructType.TYPEDEF_DATA; |
| 58 | import static org.onosproject.yangutils.utils.YangConstructType.TYPE_DATA; |
| 59 | import static org.onosproject.yangutils.utils.YangConstructType.UNITS_DATA; |
| 60 | |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 61 | /* |
| 62 | * Reference: RFC6020 and YANG ANTLR Grammar |
| 63 | * |
| 64 | * body-stmts = *((extension-stmt / |
| 65 | * feature-stmt / |
| 66 | * identity-stmt / |
| 67 | * typedef-stmt / |
| 68 | * grouping-stmt / |
| 69 | * data-def-stmt / |
| 70 | * augment-stmt / |
| 71 | * rpc-stmt / |
| 72 | * notification-stmt / |
| 73 | * deviation-stmt) stmtsep) |
| 74 | * |
| 75 | * typedef-stmt = typedef-keyword sep identifier-arg-str optsep |
| 76 | * "{" stmtsep |
| 77 | * ;; these stmts can appear in any order |
| 78 | * type-stmt stmtsep |
| 79 | * [units-stmt stmtsep] |
| 80 | * [default-stmt stmtsep] |
| 81 | * [status-stmt stmtsep] |
| 82 | * [description-stmt stmtsep] |
| 83 | * [reference-stmt stmtsep] |
| 84 | * "}" |
| 85 | * |
| 86 | * ANTLR grammar rule |
Vidyashree Rama | d322132 | 2016-03-04 19:08:35 +0530 | [diff] [blame] | 87 | * typedefStatement : TYPEDEF_KEYWORD identifier LEFT_CURLY_BRACE |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 88 | * (typeStatement | unitsStatement | defaultStatement | statusStatement |
| 89 | * | descriptionStatement | referenceStatement)* RIGHT_CURLY_BRACE; |
| 90 | */ |
| 91 | |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 92 | /** |
| 93 | * Implements listener based call back function corresponding to the "typedef" |
| 94 | * rule defined in ANTLR grammar file for corresponding ABNF rule in RFC 6020. |
| 95 | */ |
| 96 | public final class TypeDefListener { |
| 97 | |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 98 | /** |
| 99 | * Creates a new typedef listener. |
| 100 | */ |
| 101 | private TypeDefListener() { |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * It is called when parser enters grammar rule (typedef), it perform |
| 106 | * validations and updates the data model tree. |
| 107 | * |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 108 | * @param listener listener's object |
| 109 | * @param ctx context object of the grammar rule |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 110 | */ |
| 111 | public static void processTypeDefEntry(TreeWalkListener listener, |
| 112 | GeneratedYangParser.TypedefStatementContext ctx) { |
| 113 | |
| 114 | // Check for stack to be non empty. |
Vidyashree Rama | d322132 | 2016-03-04 19:08:35 +0530 | [diff] [blame] | 115 | checkStackIsNotEmpty(listener, MISSING_HOLDER, TYPEDEF_DATA, ctx.identifier().getText(), ENTRY); |
| 116 | |
| 117 | String identifier = getValidIdentifier(ctx.identifier().getText(), TYPEDEF_DATA, ctx); |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 118 | |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 119 | // Validate sub statement cardinality. |
| 120 | validateSubStatementsCardinality(ctx); |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 121 | |
Vinod Kumar S | 48848f7 | 2016-02-25 15:52:16 +0530 | [diff] [blame] | 122 | /* |
| 123 | * Create a derived type information, the base type must be set in type |
| 124 | * listener. |
| 125 | */ |
| 126 | YangType<YangDerivedType> derivedType = new YangType<YangDerivedType>(); |
| 127 | derivedType.setDataType(YangDataTypes.DERIVED); |
Vidyashree Rama | d322132 | 2016-03-04 19:08:35 +0530 | [diff] [blame] | 128 | derivedType.setDataTypeName(identifier); |
Vinod Kumar S | 48848f7 | 2016-02-25 15:52:16 +0530 | [diff] [blame] | 129 | |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 130 | YangTypeDef typeDefNode = getYangTypeDefNode(JAVA_GENERATION); |
Vinod Kumar S | 48848f7 | 2016-02-25 15:52:16 +0530 | [diff] [blame] | 131 | typeDefNode.setDerivedType(derivedType); |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 132 | |
| 133 | Parsable curData = listener.getParsedDataStack().peek(); |
| 134 | |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 135 | if (curData instanceof YangModule || curData instanceof YangSubModule || curData instanceof YangContainer |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame^] | 136 | || curData instanceof YangList || curData instanceof YangNotification || curData instanceof YangRpc |
| 137 | || curData instanceof YangInput || curData instanceof YangOutput) { |
| 138 | |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 139 | /* |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame^] | 140 | * TODO YangGrouping. |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 141 | */ |
| 142 | YangNode curNode = (YangNode) curData; |
| 143 | try { |
| 144 | curNode.addChild(typeDefNode); |
| 145 | } catch (DataModelException e) { |
| 146 | throw new ParserException(constructExtendedListenerErrorMessage(UNHANDLED_PARSED_DATA, |
Vidyashree Rama | d322132 | 2016-03-04 19:08:35 +0530 | [diff] [blame] | 147 | TYPEDEF_DATA, ctx.identifier().getText(), ENTRY, e.getMessage())); |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 148 | } |
| 149 | listener.getParsedDataStack().push(typeDefNode); |
| 150 | } else { |
| 151 | throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, |
Vidyashree Rama | d322132 | 2016-03-04 19:08:35 +0530 | [diff] [blame] | 152 | TYPEDEF_DATA, ctx.identifier().getText(), ENTRY)); |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 153 | } |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * It is called when parser exits from grammar rule (typedef), it perform |
| 158 | * validations and updates the data model tree. |
| 159 | * |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 160 | * @param listener listener's object |
| 161 | * @param ctx context object of the grammar rule |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 162 | */ |
| 163 | public static void processTypeDefExit(TreeWalkListener listener, |
| 164 | GeneratedYangParser.TypedefStatementContext ctx) { |
| 165 | |
| 166 | // Check for stack to be non empty. |
Vidyashree Rama | d322132 | 2016-03-04 19:08:35 +0530 | [diff] [blame] | 167 | checkStackIsNotEmpty(listener, MISSING_HOLDER, TYPEDEF_DATA, ctx.identifier().getText(), EXIT); |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 168 | |
| 169 | if (listener.getParsedDataStack().peek() instanceof YangTypeDef) { |
Vinod Kumar S | 48848f7 | 2016-02-25 15:52:16 +0530 | [diff] [blame] | 170 | YangTypeDef typeDefNode = (YangTypeDef) listener.getParsedDataStack().peek(); |
| 171 | try { |
| 172 | typeDefNode.validateDataOnExit(); |
| 173 | } catch (DataModelException e) { |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 174 | throw new ParserException(constructListenerErrorMessage(INVALID_CONTENT, TYPEDEF_DATA, |
Vidyashree Rama | d322132 | 2016-03-04 19:08:35 +0530 | [diff] [blame] | 175 | ctx.identifier().getText(), EXIT)); |
Vinod Kumar S | 48848f7 | 2016-02-25 15:52:16 +0530 | [diff] [blame] | 176 | } |
| 177 | |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 178 | listener.getParsedDataStack().pop(); |
| 179 | } else { |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 180 | throw new ParserException(constructListenerErrorMessage(MISSING_CURRENT_HOLDER, TYPEDEF_DATA, |
Vidyashree Rama | d322132 | 2016-03-04 19:08:35 +0530 | [diff] [blame] | 181 | ctx.identifier().getText(), EXIT)); |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 182 | } |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * Validates the cardinality of typedef sub-statements as per grammar. |
| 187 | * |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 188 | * @param ctx context object of the grammar rule |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 189 | */ |
Gaurav Agrawal | db828bd | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 190 | private static void validateSubStatementsCardinality(GeneratedYangParser.TypedefStatementContext ctx) { |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 191 | |
Gaurav Agrawal | 0cb696d | 2016-03-11 00:30:12 +0530 | [diff] [blame] | 192 | validateCardinalityMaxOne(ctx.unitsStatement(), UNITS_DATA, TYPEDEF_DATA, ctx.identifier().getText()); |
| 193 | validateCardinalityMaxOne(ctx.defaultStatement(), DEFAULT_DATA, TYPEDEF_DATA, ctx.identifier().getText()); |
| 194 | validateCardinalityEqualsOne(ctx.typeStatement(), TYPE_DATA, TYPEDEF_DATA, ctx.identifier().getText(), ctx); |
| 195 | validateCardinalityMaxOne(ctx.descriptionStatement(), DESCRIPTION_DATA, TYPEDEF_DATA, |
| 196 | ctx.identifier().getText()); |
| 197 | validateCardinalityMaxOne(ctx.referenceStatement(), REFERENCE_DATA, TYPEDEF_DATA, ctx.identifier().getText()); |
| 198 | validateCardinalityMaxOne(ctx.statusStatement(), STATUS_DATA, TYPEDEF_DATA, ctx.identifier().getText()); |
Gaurav Agrawal | 0520c7c | 2016-02-21 02:56:46 +0530 | [diff] [blame] | 199 | } |
| 200 | } |