yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/uses/UsesStatementSupport.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.uses;
   9
  10 import java.util.Collection;
  11 import org.opendaylight.yangtools.yang.common.QName;
  12 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  13 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  14 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  15 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  16 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  17 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  18 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  19 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  20 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  27 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  28 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  29 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.UsesEffectiveStatementImpl;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 public final class UsesStatementSupport extends
  34         AbstractQNameStatementSupport<UsesStatement, EffectiveStatement<QName, UsesStatement>> {
  35     private static final Logger LOG = LoggerFactory.getLogger(UsesStatementSupport.class);
  36     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  37         .USES)
  38         .addAny(YangStmtMapping.AUGMENT)
  39         .addOptional(YangStmtMapping.DESCRIPTION)
  40         .addAny(YangStmtMapping.IF_FEATURE)
  41         .addAny(YangStmtMapping.REFINE)
  42         .addOptional(YangStmtMapping.REFERENCE)
  43         .addOptional(YangStmtMapping.STATUS)
  44         .addOptional(YangStmtMapping.WHEN)
  45         .build();
  46
  47     public UsesStatementSupport() {
  48         super(YangStmtMapping.USES);
  49     }
  50
  51     @Override
  52     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  53         return StmtContextUtils.qnameFromArgument(ctx, value);
  54     }
  55
  56     @Override
  57     public void onFullDefinitionDeclared(
  58             final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
  59         if (!usesNode.isSupportedByFeatures()) {
  60             return;
  61         }
  62         super.onFullDefinitionDeclared(usesNode);
  63
  64         final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  65         final QName groupingName = usesNode.getStatementArgument();
  66
  67         final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
  68                 GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
  69         final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
  70                 usesNode.getParentContext());
  71
  72         usesAction.apply(new InferenceAction() {
  73
  74             @Override
  75             public void apply(final InferenceContext ctx) {
  76                 final StatementContextBase<?, ?, ?> targetNodeStmtCtx =
  77                         (StatementContextBase<?, ?, ?>) targetNodePre.resolve(ctx);
  78                 final StatementContextBase<?, ?, ?> sourceGrpStmtCtx =
  79                         (StatementContextBase<?, ?, ?>) sourceGroupingPre.resolve(ctx);
  80
  81                 try {
  82                     UsesStatementImpl.copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
  83                     UsesStatementImpl.resolveUsesNode(usesNode, targetNodeStmtCtx);
  84                     StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
  85                 } catch (final SourceException e) {
  86                     LOG.warn(e.getMessage(), e);
  87                     throw e;
  88                 }
  89             }
  90
  91             @Override
  92             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  93                 InferenceException.throwIf(failed.contains(sourceGroupingPre),
  94                         usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
  95                 throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
  96             }
  97         });
  98     }
  99
 100     @Override
 101     public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
 102         return new UsesStatementImpl(ctx);
 103     }
 104
 105     @Override
 106     public EffectiveStatement<QName, UsesStatement> createEffective(
 107             final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
 108         return new UsesEffectiveStatementImpl(ctx);
 109     }
 110
 111     @Override
 112     protected SubstatementValidator getSubstatementValidator() {
 113         return SUBSTATEMENT_VALIDATOR;
 114     }
 115 }