parser/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StatementSupport.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.spi.meta;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.base.VerifyException;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.opendaylight.yangtools.concepts.Immutable;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.common.QNameModule;
  22 import org.opendaylight.yangtools.yang.model.api.meta.ArgumentDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  24 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  28 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  29
  30 /**
  31  * Support for processing concrete YANG statement.
  32  *
  33  * <p>
  34  * This interface is intended to be implemented by developers, which want to introduce support of statement to parser.
  35  * Consider subclassing {@link AbstractStatementSupport} for easier implementation of this interface.
  36  *
  37  * @param <A> Argument type
  38  * @param <D> Declared Statement representation
  39  * @param <E> Effective Statement representation
  40  */
  41 public abstract class StatementSupport<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
  42         implements StatementFactory<A, D, E> {
  43     /**
  44      * A baseline class for implementing the {@link StatementFactory#canReuseCurrent(Current, Current, Collection)}
  45      * contract in a manner which is consistent with a statement's {@link CopyPolicy}.
  46      *
  47      * @param <A> Argument type
  48      * @param <D> Declared Statement representation
  49      */
  50     public abstract static class StatementPolicy<A, D extends DeclaredStatement<A>> implements Immutable {
  51         final @NonNull CopyPolicy copyPolicy;
  52
  53         StatementPolicy(final CopyPolicy copyPolicy) {
  54             this.copyPolicy = requireNonNull(copyPolicy);
  55         }
  56
  57         /**
  58          * Return a {@link StatementPolicy} for {@link CopyPolicy#CONTEXT_INDEPENDENT}.
  59          *
  60          * @param <A> Argument type
  61          * @param <D> Declared Statement representation
  62          * @return Context-independent policy
  63          */
  64         @SuppressWarnings("unchecked")
  65         public static final <A, D extends DeclaredStatement<A>> @NonNull StatementPolicy<A, D> contextIndependent() {
  66             return (StatementPolicy<A, D>) EqualSemantics.CONTEXT_INDEPENDENT;
  67         }
  68
  69         /**
  70          * Return a {@link StatementPolicy} for {@link CopyPolicy#EXACT_REPLICA}.
  71          *
  72          * @param <A> Argument type
  73          * @param <D> Declared Statement representation
  74          * @return Exact-replica policy
  75          */
  76         @SuppressWarnings("unchecked")
  77         public static final <A, D extends DeclaredStatement<A>> @NonNull StatementPolicy<A, D> exactReplica() {
  78             return (StatementPolicy<A, D>) EqualSemantics.EXACT_REPLICA;
  79         }
  80
  81         /**
  82          * Return a {@link StatementPolicy} for {@link CopyPolicy#IGNORE}.
  83          *
  84          * @param <A> Argument type
  85          * @param <D> Declared Statement representation
  86          * @return Ignoring policy
  87          */
  88         @SuppressWarnings("unchecked")
  89         public static final <A, D extends DeclaredStatement<A>> @NonNull StatementPolicy<A, D> ignore() {
  90             return (StatementPolicy<A, D>) AlwaysFail.IGNORE;
  91         }
  92
  93         /**
  94          * Return a {@link StatementPolicy} for {@link CopyPolicy#REJECT}.
  95          *
  96          * @param <A> Argument type
  97          * @param <D> Declared Statement representation
  98          * @return Rejecting statement policy
  99          */
 100         @SuppressWarnings("unchecked")
 101         public static final <A, D extends DeclaredStatement<A>> @NonNull StatementPolicy<A, D> reject() {
 102             return (StatementPolicy<A, D>) AlwaysFail.REJECT;
 103         }
 104
 105         /**
 106          * Return a {@link StatementPolicy} for {@link CopyPolicy#DECLARED_COPY}, deferring to a
 107          * {@link StatementEquality} for individual decisions.
 108          *
 109          * @param <A> Argument type
 110          * @param <D> Declared Statement representation
 111          * @param equality {@link StatementEquality} to apply to effective statements
 112          * @return Equality-based statement policy
 113          */
 114         public static final <A, D extends DeclaredStatement<A>> @NonNull StatementPolicy<A, D> copyDeclared(
 115                 final @NonNull StatementEquality<A, D> equality) {
 116             return new EqualSemantics<>(equality);
 117         }
 118
 119         /**
 120          * Return a {@link StatementPolicy} for {@link CopyPolicy#DECLARED_COPY}, always performing a copy operation.
 121          *
 122          * @param <A> Argument type
 123          * @param <D> Declared Statement representation
 124          * @return Rejecting statement policy
 125          */
 126         @SuppressWarnings("unchecked")
 127         public static final <A, D extends DeclaredStatement<A>> @NonNull StatementPolicy<A, D> alwaysCopyDeclared() {
 128             return (StatementPolicy<A, D>) EqualSemantics.ALWAYS_COPY;
 129         }
 130
 131         abstract boolean canReuseCurrent(@NonNull Current<A, D> copy, @NonNull Current<A, D> current,
 132             @NonNull Collection<? extends EffectiveStatement<?, ?>> substatements);
 133
 134         private static final class AlwaysFail<A, D extends DeclaredStatement<A>> extends StatementPolicy<A, D> {
 135             static final @NonNull AlwaysFail<?, ?> IGNORE = new AlwaysFail<>(CopyPolicy.IGNORE);
 136             static final @NonNull AlwaysFail<?, ?> REJECT = new AlwaysFail<>(CopyPolicy.REJECT);
 137
 138             private AlwaysFail(final CopyPolicy copyPolicy) {
 139                 super(copyPolicy);
 140             }
 141
 142             @Override
 143             boolean canReuseCurrent(final Current<A, D> copy, final Current<A, D> current,
 144                     final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 145                 throw new VerifyException("This implementation should never be invoked");
 146             }
 147         }
 148
 149         private static final class EqualSemantics<A, D extends DeclaredStatement<A>> extends StatementPolicy<A, D> {
 150             static final @NonNull EqualSemantics<?, ?> ALWAYS_COPY =
 151                 new EqualSemantics<>((copy, stmt, substatements) -> false);
 152             static final @NonNull EqualSemantics<?, ?> CONTEXT_INDEPENDENT =
 153                 new EqualSemantics<>(CopyPolicy.CONTEXT_INDEPENDENT, (copy, stmt, substatements) -> true);
 154             static final @NonNull EqualSemantics<?, ?> EXACT_REPLICA =
 155                 new EqualSemantics<>(CopyPolicy.EXACT_REPLICA, (copy, stmt, substatements) -> true);
 156
 157             private final @NonNull StatementEquality<A, D> equality;
 158
 159             private EqualSemantics(final CopyPolicy copyPolicy, final StatementEquality<A, D> equality) {
 160                 super(copyPolicy);
 161                 this.equality = requireNonNull(equality);
 162             }
 163
 164             EqualSemantics(final StatementEquality<A, D> equality) {
 165                 this(CopyPolicy.DECLARED_COPY, equality);
 166             }
 167
 168             @Override
 169             boolean canReuseCurrent(final Current<A, D> copy, final Current<A, D> current,
 170                     final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 171                 return equality.canReuseCurrent(copy, current, substatements);
 172             }
 173         }
 174     }
 175
 176     /**
 177      * Abstract base class for comparators associated with statements with a {@link CopyPolicy#DECLARED_COPY} copy
 178      * policy.
 179      *
 180      * @param <A> Argument type
 181      * @param <D> Declared Statement representation
 182      */
 183     @FunctionalInterface
 184     public interface StatementEquality<A, D extends DeclaredStatement<A>> {
 185         /**
 186          * Determine whether {@code current} statement has the same semantics as the provided copy. See the contract
 187          * specification of {@link StatementFactory#canReuseCurrent(Current, Current, Collection)}.
 188          *
 189          * @param copy Copy of current effective context
 190          * @param current Current effective context
 191          * @param substatements Current effective substatements
 192          * @return True if {@code current} can be reused in place of {@code copy}, false if the copy needs to be used.
 193          */
 194         boolean canReuseCurrent(@NonNull Current<A, D> copy, @NonNull Current<A, D> current,
 195             @NonNull Collection<? extends EffectiveStatement<?, ?>> substatements);
 196     }
 197
 198     private final @NonNull StatementPolicy<A, D> policy;
 199     private final @NonNull StatementDefinition publicDefinition;
 200     private final @NonNull CopyPolicy copyPolicy;
 201
 202     @Beta
 203     protected StatementSupport(final StatementSupport<A, D, E> delegate) {
 204         checkArgument(delegate != this);
 205         this.publicDefinition = delegate.publicDefinition;
 206         this.policy = delegate.policy;
 207         this.copyPolicy = delegate.copyPolicy;
 208     }
 209
 210     @Beta
 211     protected StatementSupport(final StatementDefinition publicDefinition, final StatementPolicy<A, D> policy) {
 212         this.publicDefinition = requireNonNull(publicDefinition);
 213         this.policy = requireNonNull(policy);
 214         this.copyPolicy = policy.copyPolicy;
 215     }
 216
 217     /**
 218      * Returns public statement definition, which will be present in built statements.
 219      *
 220      * <p>
 221      * Public statement definition may be used to provide different implementation of statement definition,
 222      * which will not retain any build specific data or context.
 223      *
 224      * @return public statement definition, which will be present in built statements.
 225      */
 226     public final @NonNull StatementDefinition getPublicView() {
 227         return publicDefinition;
 228     }
 229
 230     // Appropriate to most definitions
 231     // Non-final for compatible extensions
 232     public @NonNull StatementDefinition definition() {
 233         return publicDefinition;
 234     }
 235
 236     /**
 237      * Return this statement's {@link CopyPolicy}. This is a static value, reflecting how this statement reacts to being
 238      * replicated to a different context, without reflecting on behaviour of potential substatements, which would come
 239      * into play in something like:
 240      *
 241      * <pre>
 242      *   <code>
 243      *     module foo {
 244      *       namespace foo;
 245      *       prefix foo;
 246      *
 247      *       extension note {
 248      *         argument string {
 249      *           type string {
 250      *             length 1..max;
 251      *           }
 252      *         }
 253      *         description "Can be used in description/reference statements to attach additional notes";
 254      *       }
 255      *
 256      *       description "A nice module extending description statement semantics" {
 257      *         foo:note "We can now attach description/reference a note.";
 258      *         foo:note "Also another note";
 259      *       }
 260      *     }
 261      *   </code>
 262      * </pre>
 263      *
 264      * <p>
 265      * In this scenario, it is the reactor's job to figure out what to do (like talking to substatements).
 266      *
 267      * @return This statement's copy policy
 268      */
 269     public final @NonNull CopyPolicy copyPolicy() {
 270         return copyPolicy;
 271     }
 272
 273     @Override
 274     public final boolean canReuseCurrent(final Current<A, D> copy, final Current<A, D> current,
 275             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 276         return policy.canReuseCurrent(copy, current, substatements);
 277     }
 278
 279     @Override
 280     public EffectiveStatementState extractEffectiveState(final E stmt) {
 281         // Not implemented for most statements
 282         return null;
 283     }
 284
 285     /**
 286      * Parses textual representation of argument in object representation.
 287      *
 288      * @param ctx Context, which may be used to access source-specific namespaces required for parsing.
 289      * @param value String representation of value, as was present in text source.
 290      * @return Parsed value
 291      * @throws SourceException when an inconsistency is detected.
 292      */
 293     public abstract A parseArgumentValue(StmtContext<?, ?, ?> ctx, String value);
 294
 295     /**
 296      * Adapts the argument value to match a new module. Default implementation returns original value stored in context,
 297      * which is appropriate for most implementations.
 298      *
 299      * @param ctx Context, which may be used to access source-specific namespaces required for parsing.
 300      * @param targetModule Target module, may not be null.
 301      * @return Adapted argument value.
 302      */
 303     public A adaptArgumentValue(final @NonNull StmtContext<A, D, E> ctx, final @NonNull QNameModule targetModule) {
 304         return ctx.argument();
 305     }
 306
 307     /**
 308      * Invoked when a statement supported by this instance is added to build context. This allows implementations
 309      * of this interface to start tracking the statement and perform any modifications to the build context hierarchy,
 310      * accessible via {@link StmtContext#getParentContext()}. One such use is populating the parent's namespaces to
 311      * allow it to locate this child statement.
 312      *
 313      * @param stmt Context of added statement. No substatements are available.
 314      */
 315     public void onStatementAdded(final @NonNull Mutable<A, D, E> stmt) {
 316         // NOOP for most implementations
 317     }
 318
 319     /**
 320      * Invoked when statement is closed during {@link ModelProcessingPhase#SOURCE_PRE_LINKAGE} phase, only substatements
 321      * from this and previous phase are available.
 322      *
 323      * <p>
 324      * Implementation may use method to perform actions on this event or register modification action using
 325      * {@link Mutable#newInferenceAction(ModelProcessingPhase)}.
 326      *
 327      * @param stmt Context of added statement.
 328      */
 329     public void onPreLinkageDeclared(final @NonNull Mutable<A, D, E> stmt) {
 330         // NOOP for most implementations
 331     }
 332
 333     /**
 334      * Invoked when statement is closed during {@link ModelProcessingPhase#SOURCE_LINKAGE} phase, only substatements
 335      * from this and previous phase are available.
 336      *
 337      * <p>
 338      * Implementation may use method to perform actions on this event or register modification action using
 339      * {@link Mutable#newInferenceAction(ModelProcessingPhase)}.
 340      *
 341      * @param stmt Context of added statement.
 342      * @throws SourceException when an inconsistency is detected.
 343      */
 344     public void onLinkageDeclared(final @NonNull Mutable<A, D, E> stmt) {
 345         // NOOP for most implementations
 346     }
 347
 348     /**
 349      * Invoked when statement is closed during {@link ModelProcessingPhase#STATEMENT_DEFINITION} phase,
 350      * only substatements from this phase are available.
 351      *
 352      * <p>
 353      * Implementation may use method to perform actions on this event or register modification action using
 354      * {@link Mutable#newInferenceAction(ModelProcessingPhase)}.
 355      *
 356      * @param stmt Context of added statement. Argument and statement parent is accessible.
 357      * @throws SourceException when an inconsistency is detected.
 358      */
 359     public void onStatementDefinitionDeclared(final Mutable<A, D, E> stmt) {
 360         // NOOP for most implementations
 361     }
 362
 363     /**
 364      * Invoked when statement is closed during {@link ModelProcessingPhase#FULL_DECLARATION} phase,
 365      * only substatements from this phase are available.
 366      *
 367      * <p>
 368      * Implementation may use method to perform actions on this event or register modification action using
 369      * {@link Mutable#newInferenceAction(ModelProcessingPhase)}.
 370      *
 371      * @param stmt Context of added statement. Argument and statement parent is accessible.
 372      * @throws SourceException when an inconsistency is detected.
 373      */
 374     public void onFullDefinitionDeclared(final Mutable<A, D, E> stmt) {
 375         final SubstatementValidator validator = substatementValidator();
 376         if (validator != null) {
 377             validator.validate(stmt);
 378         }
 379     }
 380
 381     /**
 382      * Returns corresponding substatement validator of a statement support.
 383      *
 384      * @return substatement validator or null, if substatement validator is not defined
 385      */
 386     protected abstract @Nullable SubstatementValidator substatementValidator();
 387
 388     /**
 389      * Returns true if this support has argument specific supports.
 390      *
 391      * @return true if this support has argument specific supports.
 392      */
 393     public boolean hasArgumentSpecificSupports() {
 394         // Most of statement supports don't have any argument specific supports, so return 'false'.
 395         return false;
 396     }
 397
 398     /**
 399      * If this support has argument specific supports, the method returns support specific for given argument
 400      * (e.g. type statement support need to be specialized based on its argument), otherwise returns null.
 401      *
 402      * @param argument argument of statement
 403      * @return statement support specific for supplied argument or null
 404      */
 405     public @Nullable StatementSupport<?, ?, ?> getSupportSpecificForArgument(final String argument) {
 406         // Most of statement supports don't have any argument specific supports, so return null.
 407         return null;
 408     }
 409
 410     /**
 411      * Given a raw string representation of an argument, try to use a shared representation. Default implementation
 412      * does nothing.
 413      *
 414      * @param rawArgument Argument string
 415      * @return A potentially-shard instance
 416      */
 417     public String internArgument(final String rawArgument) {
 418         return rawArgument;
 419     }
 420
 421     /**
 422      * Returns true if this statement support and all its substatements ignore if-feature statements (e.g. yang-data
 423      * extension defined in <a href="https://tools.ietf.org/html/rfc8040#section-8">RFC 8040</a>). Default
 424      * implementation returns false.
 425      *
 426      * @return true if this statement support ignores if-feature statements, otherwise false.
 427      */
 428     @Beta
 429     public boolean isIgnoringIfFeatures() {
 430         return false;
 431     }
 432
 433     /**
 434      * Returns true if this statement support and all its substatements ignore config statements (e.g. yang-data
 435      * extension defined in <a href="https://tools.ietf.org/html/rfc8040#section-8">RFC 8040</a>). Default
 436      * implementation returns false.
 437      *
 438      * @return true if this statement support ignores config statements,
 439      *         otherwise false.
 440      */
 441     @Beta
 442     public boolean isIgnoringConfig() {
 443         return false;
 444     }
 445
 446     public final @NonNull QName statementName() {
 447         return publicDefinition.getStatementName();
 448     }
 449
 450     public final @Nullable QName argumentName() {
 451         return publicDefinition.getArgumentDefinition().map(ArgumentDefinition::getArgumentName).orElse(null);
 452     }
 453
 454     public final @NonNull Optional<ArgumentDefinition> getArgumentDefinition() {
 455         return publicDefinition.getArgumentDefinition();
 456     }
 457
 458     /**
 459      * Statement context copy policy, indicating how should reactor handle statement copy operations. Every statement
 460      * copied by the reactor is subject to this policy.
 461      */
 462     public enum CopyPolicy {
 463         /**
 464          * Reuse the source statement context in the new place, as it cannot be affected by any further operations. This
 465          * implies that the semantics of the effective statement are not affected by any of its substatements. Each
 466          * of the substatements is free to make its own policy.
 467          *
 468          * <p>
 469          * This policy is typically used by static constant statements such as {@code description} or {@code length},
 470          * where the baseline RFC7950 does not allow any impact. A {@code description} could hold an extension statement
 471          * in which case this interaction would come into play. Normal YANG will see empty substatements, so the reactor
 472          * will be free to complete reuse the context.
 473          *
 474          * <p>
 475          * In case any substatement is of stronger policy, it is up to the reactor to handle correct handling of
 476          * resulting subobjects.
 477          */
 478         // TODO: does this mean source must have transitioned to ModelProcessingPhase.EFFECTIVE_MODEL?
 479         CONTEXT_INDEPENDENT,
 480         /**
 481          * Reuse the source statement context in the new place completely. This policy is more stringent than
 482          * {@link #CONTEXT_INDEPENDENT} in that the statement is dependent on circumstances of its original definition
 483          * and any copy operation must replicate it exactly as is. This implies ignoring the usual policy of its
 484          * substatements. A typical example of such a statement is {@code type}.
 485          */
 486         EXACT_REPLICA,
 487         /**
 488          * Create a copy sharing declared instance, but otherwise having a separate disconnected lifecycle.
 489          */
 490         // TODO: will the copy transition to ModelProcessingPhase.FULL_DECLARATION or which phase?
 491         DECLARED_COPY,
 492         /**
 493          * Reject any attempt to copy this statement. This is useful for statements that are defined as top-level
 494          * constructs, such as {@code contact}, {@code deviation} and similar.
 495          */
 496         REJECT,
 497         /**
 498          * Ignore this statement's existence for the purposes of the new place -- it is not impacted. This guidance
 499          * is left here for completeness, as it can have justifiable uses (but I can't think of any). Any substatements
 500          * need to be ignored, too.
 501          */
 502         IGNORE;
 503     }
 504 }