yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/BaseStatementSupport.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.collect.ImmutableList;
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.HashSet;
  15 import java.util.List;
  16 import java.util.Set;
  17 import java.util.stream.Collectors;
  18 import java.util.stream.Stream;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.eclipse.jdt.annotation.Nullable;
  21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  27
  28 /**
  29  * Implementation-internal base class for {@link AbstractStatementSupport} implementations.
  30  *
  31  * @param <A> Argument type
  32  * @param <D> Declared Statement representation
  33  * @param <E> Effective Statement representation
  34  */
  35 // FIXME: YANGTOOLS-1161: move this into yang-parser-spi, as the substatement handling has natural place there. Also
  36 //        we rely on  getEffectOfStatement() -- which is something reactor mechanics need to make work better.
  37 @Beta
  38 public abstract class BaseStatementSupport<A, D extends DeclaredStatement<A>,
  39         E extends EffectiveStatement<A, D>> extends AbstractStatementSupport<A, D, E> {
  40
  41     protected BaseStatementSupport(final StatementDefinition publicDefinition, final CopyPolicy copyPolicy) {
  42         super(publicDefinition, copyPolicy);
  43     }
  44
  45     @Override
  46     public final D createDeclared(final StmtContext<A, D, ?> ctx) {
  47         final ImmutableList<? extends DeclaredStatement<?>> substatements = ctx.declaredSubstatements().stream()
  48                 .map(StmtContext::declared)
  49                 .collect(ImmutableList.toImmutableList());
  50         return substatements.isEmpty() ? createEmptyDeclared(ctx) : createDeclared(ctx, substatements);
  51     }
  52
  53     protected abstract @NonNull D createDeclared(@NonNull StmtContext<A, D, ?> ctx,
  54             @NonNull ImmutableList<? extends DeclaredStatement<?>> substatements);
  55
  56     protected abstract @NonNull D createEmptyDeclared(@NonNull StmtContext<A, D, ?> ctx);
  57
  58     @Override
  59     public E createEffective(final Current<A, D> stmt,
  60             final Stream<? extends StmtContext<?, ?, ?>> declaredSubstatements,
  61             final Stream<? extends StmtContext<?, ?, ?>> effectiveSubstatements) {
  62         final ImmutableList<? extends EffectiveStatement<?, ?>> substatements =
  63                 buildEffectiveSubstatements(stmt, statementsToBuild(stmt,
  64                     declaredSubstatements(declaredSubstatements, effectiveSubstatements)));
  65         return createEffective(stmt, substatements);
  66     }
  67
  68     protected abstract @NonNull E createEffective(@NonNull Current<A, D> stmt,
  69             @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> substatements);
  70
  71     /**
  72      * Give statement support a hook to transform statement contexts before they are built. Default implementation
  73      * does nothing, but note {@code augment} statement performs a real transformation.
  74      *
  75      * @param ctx Effective capture of this statement's significant state
  76      * @param substatements Substatement contexts which have been determined to be built
  77      * @return Substatement context which are to be actually built
  78      */
  79     protected List<? extends StmtContext<?, ?, ?>> statementsToBuild(final Current<A, D> ctx,
  80             final List<? extends StmtContext<?, ?, ?>> substatements) {
  81         return substatements;
  82     }
  83
  84     protected static final <E extends EffectiveStatement<?, ?>> @Nullable E findFirstStatement(
  85             final ImmutableList<? extends EffectiveStatement<?, ?>> statements, final Class<E> type) {
  86         for (EffectiveStatement<?, ?> stmt : statements) {
  87             if (type.isInstance(stmt)) {
  88                 return type.cast(stmt);
  89             }
  90         }
  91         return null;
  92     }
  93
  94     protected static final <A, E extends EffectiveStatement<A, ?>> A findFirstArgument(
  95             final ImmutableList<? extends EffectiveStatement<?, ?>> statements, final Class<@NonNull E> type,
  96                     final A defValue) {
  97         final @Nullable E stmt = findFirstStatement(statements, type);
  98         return stmt != null ? stmt.argument() : defValue;
  99     }
 100
 101     /**
 102      * Create a set of substatements. This method is split out so it can be overridden in subclasses adjust the
 103      * resulting statements.
 104      *
 105      * @param stmt Current statement context
 106      * @param substatements proposed substatements
 107      * @return Built effective substatements
 108      */
 109     protected @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> buildEffectiveSubstatements(
 110             final Current<A, D> stmt, final List<? extends StmtContext<?, ?, ?>> substatements) {
 111         return defaultBuildEffectiveSubstatements(substatements);
 112     }
 113
 114     private static @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> defaultBuildEffectiveSubstatements(
 115             final List<? extends StmtContext<?, ?, ?>> substatements) {
 116         return substatements.stream()
 117                 .filter(StmtContext::isSupportedToBuildEffective)
 118                 .map(StmtContext::buildEffective)
 119                 .collect(ImmutableList.toImmutableList());
 120     }
 121
 122     private static @NonNull List<StmtContext<?, ?, ?>> declaredSubstatements(
 123             final Stream<? extends StmtContext<?, ?, ?>> declaredSubstatements,
 124             final Stream<? extends StmtContext<?, ?, ?>> effectiveSubstatements) {
 125         /*
 126          * This dance is required to ensure that effects of 'uses' nodes are applied in the same order as
 127          * the statements were defined -- i.e. if we have something like this:
 128          *
 129          * container foo {
 130          *   uses bar;
 131          *   uses baz;
 132          * }
 133          *
 134          * grouping baz {
 135          *   leaf baz {
 136          *     type string;
 137          *   }
 138          * }
 139          *
 140          * grouping bar {
 141          *   leaf bar {
 142          *     type string;
 143          *   }
 144          * }
 145          *
 146          * The reactor would first inline 'uses baz' as that definition is the first one completely resolved and then
 147          * inline 'uses bar'. Here we are iterating in declaration order re-inline the statements.
 148          *
 149          * FIXME: 7.0.0: this really should be handled by UsesStatementSupport such that 'uses baz' would have a
 150          *               prerequisite of a resolved 'uses bar'.
 151          */
 152         final List<StmtContext<?, ?, ?>> declaredInit = declaredSubstatements
 153             .filter(StmtContext::isSupportedByFeatures)
 154             .collect(Collectors.toList());
 155
 156         final List<StmtContext<?, ?, ?>> substatementsInit = new ArrayList<>();
 157         Set<StmtContext<?, ?, ?>> filteredStatements = null;
 158         for (final StmtContext<?, ?, ?> declaredSubstatement : declaredInit) {
 159             substatementsInit.add(declaredSubstatement);
 160
 161             final Collection<? extends StmtContext<?, ?, ?>> effect = declaredSubstatement.getEffectOfStatement();
 162             if (!effect.isEmpty()) {
 163                 if (filteredStatements == null) {
 164                     filteredStatements = new HashSet<>();
 165                 }
 166                 filteredStatements.addAll(effect);
 167                 substatementsInit.addAll(effect);
 168             }
 169         }
 170
 171         final Stream<? extends StmtContext<?, ?, ?>> effective;
 172         if (filteredStatements != null) {
 173             final Set<StmtContext<?, ?, ?>> filtered = filteredStatements;
 174             effective = effectiveSubstatements.filter(stmt -> !filtered.contains(stmt));
 175         } else {
 176             effective = effectiveSubstatements;
 177         }
 178
 179         substatementsInit.addAll(effective.collect(Collectors.toList()));
 180         return substatementsInit;
 181     }
 182 }