parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/DeviationStatementSupport.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.meta;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.Iterables;
  14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  15 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  17 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.DeviationEffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.DeviationStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
  22 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  23 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  24 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  25 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  26 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  34 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleCtx;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  36
  37 public final class DeviationStatementSupport
  38         extends AbstractStatementSupport<Absolute, DeviationStatement, DeviationEffectiveStatement> {
  39     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  40         SubstatementValidator.builder(YangStmtMapping.DEVIATION)
  41             .addOptional(YangStmtMapping.DESCRIPTION)
  42             .addAny(YangStmtMapping.DEVIATE)
  43             .addOptional(YangStmtMapping.REFERENCE)
  44             .build();
  45
  46     public DeviationStatementSupport(final YangParserConfiguration config) {
  47         super(YangStmtMapping.DEVIATION, StatementPolicy.reject(), config, SUBSTATEMENT_VALIDATOR);
  48     }
  49
  50     @Override
  51     public Absolute parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  52         return ArgumentUtils.parseAbsoluteSchemaNodeIdentifier(ctx, value);
  53     }
  54
  55     @Override
  56     public void onFullDefinitionDeclared(final Mutable<Absolute, DeviationStatement, DeviationEffectiveStatement> ctx) {
  57         super.onFullDefinitionDeclared(ctx);
  58
  59         StmtContext<?, ?, ?> root = ctx.getRoot();
  60         if (root.producesDeclared(SubmoduleStatement.class)) {
  61             // root is submodule, we need to find the module we belong to. We can rely on there being exactly one
  62             // belongs-to statement, enforced SubmoduleStatementSupport's validator.
  63             root = Iterables.getOnlyElement(
  64                 root.getAllFromNamespace(BelongsToPrefixToModuleCtx.class).values());
  65         }
  66
  67         final var currentModule = verifyNotNull(ctx.getFromNamespace(ModuleCtxToModuleQName.class, root),
  68             "Failed to find QName for %s", root);
  69         final var targetModule = Iterables.getLast(ctx.getArgument().getNodeIdentifiers()).getModule();
  70         if (currentModule.equals(targetModule)) {
  71             throw new InferenceException(ctx,
  72                     "Deviation must not target the same module as the one it is defined in: %s", currentModule);
  73         }
  74     }
  75
  76     @Override
  77     protected DeviationStatement createDeclared(final BoundStmtCtx<Absolute> ctx,
  78             final ImmutableList<DeclaredStatement<?>> substatements) {
  79         return DeclaredStatements.createDeviation(ctx.getRawArgument(), ctx.getArgument(), substatements);
  80     }
  81
  82     @Override
  83     protected DeviationStatement attachDeclarationReference(final DeviationStatement stmt,
  84             final DeclarationReference reference) {
  85         return DeclaredStatementDecorators.decorateDeviation(stmt, reference);
  86     }
  87
  88     @Override
  89     protected DeviationEffectiveStatement createEffective(final Current<Absolute, DeviationStatement> stmt,
  90             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  91         return EffectiveStatements.createDeviation(stmt.declared(), substatements);
  92     }
  93 }