Teach YANG parser to retain DeclarationReference
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / if_feature / AbstractIfFeatureStatementSupport.java
1 /*
2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.if_feature;
9
10 import static com.google.common.base.Verify.verifyNotNull;
11
12 import com.google.common.collect.ImmutableList;
13 import java.util.Collection;
14 import java.util.HashMap;
15 import java.util.HashSet;
16 import java.util.Map;
17 import java.util.Set;
18 import org.opendaylight.yangtools.yang.common.QName;
19 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureEffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureExpr;
24 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
25 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
27 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
28 import org.opendaylight.yangtools.yang.parser.spi.FeatureNamespace;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42
43 abstract class AbstractIfFeatureStatementSupport
44         extends AbstractStatementSupport<IfFeatureExpr, IfFeatureStatement, IfFeatureEffectiveStatement> {
45     private static final Logger LOG = LoggerFactory.getLogger(AbstractIfFeatureStatementSupport.class);
46     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
47         YangStmtMapping.IF_FEATURE)
48         .build();
49
50     AbstractIfFeatureStatementSupport(final YangParserConfiguration config) {
51         super(YangStmtMapping.IF_FEATURE, StatementPolicy.contextIndependent(), config);
52     }
53
54     @Override
55     public final void onFullDefinitionDeclared(
56             final Mutable<IfFeatureExpr, IfFeatureStatement, IfFeatureEffectiveStatement> stmt) {
57         super.onFullDefinitionDeclared(stmt);
58
59         final ModelActionBuilder verifyFeatures = stmt.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
60         final Map<Prerequisite<?>, QName> backRef = new HashMap<>();
61         for (QName feature : stmt.getArgument().getReferencedFeatures()) {
62             backRef.put(verifyFeatures.requiresCtx(stmt, FeatureNamespace.class, feature,
63                 ModelProcessingPhase.EFFECTIVE_MODEL), feature);
64         }
65
66         verifyFeatures.apply(new InferenceAction() {
67             @Override
68             public void apply(final InferenceContext ctx) {
69                 LOG.debug("Resolved all feature references in {}", backRef.values());
70             }
71
72             @Override
73             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
74                 final Set<QName> unresolvedFeatures = new HashSet<>();
75                 for (Prerequisite<?> prereq : failed) {
76                     unresolvedFeatures.add(verifyNotNull(backRef.get(prereq)));
77                 }
78
79                 throw new InferenceException(stmt, "Failed to resolve feature references %s in \"%s\"",
80                     unresolvedFeatures, stmt.rawArgument());
81             }
82         });
83     }
84
85     @Override
86     protected final SubstatementValidator getSubstatementValidator() {
87         return SUBSTATEMENT_VALIDATOR;
88     }
89
90     @Override
91     protected final IfFeatureStatement createDeclared(final StmtContext<IfFeatureExpr, IfFeatureStatement, ?> ctx,
92             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
93         return DeclaredStatements.createIfFeature(ctx.getRawArgument(), ctx.getArgument(), substatements);
94     }
95
96     @Override
97     protected final IfFeatureEffectiveStatement createEffective(final Current<IfFeatureExpr, IfFeatureStatement> stmt,
98             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
99         return EffectiveStatements.createIfFeature(stmt.declared(), substatements);
100     }
101 }