2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.augment;
10 import static com.google.common.base.Verify.verify;
12 import com.google.common.collect.ImmutableList;
13 import com.google.common.collect.Lists;
14 import java.util.List;
15 import java.util.Objects;
16 import java.util.regex.Pattern;
17 import org.opendaylight.yangtools.yang.common.Empty;
18 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
19 import org.opendaylight.yangtools.yang.model.api.Status;
20 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
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.parser.api.YangParserConfiguration;
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.rfc7950.stmt.ArgumentUtils;
37 import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
44 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
45 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
46 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
47 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
49 abstract class AbstractAugmentStatementSupport
50 extends AbstractStatementSupport<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> {
51 private static final Pattern PATH_REL_PATTERN1 = Pattern.compile("\\.\\.?\\s*/(.+)");
52 private static final Pattern PATH_REL_PATTERN2 = Pattern.compile("//.*");
54 AbstractAugmentStatementSupport(final YangParserConfiguration config) {
55 super(YangStmtMapping.AUGMENT, StatementPolicy.copyDeclared(
56 (copy, current, substatements) ->
57 copy.getArgument().equals(current.getArgument())
58 && copy.moduleName().getModule().equals(current.moduleName().getModule())
59 && Objects.equals(copy.original(), current.original())
64 public final SchemaNodeIdentifier parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
65 SourceException.throwIf(PATH_REL_PATTERN1.matcher(value).matches()
66 || PATH_REL_PATTERN2.matcher(value).matches(), ctx,
67 "Augment argument \'%s\' is not valid, it can be only absolute path; or descendant if used in uses", value);
70 // https://tools.ietf.org/html/rfc6020#section-7.15
71 // https://tools.ietf.org/html/rfc7950#section-7.17
73 // The argument is either Absolute or Descendant based on whether the statement is declared within a 'uses'
74 // statement. The mechanics differs wildly between the two cases, so let's start by ensuring our argument
75 // is in the correct domain.
76 final SchemaNodeIdentifier result = ArgumentUtils.nodeIdentifierFromPath(ctx, value);
77 final StatementDefinition parent = ctx.coerceParentContext().publicDefinition();
78 if (parent == YangStmtMapping.USES) {
79 SourceException.throwIf(result instanceof Absolute, ctx,
80 "Absolute schema node identifier is not allowed when used within a uses statement");
82 SourceException.throwIf(result instanceof Descendant, ctx,
83 "Descendant schema node identifier is not allowed when used outside of a uses statement");
89 public final void onFullDefinitionDeclared(
90 final Mutable<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> augmentNode) {
91 if (!augmentNode.isSupportedByFeatures()) {
92 // We need this augment node to be present, but it should not escape to effective world
93 augmentNode.setIsSupportedToBuildEffective(false);
96 super.onFullDefinitionDeclared(augmentNode);
98 if (StmtContextUtils.isInExtensionBody(augmentNode)) {
102 final ModelActionBuilder augmentAction = augmentNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
103 augmentAction.requiresCtx(augmentNode, ModelProcessingPhase.EFFECTIVE_MODEL);
104 final Prerequisite<Mutable<?, ?, EffectiveStatement<?, ?>>> target = augmentAction.mutatesEffectiveCtxPath(
105 getSearchRoot(augmentNode), SchemaTreeNamespace.class, augmentNode.getArgument().getNodeIdentifiers());
107 augmentAction.apply(new AugmentInferenceAction(this, augmentNode, target));
111 protected final AugmentStatement createDeclared(final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx,
112 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
113 return DeclaredStatements.createAugment(ctx.getRawArgument(), ctx.getArgument(), substatements);
117 protected final List<? extends StmtContext<?, ?, ?>> statementsToBuild(
118 final Current<SchemaNodeIdentifier, AugmentStatement> stmt,
119 final List<? extends StmtContext<?, ?, ?>> substatements) {
120 // Pick up the marker left by onFullDefinitionDeclared() inference action. If it is present we need to pass our
121 // children through target's implicit wrapping.
122 final StatementContextBase<?, ?, ?> implicitDef = stmt.getFromNamespace(AugmentImplicitHandlingNamespace.class,
123 Empty.getInstance());
124 return implicitDef == null ? substatements : Lists.transform(substatements, subCtx -> {
125 verify(subCtx instanceof StatementContextBase);
126 return implicitDef.wrapWithImplicit((StatementContextBase<?, ?, ?>) subCtx);
131 protected final AugmentEffectiveStatement createEffective(
132 final Current<SchemaNodeIdentifier, AugmentStatement> stmt,
133 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
134 final int flags = new FlagsBuilder()
135 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
139 return EffectiveStatements.createAugment(stmt.declared(), stmt.getArgument(), flags,
140 stmt.moduleName().getModule(), substatements, stmt.original(AugmentationSchemaNode.class));
141 } catch (SubstatementIndexingException e) {
142 throw new SourceException(e.getMessage(), stmt, e);
146 abstract boolean allowsMandatory(StmtContext<?, ?, ?> ctx);
148 static StmtContext<?, ?, ?> getSearchRoot(final StmtContext<?, ?, ?> augmentContext) {
149 // Augment is in uses - we need to augment instantiated nodes in parent.
150 final StmtContext<?, ?, ?> parent = augmentContext.coerceParentContext();
151 if (YangStmtMapping.USES == parent.publicDefinition()) {
152 return parent.getParentContext();
157 static boolean hasWhenSubstatement(final StmtContext<?, ?, ?> ctx) {
158 return ctx.hasSubstatement(WhenEffectiveStatement.class);