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 com.google.common.annotations.Beta;
  11 import com.google.common.base.MoreObjects;
  12 import com.google.common.base.Strings;
  13 import com.google.common.collect.Collections2;
  14 import com.google.common.collect.ImmutableSet;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.jdt.annotation.NonNullByDefault;
  19 import org.opendaylight.yangtools.concepts.Mutable;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  22 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
  23 import org.opendaylight.yangtools.yang.model.api.AddedByUsesAware;
  24 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  26 import org.opendaylight.yangtools.yang.model.api.ConstraintMetaDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  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.InputSchemaNode;
  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.OutputSchemaNode;
  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.xpath.api.YangXPathExpression.QualifiedBound;
  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> @NonNull 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 {@link UnknownSchemaNode}.
 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 UnknownSchemaNodeMixin<A, D extends DeclaredStatement<A>>
 314             extends SchemaNodeMixin<A, D>, CopyableMixin<A, D>, UnknownSchemaNode {
 315
 316         @Override
 317         default String getNodeParameter() {
 318             return Strings.nullToEmpty(getDeclared().rawArgument());
 319         }
 320     }
 321
 322     /**
 323      * Bridge between {@link EffectiveStatementWithFlags} and {@code ordered-by} statement.
 324      *
 325      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 326      * @param <D> Class representing declared version of this statement.
 327      */
 328     public interface UserOrderedMixin<A, D extends DeclaredStatement<A>> extends EffectiveStatementWithFlags<A, D> {
 329         default boolean userOrdered() {
 330             return (flags() & FlagsBuilder.USER_ORDERED) != 0;
 331         }
 332     }
 333
 334     /**
 335      * Helper used to locate the effective {@code when} statement and exposing its argument as per
 336      * {@link WhenConditionAware}.
 337      *
 338      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 339      * @param <D> Class representing declared version of this statement.
 340      */
 341     public interface WhenConditionMixin<A, D extends DeclaredStatement<A>> extends Mixin<A, D>, WhenConditionAware {
 342         @Override
 343         default Optional<QualifiedBound> getWhenCondition() {
 344             return findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class);
 345         }
 346     }
 347
 348     /**
 349      * Helper bridge for operation containers ({@code input} and {@code output}).
 350      *
 351      * @param <D> Class representing declared version of this statement.
 352      */
 353     public interface OperationContainerMixin<D extends DeclaredStatement<QName>>
 354             extends ContainerLike, DocumentedNodeMixin.WithStatus<QName, D>, DataNodeContainerMixin<QName, D>,
 355                     MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D>, AugmentationTargetMixin<QName, D>,
 356                     SchemaNodeMixin<QName, D>, CopyableMixin<QName, D> {
 357         @Override
 358         default @NonNull QName argument() {
 359             return getQName();
 360         }
 361
 362         @Override
 363         default Optional<ActionDefinition> findAction(final QName qname) {
 364             return Optional.empty();
 365         }
 366
 367         @Override
 368         default Optional<NotificationDefinition> findNotification(final QName qname) {
 369             return Optional.empty();
 370         }
 371
 372         @Override
 373         default Collection<? extends ActionDefinition> getActions() {
 374             return ImmutableSet.of();
 375         }
 376
 377         @Override
 378         default Collection<? extends NotificationDefinition> getNotifications() {
 379             return ImmutableSet.of();
 380         }
 381
 382         @Override
 383         default boolean isConfiguration() {
 384             return false;
 385         }
 386
 387         default String defaultToString() {
 388             return MoreObjects.toStringHelper(this).add("path", getPath()).toString();
 389         }
 390     }
 391
 392     /**
 393      * Helper bridge for {@code anydata} and {@code anyxml} opaque data.
 394      *
 395      * @param <D> Class representing declared version of this statement.
 396      */
 397     public interface OpaqueDataSchemaNodeMixin<D extends DeclaredStatement<QName>>
 398             extends DerivableSchemaNode, DataSchemaNodeMixin<QName, D>, DocumentedNodeMixin.WithStatus<QName, D>,
 399                     MandatoryMixin<QName, D>, MustConstraintMixin<QName, D>, WhenConditionMixin<QName, D> {
 400         @Override
 401         default @NonNull QName argument() {
 402             return getQName();
 403         }
 404     }
 405
 406     /**
 407      * Helper bridge for {@code rpc} and {@code action} operations.
 408      *
 409      * @param <D> Class representing declared version of this statement.
 410      */
 411     public interface OperationDefinitionMixin<D extends DeclaredStatement<QName>>
 412             extends SchemaNodeMixin<QName, D>, OperationDefinition {
 413         @Override
 414         default @NonNull QName argument() {
 415             return getQName();
 416         }
 417
 418         @Override
 419         default Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 420             return filterTypeDefinitions(this);
 421         }
 422
 423         @Override
 424         default Collection<? extends GroupingDefinition> getGroupings() {
 425             return filterEffectiveStatements(GroupingDefinition.class);
 426         }
 427
 428         @Override
 429         default InputSchemaNode getInput() {
 430             return findAsContainer(this, InputEffectiveStatement.class, InputSchemaNode.class);
 431         }
 432
 433         @Override
 434         default OutputSchemaNode getOutput() {
 435             return findAsContainer(this, OutputEffectiveStatement.class, OutputSchemaNode.class);
 436         }
 437     }
 438
 439     /**
 440      * Support interface for various mixins. Implementations are required to store 32bits worth of flags, which are
 441      * globally assigned to sub-interfaces -- thus providing storage for many low-cardinality properties.
 442      *
 443      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 444      * @param <D> Class representing declared version of this statement.
 445      */
 446     public interface EffectiveStatementWithFlags<A, D extends DeclaredStatement<A>> extends Mixin<A, D> {
 447         /**
 448          * Return flags assicated with this statements. Flags can be built using {@link FlagsBuilder}.
 449          *
 450          * @return Flag field value (32 bits).
 451          */
 452         int flags();
 453
 454         @NonNullByDefault
 455         final class FlagsBuilder implements Mutable {
 456             // We still have 24 flags remaining
 457             static final int STATUS_CURRENT       = 0x0001;
 458             static final int STATUS_DEPRECATED    = 0x0002;
 459             static final int STATUS_OBSOLETE      = 0x0003;
 460             static final int MASK_STATUS          = 0x0003;
 461
 462             static final int CONFIGURATION        = 0x0004;
 463             static final int MANDATORY            = 0x0008;
 464
 465             static final int AUGMENTING           = 0x0010;
 466             static final int ADDED_BY_USES        = 0x0020;
 467             private static final int MASK_HISTORY = 0x0030;
 468
 469             static final int USER_ORDERED         = 0x0040;
 470             static final int PRESENCE             = 0x0080;
 471
 472             private int flags;
 473
 474             public FlagsBuilder setConfiguration(final boolean config) {
 475                 if (config) {
 476                     flags |= CONFIGURATION;
 477                 } else {
 478                     flags &= ~CONFIGURATION;
 479                 }
 480                 return this;
 481             }
 482
 483             public FlagsBuilder setHistory(final CopyHistory history) {
 484                 flags = flags & ~MASK_HISTORY
 485                     | (history.isAugmenting() ? AUGMENTING : 0) | (history.isAddedByUses() ? ADDED_BY_USES : 0);
 486                 return this;
 487             }
 488
 489             public FlagsBuilder setMandatory(final boolean mandatory) {
 490                 if (mandatory) {
 491                     flags |= MANDATORY;
 492                 } else {
 493                     flags &= ~MANDATORY;
 494                 }
 495                 return this;
 496             }
 497
 498             public FlagsBuilder setPresence(final boolean presence) {
 499                 if (presence) {
 500                     flags |= PRESENCE;
 501                 } else {
 502                     flags &= ~PRESENCE;
 503                 }
 504                 return this;
 505             }
 506
 507             public FlagsBuilder setStatus(final Status status) {
 508                 final int bits;
 509                 switch (status) {
 510                     case CURRENT:
 511                         bits = STATUS_CURRENT;
 512                         break;
 513                     case DEPRECATED:
 514                         bits = STATUS_DEPRECATED;
 515                         break;
 516                     case OBSOLETE:
 517                         bits = STATUS_OBSOLETE;
 518                         break;
 519                     default:
 520                         throw new IllegalStateException("Unhandled status " + status);
 521                 }
 522
 523                 flags = flags & ~MASK_STATUS | bits;
 524                 return this;
 525             }
 526
 527             public FlagsBuilder setUserOrdered(final boolean userOrdered) {
 528                 if (userOrdered) {
 529                     flags |= USER_ORDERED;
 530                 } else {
 531                     flags &= ~USER_ORDERED;
 532                 }
 533                 return this;
 534             }
 535
 536             public int toFlags() {
 537                 return flags;
 538             }
 539         }
 540     }
 541
 542     private EffectiveStatementMixins() {
 543     }
 544
 545     static <T extends ContainerLike> T findAsContainer(final EffectiveStatement<?, ?> stmt,
 546             final Class<? extends EffectiveStatement<QName, ?>> type, Class<T> target) {
 547         return target.cast(stmt.findFirstEffectiveSubstatement(type).get());
 548     }
 549
 550     static Collection<? extends TypeDefinition<?>> filterTypeDefinitions(final Mixin<?, ?> stmt) {
 551         return Collections2.transform(stmt.filterEffectiveStatements(TypedefEffectiveStatement.class),
 552             TypedefEffectiveStatement::getTypeDefinition);
 553     }
 554 }