Centralize substatement validators
[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.DeclarationReference;
21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureExpr;
25 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
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.parser.api.YangParserConfiguration;
30 import org.opendaylight.yangtools.yang.parser.spi.FeatureNamespace;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
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.SubstatementValidator;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44
45 abstract class AbstractIfFeatureStatementSupport
46         extends AbstractStatementSupport<IfFeatureExpr, IfFeatureStatement, IfFeatureEffectiveStatement> {
47     private static final Logger LOG = LoggerFactory.getLogger(AbstractIfFeatureStatementSupport.class);
48     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
49         SubstatementValidator.builder(YangStmtMapping.IF_FEATURE).build();
50
51     AbstractIfFeatureStatementSupport(final YangParserConfiguration config) {
52         super(YangStmtMapping.IF_FEATURE, StatementPolicy.contextIndependent(), config, SUBSTATEMENT_VALIDATOR);
53     }
54
55     @Override
56     public final void onFullDefinitionDeclared(
57             final Mutable<IfFeatureExpr, IfFeatureStatement, IfFeatureEffectiveStatement> stmt) {
58         super.onFullDefinitionDeclared(stmt);
59
60         final ModelActionBuilder verifyFeatures = stmt.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
61         final Map<Prerequisite<?>, QName> backRef = new HashMap<>();
62         for (QName feature : stmt.getArgument().getReferencedFeatures()) {
63             backRef.put(verifyFeatures.requiresCtx(stmt, FeatureNamespace.class, feature,
64                 ModelProcessingPhase.EFFECTIVE_MODEL), feature);
65         }
66
67         verifyFeatures.apply(new InferenceAction() {
68             @Override
69             public void apply(final InferenceContext ctx) {
70                 LOG.debug("Resolved all feature references in {}", backRef.values());
71             }
72
73             @Override
74             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
75                 final Set<QName> unresolvedFeatures = new HashSet<>();
76                 for (Prerequisite<?> prereq : failed) {
77                     unresolvedFeatures.add(verifyNotNull(backRef.get(prereq)));
78                 }
79
80                 throw new InferenceException(stmt, "Failed to resolve feature references %s in \"%s\"",
81                     unresolvedFeatures, stmt.rawArgument());
82             }
83         });
84     }
85
86     @Override
87     protected final IfFeatureStatement createDeclared(final StmtContext<IfFeatureExpr, IfFeatureStatement, ?> ctx,
88             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
89         return DeclaredStatements.createIfFeature(ctx.getRawArgument(), ctx.getArgument(), substatements);
90     }
91
92     @Override
93     protected final IfFeatureStatement attachDeclarationReference(final IfFeatureStatement stmt,
94             final DeclarationReference reference) {
95         return DeclaredStatementDecorators.decorateIfFeature(stmt, reference);
96     }
97
98     @Override
99     protected final IfFeatureEffectiveStatement createEffective(final Current<IfFeatureExpr, IfFeatureStatement> stmt,
100             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
101         return EffectiveStatements.createIfFeature(stmt.declared(), substatements);
102     }
103 }