2 * Copyright (c) 2015 Cisco Systems, Inc. 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.stmt.rfc6020;
10 import com.google.common.collect.ImmutableSet;
11 import java.util.ArrayList;
12 import java.util.Collection;
14 import javax.annotation.Nonnull;
15 import org.opendaylight.yangtools.yang.common.QName;
16 import org.opendaylight.yangtools.yang.common.QNameModule;
17 import org.opendaylight.yangtools.yang.common.YangVersion;
18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
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.AugmentStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
27 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
30 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
31 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
44 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
45 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
46 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
47 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
48 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
49 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.UsesEffectiveStatementImpl;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
53 public class UsesStatementImpl extends AbstractDeclaredStatement<QName> implements UsesStatement {
54 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
56 .addAny(YangStmtMapping.AUGMENT)
57 .addOptional(YangStmtMapping.DESCRIPTION)
58 .addAny(YangStmtMapping.IF_FEATURE)
59 .addAny(YangStmtMapping.REFINE)
60 .addOptional(YangStmtMapping.REFERENCE)
61 .addOptional(YangStmtMapping.STATUS)
62 .addOptional(YangStmtMapping.WHEN)
65 private static final Logger LOG = LoggerFactory.getLogger(UsesStatementImpl.class);
67 protected UsesStatementImpl(final StmtContext<QName, UsesStatement, ?> context) {
71 public static class Definition extends
72 AbstractStatementSupport<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> {
75 super(YangStmtMapping.USES);
79 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
80 return Utils.qNameFromArgument(ctx, value);
84 public void onFullDefinitionDeclared(
85 final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
86 if (!usesNode.isSupportedByFeatures()) {
89 super.onFullDefinitionDeclared(usesNode);
91 if (StmtContextUtils.isInExtensionBody(usesNode)) {
95 final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
96 final QName groupingName = usesNode.getStatementArgument();
98 final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
99 GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
100 final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
101 usesNode.getParentContext());
103 usesAction.apply(new InferenceAction() {
106 public void apply(final InferenceContext ctx) {
107 final StatementContextBase<?, ?, ?> targetNodeStmtCtx = (StatementContextBase<?, ?, ?>) targetNodePre.resolve(ctx);
108 final StatementContextBase<?, ?, ?> sourceGrpStmtCtx = (StatementContextBase<?, ?, ?>) sourceGroupingPre.resolve(ctx);
111 copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
112 resolveUsesNode(usesNode, targetNodeStmtCtx);
113 StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
114 } catch (final SourceException e) {
115 LOG.warn(e.getMessage(), e);
121 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
122 InferenceException.throwIf(failed.contains(sourceGroupingPre),
123 usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
124 throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
130 public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
131 return new UsesStatementImpl(ctx);
135 public EffectiveStatement<QName, UsesStatement> createEffective(
136 final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
137 return new UsesEffectiveStatementImpl(ctx);
141 protected SubstatementValidator getSubstatementValidator() {
142 return SUBSTATEMENT_VALIDATOR;
149 public QName getName() {
154 public WhenStatement getWhenStatement() {
155 return firstDeclared(WhenStatement.class);
160 public Collection<? extends IfFeatureStatement> getIfFeatures() {
161 return allDeclared(IfFeatureStatement.class);
165 public StatusStatement getStatus() {
166 return firstDeclared(StatusStatement.class);
170 public DescriptionStatement getDescription() {
171 return firstDeclared(DescriptionStatement.class);
175 public ReferenceStatement getReference() {
176 return firstDeclared(ReferenceStatement.class);
181 public Collection<? extends AugmentStatement> getAugments() {
182 return allDeclared(AugmentStatement.class);
187 public Collection<? extends RefineStatement> getRefines() {
188 return allDeclared(RefineStatement.class);
192 * @param sourceGrpStmtCtx
193 * source grouping statement context
198 * @throws SourceException
199 * instance of SourceException
201 private static void copyFromSourceToTarget(final Mutable<?, ?, ?> sourceGrpStmtCtx,
202 final StatementContextBase<?, ?, ?> targetCtx,
203 final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
204 final Collection<? extends Mutable<?, ?, ?>> declared = sourceGrpStmtCtx.mutableDeclaredSubstatements();
205 final Collection<? extends Mutable<?, ?, ?>> effective = sourceGrpStmtCtx.mutableEffectiveSubstatements();
206 final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
207 final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
209 for (final Mutable<?, ?, ?> original : declared) {
210 if (original.isSupportedByFeatures()) {
211 copyStatement(original, targetCtx, newQNameModule, buffer);
215 for (final Mutable<?, ?, ?> original : effective) {
216 copyStatement(original, targetCtx, newQNameModule, buffer);
219 targetCtx.addEffectiveSubstatements(buffer);
220 usesNode.addAsEffectOfStatement(buffer);
223 private static void copyStatement(final Mutable<?, ?, ?> original,
224 final StatementContextBase<?, ?, ?> targetCtx, final QNameModule targetModule,
225 final Collection<Mutable<?, ?, ?>> buffer) {
226 if (needToCopyByUses(original)) {
227 final Mutable<?, ?, ?> copy = original.createCopy(targetModule, targetCtx, CopyType.ADDED_BY_USES);
229 } else if (isReusedByUsesOnTop(original)) {
230 buffer.add(original);
234 private static final Set<YangStmtMapping> TOP_REUSED_DEF_SET = ImmutableSet.of(
235 YangStmtMapping.TYPE,
236 YangStmtMapping.TYPEDEF);
238 private static boolean isReusedByUsesOnTop(final StmtContext<?, ?, ?> stmtContext) {
239 return TOP_REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
242 private static final Set<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
243 YangStmtMapping.DESCRIPTION,
244 YangStmtMapping.REFERENCE,
245 YangStmtMapping.STATUS);
246 private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
247 YangStmtMapping.TYPE,
248 YangStmtMapping.TYPEDEF,
249 YangStmtMapping.USES);
251 public static boolean needToCopyByUses(final StmtContext<?, ?, ?> stmtContext) {
252 final StatementDefinition def = stmtContext.getPublicDefinition();
253 if (REUSED_DEF_SET.contains(def)) {
254 LOG.debug("Will reuse {} statement {}", def, stmtContext);
257 if (NOCOPY_FROM_GROUPING_SET.contains(def)) {
258 return !YangStmtMapping.GROUPING.equals(stmtContext.getParentContext().getPublicDefinition());
261 LOG.debug("Will copy {} statement {}", def, stmtContext);
265 public static void resolveUsesNode(
266 final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
267 final StatementContextBase<?, ?, ?> targetNodeStmtCtx) {
268 for (final Mutable<?, ?, ?> subStmtCtx : usesNode.mutableDeclaredSubstatements()) {
269 if (StmtContextUtils.producesDeclared(subStmtCtx, RefineStatement.class)
270 && areFeaturesSupported(subStmtCtx)) {
271 performRefine(subStmtCtx, targetNodeStmtCtx);
276 private static boolean areFeaturesSupported(final Mutable<?, ?, ?> subStmtCtx) {
278 * In case of Yang 1.1, checks whether features are supported.
280 return !YangVersion.VERSION_1_1.equals(subStmtCtx.getRootVersion()) || subStmtCtx.isSupportedByFeatures();
283 private static void performRefine(final Mutable<?, ?, ?> subStmtCtx,
284 final StatementContextBase<?, ?, ?> usesParentCtx) {
286 final Object refineArgument = subStmtCtx.getStatementArgument();
287 InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier),
288 subStmtCtx.getStatementSourceReference(),
289 "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
291 final SchemaNodeIdentifier refineTargetNodeIdentifier = (SchemaNodeIdentifier) refineArgument;
292 final StatementContextBase<?, ?, ?> refineTargetNodeCtx = Utils.findNode(usesParentCtx,
293 refineTargetNodeIdentifier);
295 InferenceException.throwIfNull(refineTargetNodeCtx, subStmtCtx.getStatementSourceReference(),
296 "Refine target node %s not found.", refineTargetNodeIdentifier);
298 if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
300 "Refine node '{}' in uses '{}' has target node unknown statement '{}'. Refine has been skipped. At line: {}",
301 subStmtCtx.getStatementArgument(), subStmtCtx.getParentContext().getStatementArgument(),
302 refineTargetNodeCtx.getStatementArgument(), subStmtCtx.getStatementSourceReference());
303 subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
307 addOrReplaceNodes(subStmtCtx, refineTargetNodeCtx);
308 subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
311 private static void addOrReplaceNodes(final Mutable<?, ?, ?> subStmtCtx,
312 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
313 for (final Mutable<?, ?, ?> refineSubstatementCtx : subStmtCtx.mutableDeclaredSubstatements()) {
314 if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
315 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
320 private static void addOrReplaceNode(final Mutable<?, ?, ?> refineSubstatementCtx,
321 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
323 final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
325 SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
326 refineSubstatementCtx.getStatementSourceReference(),
327 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
328 refineSubstatementCtx.getRoot().getStatementArgument(), refineSubstatementCtx.getParentContext()
329 .getStatementArgument(), refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx
330 .getPublicDefinition());
332 if (isAllowedToAddByRefine(refineSubstatementDef)) {
333 refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
335 refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
336 refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
340 private static final Set<YangStmtMapping> ALLOWED_TO_ADD_BY_REFINE_DEF_SET = ImmutableSet.of(YangStmtMapping.MUST);
342 private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
343 return ALLOWED_TO_ADD_BY_REFINE_DEF_SET.contains(publicDefinition);
346 private static boolean isSupportedRefineSubstatement(final StmtContext<?, ?, ?> refineSubstatementCtx) {
347 final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
348 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
350 return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
351 || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
352 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
355 private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
356 final StmtContext<?, ?, ?> refineTargetNodeCtx) {
357 final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
358 .get(refineSubstatementCtx.getPublicDefinition());
360 return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
361 || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
365 private static QNameModule getNewQNameModule(final StmtContext<?, ?, ?> targetCtx,
366 final StmtContext<?, ?, ?> stmtContext) {
367 if (targetCtx.isRootContext()) {
368 return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
370 if (targetCtx.getPublicDefinition() == YangStmtMapping.AUGMENT) {
371 return Utils.getRootModuleQName(targetCtx);
374 final Object targetStmtArgument = targetCtx.getStatementArgument();
375 final Object sourceStmtArgument = stmtContext.getStatementArgument();
376 if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
377 return ((QName) targetStmtArgument).getModule();