2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/eplv10.html
8 package org.opendaylight.yangtools.yang.parser.impl;
10 import static com.google.common.base.Preconditions.checkState;
12 import com.google.common.base.Optional;
13 import java.math.BigDecimal;
14 import java.math.BigInteger;
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.Date;
19 import java.util.List;
20 import java.util.Stack;
21 import org.antlr.v4.runtime.ParserRuleContext;
22 import org.antlr.v4.runtime.tree.ParseTree;
23 import org.antlr.v4.runtime.tree.TerminalNode;
24 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser;
25 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Argument_stmtContext;
26 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Base_stmtContext;
27 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Bit_stmtContext;
28 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Bits_specificationContext;
29 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Config_argContext;
30 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Config_stmtContext;
31 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Decimal64_specificationContext;
32 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Default_stmtContext;
33 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Description_stmtContext;
34 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Enum_specificationContext;
35 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Enum_stmtContext;
36 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Error_app_tag_stmtContext;
37 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Error_message_stmtContext;
38 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Fraction_digits_stmtContext;
39 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Identityref_specificationContext;
40 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Instance_identifier_specificationContext;
41 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Key_stmtContext;
42 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Leafref_specificationContext;
43 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Length_stmtContext;
44 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Mandatory_argContext;
45 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Mandatory_stmtContext;
46 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Max_elements_stmtContext;
47 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Max_value_argContext;
48 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Min_elements_stmtContext;
49 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Min_value_argContext;
50 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Module_stmtContext;
51 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Must_stmtContext;
52 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Numerical_restrictionsContext;
53 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Ordered_by_argContext;
54 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Ordered_by_stmtContext;
55 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Path_stmtContext;
56 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Pattern_stmtContext;
57 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Position_stmtContext;
58 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Presence_stmtContext;
59 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Range_stmtContext;
60 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Reference_stmtContext;
61 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Refine_anyxml_stmtsContext;
62 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Refine_choice_stmtsContext;
63 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Refine_container_stmtsContext;
64 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Refine_leaf_list_stmtsContext;
65 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Refine_leaf_stmtsContext;
66 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Refine_list_stmtsContext;
67 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Refine_pomContext;
68 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Refine_stmtContext;
69 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Require_instance_argContext;
70 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Require_instance_stmtContext;
71 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Status_argContext;
72 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Status_stmtContext;
73 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.StringContext;
74 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.String_restrictionsContext;
75 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Type_body_stmtsContext;
76 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Units_stmtContext;
77 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Value_stmtContext;
78 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.When_stmtContext;
79 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Yin_element_argContext;
80 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Yin_element_stmtContext;
81 import org.opendaylight.yangtools.yang.common.QName;
82 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
83 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
84 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
85 import org.opendaylight.yangtools.yang.model.api.Status;
86 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
87 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
89 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
90 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
91 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
92 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition.EnumPair;
93 import org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition;
94 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
95 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
96 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
97 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
98 import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition;
99 import org.opendaylight.yangtools.yang.model.util.BaseConstraints;
100 import org.opendaylight.yangtools.yang.model.util.BaseTypes;
101 import org.opendaylight.yangtools.yang.model.util.BinaryType;
102 import org.opendaylight.yangtools.yang.model.util.BitImpl;
103 import org.opendaylight.yangtools.yang.model.util.BitsType;
104 import org.opendaylight.yangtools.yang.model.util.Decimal64;
105 import org.opendaylight.yangtools.yang.model.util.EnumerationType;
106 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
107 import org.opendaylight.yangtools.yang.model.util.InstanceIdentifier;
108 import org.opendaylight.yangtools.yang.model.util.Int16;
109 import org.opendaylight.yangtools.yang.model.util.Int32;
110 import org.opendaylight.yangtools.yang.model.util.Int64;
111 import org.opendaylight.yangtools.yang.model.util.Int8;
112 import org.opendaylight.yangtools.yang.model.util.Leafref;
113 import org.opendaylight.yangtools.yang.model.util.MustDefinitionImpl;
114 import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl;
115 import org.opendaylight.yangtools.yang.model.util.StringType;
116 import org.opendaylight.yangtools.yang.model.util.Uint16;
117 import org.opendaylight.yangtools.yang.model.util.Uint32;
118 import org.opendaylight.yangtools.yang.model.util.Uint64;
119 import org.opendaylight.yangtools.yang.model.util.Uint8;
120 import org.opendaylight.yangtools.yang.model.util.UnknownType;
121 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
122 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
123 import org.opendaylight.yangtools.yang.parser.builder.api.ConstraintsBuilder;
124 import org.opendaylight.yangtools.yang.parser.builder.api.RefineBuilder;
125 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
126 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
127 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder;
128 import org.opendaylight.yangtools.yang.parser.builder.impl.RefineHolderImpl;
129 import org.opendaylight.yangtools.yang.parser.builder.impl.UnionTypeBuilder;
130 import org.opendaylight.yangtools.yang.parser.util.TypeConstraints;
131 import org.opendaylight.yangtools.yang.parser.util.UnknownBoundaryNumber;
132 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
133 import org.slf4j.Logger;
134 import org.slf4j.LoggerFactory;
136 public final class ParserListenerUtils {
137 private static final Logger LOG = LoggerFactory.getLogger(ParserListenerUtils.class);
139 private ParserListenerUtils() {
143 * Parse given tree and get first string value.
147 * @return first string value from given tree
149 public static String stringFromNode(final ParseTree treeNode) {
151 for (int i = 0; i < treeNode.getChildCount(); ++i) {
152 if (treeNode.getChild(i) instanceof StringContext) {
153 final StringContext context = (StringContext) treeNode.getChild(i);
154 if (context != null) {
155 return stringFromStringContext(context);
163 public static String stringFromStringContext(final StringContext context) {
164 StringBuilder str = new StringBuilder();
165 for (TerminalNode stringNode : context.STRING()) {
166 String result = stringNode.getText();
167 if(!result.contains("\"")){
169 } else if (!(result.startsWith("\"")) && result.endsWith("\"")) {
170 LOG.error("Syntax error in module {} at line {}: missing '\"'.", getParentModule(context),
171 context.getStart().getLine());
173 str.append(result.replace("\"", ""));
176 return str.toString();
179 private static String getParentModule(final ParseTree ctx) {
180 ParseTree current = ctx;
181 while (current != null && !(current instanceof Module_stmtContext)) {
182 current = current.getParent();
184 if (current instanceof Module_stmtContext) {
185 Module_stmtContext module = (Module_stmtContext) current;
186 for (int i = 0; i < module.getChildCount(); i++) {
187 if (module.getChild(i) instanceof StringContext) {
188 final StringContext str = (StringContext) module.getChild(i);
189 return str.getChild(0).getText();
197 * Parse 'description', 'reference' and 'status' statements and fill in
203 * builder to fill in with parsed statements
205 public static void parseSchemaNodeArgs(final ParseTree ctx, final SchemaNodeBuilder builder) {
206 for (int i = 0; i < ctx.getChildCount(); i++) {
207 final ParseTree child = ctx.getChild(i);
208 if (child instanceof Description_stmtContext) {
209 final String desc = stringFromNode(child);
210 builder.setDescription(desc);
211 } else if (child instanceof Reference_stmtContext) {
212 final String ref = stringFromNode(child);
213 builder.setReference(ref);
214 } else if (child instanceof Status_stmtContext) {
215 final Status status = parseStatus((Status_stmtContext) child);
216 builder.setStatus(status);
222 * Parse given context and return its value;
226 * @return value parsed from context
228 public static Status parseStatus(final Status_stmtContext ctx) {
229 Status result = null;
230 for (int i = 0; i < ctx.getChildCount(); i++) {
231 ParseTree statusArg = ctx.getChild(i);
232 if (statusArg instanceof Status_argContext) {
233 String statusArgStr = stringFromNode(statusArg);
234 switch (statusArgStr) {
236 result = Status.CURRENT;
239 result = Status.DEPRECATED;
242 result = Status.OBSOLETE;
245 LOG.warn("Invalid 'status' statement: " + statusArgStr);
253 * Parse given tree and returns units statement as string.
257 * @return value of units statement as string or null if there is no units
260 public static String parseUnits(final ParseTree ctx) {
262 for (int i = 0; i < ctx.getChildCount(); i++) {
263 ParseTree child = ctx.getChild(i);
264 if (child instanceof Units_stmtContext) {
265 units = stringFromNode(child);
273 * Parse given tree and returns default statement as string.
277 * @return value of default statement as string or null if there is no
280 public static String parseDefault(final ParseTree ctx) {
281 String defaultValue = null;
282 for (int i = 0; i < ctx.getChildCount(); i++) {
283 ParseTree child = ctx.getChild(i);
284 if (child instanceof Default_stmtContext) {
285 defaultValue = stringFromNode(child);
293 * Create SchemaPath from actualPath and new node name.
296 * current position in model
297 * @return SchemaPath object
299 public static SchemaPath createActualSchemaPath(final Stack<QName> actualPath) {
300 return SchemaPath.create(actualPath, true);
304 * Create java.util.List of key node names.
307 * Key_stmtContext context
308 * @return YANG list key as java.util.List of key node names
310 public static List<String> createListKey(final Key_stmtContext ctx) {
311 String keyDefinition = stringFromNode(ctx);
312 List<String> keys = new ArrayList<>();
313 String[] splittedKey = keyDefinition.split(" ");
314 for (String keyElement : splittedKey) {
315 if (!keyElement.isEmpty()) {
316 keys.add(keyElement);
323 * Parse given type body of enumeration statement.
326 * type body context to parse
328 * actual position in YANG model
330 * current module name
331 * @return List of EnumPair object parsed from given context
333 private static List<EnumTypeDefinition.EnumPair> getEnumConstants(final Type_body_stmtsContext ctx,
334 final Stack<QName> path, final String moduleName) {
335 List<EnumTypeDefinition.EnumPair> enumConstants = new ArrayList<>();
337 for (int i = 0; i < ctx.getChildCount(); i++) {
338 ParseTree enumSpecChild = ctx.getChild(i);
339 if (enumSpecChild instanceof Enum_specificationContext) {
340 int highestValue = -1;
341 for (int j = 0; j < enumSpecChild.getChildCount(); j++) {
342 ParseTree enumChild = enumSpecChild.getChild(j);
343 if (enumChild instanceof Enum_stmtContext) {
344 EnumPair enumPair = createEnumPair((Enum_stmtContext) enumChild, highestValue, path, moduleName);
345 if (enumPair.getValue() > highestValue) {
346 highestValue = enumPair.getValue();
348 enumConstants.add(enumPair);
353 return enumConstants;
357 * Parse enum statement context
360 * enum statement context
361 * @param highestValue
362 * current highest value in enumeration
364 * actual position in YANG model
366 * current module name
367 * @return EnumPair object parsed from given context
369 private static EnumTypeDefinition.EnumPair createEnumPair(final Enum_stmtContext ctx, final int highestValue,
370 final Stack<QName> actualPath, final String moduleName) {
371 final String name = stringFromNode(ctx);
372 SchemaPath path = createTypePath(actualPath, name);
373 Integer value = null;
375 String description = null;
376 String reference = null;
377 Status status = null;
379 for (int i = 0; i < ctx.getChildCount(); i++) {
380 ParseTree child = ctx.getChild(i);
381 if (child instanceof Value_stmtContext) {
382 String valueStr = stringFromNode(child);
383 value = Integer.valueOf(valueStr);
384 } else if (child instanceof Description_stmtContext) {
385 description = stringFromNode(child);
386 } else if (child instanceof Reference_stmtContext) {
387 reference = stringFromNode(child);
388 } else if (child instanceof Status_stmtContext) {
389 status = parseStatus((Status_stmtContext) child);
394 value = highestValue + 1;
396 if (value < -2147483648 || value > 2147483647) {
397 throw new YangParseException(moduleName, ctx.getStart().getLine(), "Error on enum '" + name
398 + "': the enum value MUST be in the range from -2147483648 to 2147483647, but was: " + value);
401 EnumPairImpl result = new EnumPairImpl();
402 result.qname = path.getPathTowardsRoot().iterator().next();
404 result.description = description;
405 result.reference = reference;
406 result.status = status;
408 result.value = value;
413 * Internal implementation of EnumPair.
415 private static class EnumPairImpl implements EnumTypeDefinition.EnumPair {
417 private SchemaPath path;
418 private String description;
419 private String reference;
420 private Status status;
421 private final List<UnknownSchemaNode> unknownNodes = Collections.emptyList();
423 private Integer value;
426 public QName getQName() {
431 public SchemaPath getPath() {
436 public String getDescription() {
441 public String getReference() {
446 public Status getStatus() {
451 public List<UnknownSchemaNode> getUnknownSchemaNodes() {
456 public String getName() {
461 public Integer getValue() {
466 public int hashCode() {
467 final int prime = 31;
469 result = prime * result + ((qname == null) ? 0 : qname.hashCode());
470 result = prime * result + ((path == null) ? 0 : path.hashCode());
471 result = prime * result + ((unknownNodes == null) ? 0 : unknownNodes.hashCode());
472 result = prime * result + ((name == null) ? 0 : name.hashCode());
473 result = prime * result + ((value == null) ? 0 : value.hashCode());
478 public boolean equals(final Object obj) {
485 if (getClass() != obj.getClass()) {
488 EnumPairImpl other = (EnumPairImpl) obj;
490 if (other.qname != null) {
493 } else if (!qname.equals(other.qname)) {
497 if (other.path != null) {
500 } else if (!path.equals(other.path)) {
503 if (unknownNodes == null) {
504 if (other.unknownNodes != null) {
507 } else if (!unknownNodes.equals(other.unknownNodes)) {
511 if (other.name != null) {
514 } else if (!name.equals(other.name)) {
518 if (other.value != null) {
521 } else if (!value.equals(other.value)) {
528 public String toString() {
529 return EnumTypeDefinition.EnumPair.class.getSimpleName() + "[name=" + name + ", value=" + value + "]";
534 * Get and parse range from given type body context.
537 * type body context to parse
539 * name of current module
540 * @return List of RangeConstraint created from this context
542 private static List<RangeConstraint> getRangeConstraints(final Type_body_stmtsContext ctx, final String moduleName) {
543 List<RangeConstraint> rangeConstraints = Collections.emptyList();
544 outer: for (int i = 0; i < ctx.getChildCount(); i++) {
545 ParseTree numRestrChild = ctx.getChild(i);
547 if (numRestrChild instanceof Numerical_restrictionsContext) {
548 for (int j = 0; j < numRestrChild.getChildCount(); j++) {
549 ParseTree rangeChild = numRestrChild.getChild(j);
550 if (rangeChild instanceof Range_stmtContext) {
551 rangeConstraints = parseRangeConstraints((Range_stmtContext) rangeChild, moduleName);
557 if (numRestrChild instanceof Decimal64_specificationContext) {
558 for (int j = 0; j < numRestrChild.getChildCount(); j++) {
559 ParseTree decRestr = numRestrChild.getChild(j);
560 if (decRestr instanceof Numerical_restrictionsContext) {
561 for (int k = 0; k < decRestr.getChildCount(); k++) {
562 ParseTree rangeChild = decRestr.getChild(k);
563 if (rangeChild instanceof Range_stmtContext) {
564 rangeConstraints = parseRangeConstraints((Range_stmtContext) rangeChild, moduleName);
573 return rangeConstraints;
577 * Parse given range context.
580 * range context to parse
582 * name of current module
583 * @return List of RangeConstraints parsed from this context
585 private static List<RangeConstraint> parseRangeConstraints(final Range_stmtContext ctx, final String moduleName) {
586 final int line = ctx.getStart().getLine();
587 List<RangeConstraint> rangeConstraints = new ArrayList<>();
588 String description = null;
589 String reference = null;
591 for (int i = 0; i < ctx.getChildCount(); i++) {
592 ParseTree child = ctx.getChild(i);
593 if (child instanceof Description_stmtContext) {
594 description = stringFromNode(child);
595 } else if (child instanceof Reference_stmtContext) {
596 reference = stringFromNode(child);
600 String rangeStr = stringFromNode(ctx);
601 String trimmed = rangeStr.replace(" ", "");
602 String[] splittedRange = trimmed.split("\\|");
603 for (String rangeDef : splittedRange) {
604 String[] splittedRangeDef = rangeDef.split("\\.\\.");
607 if (splittedRangeDef.length == 1) {
608 min = max = parseNumberConstraintValue(splittedRangeDef[0], moduleName, line);
610 min = parseNumberConstraintValue(splittedRangeDef[0], moduleName, line);
611 max = parseNumberConstraintValue(splittedRangeDef[1], moduleName, line);
613 RangeConstraint range = BaseConstraints.rangeConstraint(min, max, description, reference);
614 rangeConstraints.add(range);
617 return rangeConstraints;
621 * Get and parse length from given type body context.
624 * type body context to parse
626 * name of current module
627 * @return List of LengthConstraint created from this context
629 private static List<LengthConstraint> getLengthConstraints(final Type_body_stmtsContext ctx, final String moduleName) {
630 List<LengthConstraint> lengthConstraints = Collections.emptyList();
631 outer: for (int i = 0; i < ctx.getChildCount(); i++) {
632 ParseTree stringRestrChild = ctx.getChild(i);
633 if (stringRestrChild instanceof String_restrictionsContext) {
634 for (int j = 0; j < stringRestrChild.getChildCount(); j++) {
635 ParseTree lengthChild = stringRestrChild.getChild(j);
636 if (lengthChild instanceof Length_stmtContext) {
637 lengthConstraints = parseLengthConstraints((Length_stmtContext) lengthChild, moduleName);
643 return lengthConstraints;
647 * Parse given length context.
650 * length context to parse
652 * name of current module
653 * @return List of LengthConstraints parsed from this context
655 private static List<LengthConstraint> parseLengthConstraints(final Length_stmtContext ctx, final String moduleName) {
656 final int line = ctx.getStart().getLine();
657 List<LengthConstraint> lengthConstraints = new ArrayList<>();
658 String description = null;
659 String reference = null;
661 for (int i = 0; i < ctx.getChildCount(); i++) {
662 ParseTree child = ctx.getChild(i);
663 if (child instanceof Description_stmtContext) {
664 description = stringFromNode(child);
665 } else if (child instanceof Reference_stmtContext) {
666 reference = stringFromNode(child);
670 String lengthStr = stringFromNode(ctx);
671 String trimmed = lengthStr.replace(" ", "");
672 String[] splittedRange = trimmed.split("\\|");
673 for (String rangeDef : splittedRange) {
674 String[] splittedRangeDef = rangeDef.split("\\.\\.");
677 if (splittedRangeDef.length == 1) {
678 min = max = parseNumberConstraintValue(splittedRangeDef[0], moduleName, line);
680 min = parseNumberConstraintValue(splittedRangeDef[0], moduleName, line);
681 max = parseNumberConstraintValue(splittedRangeDef[1], moduleName, line);
683 LengthConstraint range = BaseConstraints.lengthConstraint(min, max, description, reference);
684 lengthConstraints.add(range);
687 return lengthConstraints;
694 * name of current module
696 * current line in module
697 * @return wrapper object of primitive java type or UnknownBoundaryNumber if
698 * type is one of special YANG values 'min' or 'max'
700 private static Number parseNumberConstraintValue(final String value, final String moduleName, final int line) {
702 if ("min".equals(value) || "max".equals(value)) {
703 result = new UnknownBoundaryNumber(value);
706 if (value.contains(".")) {
707 result = new BigDecimal(value);
709 result = new BigInteger(value);
711 } catch (NumberFormatException e) {
712 throw new YangParseException(moduleName, line, "Unable to parse range value '" + value + "'.", e);
719 * Parse type body and return pattern constraints.
723 * @return list of pattern constraints
725 private static List<PatternConstraint> getPatternConstraint(final Type_body_stmtsContext ctx) {
726 List<PatternConstraint> patterns = new ArrayList<>();
728 for (int i = 0; i < ctx.getChildCount(); i++) {
729 ParseTree stringRestrChild = ctx.getChild(i);
730 if (stringRestrChild instanceof String_restrictionsContext) {
731 for (int j = 0; j < stringRestrChild.getChildCount(); j++) {
732 ParseTree lengthChild = stringRestrChild.getChild(j);
733 if (lengthChild instanceof Pattern_stmtContext) {
734 patterns.add(parsePatternConstraint((Pattern_stmtContext) lengthChild));
743 * Internal helper method.
747 * @return PatternConstraint object
749 private static PatternConstraint parsePatternConstraint(final Pattern_stmtContext ctx) {
750 String description = null;
751 String reference = null;
752 for (int i = 0; i < ctx.getChildCount(); i++) {
753 ParseTree child = ctx.getChild(i);
754 if (child instanceof Description_stmtContext) {
755 description = stringFromNode(child);
756 } else if (child instanceof Reference_stmtContext) {
757 reference = stringFromNode(child);
760 String pattern = parsePatternString(ctx);
761 return BaseConstraints.patternConstraint(pattern, description, reference);
765 * Parse given context and return pattern value.
769 * @return pattern value as String
771 private static String parsePatternString(final Pattern_stmtContext ctx) {
772 StringBuilder result = new StringBuilder();
773 for (int i = 0; i < ctx.getChildCount(); ++i) {
774 ParseTree child = ctx.getChild(i);
775 if (child instanceof StringContext) {
776 for (int j = 0; j < child.getChildCount(); j++) {
778 String patternToken = child.getChild(j).getText();
779 result.append(patternToken.substring(1, patternToken.length() - 1));
784 return result.toString();
788 * Get fraction digits value from type body.
791 * type body context to parse
793 * name of current module
794 * @return 'fraction-digits' value if present in given context, null
797 private static Integer getFractionDigits(final Type_body_stmtsContext ctx, final String moduleName) {
798 Integer result = null;
799 for (int i = 0; i < ctx.getChildCount(); i++) {
800 ParseTree dec64specChild = ctx.getChild(i);
801 if (dec64specChild instanceof Decimal64_specificationContext) {
802 result = parseFractionDigits((Decimal64_specificationContext) dec64specChild, moduleName);
809 * Parse decimal64 fraction-digits value.
814 * name of current module
815 * @return fraction-digits value as Integer
817 private static Integer parseFractionDigits(final Decimal64_specificationContext ctx, final String moduleName) {
818 Integer result = null;
819 for (int i = 0; i < ctx.getChildCount(); i++) {
820 ParseTree fdChild = ctx.getChild(i);
821 if (fdChild instanceof Fraction_digits_stmtContext) {
822 String value = stringFromNode(fdChild);
824 result = Integer.valueOf(value);
825 } catch (NumberFormatException e) {
826 throw new YangParseException(moduleName, ctx.getStart().getLine(),
827 "Unable to parse fraction digits value '" + value + "'.", e);
835 * Internal helper method for parsing bit statements from given type body
839 * type body context to parse
841 * current position in YANG model
843 * current module name
844 * @return List of Bit objects created from this context
846 private static List<BitsTypeDefinition.Bit> getBits(final Type_body_stmtsContext ctx, final Stack<QName> actualPath,
847 final String moduleName) {
848 final List<BitsTypeDefinition.Bit> bits = new ArrayList<>();
849 for (int j = 0; j < ctx.getChildCount(); j++) {
850 ParseTree bitsSpecChild = ctx.getChild(j);
851 if (bitsSpecChild instanceof Bits_specificationContext) {
852 long highestPosition = -1;
853 for (int k = 0; k < bitsSpecChild.getChildCount(); k++) {
854 ParseTree bitChild = bitsSpecChild.getChild(k);
855 if (bitChild instanceof Bit_stmtContext) {
856 Bit bit = parseBit((Bit_stmtContext) bitChild, highestPosition, actualPath, moduleName);
857 if (bit.getPosition() > highestPosition) {
858 highestPosition = bit.getPosition();
869 * Internal helper method for parsing bit context.
872 * bit statement context to parse
873 * @param highestPosition
874 * current highest position in bits type
876 * current position in YANG model
878 * current module name
879 * @return Bit object parsed from this context
881 private static BitsTypeDefinition.Bit parseBit(final Bit_stmtContext ctx, final long highestPosition,
882 final Stack<QName> actualPath, final String moduleName) {
883 String name = stringFromNode(ctx);
884 Long position = null;
886 String description = null;
887 String reference = null;
888 Status status = Status.CURRENT;
890 SchemaPath schemaPath = createBaseTypePath(actualPath, name);
892 for (int i = 0; i < ctx.getChildCount(); i++) {
893 ParseTree child = ctx.getChild(i);
894 if (child instanceof Position_stmtContext) {
895 String positionStr = stringFromNode(child);
896 position = Long.valueOf(positionStr);
897 } else if (child instanceof Description_stmtContext) {
898 description = stringFromNode(child);
899 } else if (child instanceof Reference_stmtContext) {
900 reference = stringFromNode(child);
901 } else if (child instanceof Status_stmtContext) {
902 status = parseStatus((Status_stmtContext) child);
906 if (position == null) {
907 position = highestPosition + 1;
909 if (position < 0 || position > 4294967295L) {
910 throw new YangParseException(moduleName, ctx.getStart().getLine(), "Error on bit '" + name
911 + "': the position value MUST be in the range 0 to 4294967295");
914 final List<UnknownSchemaNode> unknownNodes = Collections.emptyList();
915 return new BitImpl(position, schemaPath.getPathTowardsRoot().iterator().next(), schemaPath,
916 description, reference, status, unknownNodes);
920 * Parse 'ordered-by' statement.
922 * The 'ordered-by' statement defines whether the order of entries within a
923 * list are determined by the user or the system. The argument is one of the
924 * strings "system" or "user". If not present, order defaults to "system".
927 * Ordered_by_stmtContext
928 * @return true, if ordered-by contains value 'user', false otherwise
930 public static boolean parseUserOrdered(final Ordered_by_stmtContext ctx) {
931 boolean result = false;
932 for (int j = 0; j < ctx.getChildCount(); j++) {
933 ParseTree orderArg = ctx.getChild(j);
934 if (orderArg instanceof Ordered_by_argContext) {
935 String orderStr = stringFromNode(orderArg);
944 LOG.warn("Invalid 'ordered-by' statement.");
952 * Get config statement from given context. If there is no config statement,
953 * return config value of parent
960 * name of current module
962 * line in current module
963 * @return config statement parsed from given context
965 public static boolean getConfig(final ParseTree ctx, final Builder node, final String moduleName, final int line) {
967 // parse configuration statement
968 Boolean config = null;
969 for (int i = 0; i < ctx.getChildCount(); i++) {
970 ParseTree child = ctx.getChild(i);
971 if (child instanceof Config_stmtContext) {
972 config = parseConfig((Config_stmtContext) child, moduleName);
977 // If 'config' is not specified, the default is the same as the parent
978 // schema node's 'config' value
979 boolean parentConfig = getParentConfig(node);
980 if (config == null) {
981 result = parentConfig;
983 // Check: if a node has 'config' set to 'false', no node underneath
984 // it can have 'config' set to 'true'
985 if (!parentConfig && config) {
986 throw new YangParseException(moduleName, line,
987 "Can not set 'config' to 'true' if parent node has 'config' set to 'false'");
995 private static boolean getParentConfig(final Builder node) {
996 Builder parent = node.getParent();
997 boolean config = false;
999 if (parent instanceof ChoiceCaseBuilder) {
1000 parent = parent.getParent();
1002 if (parent instanceof DataSchemaNodeBuilder) {
1003 config = ((DataSchemaNodeBuilder) parent).isConfiguration();
1011 * Parse config statement.
1014 * config context to parse
1016 * current module name
1017 * @return true if given context contains string 'true', false otherwise
1019 private static Boolean parseConfig(final Config_stmtContext ctx, final String moduleName) {
1020 Boolean result = null;
1022 for (int i = 0; i < ctx.getChildCount(); ++i) {
1023 final ParseTree configContext = ctx.getChild(i);
1024 if (configContext instanceof Config_argContext) {
1025 final String value = stringFromNode(configContext);
1034 throw new YangParseException(moduleName, ctx.getStart().getLine(),
1035 "Failed to parse 'config' statement value: '" + value + "'.");
1044 * Parse type body and create UnknownType definition.
1046 * @param typedefQName
1047 * qname of current type
1051 * actual path in model
1059 * current node parent
1060 * @return UnknownType object with constraints from parsed type body
1062 public static TypeDefinition<?> parseUnknownTypeWithBody(final QName typedefQName,
1063 final Type_body_stmtsContext ctx, final Stack<QName> actualPath, final URI namespace, final Date revision,
1064 final String prefix, final Builder parent) {
1065 String moduleName = parent.getModuleName();
1066 String typeName = typedefQName.getLocalName();
1068 UnknownType.Builder unknownType = new UnknownType.Builder(typedefQName);
1071 List<RangeConstraint> rangeStatements = getRangeConstraints(ctx, moduleName);
1072 List<LengthConstraint> lengthStatements = getLengthConstraints(ctx, moduleName);
1073 List<PatternConstraint> patternStatements = getPatternConstraint(ctx);
1074 Integer fractionDigits = getFractionDigits(ctx, moduleName);
1076 if (parent instanceof TypeDefinitionBuilder) {
1077 TypeDefinitionBuilder typedef = (TypeDefinitionBuilder) parent;
1078 typedef.setRanges(rangeStatements);
1079 typedef.setLengths(lengthStatements);
1080 typedef.setPatterns(patternStatements);
1081 typedef.setFractionDigits(fractionDigits);
1082 return unknownType.build();
1084 TypeDefinition<?> baseType = unknownType.build();
1085 QName qname = new QName(namespace, revision, prefix, typeName);
1086 SchemaPath schemaPath = createTypePath(actualPath, typeName);
1088 ExtendedType.Builder typeBuilder = new ExtendedType.Builder(qname, baseType, null, null, schemaPath);
1089 typeBuilder.ranges(rangeStatements);
1090 typeBuilder.lengths(lengthStatements);
1091 typeBuilder.patterns(patternStatements);
1092 typeBuilder.fractionDigits(fractionDigits);
1094 return typeBuilder.build();
1098 return unknownType.build();
1102 * Create TypeDefinition object based on given type name and type body.
1109 * current path in schema
1118 * @return TypeDefinition object based on parsed values.
1120 public static TypeDefinition<?> parseTypeWithBody(final String typeName, final Type_body_stmtsContext typeBody,
1121 final Stack<QName> actualPath, final URI namespace, final Date revision, final String prefix,
1122 final Builder parent) {
1124 final String moduleName = parent.getModuleName();
1125 final int line = typeBody.getStart().getLine();
1126 TypeDefinition<?> baseType = null;
1128 Integer fractionDigits = getFractionDigits(typeBody, moduleName);
1129 List<LengthConstraint> lengthStatements = getLengthConstraints(typeBody, moduleName);
1130 List<PatternConstraint> patternStatements = getPatternConstraint(typeBody);
1131 List<RangeConstraint> rangeStatements = getRangeConstraints(typeBody, moduleName);
1133 TypeConstraints constraints = new TypeConstraints(moduleName, line);
1134 constraints.addFractionDigits(fractionDigits);
1135 constraints.addLengths(lengthStatements);
1136 constraints.addPatterns(patternStatements);
1137 constraints.addRanges(rangeStatements);
1139 SchemaPath baseTypePath = createBaseTypePath(actualPath, typeName);
1140 SchemaPath extBaseTypePath = createExtendedBaseTypePath(actualPath, namespace, revision, prefix, typeName);
1142 if (parent instanceof TypeDefinitionBuilder && !(parent instanceof UnionTypeBuilder)) {
1143 extBaseTypePath = baseTypePath;
1146 if ("decimal64".equals(typeName)) {
1147 if (rangeStatements.isEmpty()) {
1149 return new Decimal64(baseTypePath, fractionDigits);
1150 } catch(Exception e) {
1151 throw new YangParseException(moduleName, line, e.getMessage());
1154 Decimal64 decimalType = new Decimal64(extBaseTypePath, fractionDigits);
1155 constraints.addRanges(decimalType.getRangeConstraints());
1156 baseType = decimalType;
1157 } else if (typeName.startsWith("int")) {
1158 IntegerTypeDefinition intType = null;
1161 intType = Int8.getInstance();
1164 intType = Int16.getInstance();
1167 intType = Int32.getInstance();
1170 intType = Int64.getInstance();
1173 if (intType == null) {
1174 throw new YangParseException(moduleName, line, "Unknown yang type " + typeName);
1176 constraints.addRanges(intType.getRangeConstraints());
1178 } else if (typeName.startsWith("uint")) {
1179 UnsignedIntegerTypeDefinition uintType = null;
1182 uintType = Uint8.getInstance();
1185 uintType = Uint16.getInstance();
1188 uintType = Uint32.getInstance();
1191 uintType = Uint64.getInstance();
1194 if (uintType == null) {
1195 throw new YangParseException(moduleName, line, "Unknown yang type " + typeName);
1197 constraints.addRanges(uintType.getRangeConstraints());
1198 baseType = uintType;
1199 } else if ("enumeration".equals(typeName)) {
1200 List<EnumTypeDefinition.EnumPair> enumConstants = getEnumConstants(typeBody, actualPath, moduleName);
1201 return new EnumerationType(baseTypePath, enumConstants);
1202 } else if ("string".equals(typeName)) {
1203 StringTypeDefinition stringType = StringType.getInstance();
1204 constraints.addLengths(stringType.getLengthConstraints());
1205 baseType = stringType;
1206 } else if ("bits".equals(typeName)) {
1207 return new BitsType(baseTypePath, getBits(typeBody, actualPath, moduleName));
1208 } else if ("leafref".equals(typeName)) {
1209 final String path = parseLeafrefPath(typeBody);
1210 final boolean absolute = path.startsWith("/");
1211 RevisionAwareXPath xpath = new RevisionAwareXPathImpl(path, absolute);
1212 return new Leafref(xpath);
1213 } else if ("binary".equals(typeName)) {
1214 BinaryTypeDefinition binaryType = BinaryType.getInstance();
1215 constraints.addLengths(binaryType.getLengthConstraints());
1216 baseType = binaryType;
1217 } else if ("instance-identifier".equals(typeName)) {
1218 boolean requireInstance = isRequireInstance(typeBody);
1219 return new InstanceIdentifier(null, requireInstance);
1222 if (parent instanceof TypeDefinitionBuilder && !(parent instanceof UnionTypeBuilder)) {
1223 TypeDefinitionBuilder typedef = (TypeDefinitionBuilder) parent;
1224 typedef.setRanges(constraints.getRange());
1225 typedef.setLengths(constraints.getLength());
1226 typedef.setPatterns(constraints.getPatterns());
1227 typedef.setFractionDigits(constraints.getFractionDigits());
1231 List<QName> path = new ArrayList<>(actualPath);
1232 path.add(new QName(namespace, revision, prefix, typeName));
1233 SchemaPath schemaPath = SchemaPath.create(path, true);
1235 QName qname = schemaPath.getPath().get(schemaPath.getPath().size() - 1);
1236 ExtendedType.Builder typeBuilder = new ExtendedType.Builder(qname, baseType, "", "", schemaPath);
1238 typeBuilder.ranges(constraints.getRange());
1239 typeBuilder.lengths(constraints.getLength());
1240 typeBuilder.patterns(constraints.getPatterns());
1241 typeBuilder.fractionDigits(constraints.getFractionDigits());
1243 return typeBuilder.build();
1246 private static SchemaPath createTypePath(final Stack<QName> actual, final String typeName) {
1247 QName last = actual.peek();
1248 QName typeQName = new QName(last.getNamespace(), last.getRevision(), last.getPrefix(), typeName);
1249 List<QName> path = new ArrayList<>(actual);
1250 path.add(typeQName);
1251 return SchemaPath.create(path, true);
1254 private static SchemaPath createBaseTypePath(final Stack<QName> actual, final String typeName) {
1255 List<QName> path = new ArrayList<>(actual);
1256 path.add(BaseTypes.constructQName(typeName));
1257 return SchemaPath.create(path, true);
1260 private static SchemaPath createExtendedBaseTypePath(final Stack<QName> actual, final URI namespace, final Date revision,
1261 final String prefix, final String typeName) {
1262 QName extTypeName = new QName(namespace, revision, prefix, typeName);
1263 QName baseTypeName = BaseTypes.constructQName(typeName);
1264 List<QName> path = new ArrayList<>(actual);
1265 path.add(extTypeName);
1266 path.add(baseTypeName);
1267 return SchemaPath.create(path, true);
1271 * Parse given context and find identityref base value.
1275 * @return identityref base value as String
1277 public static String getIdentityrefBase(final Type_body_stmtsContext ctx) {
1278 String result = null;
1279 outer: for (int i = 0; i < ctx.getChildCount(); i++) {
1280 ParseTree child = ctx.getChild(i);
1281 if (child instanceof Identityref_specificationContext) {
1282 for (int j = 0; j < child.getChildCount(); j++) {
1283 ParseTree baseArg = child.getChild(j);
1284 if (baseArg instanceof Base_stmtContext) {
1285 result = stringFromNode(baseArg);
1295 * Parse type body statement and find require-instance value.
1299 * @return require-instance value
1301 private static boolean isRequireInstance(final Type_body_stmtsContext ctx) {
1302 for (int i = 0; i < ctx.getChildCount(); i++) {
1303 ParseTree child = ctx.getChild(i);
1304 if (child instanceof Instance_identifier_specificationContext) {
1305 for (int j = 0; j < child.getChildCount(); j++) {
1306 ParseTree reqStmt = child.getChild(j);
1307 if (reqStmt instanceof Require_instance_stmtContext) {
1308 for (int k = 0; k < reqStmt.getChildCount(); k++) {
1309 ParseTree reqArg = reqStmt.getChild(k);
1310 if (reqArg instanceof Require_instance_argContext) {
1311 return Boolean.valueOf(stringFromNode(reqArg));
1322 * Parse type body statement and find leafref path.
1326 * @return leafref path as String
1328 private static String parseLeafrefPath(final Type_body_stmtsContext ctx) {
1329 for (int i = 0; i < ctx.getChildCount(); i++) {
1330 ParseTree child = ctx.getChild(i);
1331 if (child instanceof Leafref_specificationContext) {
1332 for (int j = 0; j < child.getChildCount(); j++) {
1333 ParseTree leafRefSpec = child.getChild(j);
1334 if (leafRefSpec instanceof Path_stmtContext) {
1335 return stringFromNode(leafRefSpec);
1344 * Internal helper method for parsing must statement.
1348 * @return MustDefinition object based on parsed context
1350 public static MustDefinition parseMust(final YangParser.Must_stmtContext ctx) {
1351 StringBuilder mustText = new StringBuilder();
1352 String description = null;
1353 String reference = null;
1354 String errorAppTag = null;
1355 String errorMessage = null;
1356 for (int i = 0; i < ctx.getChildCount(); ++i) {
1357 ParseTree child = ctx.getChild(i);
1358 if (child instanceof StringContext) {
1359 final StringContext context = (StringContext) child;
1360 if (context.getChildCount() == 1) {
1361 String mustPart = context.getChild(0).getText();
1362 // trim start and end quotation
1363 mustText.append(mustPart.substring(1, mustPart.length() - 1));
1365 for (int j = 0; j < context.getChildCount(); j++) {
1366 String mustPart = context.getChild(j).getText();
1368 mustText.append(mustPart.substring(0, mustPart.length() - 1));
1372 mustText.append(mustPart.substring(1));
1376 } else if (child instanceof Description_stmtContext) {
1377 description = stringFromNode(child);
1378 } else if (child instanceof Reference_stmtContext) {
1379 reference = stringFromNode(child);
1380 } else if (child instanceof Error_app_tag_stmtContext) {
1381 errorAppTag = stringFromNode(child);
1382 } else if (child instanceof Error_message_stmtContext) {
1383 errorMessage = stringFromNode(child);
1387 return new MustDefinitionImpl(mustText.toString(), description, reference, errorAppTag, errorMessage);
1391 * Parse given context and set constraints to constraints builder.
1395 * @param constraints
1396 * ConstraintsBuilder to fill
1398 public static void parseConstraints(final ParseTree ctx, final ConstraintsBuilder constraints) {
1399 for (int i = 0; i < ctx.getChildCount(); ++i) {
1400 final ParseTree childNode = ctx.getChild(i);
1401 if (childNode instanceof Max_elements_stmtContext) {
1402 Integer max = parseMaxElements((Max_elements_stmtContext) childNode, constraints.getModuleName());
1403 constraints.setMaxElements(max);
1404 } else if (childNode instanceof Min_elements_stmtContext) {
1405 Integer min = parseMinElements((Min_elements_stmtContext) childNode, constraints.getModuleName());
1406 constraints.setMinElements(min);
1407 } else if (childNode instanceof Must_stmtContext) {
1408 MustDefinition must = parseMust((Must_stmtContext) childNode);
1409 constraints.addMustDefinition(must);
1410 } else if (childNode instanceof Mandatory_stmtContext) {
1411 for (int j = 0; j < childNode.getChildCount(); j++) {
1412 ParseTree mandatoryTree = childNode.getChild(j);
1413 if (mandatoryTree instanceof Mandatory_argContext) {
1414 Boolean mandatory = Boolean.valueOf(stringFromNode(mandatoryTree));
1415 constraints.setMandatory(mandatory);
1418 } else if (childNode instanceof When_stmtContext) {
1419 constraints.addWhenCondition(stringFromNode(childNode));
1424 private static Integer parseMinElements(final Min_elements_stmtContext ctx, final String moduleName) {
1425 Integer result = null;
1427 for (int i = 0; i < ctx.getChildCount(); i++) {
1428 ParseTree minArg = ctx.getChild(i);
1429 if (minArg instanceof Min_value_argContext) {
1430 result = Integer.valueOf(stringFromNode(minArg));
1433 if (result == null) {
1434 throw new IllegalArgumentException();
1437 } catch (Exception e) {
1438 throw new YangParseException(moduleName, ctx.getStart().getLine(), "Failed to parse min-elements.", e);
1442 private static Integer parseMaxElements(final Max_elements_stmtContext ctx, final String moduleName) {
1443 Integer result = null;
1445 for (int i = 0; i < ctx.getChildCount(); i++) {
1446 ParseTree maxArg = ctx.getChild(i);
1447 if (maxArg instanceof Max_value_argContext) {
1448 result = Integer.valueOf(stringFromNode(maxArg));
1451 if (result == null) {
1452 throw new IllegalArgumentException();
1455 } catch (Exception e) {
1456 throw new YangParseException(moduleName, ctx.getStart().getLine(), "Failed to parse max-elements.", e);
1461 * Parse given context and return yin value.
1465 * @return true if value is 'true', false otherwise
1467 public static boolean parseYinValue(final Argument_stmtContext ctx) {
1468 boolean yinValue = false;
1469 outer: for (int i = 0; i < ctx.getChildCount(); i++) {
1470 ParseTree yin = ctx.getChild(i);
1471 if (yin instanceof Yin_element_stmtContext) {
1472 for (int j = 0; j < yin.getChildCount(); j++) {
1473 ParseTree yinArg = yin.getChild(j);
1474 if (yinArg instanceof Yin_element_argContext) {
1475 String yinString = stringFromNode(yinArg);
1476 if ("true".equals(yinString)) {
1488 * Check this base type.
1491 * base YANG type name
1493 * name of current module
1496 * @throws YangParseException
1497 * if this is one of YANG type which MUST contain additional
1498 * informations in its body
1500 public static void checkMissingBody(final String typeName, final String moduleName, final int line) {
1503 throw new YangParseException(moduleName, line,
1504 "The 'fraction-digits' statement MUST be present if the type is 'decimal64'.");
1506 throw new YangParseException(moduleName, line,
1507 "The 'base' statement MUST be present if the type is 'identityref'.");
1509 throw new YangParseException(moduleName, line,
1510 "The 'path' statement MUST be present if the type is 'leafref'.");
1512 throw new YangParseException(moduleName, line, "The 'bit' statement MUST be present if the type is 'bits'.");
1514 throw new YangParseException(moduleName, line,
1515 "The 'enum' statement MUST be present if the type is 'enumeration'.");
1520 * Parse refine statement.
1525 * name of current module
1526 * @return RefineHolder object representing this refine statement
1528 public static RefineHolderImpl parseRefine(final Refine_stmtContext refineCtx, final String moduleName) {
1529 final String refineTarget = stringFromNode(refineCtx);
1530 final RefineHolderImpl refine = new RefineHolderImpl(moduleName, refineCtx.getStart().getLine(), refineTarget);
1531 for (int i = 0; i < refineCtx.getChildCount(); i++) {
1532 ParseTree refinePom = refineCtx.getChild(i);
1533 if (refinePom instanceof Refine_pomContext) {
1534 for (int j = 0; j < refinePom.getChildCount(); j++) {
1535 ParseTree refineStmt = refinePom.getChild(j);
1536 parseRefineDefault(refine, refineStmt);
1538 if (refineStmt instanceof Refine_leaf_stmtsContext) {
1539 parseRefine(refine, (Refine_leaf_stmtsContext) refineStmt);
1540 } else if (refineStmt instanceof Refine_container_stmtsContext) {
1541 parseRefine(refine, (Refine_container_stmtsContext) refineStmt);
1542 } else if (refineStmt instanceof Refine_list_stmtsContext) {
1543 parseRefine(refine, (Refine_list_stmtsContext) refineStmt);
1544 } else if (refineStmt instanceof Refine_leaf_list_stmtsContext) {
1545 parseRefine(refine, (Refine_leaf_list_stmtsContext) refineStmt);
1546 } else if (refineStmt instanceof Refine_choice_stmtsContext) {
1547 parseRefine(refine, (Refine_choice_stmtsContext) refineStmt);
1548 } else if (refineStmt instanceof Refine_anyxml_stmtsContext) {
1549 parseRefine(refine, (Refine_anyxml_stmtsContext) refineStmt);
1557 private static void parseRefineDefault(final RefineHolderImpl refine, final ParseTree refineStmt) {
1558 for (int i = 0; i < refineStmt.getChildCount(); i++) {
1559 ParseTree refineArg = refineStmt.getChild(i);
1560 if (refineArg instanceof Description_stmtContext) {
1561 String description = stringFromNode(refineArg);
1562 refine.setDescription(description);
1563 } else if (refineArg instanceof Reference_stmtContext) {
1564 String reference = stringFromNode(refineArg);
1565 refine.setReference(reference);
1566 } else if (refineArg instanceof Config_stmtContext) {
1567 Boolean config = parseConfig((Config_stmtContext) refineArg, refine.getModuleName());
1568 refine.setConfiguration(config);
1573 private static RefineBuilder parseRefine(final RefineHolderImpl refine, final Refine_leaf_stmtsContext refineStmt) {
1574 for (int i = 0; i < refineStmt.getChildCount(); i++) {
1575 ParseTree refineArg = refineStmt.getChild(i);
1576 if (refineArg instanceof Default_stmtContext) {
1577 String defaultStr = stringFromNode(refineArg);
1578 refine.setDefaultStr(defaultStr);
1579 } else if (refineArg instanceof Mandatory_stmtContext) {
1580 for (int j = 0; j < refineArg.getChildCount(); j++) {
1581 ParseTree mandatoryTree = refineArg.getChild(j);
1582 if (mandatoryTree instanceof Mandatory_argContext) {
1583 Boolean mandatory = Boolean.valueOf(stringFromNode(mandatoryTree));
1584 refine.setMandatory(mandatory);
1587 } else if (refineArg instanceof Must_stmtContext) {
1588 MustDefinition must = parseMust((Must_stmtContext) refineArg);
1589 refine.setMust(must);
1596 private static RefineBuilder parseRefine(final RefineBuilder refine, final Refine_container_stmtsContext refineStmt) {
1597 for (int i = 0; i < refineStmt.getChildCount(); i++) {
1598 ParseTree refineArg = refineStmt.getChild(i);
1599 if (refineArg instanceof Must_stmtContext) {
1600 MustDefinition must = parseMust((Must_stmtContext) refineArg);
1601 refine.setMust(must);
1602 } else if (refineArg instanceof Presence_stmtContext) {
1603 refine.setPresence(true);
1609 private static RefineBuilder parseRefine(final RefineHolderImpl refine, final Refine_list_stmtsContext refineStmt) {
1610 for (int i = 0; i < refineStmt.getChildCount(); i++) {
1611 ParseTree refineArg = refineStmt.getChild(i);
1612 if (refineArg instanceof Must_stmtContext) {
1613 MustDefinition must = parseMust((Must_stmtContext) refineArg);
1614 refine.setMust(must);
1615 } else if (refineArg instanceof Max_elements_stmtContext) {
1616 Integer max = parseMaxElements((Max_elements_stmtContext) refineArg, refine.getModuleName());
1617 refine.setMaxElements(max);
1618 } else if (refineArg instanceof Min_elements_stmtContext) {
1619 Integer min = parseMinElements((Min_elements_stmtContext) refineArg, refine.getModuleName());
1620 refine.setMinElements(min);
1626 private static RefineBuilder parseRefine(final RefineHolderImpl refine, final Refine_leaf_list_stmtsContext refineStmt) {
1627 for (int i = 0; i < refineStmt.getChildCount(); i++) {
1628 ParseTree refineArg = refineStmt.getChild(i);
1629 if (refineArg instanceof Must_stmtContext) {
1630 MustDefinition must = parseMust((Must_stmtContext) refineArg);
1631 refine.setMust(must);
1632 } else if (refineArg instanceof Max_elements_stmtContext) {
1633 Integer max = parseMaxElements((Max_elements_stmtContext) refineArg, refine.getModuleName());
1634 refine.setMaxElements(max);
1635 } else if (refineArg instanceof Min_elements_stmtContext) {
1636 Integer min = parseMinElements((Min_elements_stmtContext) refineArg, refine.getModuleName());
1637 refine.setMinElements(min);
1643 private static RefineBuilder parseRefine(final RefineHolderImpl refine, final Refine_choice_stmtsContext refineStmt) {
1644 for (int i = 0; i < refineStmt.getChildCount(); i++) {
1645 ParseTree refineArg = refineStmt.getChild(i);
1646 if (refineArg instanceof Default_stmtContext) {
1647 String defaultStr = stringFromNode(refineArg);
1648 refine.setDefaultStr(defaultStr);
1649 } else if (refineArg instanceof Mandatory_stmtContext) {
1650 for (int j = 0; j < refineArg.getChildCount(); j++) {
1651 ParseTree mandatoryTree = refineArg.getChild(j);
1652 if (mandatoryTree instanceof Mandatory_argContext) {
1653 Boolean mandatory = Boolean.valueOf(stringFromNode(mandatoryTree));
1654 refine.setMandatory(mandatory);
1662 private static RefineBuilder parseRefine(final RefineBuilder refine, final Refine_anyxml_stmtsContext refineStmt) {
1663 for (int i = 0; i < refineStmt.getChildCount(); i++) {
1664 ParseTree refineArg = refineStmt.getChild(i);
1665 if (refineArg instanceof Must_stmtContext) {
1666 MustDefinition must = parseMust((Must_stmtContext) refineArg);
1667 refine.setMust(must);
1668 } else if (refineArg instanceof Mandatory_stmtContext) {
1669 for (int j = 0; j < refineArg.getChildCount(); j++) {
1670 ParseTree mandatoryTree = refineArg.getChild(j);
1671 if (mandatoryTree instanceof Mandatory_argContext) {
1672 Boolean mandatory = Boolean.valueOf(stringFromNode(mandatoryTree));
1673 refine.setMandatory(mandatory);
1681 public static String getArgumentString(final org.antlr.v4.runtime.ParserRuleContext ctx) {
1682 List<StringContext> potentialValues = ctx.getRuleContexts(StringContext.class);
1683 checkState(!potentialValues.isEmpty());
1684 return ParserListenerUtils.stringFromStringContext(potentialValues.get(0));
1687 public static <T extends ParserRuleContext> Optional<T> getFirstContext(final ParserRuleContext context,final Class<T> contextType) {
1688 List<T> potential = context.getRuleContexts(contextType);
1689 if(potential.isEmpty()) {
1690 return Optional.absent();
1692 return Optional.of(potential.get(0));