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