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