yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/EffectiveStatementMixins.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt;
   9
  10 import static com.google.common.base.Verify.verify;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.collect.Collections2;
  15 import com.google.common.collect.ImmutableSet;
  16 import java.util.Collection;
  17 import java.util.Optional;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.opendaylight.yangtools.concepts.Mutable;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
  24 import org.opendaylight.yangtools.yang.model.api.AddedByUsesAware;
  25 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  27 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.CopyableNode;
  29 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  30 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
  33 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
  35 import org.opendaylight.yangtools.yang.model.api.MustConstraintAware;
  36 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
  37 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
  39 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
  41 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.Status;
  43 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  44 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  46 import org.opendaylight.yangtools.yang.model.api.WhenConditionAware;
  47 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  48 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.OutputEffectiveStatement;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceEffectiveStatement;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  54 import org.opendaylight.yangtools.yang.model.api.stmt.WhenEffectiveStatement;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
  56 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  57
  58 /**
  59  * Mix-in interfaces providing services required by SchemaNode et al. These interfaces provide implementations, or
  60  * implementation helpers based on default methods, so the correct behavior can be logically centralized.
  61  */
  62 @Beta
  63 public final class EffectiveStatementMixins {
  64     // Marker interface requiring all mixins to be derived from EffectiveStatement.
  65     private interface Mixin<A, D extends DeclaredStatement<A>> extends EffectiveStatement<A, D> {
  66         @SuppressWarnings("unchecked")
  67         default <T> Collection<? extends T> filterEffectiveStatements(final Class<T> type) {
  68             // Yeah, this is not nice, but saves one transformation
  69             return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
  70         }
  71     }
  72
  73     /**
  74      * Bridge between {@link EffectiveStatement} and {@link AugmentationTarget}.
  75      *
  76      * @param <A> Argument type ({@link Void} if statement does not have argument.)
  77      * @param <D> Class representing declared version of this statement.
  78      */
  79     public interface AugmentationTargetMixin<A, D extends DeclaredStatement<A>>
  80             extends Mixin<A, D>, AugmentationTarget {
  81         @Override
  82         default Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
  83             return filterEffectiveStatements(AugmentationSchemaNode.class);
  84         }
  85     }
  86
  87     /**
  88      * Bridge between {@link EffectiveStatementWithFlags} and {@link AddedByUsesAware}.
  89      *
  90      * @param <A> Argument type ({@link Void} if statement does not have argument.)
  91      * @param <D> Class representing declared version of this statement.
  92      */
  93     public interface AddedByUsesMixin<A, D extends DeclaredStatement<A>>
  94             extends EffectiveStatementWithFlags<A, D>, AddedByUsesAware {
  95         @Override
  96         default boolean isAddedByUses() {
  97             return (flags() & FlagsBuilder.ADDED_BY_USES) != 0;
  98         }
  99     }
 100
 101     /**
 102      * Bridge between {@link EffectiveStatementWithFlags} and {@link ActionNodeContainer}.
 103      *
 104      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 105      * @param <D> Class representing declared version of this statement.
 106      */
 107     public interface ActionNodeContainerMixin<A, D extends DeclaredStatement<A>>
 108             extends Mixin<A, D>, ActionNodeContainer {
 109         @Override
 110         default Collection<? extends ActionDefinition> getActions() {
 111             return filterEffectiveStatements(ActionDefinition.class);
 112         }
 113     }
 114
 115     /**
 116      * Bridge between {@link EffectiveStatementWithFlags} and {@link NotificationNodeContainer}.
 117      *
 118      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 119      * @param <D> Class representing declared version of this statement.
 120      */
 121     public interface NotificationNodeContainerMixin<A, D extends DeclaredStatement<A>>
 122             extends Mixin<A, D>, NotificationNodeContainer {
 123         @Override
 124         default Collection<? extends NotificationDefinition> getNotifications() {
 125             return filterEffectiveStatements(NotificationDefinition.class);
 126         }
 127     }
 128
 129     /**
 130      * Bridge between {@link EffectiveStatementWithFlags} and {@link MustConstraintAware}.
 131      *
 132      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 133      * @param <D> Class representing declared version of this statement.
 134      */
 135     public interface MustConstraintMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, MustConstraintAware {
 136         @Override
 137         default Collection<? extends MustDefinition> getMustConstraints() {
 138             return filterEffectiveStatements(MustDefinition.class);
 139         }
 140     }
 141
 142     /**
 143      * Bridge between {@link EffectiveStatementWithFlags} and {@link CopyableNode}.
 144      *
 145      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 146      * @param <D> Class representing declared version of this statement.
 147      */
 148     public interface CopyableMixin<A, D extends DeclaredStatement<A>> extends AddedByUsesMixin<A, D>, CopyableNode {
 149         @Override
 150         default boolean isAugmenting() {
 151             return (flags() & FlagsBuilder.AUGMENTING) != 0;
 152         }
 153     }
 154
 155     /**
 156      * Bridge between {@link EffectiveStatementWithFlags} and {@link DataNodeContainer}.
 157      *
 158      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 159      * @param <D> Class representing declared version of this statement.
 160      */
 161     public interface DataNodeContainerMixin<A, D extends DeclaredStatement<A>> extends DataNodeContainer, Mixin<A, D> {
 162         @Override
 163         default Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 164             return filterTypeDefinitions(this);
 165         }
 166
 167         @Override
 168         default Collection<? extends DataSchemaNode> getChildNodes() {
 169             return filterEffectiveStatements(DataSchemaNode.class);
 170         }
 171
 172         @Override
 173         default Collection<? extends GroupingDefinition> getGroupings() {
 174             return filterEffectiveStatements(GroupingDefinition.class);
 175         }
 176
 177         @Override
 178         default Collection<? extends UsesNode> getUses() {
 179             return filterEffectiveStatements(UsesNode.class);
 180         }
 181     }
 182
 183     /**
 184      * Bridge between {@link EffectiveStatementWithFlags} and {@link DataSchemaNode}.
 185      *
 186      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 187      * @param <D> Class representing declared version of this statement.
 188      */
 189     public interface DataSchemaNodeMixin<A, D extends DeclaredStatement<A>>
 190             extends DataSchemaNode, CopyableMixin<A, D>, SchemaNodeMixin<A, D>, WhenConditionMixin<A, D> {
 191         @Override
 192         default boolean isConfiguration() {
 193             return (flags() & FlagsBuilder.CONFIGURATION) != 0;
 194         }
 195     }
 196
 197     /**
 198      * Bridge between {@link EffectiveStatementWithFlags} and {@link DocumentedNode}.
 199      *
 200      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 201      * @param <D> Class representing declared version of this statement.
 202      */
 203     public interface DocumentedNodeMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, DocumentedNode {
 204         /**
 205          * Bridge between {@link EffectiveStatementWithFlags} and
 206          * {@link org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus}.
 207          *
 208          * @param <A> Argument type ({@link Void} if statement does not have argument.)
 209          * @param <D> Class representing declared version of this statement.
 210          */
 211         interface WithStatus<A, D extends DeclaredStatement<A>>
 212                 extends EffectiveStatementWithFlags<A, D>, DocumentedNodeMixin<A, D>, DocumentedNode.WithStatus {
 213             @Override
 214             default Status getStatus() {
 215                 final int status = flags() & FlagsBuilder.MASK_STATUS;
 216                 switch (status) {
 217                     case FlagsBuilder.STATUS_CURRENT:
 218                         return Status.CURRENT;
 219                     case FlagsBuilder.STATUS_DEPRECATED:
 220                         return Status.DEPRECATED;
 221                     case FlagsBuilder.STATUS_OBSOLETE:
 222                         return Status.OBSOLETE;
 223                     default:
 224                         throw new IllegalStateException("Illegal status " + status);
 225                 }
 226             }
 227         }
 228
 229         @Override
 230         default Optional<String> getDescription() {
 231             return findFirstEffectiveSubstatementArgument(DescriptionEffectiveStatement.class);
 232         }
 233
 234         @Override
 235         default Optional<String> getReference() {
 236             return findFirstEffectiveSubstatementArgument(ReferenceEffectiveStatement.class);
 237         }
 238
 239         @Override
 240         default Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
 241             return filterEffectiveStatements(UnknownSchemaNode.class);
 242         }
 243     }
 244
 245     /**
 246      * Bridge between {@link EffectiveStatementWithFlags} and {@link MandatoryAware}.
 247      *
 248      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 249      * @param <D> Class representing declared version of this statement.
 250      */
 251     public interface MandatoryMixin<A, D extends DeclaredStatement<A>>
 252             extends EffectiveStatementWithFlags<A, D>, MandatoryAware {
 253         @Override
 254         default boolean isMandatory() {
 255             return (flags() & FlagsBuilder.MANDATORY) != 0;
 256         }
 257     }
 258
 259     /**
 260      * Bridge between {@link EffectiveStatementWithFlags} and {@code presence} statement.
 261      *
 262      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 263      * @param <D> Class representing declared version of this statement.
 264      */
 265     public interface PresenceMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
 266         default boolean presence() {
 267             return (flags() & FlagsBuilder.PRESENCE) != 0;
 268         }
 269     }
 270
 271     /**
 272      * Bridge between {@link EffectiveStatementWithFlags} and {@link SchemaNode}.
 273      *
 274      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 275      * @param <D> Class representing declared version of this statement.
 276      */
 277     public interface SchemaNodeMixin<A, D extends DeclaredStatement<A>>
 278             extends DocumentedNodeMixin.WithStatus<A, D>, SchemaNode {
 279         @Override
 280         default QName getQName() {
 281             return getPath().getLastComponent();
 282         }
 283     }
 284
 285     /**
 286      * Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
 287      *
 288      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 289      * @param <D> Class representing declared version of this statement.
 290      */
 291     public interface UserOrderedMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
 292         default boolean userOrdered() {
 293             return (flags() & FlagsBuilder.USER_ORDERED) != 0;
 294         }
 295     }
 296
 297     /**
 298      * Helper used to locate the effective {@code when} statement and exposing its argument as per
 299      * {@link WhenConditionAware}.
 300      *
 301      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 302      * @param <D> Class representing declared version of this statement.
 303      */
 304     public interface WhenConditionMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, WhenConditionAware {
 305         @Override
 306         default Optional<RevisionAwareXPath> getWhenCondition() {
 307             return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
 308         }
 309     }
 310
 311     /**
 312      * Helper bridge for operation containers ({@code input} and {@code output}).
 313      *
 314      * @param <D> Class representing declared version of this statement.
 315      */
 316     public interface OperationContainerMixin<D extends DeclaredStatement<QName>>
 317             extends ContainerSchemaNode, DocumentedNodeMixin.WithStatus<QName, D>, DataNodeContainerMixin<QName, D>,
 318                     MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D>, AugmentationTargetMixin<QName, D>,
 319                     SchemaNodeMixin<QName, D>, CopyableMixin<QName, D> {
 320         @Override
 321         default @NonNull QName argument() {
 322             return getQName();
 323         }
 324
 325         @Override
 326         default Optional<ActionDefinition> findAction(final QName qname) {
 327             return Optional.empty();
 328         }
 329
 330         @Override
 331         default Optional<NotificationDefinition> findNotification(final QName qname) {
 332             return Optional.empty();
 333         }
 334
 335         @Override
 336         default Collection<? extends ActionDefinition> getActions() {
 337             return ImmutableSet.of();
 338         }
 339
 340         @Override
 341         default Collection<? extends NotificationDefinition> getNotifications() {
 342             return ImmutableSet.of();
 343         }
 344
 345         @Override
 346         default boolean isConfiguration() {
 347             return false;
 348         }
 349
 350         @Override
 351         default boolean isPresenceContainer() {
 352             // FIXME: this should not really be here
 353             return false;
 354         }
 355
 356         default String defaultToString() {
 357             return MoreObjects.toStringHelper(this).add("path", getPath()).toString();
 358         }
 359     }
 360
 361     /**
 362      * Helper bridge for {@code anydata} and {@code anyxml} opaque data.
 363      *
 364      * @param <D> Class representing declared version of this statement.
 365      */
 366     public interface OpaqueDataSchemaNodeMixin<D extends DeclaredStatement<QName>>
 367             extends DerivableSchemaNode, DataSchemaNodeMixin<QName, D>, DocumentedNodeMixin.WithStatus<QName, D>,
 368                     MandatoryMixin<QName, D>, MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D> {
 369         @Override
 370         default @NonNull QName argument() {
 371             return getQName();
 372         }
 373     }
 374
 375     /**
 376      * Helper bridge for {@code rpc} and {@code action} operations.
 377      *
 378      * @param <D> Class representing declared version of this statement.
 379      */
 380     public interface OperationDefinitionMixin<D extends DeclaredStatement<QName>>
 381             extends SchemaNodeMixin<QName, D>, OperationDefinition {
 382         @Override
 383         default @NonNull QName argument() {
 384             return getQName();
 385         }
 386
 387         @Override
 388         default Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 389             return filterTypeDefinitions(this);
 390         }
 391
 392         @Override
 393         default Collection<? extends GroupingDefinition> getGroupings() {
 394             return filterEffectiveStatements(GroupingDefinition.class);
 395         }
 396
 397         @Override
 398         default ContainerSchemaNode getInput() {
 399             return findAsContainer(this, InputEffectiveStatement.class);
 400         }
 401
 402         @Override
 403         default ContainerSchemaNode getOutput() {
 404             return findAsContainer(this, OutputEffectiveStatement.class);
 405         }
 406     }
 407
 408     /**
 409      * Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
 410      * globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
 411      *
 412      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 413      * @param <D> Class representing declared version of this statement.
 414      */
 415     public interface EffectiveStatementWithFlags<A, D extends DeclaredStatement<A>> extends Mixin<A, D> {
 416         /**
 417          * Return flags assicated with this statements. Flags can be built using {@link FlagsBuilder}.
 418          *
 419          * @return Flag field value (32 bits).
 420          */
 421         int flags();
 422
 423         @NonNullByDefault
 424         final class FlagsBuilder implements Mutable {
 425             // We still have 24 flags remaining
 426             static final int STATUS_CURRENT       = 0x0001;
 427             static final int STATUS_DEPRECATED    = 0x0002;
 428             static final int STATUS_OBSOLETE      = 0x0003;
 429             static final int MASK_STATUS          = 0x0003;
 430
 431             static final int CONFIGURATION        = 0x0004;
 432             static final int MANDATORY            = 0x0008;
 433
 434             static final int AUGMENTING           = 0x0010;
 435             static final int ADDED_BY_USES        = 0x0020;
 436             private static final int MASK_HISTORY = 0x0030;
 437
 438             static final int USER_ORDERED         = 0x0040;
 439             static final int PRESENCE             = 0x0080;
 440
 441             private int flags;
 442
 443             public FlagsBuilder setConfiguration(final boolean config) {
 444                 if (config) {
 445                     flags |= CONFIGURATION;
 446                 } else {
 447                     flags &= ~CONFIGURATION;
 448                 }
 449                 return this;
 450             }
 451
 452             public FlagsBuilder setHistory(final CopyHistory history) {
 453                 int bits;
 454                 if (history.contains(CopyType.ADDED_BY_USES_AUGMENTATION)) {
 455                     bits = AUGMENTING | ADDED_BY_USES;
 456                 } else {
 457                     bits = 0;
 458                     if (history.contains(CopyType.ADDED_BY_AUGMENTATION)) {
 459                         bits |= AUGMENTING;
 460                     }
 461                     if (history.contains(CopyType.ADDED_BY_USES)) {
 462                         bits |= ADDED_BY_USES;
 463                     }
 464                 }
 465
 466                 flags = flags & ~MASK_HISTORY | bits;
 467                 return this;
 468             }
 469
 470             public FlagsBuilder setMandatory(final boolean mandatory) {
 471                 if (mandatory) {
 472                     flags |= MANDATORY;
 473                 } else {
 474                     flags &= ~MANDATORY;
 475                 }
 476                 return this;
 477             }
 478
 479             public FlagsBuilder setPresence(final boolean presence) {
 480                 if (presence) {
 481                     flags |= PRESENCE;
 482                 } else {
 483                     flags &= ~PRESENCE;
 484                 }
 485                 return this;
 486             }
 487
 488             public FlagsBuilder setStatus(final Status status) {
 489                 final int bits;
 490                 switch (status) {
 491                     case CURRENT:
 492                         bits = STATUS_CURRENT;
 493                         break;
 494                     case DEPRECATED:
 495                         bits = STATUS_DEPRECATED;
 496                         break;
 497                     case OBSOLETE:
 498                         bits = STATUS_OBSOLETE;
 499                         break;
 500                     default:
 501                         throw new IllegalStateException("Unhandled status " + status);
 502                 }
 503
 504                 flags = flags & ~MASK_STATUS | bits;
 505                 return this;
 506             }
 507
 508             public FlagsBuilder setUserOrdered(final boolean userOrdered) {
 509                 if (userOrdered) {
 510                     flags |= USER_ORDERED;
 511                 } else {
 512                     flags &= ~USER_ORDERED;
 513                 }
 514                 return this;
 515             }
 516
 517             public int toFlags() {
 518                 return flags;
 519             }
 520         }
 521     }
 522
 523     private EffectiveStatementMixins() {
 524     }
 525
 526     static ContainerSchemaNode findAsContainer(final EffectiveStatement<?, ?> stmt,
 527             final Class<? extends EffectiveStatement<QName, ?>> type) {
 528         final EffectiveStatement<?, ?> statement = stmt.findFirstEffectiveSubstatement(type).get();
 529         verify(statement instanceof ContainerSchemaNode, "Child statement %s is not a ContainerSchemaNode",
 530             statement);
 531         return (ContainerSchemaNode) statement;
 532     }
 533
 534     static Collection<? extends TypeDefinition<?>> filterTypeDefinitions(final Mixin<?, ?> stmt) {
 535         return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
 536             TypedefEffectiveStatement::getTypeDefinition);
 537     }
 538 }