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.meta.AbstractDeclaredStatement;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
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.meta.SubstatementValidator;
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 AbstractQNameStatementSupport<UsesStatement, EffectiveStatement<QName, UsesStatement>> {
75 super(YangStmtMapping.USES);
79 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
80 return StmtContextUtils.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 final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
92 final QName groupingName = usesNode.getStatementArgument();
94 final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
95 GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
96 final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
97 usesNode.getParentContext());
99 usesAction.apply(new InferenceAction() {
102 public void apply(final InferenceContext ctx) {
103 final StatementContextBase<?, ?, ?> targetNodeStmtCtx = (StatementContextBase<?, ?, ?>) targetNodePre.resolve(ctx);
104 final StatementContextBase<?, ?, ?> sourceGrpStmtCtx = (StatementContextBase<?, ?, ?>) sourceGroupingPre.resolve(ctx);
107 copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
108 resolveUsesNode(usesNode, targetNodeStmtCtx);
109 StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
110 } catch (final SourceException e) {
111 LOG.warn(e.getMessage(), e);
117 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
118 InferenceException.throwIf(failed.contains(sourceGroupingPre),
119 usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
120 throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
126 public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
127 return new UsesStatementImpl(ctx);
131 public EffectiveStatement<QName, UsesStatement> createEffective(
132 final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
133 return new UsesEffectiveStatementImpl(ctx);
137 protected SubstatementValidator getSubstatementValidator() {
138 return SUBSTATEMENT_VALIDATOR;
145 public QName getName() {
150 public WhenStatement getWhenStatement() {
151 return firstDeclared(WhenStatement.class);
156 public Collection<? extends IfFeatureStatement> getIfFeatures() {
157 return allDeclared(IfFeatureStatement.class);
161 public StatusStatement getStatus() {
162 return firstDeclared(StatusStatement.class);
166 public DescriptionStatement getDescription() {
167 return firstDeclared(DescriptionStatement.class);
171 public ReferenceStatement getReference() {
172 return firstDeclared(ReferenceStatement.class);
177 public Collection<? extends AugmentStatement> getAugments() {
178 return allDeclared(AugmentStatement.class);
183 public Collection<? extends RefineStatement> getRefines() {
184 return allDeclared(RefineStatement.class);
188 * @param sourceGrpStmtCtx
189 * source grouping statement context
194 * @throws SourceException
195 * instance of SourceException
197 static void copyFromSourceToTarget(final Mutable<?, ?, ?> sourceGrpStmtCtx,
198 final StatementContextBase<?, ?, ?> targetCtx,
199 final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
200 final Collection<? extends Mutable<?, ?, ?>> declared = sourceGrpStmtCtx.mutableDeclaredSubstatements();
201 final Collection<? extends Mutable<?, ?, ?>> effective = sourceGrpStmtCtx.mutableEffectiveSubstatements();
202 final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
203 final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
205 for (final Mutable<?, ?, ?> original : declared) {
206 if (original.isSupportedByFeatures()) {
207 copyStatement(original, targetCtx, newQNameModule, buffer);
211 for (final Mutable<?, ?, ?> original : effective) {
212 copyStatement(original, targetCtx, newQNameModule, buffer);
215 targetCtx.addEffectiveSubstatements(buffer);
216 usesNode.addAsEffectOfStatement(buffer);
219 private static void copyStatement(final Mutable<?, ?, ?> original,
220 final StatementContextBase<?, ?, ?> targetCtx, final QNameModule targetModule,
221 final Collection<Mutable<?, ?, ?>> buffer) {
222 if (needToCopyByUses(original)) {
223 final Mutable<?, ?, ?> copy = targetCtx.childCopyOf(original, CopyType.ADDED_BY_USES, targetModule);
225 } else if (isReusedByUsesOnTop(original)) {
226 buffer.add(original);
230 private static final Set<YangStmtMapping> TOP_REUSED_DEF_SET = ImmutableSet.of(
231 YangStmtMapping.TYPE,
232 YangStmtMapping.TYPEDEF);
234 private static boolean isReusedByUsesOnTop(final StmtContext<?, ?, ?> stmtContext) {
235 return TOP_REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
238 private static final Set<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
239 YangStmtMapping.DESCRIPTION,
240 YangStmtMapping.REFERENCE,
241 YangStmtMapping.STATUS);
242 private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
243 YangStmtMapping.TYPE,
244 YangStmtMapping.TYPEDEF,
245 YangStmtMapping.USES);
247 public static boolean needToCopyByUses(final StmtContext<?, ?, ?> stmtContext) {
248 final StatementDefinition def = stmtContext.getPublicDefinition();
249 if (REUSED_DEF_SET.contains(def)) {
250 LOG.debug("Will reuse {} statement {}", def, stmtContext);
253 if (NOCOPY_FROM_GROUPING_SET.contains(def)) {
254 return !YangStmtMapping.GROUPING.equals(stmtContext.getParentContext().getPublicDefinition());
257 LOG.debug("Will copy {} statement {}", def, stmtContext);
261 public static void resolveUsesNode(
262 final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
263 final StmtContext<?, ?, ?> targetNodeStmtCtx) {
264 for (final Mutable<?, ?, ?> subStmtCtx : usesNode.mutableDeclaredSubstatements()) {
265 if (StmtContextUtils.producesDeclared(subStmtCtx, RefineStatement.class)
266 && areFeaturesSupported(subStmtCtx)) {
267 performRefine(subStmtCtx, targetNodeStmtCtx);
272 private static boolean areFeaturesSupported(final StmtContext<?, ?, ?> subStmtCtx) {
274 * In case of Yang 1.1, checks whether features are supported.
276 return !YangVersion.VERSION_1_1.equals(subStmtCtx.getRootVersion()) || subStmtCtx.isSupportedByFeatures();
279 private static void performRefine(final Mutable<?, ?, ?> subStmtCtx, final StmtContext<?, ?, ?> usesParentCtx) {
281 final Object refineArgument = subStmtCtx.getStatementArgument();
282 InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier),
283 subStmtCtx.getStatementSourceReference(),
284 "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
286 final SchemaNodeIdentifier refineTargetNodeIdentifier = (SchemaNodeIdentifier) refineArgument;
287 final StatementContextBase<?, ?, ?> refineTargetNodeCtx = Utils.findNode(usesParentCtx,
288 refineTargetNodeIdentifier);
290 InferenceException.throwIfNull(refineTargetNodeCtx, subStmtCtx.getStatementSourceReference(),
291 "Refine target node %s not found.", refineTargetNodeIdentifier);
293 if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
294 LOG.debug("Refine node '{}' in uses '{}' has target node unknown statement '{}'. "
295 + "Refine has been skipped. At line: {}", subStmtCtx.getStatementArgument(),
296 subStmtCtx.getParentContext().getStatementArgument(),
297 refineTargetNodeCtx.getStatementArgument(), subStmtCtx.getStatementSourceReference());
298 subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
302 addOrReplaceNodes(subStmtCtx, refineTargetNodeCtx);
303 subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
306 private static void addOrReplaceNodes(final Mutable<?, ?, ?> subStmtCtx,
307 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
308 for (final Mutable<?, ?, ?> refineSubstatementCtx : subStmtCtx.mutableDeclaredSubstatements()) {
309 if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
310 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
315 private static void addOrReplaceNode(final Mutable<?, ?, ?> refineSubstatementCtx,
316 final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
318 final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
320 SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
321 refineSubstatementCtx.getStatementSourceReference(),
322 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
323 refineSubstatementCtx.getRoot().getStatementArgument(), refineSubstatementCtx.getParentContext()
324 .getStatementArgument(), refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx
325 .getPublicDefinition());
327 if (isAllowedToAddByRefine(refineSubstatementDef)) {
328 refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
330 refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
331 refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
335 private static final Set<YangStmtMapping> ALLOWED_TO_ADD_BY_REFINE_DEF_SET = ImmutableSet.of(YangStmtMapping.MUST);
337 private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
338 return ALLOWED_TO_ADD_BY_REFINE_DEF_SET.contains(publicDefinition);
341 private static boolean isSupportedRefineSubstatement(final StmtContext<?, ?, ?> refineSubstatementCtx) {
342 final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
343 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
345 return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
346 || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
347 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
350 private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
351 final StmtContext<?, ?, ?> refineTargetNodeCtx) {
352 final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
353 .get(refineSubstatementCtx.getPublicDefinition());
355 return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
356 || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
360 private static QNameModule getNewQNameModule(final StmtContext<?, ?, ?> targetCtx,
361 final StmtContext<?, ?, ?> stmtContext) {
362 if (targetCtx.getParentContext() == null) {
363 return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
365 if (targetCtx.getPublicDefinition() == YangStmtMapping.AUGMENT) {
366 return StmtContextUtils.getRootModuleQName(targetCtx);
369 final Object targetStmtArgument = targetCtx.getStatementArgument();
370 final Object sourceStmtArgument = stmtContext.getStatementArgument();
371 if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
372 return ((QName) targetStmtArgument).getModule();