/*
* Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.yangtools.yang.parser.rfc7950.stmt;
import static com.google.common.base.Verify.verify;
import com.google.common.annotations.Beta;
import com.google.common.base.MoreObjects;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableSet;
import java.util.Collection;
import java.util.Optional;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.opendaylight.yangtools.concepts.Mutable;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
import org.opendaylight.yangtools.yang.model.api.AddedByUsesAware;
import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
import org.opendaylight.yangtools.yang.model.api.ConstraintMetaDefinition;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.CopyableNode;
import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
import org.opendaylight.yangtools.yang.model.api.MustConstraintAware;
import org.opendaylight.yangtools.yang.model.api.MustDefinition;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
import org.opendaylight.yangtools.yang.model.api.Status;
import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
import org.opendaylight.yangtools.yang.model.api.UsesNode;
import org.opendaylight.yangtools.yang.model.api.WhenConditionAware;
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.stmt.DescriptionEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ErrorAppTagEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ErrorMessageEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.OutputEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.WhenEffectiveStatement;
import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
/**
* Mix-in interfaces providing services required by SchemaNode et al. These interfaces provide implementations, or
* implementation helpers based on default methods, so the correct behavior can be logically centralized.
*/
@Beta
public final class EffectiveStatementMixins {
// Marker interface requiring all mixins to be derived from EffectiveStatement.
private interface Mixin> extends EffectiveStatement {
@SuppressWarnings("unchecked")
default @NonNull Collection extends T> filterEffectiveStatements(final Class type) {
// Yeah, this is not nice, but saves one transformation
return (Collection extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
}
}
/**
* Bridge between {@link EffectiveStatement} and {@link AugmentationTarget}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface AugmentationTargetMixin>
extends Mixin, AugmentationTarget {
@Override
default Collection extends AugmentationSchemaNode> getAvailableAugmentations() {
return filterEffectiveStatements(AugmentationSchemaNode.class);
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link AddedByUsesAware}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface AddedByUsesMixin>
extends EffectiveStatementWithFlags, AddedByUsesAware {
@Override
default boolean isAddedByUses() {
return (flags() & FlagsBuilder.ADDED_BY_USES) != 0;
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link ActionNodeContainer}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface ActionNodeContainerMixin>
extends Mixin, ActionNodeContainer {
@Override
default Collection extends ActionDefinition> getActions() {
return filterEffectiveStatements(ActionDefinition.class);
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link NotificationNodeContainer}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface NotificationNodeContainerMixin>
extends Mixin, NotificationNodeContainer {
@Override
default Collection extends NotificationDefinition> getNotifications() {
return filterEffectiveStatements(NotificationDefinition.class);
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link MustConstraintAware}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface MustConstraintMixin> extends Mixin, MustConstraintAware {
@Override
default Collection extends MustDefinition> getMustConstraints() {
return filterEffectiveStatements(MustDefinition.class);
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link CopyableNode}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface CopyableMixin> extends AddedByUsesMixin, CopyableNode {
@Override
default boolean isAugmenting() {
return (flags() & FlagsBuilder.AUGMENTING) != 0;
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link DataNodeContainer}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface DataNodeContainerMixin> extends DataNodeContainer, Mixin {
@Override
default Collection extends TypeDefinition>> getTypeDefinitions() {
return filterTypeDefinitions(this);
}
@Override
default Collection extends DataSchemaNode> getChildNodes() {
return filterEffectiveStatements(DataSchemaNode.class);
}
@Override
default Collection extends GroupingDefinition> getGroupings() {
return filterEffectiveStatements(GroupingDefinition.class);
}
@Override
default Collection extends UsesNode> getUses() {
return filterEffectiveStatements(UsesNode.class);
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link DataSchemaNode}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface DataSchemaNodeMixin>
extends DataSchemaNode, CopyableMixin, SchemaNodeMixin, WhenConditionMixin {
@Override
default boolean isConfiguration() {
return (flags() & FlagsBuilder.CONFIGURATION) != 0;
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link DocumentedNode}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface DocumentedNodeMixin> extends Mixin, DocumentedNode {
/**
* Bridge between {@link EffectiveStatementWithFlags} and
* {@link org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
interface WithStatus>
extends EffectiveStatementWithFlags, DocumentedNodeMixin, DocumentedNode.WithStatus {
@Override
default Status getStatus() {
final int status = flags() & FlagsBuilder.MASK_STATUS;
switch (status) {
case FlagsBuilder.STATUS_CURRENT:
return Status.CURRENT;
case FlagsBuilder.STATUS_DEPRECATED:
return Status.DEPRECATED;
case FlagsBuilder.STATUS_OBSOLETE:
return Status.OBSOLETE;
default:
throw new IllegalStateException("Illegal status " + status);
}
}
}
@Override
default Optional getDescription() {
return findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class);
}
@Override
default Optional getReference() {
return findFirstEffectiveSubstatementArgument(ReferenceEffectiveStatement.class);
}
@Override
default Collection extends UnknownSchemaNode> getUnknownSchemaNodes() {
return filterEffectiveStatements(UnknownSchemaNode.class);
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link ConstraintMetaDefinition}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface ConstraintMetaDefinitionMixin> extends DocumentedNodeMixin,
ConstraintMetaDefinition {
@Override
default Optional getErrorAppTag() {
return findFirstEffectiveSubstatementArgument(ErrorAppTagEffectiveStatement.class);
}
@Override
default Optional getErrorMessage() {
return findFirstEffectiveSubstatementArgument(ErrorMessageEffectiveStatement.class);
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link MandatoryAware}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface MandatoryMixin>
extends EffectiveStatementWithFlags, MandatoryAware {
@Override
default boolean isMandatory() {
return (flags() & FlagsBuilder.MANDATORY) != 0;
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@code presence} statement.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface PresenceMixin> extends EffectiveStatementWithFlags {
default boolean presence() {
return (flags() & FlagsBuilder.PRESENCE) != 0;
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@link SchemaNode}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface SchemaNodeMixin>
extends DocumentedNodeMixin.WithStatus, SchemaNode {
@Override
default QName getQName() {
return getPath().getLastComponent();
}
}
/**
* Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface UserOrderedMixin> extends EffectiveStatementWithFlags {
default boolean userOrdered() {
return (flags() & FlagsBuilder.USER_ORDERED) != 0;
}
}
/**
* Helper used to locate the effective {@code when} statement and exposing its argument as per
* {@link WhenConditionAware}.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface WhenConditionMixin> extends Mixin, WhenConditionAware {
@Override
default Optional getWhenCondition() {
return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
}
}
/**
* Helper bridge for operation containers ({@code input} and {@code output}).
*
* @param Class representing declared version of this statement.
*/
public interface OperationContainerMixin>
extends ContainerSchemaNode, DocumentedNodeMixin.WithStatus, DataNodeContainerMixin,
MustConstraintMixin, WhenConditionMixin, AugmentationTargetMixin,
SchemaNodeMixin, CopyableMixin {
@Override
default @NonNull QName argument() {
return getQName();
}
@Override
default Optional findAction(final QName qname) {
return Optional.empty();
}
@Override
default Optional findNotification(final QName qname) {
return Optional.empty();
}
@Override
default Collection extends ActionDefinition> getActions() {
return ImmutableSet.of();
}
@Override
default Collection extends NotificationDefinition> getNotifications() {
return ImmutableSet.of();
}
@Override
default boolean isConfiguration() {
return false;
}
@Override
default boolean isPresenceContainer() {
// FIXME: this should not really be here
return false;
}
default String defaultToString() {
return MoreObjects.toStringHelper(this).add("path", getPath()).toString();
}
}
/**
* Helper bridge for {@code anydata} and {@code anyxml} opaque data.
*
* @param Class representing declared version of this statement.
*/
public interface OpaqueDataSchemaNodeMixin>
extends DerivableSchemaNode, DataSchemaNodeMixin, DocumentedNodeMixin.WithStatus,
MandatoryMixin, MustConstraintMixin, WhenConditionMixin {
@Override
default @NonNull QName argument() {
return getQName();
}
}
/**
* Helper bridge for {@code rpc} and {@code action} operations.
*
* @param Class representing declared version of this statement.
*/
public interface OperationDefinitionMixin>
extends SchemaNodeMixin, OperationDefinition {
@Override
default @NonNull QName argument() {
return getQName();
}
@Override
default Collection extends TypeDefinition>> getTypeDefinitions() {
return filterTypeDefinitions(this);
}
@Override
default Collection extends GroupingDefinition> getGroupings() {
return filterEffectiveStatements(GroupingDefinition.class);
}
@Override
default ContainerSchemaNode getInput() {
return findAsContainer(this, InputEffectiveStatement.class);
}
@Override
default ContainerSchemaNode getOutput() {
return findAsContainer(this, OutputEffectiveStatement.class);
}
}
/**
* Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
* globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
*
* @param Argument type ({@link Void} if statement does not have argument.)
* @param Class representing declared version of this statement.
*/
public interface EffectiveStatementWithFlags> extends Mixin {
/**
* Return flags assicated with this statements. Flags can be built using {@link FlagsBuilder}.
*
* @return Flag field value (32 bits).
*/
int flags();
@NonNullByDefault
final class FlagsBuilder implements Mutable {
// We still have 24 flags remaining
static final int STATUS_CURRENT = 0x0001;
static final int STATUS_DEPRECATED = 0x0002;
static final int STATUS_OBSOLETE = 0x0003;
static final int MASK_STATUS = 0x0003;
static final int CONFIGURATION = 0x0004;
static final int MANDATORY = 0x0008;
static final int AUGMENTING = 0x0010;
static final int ADDED_BY_USES = 0x0020;
private static final int MASK_HISTORY = 0x0030;
static final int USER_ORDERED = 0x0040;
static final int PRESENCE = 0x0080;
private int flags;
public FlagsBuilder setConfiguration(final boolean config) {
if (config) {
flags |= CONFIGURATION;
} else {
flags &= ~CONFIGURATION;
}
return this;
}
public FlagsBuilder setHistory(final CopyHistory history) {
int bits;
if (history.contains(CopyType.ADDED_BY_USES_AUGMENTATION)) {
bits = AUGMENTING | ADDED_BY_USES;
} else {
bits = 0;
if (history.contains(CopyType.ADDED_BY_AUGMENTATION)) {
bits |= AUGMENTING;
}
if (history.contains(CopyType.ADDED_BY_USES)) {
bits |= ADDED_BY_USES;
}
}
flags = flags & ~MASK_HISTORY | bits;
return this;
}
public FlagsBuilder setMandatory(final boolean mandatory) {
if (mandatory) {
flags |= MANDATORY;
} else {
flags &= ~MANDATORY;
}
return this;
}
public FlagsBuilder setPresence(final boolean presence) {
if (presence) {
flags |= PRESENCE;
} else {
flags &= ~PRESENCE;
}
return this;
}
public FlagsBuilder setStatus(final Status status) {
final int bits;
switch (status) {
case CURRENT:
bits = STATUS_CURRENT;
break;
case DEPRECATED:
bits = STATUS_DEPRECATED;
break;
case OBSOLETE:
bits = STATUS_OBSOLETE;
break;
default:
throw new IllegalStateException("Unhandled status " + status);
}
flags = flags & ~MASK_STATUS | bits;
return this;
}
public FlagsBuilder setUserOrdered(final boolean userOrdered) {
if (userOrdered) {
flags |= USER_ORDERED;
} else {
flags &= ~USER_ORDERED;
}
return this;
}
public int toFlags() {
return flags;
}
}
}
private EffectiveStatementMixins() {
}
static ContainerSchemaNode findAsContainer(final EffectiveStatement, ?> stmt,
final Class extends EffectiveStatement> type) {
final EffectiveStatement, ?> statement = stmt.findFirstEffectiveSubstatement(type).get();
verify(statement instanceof ContainerSchemaNode, "Child statement %s is not a ContainerSchemaNode",
statement);
return (ContainerSchemaNode) statement;
}
static Collection extends TypeDefinition>> filterTypeDefinitions(final Mixin, ?> stmt) {
return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
TypedefEffectiveStatement::getTypeDefinition);
}
}