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