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