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.Prerequisite;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
43 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
44 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
45 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
46 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
47 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
48 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.UsesEffectiveStatementImpl;
49 import org.slf4j.Logger;
50 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 StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
86 if (!StmtContextUtils.areFeaturesSupported(usesNode)) {
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() {
107 final StatementContextBase<?, ?, ?> targetNodeStmtCtx = (StatementContextBase<?, ?, ?>) targetNodePre.get();
108 final StatementContextBase<?, ?, ?> sourceGrpStmtCtx = (StatementContextBase<?, ?, ?>) sourceGroupingPre.get();
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 StatementContextBase<?, ?, ?> sourceGrpStmtCtx,
202 final StatementContextBase<?, ?, ?> targetCtx,
203 final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
204 final Collection<StatementContextBase<?, ?, ?>> declared = sourceGrpStmtCtx.declaredSubstatements();
205 final Collection<StatementContextBase<?, ?, ?>> effective = sourceGrpStmtCtx.effectiveSubstatements();
206 final Collection<StatementContextBase<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
207 final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
209 for (final StatementContextBase<?, ?, ?> original : declared) {
210 if (StmtContextUtils.areFeaturesSupported(original)) {
211 copyStatement(original, targetCtx, newQNameModule, buffer);
215 for (final StatementContextBase<?, ?, ?> original : effective) {
216 copyStatement(original, targetCtx, newQNameModule, buffer);
219 targetCtx.addEffectiveSubstatements(buffer);
220 usesNode.addAsEffectOfStatement(buffer);
223 private static void copyStatement(final StatementContextBase<?, ?, ?> original,
224 final StatementContextBase<?, ?, ?> targetCtx, final QNameModule targetModule,
225 final Collection<StatementContextBase<?, ?, ?>> buffer) {
226 if (needToCopyByUses(original)) {
227 final StatementContextBase<?, ?, ?> copy = original.createCopy(targetModule, targetCtx,
228 CopyType.ADDED_BY_USES);
230 } else if (isReusedByUsesOnTop(original)) {
231 buffer.add(original);
235 private static final Set<YangStmtMapping> TOP_REUSED_DEF_SET = ImmutableSet.of(
236 YangStmtMapping.TYPE,
237 YangStmtMapping.TYPEDEF);
239 private static boolean isReusedByUsesOnTop(final StmtContext<?, ?, ?> stmtContext) {
240 return TOP_REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
243 private static final Set<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
244 YangStmtMapping.DESCRIPTION,
245 YangStmtMapping.REFERENCE,
246 YangStmtMapping.STATUS);
247 private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
248 YangStmtMapping.TYPE,
249 YangStmtMapping.TYPEDEF,
250 YangStmtMapping.USES);
252 public static boolean needToCopyByUses(final StmtContext<?, ?, ?> stmtContext) {
253 final StatementDefinition def = stmtContext.getPublicDefinition();
254 if (REUSED_DEF_SET.contains(def)) {
255 LOG.debug("Will reuse {} statement {}", def, stmtContext);
258 if (NOCOPY_FROM_GROUPING_SET.contains(def)) {
259 return !YangStmtMapping.GROUPING.equals(stmtContext.getParentContext().getPublicDefinition());
262 LOG.debug("Will copy {} statement {}", def, stmtContext);
266 public static void resolveUsesNode(
267 final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
268 final StatementContextBase<?, ?, ?> targetNodeStmtCtx) {
269 for (final StatementContextBase<?, ?, ?> subStmtCtx : usesNode.declaredSubstatements()) {
270 if (StmtContextUtils.producesDeclared(subStmtCtx, RefineStatement.class)
271 && areFeaturesSupported(subStmtCtx)) {
272 performRefine(subStmtCtx, targetNodeStmtCtx);
277 private static boolean areFeaturesSupported(final StatementContextBase<?, ?, ?> subStmtCtx) {
279 * In case of Yang 1.1, checks whether features are supported.
281 return !YangVersion.VERSION_1_1.equals(subStmtCtx.getRootVersion()) || StmtContextUtils
282 .areFeaturesSupported(subStmtCtx);
285 private static void performRefine(final StatementContextBase<?, ?, ?> refineCtx,
286 final StatementContextBase<?, ?, ?> usesParentCtx) {
288 final Object refineArgument = refineCtx.getStatementArgument();
289 InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier),
290 refineCtx.getStatementSourceReference(),
291 "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
293 final SchemaNodeIdentifier refineTargetNodeIdentifier = (SchemaNodeIdentifier) refineArgument;
294 final StatementContextBase<?, ?, ?> refineTargetNodeCtx = Utils.findNode(usesParentCtx,
295 refineTargetNodeIdentifier);
297 InferenceException.throwIfNull(refineTargetNodeCtx, refineCtx.getStatementSourceReference(),
298 "Refine target node %s not found.", refineTargetNodeIdentifier);
300 if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
302 "Refine node '{}' in uses '{}' has target node unknown statement '{}'. Refine has been skipped. At line: {}",
303 refineCtx.getStatementArgument(), refineCtx.getParentContext().getStatementArgument(),
304 refineTargetNodeCtx.getStatementArgument(), refineCtx.getStatementSourceReference());
305 refineCtx.addAsEffectOfStatement(refineTargetNodeCtx);
309 addOrReplaceNodes(refineCtx, refineTargetNodeCtx);
310 refineCtx.addAsEffectOfStatement(refineTargetNodeCtx);
313 private static void addOrReplaceNodes(final StatementContextBase<?, ?, ?> refineCtx,
314 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
315 for (final StatementContextBase<?, ?, ?> refineSubstatementCtx : refineCtx.declaredSubstatements()) {
316 if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
317 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
322 private static void addOrReplaceNode(final StatementContextBase<?, ?, ?> refineSubstatementCtx,
323 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
325 final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
327 SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
328 refineSubstatementCtx.getStatementSourceReference(),
329 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
330 refineSubstatementCtx.getRoot().getStatementArgument(), refineSubstatementCtx.getParentContext()
331 .getStatementArgument(), refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx
332 .getPublicDefinition());
334 if (isAllowedToAddByRefine(refineSubstatementDef)) {
335 refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
337 refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
338 refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
342 private static final Set<YangStmtMapping> ALLOWED_TO_ADD_BY_REFINE_DEF_SET = ImmutableSet.of(YangStmtMapping.MUST);
344 private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
345 return ALLOWED_TO_ADD_BY_REFINE_DEF_SET.contains(publicDefinition);
348 private static boolean isSupportedRefineSubstatement(final StatementContextBase<?, ?, ?> refineSubstatementCtx) {
349 final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
350 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
352 return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
353 || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
354 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
357 private static boolean isSupportedRefineTarget(final StatementContextBase<?, ?, ?> refineSubstatementCtx,
358 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
360 final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
361 .get(refineSubstatementCtx.getPublicDefinition());
363 return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
364 || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
368 private static QNameModule getNewQNameModule(final StatementContextBase<?, ?, ?> targetCtx,
369 final StmtContext<?, ?, ?> stmtContext) {
370 if (targetCtx.isRootContext()) {
371 return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
373 if (targetCtx.getPublicDefinition() == YangStmtMapping.AUGMENT) {
374 return Utils.getRootModuleQName(targetCtx);
377 final Object targetStmtArgument = targetCtx.getStatementArgument();
378 final Object sourceStmtArgument = stmtContext.getStatementArgument();
379 if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
380 return ((QName) targetStmtArgument).getModule();