Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0f7908b | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 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 | |
| 19 | import org.onosproject.yangutils.datamodel.YangNode; |
| 20 | import org.onosproject.yangutils.datamodel.YangOutput; |
| 21 | import org.onosproject.yangutils.datamodel.YangRpc; |
| 22 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 23 | import org.onosproject.yangutils.parser.Parsable; |
| 24 | import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser; |
| 25 | import org.onosproject.yangutils.parser.exceptions.ParserException; |
| 26 | import org.onosproject.yangutils.parser.impl.TreeWalkListener; |
| 27 | |
| 28 | import static org.onosproject.yangutils.datamodel.utils.GeneratedLanguage.JAVA_GENERATION; |
| 29 | import static org.onosproject.yangutils.datamodel.utils.YangDataModelFactory.getYangOutputNode; |
| 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 | 02a60de | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 34 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.INVALID_HOLDER; |
| 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; |
| 37 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.UNHANDLED_PARSED_DATA; |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.checkStackIsNotEmpty; |
janani b | 06eca9b | 2016-04-26 18:49:20 +0530 | [diff] [blame^] | 39 | import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.validateCardinalityNonZero; |
| 40 | import static org.onosproject.yangutils.utils.YangConstructType.DATA_DEF_DATA; |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 41 | import static org.onosproject.yangutils.utils.YangConstructType.OUTPUT_DATA; |
| 42 | |
| 43 | /* |
| 44 | * Reference: RFC6020 and YANG ANTLR Grammar |
| 45 | * |
| 46 | * ABNF grammar as per RFC6020 |
| 47 | * |
| 48 | * output-stmt = output-keyword optsep |
| 49 | * "{" stmtsep |
| 50 | * ;; these stmts can appear in any order |
| 51 | * *((typedef-stmt / |
| 52 | * grouping-stmt) stmtsep) |
| 53 | * 1*(data-def-stmt stmtsep) |
| 54 | * "}" |
| 55 | * |
| 56 | * outputStatement : OUTPUT_KEYWORD LEFT_CURLY_BRACE outputStatementBody RIGHT_CURLY_BRACE; |
| 57 | |
| 58 | * outputStatementBody : typedefStatement* dataDefStatement+ |
| 59 | * | dataDefStatement+ typedefStatement* |
| 60 | * | groupingStatement* dataDefStatement+ |
| 61 | * | dataDefStatement+ groupingStatement*; |
| 62 | */ |
| 63 | |
| 64 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 65 | * Represents listener based call back function corresponding to the "output" |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 66 | * rule defined in ANTLR grammar file for corresponding ABNF rule in RFC 6020. |
| 67 | */ |
| 68 | public final class OutputListener { |
| 69 | |
Gaurav Agrawal | 02a60de | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 70 | private static final String OUTPUT_KEYWORD = "_output"; |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 71 | |
| 72 | /** |
| 73 | * Creates a new output listener. |
| 74 | */ |
| 75 | private OutputListener() { |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * It is called when parser receives an input matching the grammar rule |
| 80 | * (output), performs validation and updates the data model tree. |
| 81 | * |
| 82 | * @param listener listener's object |
Gaurav Agrawal | 02a60de | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 83 | * @param ctx context object of the grammar rule |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 84 | */ |
| 85 | public static void processOutputEntry(TreeWalkListener listener, |
Gaurav Agrawal | 02a60de | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 86 | GeneratedYangParser.OutputStatementContext ctx) { |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 87 | |
| 88 | // Check for stack to be non empty. |
| 89 | checkStackIsNotEmpty(listener, MISSING_HOLDER, OUTPUT_DATA, "", ENTRY); |
| 90 | |
janani b | 06eca9b | 2016-04-26 18:49:20 +0530 | [diff] [blame^] | 91 | validateCardinalityNonZero(ctx.dataDefStatement(), DATA_DEF_DATA, |
| 92 | OUTPUT_DATA, "", ctx); |
| 93 | |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 94 | Parsable curData = listener.getParsedDataStack().peek(); |
| 95 | if (curData instanceof YangRpc) { |
| 96 | |
| 97 | YangOutput yangOutput = getYangOutputNode(JAVA_GENERATION); |
| 98 | yangOutput.setName(((YangRpc) curData).getName() + OUTPUT_KEYWORD); |
| 99 | YangNode curNode = (YangNode) curData; |
| 100 | try { |
| 101 | curNode.addChild(yangOutput); |
| 102 | } catch (DataModelException e) { |
| 103 | throw new ParserException(constructExtendedListenerErrorMessage(UNHANDLED_PARSED_DATA, |
| 104 | OUTPUT_DATA, "", ENTRY, e.getMessage())); |
| 105 | } |
| 106 | listener.getParsedDataStack().push(yangOutput); |
| 107 | } else { |
| 108 | throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, OUTPUT_DATA, |
| 109 | "", ENTRY)); |
| 110 | } |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * It is called when parser exits from grammar rule (output), it perform |
| 115 | * validations and updates the data model tree. |
| 116 | * |
| 117 | * @param listener listener's object |
Gaurav Agrawal | 02a60de | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 118 | * @param ctx context object of the grammar rule |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 119 | */ |
| 120 | public static void processOutputExit(TreeWalkListener listener, |
Gaurav Agrawal | 02a60de | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 121 | GeneratedYangParser.OutputStatementContext ctx) { |
Vidyashree Rama | 09e1ca5 | 2016-03-29 12:00:42 +0530 | [diff] [blame] | 122 | |
| 123 | // Check for stack to be non empty. |
| 124 | checkStackIsNotEmpty(listener, MISSING_HOLDER, OUTPUT_DATA, "", EXIT); |
| 125 | |
| 126 | if (!(listener.getParsedDataStack().peek() instanceof YangOutput)) { |
| 127 | throw new ParserException(constructListenerErrorMessage(MISSING_CURRENT_HOLDER, OUTPUT_DATA, |
| 128 | "", EXIT)); |
| 129 | } |
| 130 | listener.getParsedDataStack().pop(); |
| 131 | } |
| 132 | } |