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