2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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/epl-v10.html
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.typedef;
10 import static com.google.common.base.Preconditions.checkState;
12 import com.google.common.collect.ImmutableList;
13 import java.util.Collection;
14 import org.opendaylight.yangtools.yang.common.QName;
15 import org.opendaylight.yangtools.yang.model.api.Status;
16 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
25 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
26 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
27 import org.opendaylight.yangtools.yang.parser.spi.TypeNamespace;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
38 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
40 public final class TypedefStatementSupport extends
41 BaseQNameStatementSupport<TypedefStatement, TypedefEffectiveStatement> {
42 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
43 YangStmtMapping.TYPEDEF)
44 .addOptional(YangStmtMapping.DEFAULT)
45 .addOptional(YangStmtMapping.DESCRIPTION)
46 .addOptional(YangStmtMapping.REFERENCE)
47 .addOptional(YangStmtMapping.STATUS)
48 .addMandatory(YangStmtMapping.TYPE)
49 .addOptional(YangStmtMapping.UNITS)
51 private static final TypedefStatementSupport INSTANCE = new TypedefStatementSupport();
53 private TypedefStatementSupport() {
54 super(YangStmtMapping.TYPEDEF);
57 public static TypedefStatementSupport getInstance() {
62 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
63 return StmtContextUtils.parseIdentifier(ctx, value);
67 public void onFullDefinitionDeclared(final Mutable<QName, TypedefStatement, TypedefEffectiveStatement> stmt) {
68 super.onFullDefinitionDeclared(stmt);
70 final Mutable<?, ?, ?> parent = stmt.getParentContext();
72 // Shadowing check: make sure we do not trample on pre-existing definitions. This catches sibling
73 // declarations and parent declarations which have already been declared.
74 checkConflict(parent, stmt);
75 parent.addContext(TypeNamespace.class, stmt.getArgument(), stmt);
77 final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
78 if (grandParent != null) {
79 // Shadowing check: make sure grandparent does not see a conflicting definition. This is required to
80 // ensure that a typedef in child scope does not shadow a typedef in parent scope which occurs later in
81 // the text. For that check we need the full declaration of our model.
83 final ModelActionBuilder action = stmt.newInferenceAction(ModelProcessingPhase.FULL_DECLARATION);
84 action.requiresCtx(grandParent.getRoot(), ModelProcessingPhase.FULL_DECLARATION);
85 action.apply(new InferenceAction() {
87 public void apply(final InferenceContext ctx) {
88 checkConflict(grandParent, stmt);
92 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
101 protected SubstatementValidator getSubstatementValidator() {
102 return SUBSTATEMENT_VALIDATOR;
106 protected TypedefStatement createDeclared(final StmtContext<QName, TypedefStatement, ?> ctx,
107 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
108 return new RegularTypedefStatement(ctx.getArgument(), substatements);
112 protected TypedefStatement createEmptyDeclared(final StmtContext<QName, TypedefStatement, ?> ctx) {
113 return new EmptyTypedefStatement(ctx.getArgument());
117 protected TypedefEffectiveStatement createEffective(final Current<QName, TypedefStatement> stmt,
118 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
119 final TypedefStatement declared = stmt.declared();
120 checkState(!substatements.isEmpty(), "Refusing to create empty typedef for %s", stmt.declared());
122 final TypeEffectiveStatement<?> typeEffectiveStmt = findFirstStatement(substatements,
123 TypeEffectiveStatement.class);
124 final String dflt = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
125 SourceException.throwIf(
126 EffectiveStmtUtils.hasDefaultValueMarkedWithIfFeature(stmt.yangVersion(), typeEffectiveStmt, dflt), stmt,
127 "Typedef '%s' has default value '%s' marked with an if-feature statement.", stmt.argument(), dflt);
129 return new TypedefEffectiveStatementImpl(declared, stmt.wrapSchemaPath(), computeFlags(substatements),
133 private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
134 final QName arg = stmt.getArgument();
135 final StmtContext<?, ?, ?> existing = parent.getFromNamespace(TypeNamespace.class, arg);
136 // RFC7950 sections 5.5 and 6.2.1: identifiers must not be shadowed
137 SourceException.throwIf(existing != null, stmt, "Duplicate name for typedef %s", arg);
140 private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
141 return new FlagsBuilder()
142 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))