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.meta;
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.DeclarationReference;
18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
25 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
28 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
29 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
31 import org.opendaylight.yangtools.yang.parser.spi.TypeNamespace;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
43 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
45 public final class TypedefStatementSupport extends
46 AbstractQNameStatementSupport<TypedefStatement, TypedefEffectiveStatement> {
47 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
48 YangStmtMapping.TYPEDEF)
49 .addOptional(YangStmtMapping.DEFAULT)
50 .addOptional(YangStmtMapping.DESCRIPTION)
51 .addOptional(YangStmtMapping.REFERENCE)
52 .addOptional(YangStmtMapping.STATUS)
53 .addMandatory(YangStmtMapping.TYPE)
54 .addOptional(YangStmtMapping.UNITS)
57 public TypedefStatementSupport(final YangParserConfiguration config) {
58 super(YangStmtMapping.TYPEDEF, StatementPolicy.exactReplica(), config);
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 DeclaredStatements.createTypedef(ctx.getArgument(), substatements);
112 protected TypedefStatement attachDeclarationReference(final TypedefStatement stmt,
113 final DeclarationReference reference) {
114 return DeclaredStatementDecorators.decorateTypedef(stmt, reference);
118 protected TypedefEffectiveStatement createEffective(final Current<QName, TypedefStatement> stmt,
119 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
120 final TypedefStatement declared = stmt.declared();
121 checkState(!substatements.isEmpty(), "Refusing to create empty typedef for %s", stmt.declared());
123 final TypeEffectiveStatement<?> typeEffectiveStmt = findFirstStatement(substatements,
124 TypeEffectiveStatement.class);
125 final String dflt = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
126 SourceException.throwIf(
127 EffectiveStmtUtils.hasDefaultValueMarkedWithIfFeature(stmt.yangVersion(), typeEffectiveStmt, dflt), stmt,
128 "Typedef '%s' has default value '%s' marked with an if-feature statement.", stmt.argument(), dflt);
130 return EffectiveStatements.createTypedef(declared, stmt.effectivePath(), computeFlags(substatements),
134 private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
135 final QName arg = stmt.getArgument();
136 final StmtContext<?, ?, ?> existing = parent.getFromNamespace(TypeNamespace.class, arg);
137 // RFC7950 sections 5.5 and 6.2.1: identifiers must not be shadowed
138 SourceException.throwIf(existing != null, stmt, "Duplicate name for typedef %s", arg);
141 private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
142 return new FlagsBuilder()
143 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))