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.list;
10 import static com.google.common.base.Verify.verify;
12 import com.google.common.collect.ImmutableList;
13 import com.google.common.collect.ImmutableSet;
14 import java.util.ArrayList;
15 import java.util.HashSet;
16 import java.util.List;
17 import java.util.Optional;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
22 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
23 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
24 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
25 import org.opendaylight.yangtools.yang.model.api.Status;
26 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
27 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
28 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
30 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
31 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
32 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
33 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
34 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByStatement.Ordering;
35 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
36 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
37 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
38 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
39 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
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.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
47 abstract class AbstractListStatementSupport extends BaseQNameStatementSupport<ListStatement, ListEffectiveStatement> {
48 private static final Logger LOG = LoggerFactory.getLogger(AbstractListStatementSupport.class);
49 private static final ImmutableSet<YangStmtMapping> UNINSTANTIATED_DATATREE_STATEMENTS = ImmutableSet.of(
50 YangStmtMapping.GROUPING, YangStmtMapping.NOTIFICATION, YangStmtMapping.INPUT, YangStmtMapping.OUTPUT);
52 AbstractListStatementSupport() {
53 super(YangStmtMapping.LIST);
57 public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
58 return StmtContextUtils.parseIdentifier(ctx, value);
62 public final void onStatementAdded(final Mutable<QName, ListStatement, ListEffectiveStatement> stmt) {
63 stmt.coerceParentContext().addToNs(ChildSchemaNodeNamespace.class, stmt.coerceStatementArgument(), stmt);
67 protected final ListStatement createDeclared(final StmtContext<QName, ListStatement, ?> ctx,
68 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
69 return new RegularListStatement(ctx.coerceStatementArgument(), substatements);
73 protected final ListStatement createEmptyDeclared(final StmtContext<QName, ListStatement, ?> ctx) {
74 return new EmptyListStatement(ctx.coerceStatementArgument());
78 protected final ListEffectiveStatement createEffective(
79 final StmtContext<QName, ListStatement, ListEffectiveStatement> ctx,
80 final ListStatement declared, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
81 final SchemaPath path = ctx.getSchemaPath().get();
82 final ListSchemaNode original = (ListSchemaNode) ctx.getOriginalCtx().map(StmtContext::buildEffective)
85 final ImmutableList<QName> keyDefinition;
86 final KeyEffectiveStatement keyStmt = findFirstStatement(substatements, KeyEffectiveStatement.class);
87 if (keyStmt != null) {
88 final List<QName> keyDefinitionInit = new ArrayList<>(keyStmt.argument().size());
89 final Set<QName> possibleLeafQNamesForKey = new HashSet<>();
90 for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
91 if (effectiveStatement instanceof LeafSchemaNode) {
92 possibleLeafQNamesForKey.add(((LeafSchemaNode) effectiveStatement).getQName());
95 for (final QName keyQName : keyStmt.argument()) {
96 if (!possibleLeafQNamesForKey.contains(keyQName)) {
97 throw new InferenceException(ctx.getStatementSourceReference(),
98 "Key '%s' misses node '%s' in list '%s'", keyStmt.getDeclared().rawArgument(),
99 keyQName.getLocalName(), ctx.getStatementArgument());
101 keyDefinitionInit.add(keyQName);
104 keyDefinition = ImmutableList.copyOf(keyDefinitionInit);
106 keyDefinition = ImmutableList.of();
109 final boolean configuration = ctx.isConfiguration();
110 final int flags = new FlagsBuilder()
111 .setHistory(ctx.getCopyHistory())
112 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
113 .setConfiguration(configuration)
114 .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, Ordering.SYSTEM)
115 .equals(Ordering.USER))
117 if (configuration && keyDefinition.isEmpty() && isInstantied(ctx)) {
121 final Optional<ElementCountConstraint> elementCountConstraint =
122 EffectiveStmtUtils.createElementCountConstraint(substatements);
123 return original == null && !elementCountConstraint.isPresent()
124 ? new EmptyListEffectiveStatement(declared, path, flags, ctx, substatements, keyDefinition)
125 : new RegularListEffectiveStatement(declared, path, flags, ctx, substatements, keyDefinition,
126 elementCountConstraint.orElse(null), original);
129 private static void warnConfigList(final @NonNull StmtContext<QName, ListStatement, ListEffectiveStatement> ctx) {
130 final StmtContext<QName, ListStatement, ListEffectiveStatement> warnCtx = ctx.getOriginalCtx().orElse(ctx);
131 final Boolean warned = warnCtx.getFromNamespace(ConfigListWarningNamespace.class, Boolean.TRUE);
132 // Hacky check if we have issued a warning for the original statement
133 if (warned == null) {
134 verify(warnCtx instanceof Mutable, "Unexpected context %s", warnCtx);
135 ((Mutable<?, ?, ?>) warnCtx).addToNs(ConfigListWarningNamespace.class, Boolean.TRUE, Boolean.TRUE);
136 LOG.info("Configuration list {} does not define any keys in violation of RFC7950 section 7.8.2. While "
137 + "this is fine with OpenDaylight, it can cause interoperability issues with other systems "
138 + "[defined at {}]", ctx.getStatementArgument(), warnCtx.getStatementSourceReference());
142 private static boolean isInstantied(final StmtContext<?, ?, ?> ctx) {
143 StmtContext<?, ?, ?> parent = ctx.getParentContext();
144 while (parent != null) {
145 final StatementDefinition parentDef = parent.getPublicDefinition();
146 if (UNINSTANTIATED_DATATREE_STATEMENTS.contains(parentDef)) {
150 final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
151 if (YangStmtMapping.AUGMENT == parentDef && grandParent != null) {
152 // If this is an augment statement and its parent is either a 'module' or 'submodule' statement, we are
153 // dealing with an uninstantiated context.
154 final StatementDefinition grandParentDef = grandParent.getPublicDefinition();
155 if (YangStmtMapping.MODULE == grandParentDef || YangStmtMapping.SUBMODULE == grandParentDef) {
160 parent = grandParent;
166 protected final ListEffectiveStatement createEmptyEffective(
167 final StmtContext<QName, ListStatement, ListEffectiveStatement> ctx, final ListStatement declared) {
168 return createEffective(ctx, declared, ImmutableList.of());