*/
package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.list;
+import static com.google.common.base.Verify.verify;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
+import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.Status;
import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
+import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
+import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
-import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
-import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
+import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByStatement.Ordering;
+import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
+import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseSchemaTreeStatementSupport;
+import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
+import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
+import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+abstract class AbstractListStatementSupport extends
+ BaseSchemaTreeStatementSupport<ListStatement, ListEffectiveStatement> {
-abstract class AbstractListStatementSupport
- extends AbstractQNameStatementSupport<ListStatement, EffectiveStatement<QName, ListStatement>> {
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractListStatementSupport.class);
+ private static final ImmutableSet<YangStmtMapping> UNINSTANTIATED_DATATREE_STATEMENTS = ImmutableSet.of(
+ YangStmtMapping.GROUPING, YangStmtMapping.NOTIFICATION, YangStmtMapping.INPUT, YangStmtMapping.OUTPUT);
AbstractListStatementSupport() {
super(YangStmtMapping.LIST);
}
@Override
- public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
- return StmtContextUtils.parseIdentifier(ctx, value);
+ protected final ListStatement createDeclared(final StmtContext<QName, ListStatement, ?> ctx,
+ final ImmutableList<? extends DeclaredStatement<?>> substatements) {
+ return new RegularListStatement(ctx.coerceStatementArgument(), substatements);
}
@Override
- public final void onStatementAdded(
- final Mutable<QName, ListStatement, EffectiveStatement<QName, ListStatement>> stmt) {
- stmt.getParentContext().addToNs(ChildSchemaNodeNamespace.class, stmt.getStatementArgument(), stmt);
+ protected final ListStatement createEmptyDeclared(final StmtContext<QName, ListStatement, ?> ctx) {
+ return new EmptyListStatement(ctx.coerceStatementArgument());
}
@Override
- public final ListStatement createDeclared(final StmtContext<QName, ListStatement, ?> ctx) {
- return new ListStatementImpl(ctx);
+ protected final ListEffectiveStatement createEffective(
+ final StmtContext<QName, ListStatement, ListEffectiveStatement> ctx,
+ final ListStatement declared, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
+ final SchemaPath path = ctx.getSchemaPath().get();
+ final ListSchemaNode original = (ListSchemaNode) ctx.getOriginalCtx().map(StmtContext::buildEffective)
+ .orElse(null);
+
+ final ImmutableList<QName> keyDefinition;
+ final KeyEffectiveStatement keyStmt = findFirstStatement(substatements, KeyEffectiveStatement.class);
+ if (keyStmt != null) {
+ final List<QName> keyDefinitionInit = new ArrayList<>(keyStmt.argument().size());
+ final Set<QName> possibleLeafQNamesForKey = new HashSet<>();
+ for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
+ if (effectiveStatement instanceof LeafSchemaNode) {
+ possibleLeafQNamesForKey.add(((LeafSchemaNode) effectiveStatement).getQName());
+ }
+ }
+ for (final QName keyQName : keyStmt.argument()) {
+ if (!possibleLeafQNamesForKey.contains(keyQName)) {
+ throw new InferenceException(ctx.getStatementSourceReference(),
+ "Key '%s' misses node '%s' in list '%s'", keyStmt.getDeclared().rawArgument(),
+ keyQName.getLocalName(), ctx.getStatementArgument());
+ }
+ keyDefinitionInit.add(keyQName);
+ }
+
+ keyDefinition = ImmutableList.copyOf(keyDefinitionInit);
+ } else {
+ keyDefinition = ImmutableList.of();
+ }
+
+ final boolean configuration = ctx.isConfiguration();
+ final int flags = new FlagsBuilder()
+ .setHistory(ctx.getCopyHistory())
+ .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
+ .setConfiguration(configuration)
+ .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, Ordering.SYSTEM)
+ .equals(Ordering.USER))
+ .toFlags();
+ if (configuration && keyDefinition.isEmpty() && isInstantied(ctx)) {
+ warnConfigList(ctx);
+ }
+
+ final Optional<ElementCountConstraint> elementCountConstraint =
+ EffectiveStmtUtils.createElementCountConstraint(substatements);
+ return original == null && !elementCountConstraint.isPresent()
+ ? new EmptyListEffectiveStatement(declared, path, flags, ctx, substatements, keyDefinition)
+ : new RegularListEffectiveStatement(declared, path, flags, ctx, substatements, keyDefinition,
+ elementCountConstraint.orElse(null), original);
+ }
+
+ private static void warnConfigList(final @NonNull StmtContext<QName, ListStatement, ListEffectiveStatement> ctx) {
+ final StmtContext<QName, ListStatement, ListEffectiveStatement> warnCtx = ctx.getOriginalCtx().orElse(ctx);
+ final Boolean warned = warnCtx.getFromNamespace(ConfigListWarningNamespace.class, Boolean.TRUE);
+ // Hacky check if we have issued a warning for the original statement
+ if (warned == null) {
+ verify(warnCtx instanceof Mutable, "Unexpected context %s", warnCtx);
+ ((Mutable<?, ?, ?>) warnCtx).addToNs(ConfigListWarningNamespace.class, Boolean.TRUE, Boolean.TRUE);
+ LOG.info("Configuration list {} does not define any keys in violation of RFC7950 section 7.8.2. While "
+ + "this is fine with OpenDaylight, it can cause interoperability issues with other systems "
+ + "[defined at {}]", ctx.getStatementArgument(), warnCtx.getStatementSourceReference());
+ }
+ }
+
+ private static boolean isInstantied(final StmtContext<?, ?, ?> ctx) {
+ StmtContext<?, ?, ?> parent = ctx.getParentContext();
+ while (parent != null) {
+ final StatementDefinition parentDef = parent.getPublicDefinition();
+ if (UNINSTANTIATED_DATATREE_STATEMENTS.contains(parentDef)) {
+ return false;
+ }
+
+ final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
+ if (YangStmtMapping.AUGMENT == parentDef && grandParent != null) {
+ // If this is an augment statement and its parent is either a 'module' or 'submodule' statement, we are
+ // dealing with an uninstantiated context.
+ final StatementDefinition grandParentDef = grandParent.getPublicDefinition();
+ if (YangStmtMapping.MODULE == grandParentDef || YangStmtMapping.SUBMODULE == grandParentDef) {
+ return false;
+ }
+ }
+
+ parent = grandParent;
+ }
+ return true;
}
@Override
- public final EffectiveStatement<QName, ListStatement> createEffective(
- final StmtContext<QName, ListStatement, EffectiveStatement<QName, ListStatement>> ctx) {
- return new ListEffectiveStatementImpl(ctx);
+ protected final ListEffectiveStatement createEmptyEffective(
+ final StmtContext<QName, ListStatement, ListEffectiveStatement> ctx, final ListStatement declared) {
+ return createEffective(ctx, declared, ImmutableList.of());
}
-}
\ No newline at end of file
+}
Code Review / yangtools.git / blobdiff