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