parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/augment/AbstractAugmentStatementSupport.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.augment;
   9
  10 import static com.google.common.base.Verify.verify;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.Lists;
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import java.util.List;
  16 import java.util.Objects;
  17 import java.util.regex.Pattern;
  18 import org.opendaylight.yangtools.yang.common.Empty;
  19 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.Status;
  21 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  22 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  23 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  24 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.WhenEffectiveStatement;
  33 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  34 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  35 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  36 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  37 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  38 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  39 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
  40 import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  44 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  50 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  51 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  52
  53 abstract class AbstractAugmentStatementSupport
  54         extends AbstractStatementSupport<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> {
  55     private static final Pattern PATH_REL_PATTERN1 = Pattern.compile("\\.\\.?\\s*/(.+)");
  56     private static final Pattern PATH_REL_PATTERN2 = Pattern.compile("//.*");
  57
  58     AbstractAugmentStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  59         super(YangStmtMapping.AUGMENT, StatementPolicy.copyDeclared(
  60             (copy, current, substatements) ->
  61                 copy.getArgument().equals(current.getArgument())
  62                 && copy.moduleName().getModule().equals(current.moduleName().getModule())
  63                 && Objects.equals(copy.original(), current.original())
  64             ), config, validator);
  65     }
  66
  67     @Override
  68     public final SchemaNodeIdentifier parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  69         SourceException.throwIf(PATH_REL_PATTERN1.matcher(value).matches()
  70             || PATH_REL_PATTERN2.matcher(value).matches(), ctx,
  71             "Augment argument \'%s\' is not valid, it can be only absolute path; or descendant if used in uses", value);
  72
  73         // As per:
  74         //   https://tools.ietf.org/html/rfc6020#section-7.15
  75         //   https://tools.ietf.org/html/rfc7950#section-7.17
  76         //
  77         // The argument is either Absolute or Descendant based on whether the statement is declared within a 'uses'
  78         // statement. The mechanics differs wildly between the two cases, so let's start by ensuring our argument
  79         // is in the correct domain.
  80         final SchemaNodeIdentifier result = ArgumentUtils.nodeIdentifierFromPath(ctx, value);
  81         final StatementDefinition parent = ctx.coerceParentContext().publicDefinition();
  82         if (parent == YangStmtMapping.USES) {
  83             SourceException.throwIf(result instanceof Absolute, ctx,
  84                 "Absolute schema node identifier is not allowed when used within a uses statement");
  85         } else {
  86             SourceException.throwIf(result instanceof Descendant, ctx,
  87                 "Descendant schema node identifier is not allowed when used outside of a uses statement");
  88         }
  89         return result;
  90     }
  91
  92     @Override
  93     public final void onFullDefinitionDeclared(
  94             final Mutable<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> augmentNode) {
  95         if (!augmentNode.isSupportedByFeatures()) {
  96             // We need this augment node to be present, but it should not escape to effective world
  97             augmentNode.setUnsupported();
  98         }
  99
 100         super.onFullDefinitionDeclared(augmentNode);
 101
 102         if (StmtContextUtils.isInExtensionBody(augmentNode)) {
 103             return;
 104         }
 105
 106         final ModelActionBuilder augmentAction = augmentNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
 107         augmentAction.requiresCtx(augmentNode, ModelProcessingPhase.EFFECTIVE_MODEL);
 108         final Prerequisite<Mutable<?, ?, EffectiveStatement<?, ?>>> target = augmentAction.mutatesEffectiveCtxPath(
 109             getSearchRoot(augmentNode), SchemaTreeNamespace.class, augmentNode.getArgument().getNodeIdentifiers());
 110
 111         augmentAction.apply(new AugmentInferenceAction(this, augmentNode, target));
 112     }
 113
 114     @Override
 115     protected final AugmentStatement createDeclared(final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx,
 116             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 117         return DeclaredStatements.createAugment(ctx.getRawArgument(), ctx.getArgument(), substatements);
 118     }
 119
 120     @Override
 121     protected final AugmentStatement attachDeclarationReference(final AugmentStatement stmt,
 122             final DeclarationReference reference) {
 123         return DeclaredStatementDecorators.decorateAugment(stmt, reference);
 124     }
 125
 126     @Override
 127     protected final List<? extends StmtContext<?, ?, ?>> statementsToBuild(
 128             final Current<SchemaNodeIdentifier, AugmentStatement> stmt,
 129             final List<? extends StmtContext<?, ?, ?>> substatements) {
 130         // Pick up the marker left by onFullDefinitionDeclared() inference action. If it is present we need to pass our
 131         // children through target's implicit wrapping.
 132         final StatementContextBase<?, ?, ?> implicitDef = stmt.getFromNamespace(AugmentImplicitHandlingNamespace.class,
 133             Empty.value());
 134         return implicitDef == null ? substatements : Lists.transform(substatements, subCtx -> {
 135             verify(subCtx instanceof StatementContextBase);
 136             return implicitDef.wrapWithImplicit((StatementContextBase<?, ?, ?>) subCtx);
 137         });
 138     }
 139
 140     @Override
 141     @SuppressFBWarnings(value = "BC_UNCONFIRMED_CAST", justification = "Cast of original(), should be always safe")
 142     protected final AugmentEffectiveStatement createEffective(
 143             final Current<SchemaNodeIdentifier, AugmentStatement> stmt,
 144             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 145         final int flags = new FlagsBuilder()
 146                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 147                 .toFlags();
 148
 149         try {
 150             return EffectiveStatements.createAugment(stmt.declared(), stmt.getArgument(), flags,
 151                 stmt.moduleName().getModule(), substatements, (AugmentationSchemaNode) stmt.original());
 152         } catch (SubstatementIndexingException e) {
 153             throw new SourceException(e.getMessage(), stmt, e);
 154         }
 155     }
 156
 157     abstract boolean allowsMandatory(StmtContext<?, ?, ?> ctx);
 158
 159     static StmtContext<?, ?, ?> getSearchRoot(final StmtContext<?, ?, ?> augmentContext) {
 160         // Augment is in uses - we need to augment instantiated nodes in parent.
 161         final StmtContext<?, ?, ?> parent = augmentContext.coerceParentContext();
 162         if (YangStmtMapping.USES == parent.publicDefinition()) {
 163             return parent.getParentContext();
 164         }
 165         return parent;
 166     }
 167
 168     static boolean hasWhenSubstatement(final StmtContext<?, ?, ?> ctx) {
 169         return ctx.hasSubstatement(WhenEffectiveStatement.class);
 170     }
 171 }