yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/AbstractStatementSupport.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.spi.meta;
   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.EffectiveStmtCtx.Current;
  25
  26 /**
  27  * Baseline implementation class for common {@link StatementSupport} implementations. This class performs many of the
  28  * its duties in the canonical way -- taking away some amount of freedom for common functionality.
  29  *
  30  * @param <A> Argument type
  31  * @param <D> Declared Statement representation
  32  * @param <E> Effective Statement representation
  33  */
  34 @Beta
  35 public abstract class AbstractStatementSupport<A, D extends DeclaredStatement<A>,
  36         E extends EffectiveStatement<A, D>> extends StatementSupport<A, D, E> {
  37     protected AbstractStatementSupport(final StatementDefinition publicDefinition, final StatementPolicy<A, D> policy) {
  38         super(publicDefinition, policy);
  39     }
  40
  41     @Override
  42     public final D createDeclared(final StmtContext<A, D, ?> ctx) {
  43         final ImmutableList<? extends DeclaredStatement<?>> substatements = ctx.declaredSubstatements().stream()
  44                 .map(StmtContext::declared)
  45                 .collect(ImmutableList.toImmutableList());
  46         return substatements.isEmpty() ? createEmptyDeclared(ctx) : createDeclared(ctx, substatements);
  47     }
  48
  49     protected abstract @NonNull D createDeclared(@NonNull StmtContext<A, D, ?> ctx,
  50             @NonNull ImmutableList<? extends DeclaredStatement<?>> substatements);
  51
  52     protected abstract @NonNull D createEmptyDeclared(@NonNull StmtContext<A, D, ?> ctx);
  53
  54     @Override
  55     public E createEffective(final Current<A, D> stmt,
  56             final Stream<? extends StmtContext<?, ?, ?>> declaredSubstatements,
  57             final Stream<? extends StmtContext<?, ?, ?>> effectiveSubstatements) {
  58         final ImmutableList<? extends EffectiveStatement<?, ?>> substatements =
  59                 buildEffectiveSubstatements(stmt, statementsToBuild(stmt,
  60                     declaredSubstatements(declaredSubstatements, effectiveSubstatements)));
  61         return createEffective(stmt, substatements);
  62     }
  63
  64     protected abstract @NonNull E createEffective(@NonNull Current<A, D> stmt,
  65             @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> substatements);
  66
  67     @Override
  68     public E copyEffective(final Current<A, D> stmt, final E original) {
  69         // Most implementations are only interested in substatements. copyOf() here should be a no-op
  70         return createEffective(stmt, ImmutableList.copyOf(original.effectiveSubstatements()));
  71     }
  72
  73     /**
  74      * Give statement support a hook to transform statement contexts before they are built. Default implementation
  75      * does nothing, but note {@code augment} statement performs a real transformation.
  76      *
  77      * @param ctx Effective capture of this statement's significant state
  78      * @param substatements Substatement contexts which have been determined to be built
  79      * @return Substatement context which are to be actually built
  80      */
  81     protected List<? extends StmtContext<?, ?, ?>> statementsToBuild(final Current<A, D> ctx,
  82             final List<? extends StmtContext<?, ?, ?>> substatements) {
  83         return substatements;
  84     }
  85
  86     // FIXME: add documentation
  87     public static final <E extends EffectiveStatement<?, ?>> @Nullable E findFirstStatement(
  88             final Collection<? extends EffectiveStatement<?, ?>> statements, final Class<E> type) {
  89         for (EffectiveStatement<?, ?> stmt : statements) {
  90             if (type.isInstance(stmt)) {
  91                 return type.cast(stmt);
  92             }
  93         }
  94         return null;
  95     }
  96
  97     // FIXME: add documentation
  98     public static final <A, E extends EffectiveStatement<A, ?>> A findFirstArgument(
  99             final Collection<? 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             // FIXME: YANGTOOLS-1161: we need to integrate this functionality into the reactor, so that this
 166             //                        transformation is something reactor's declared statements already take into
 167             //                        account.
 168             final Collection<? extends StmtContext<?, ?, ?>> effect = declaredSubstatement.getEffectOfStatement();
 169             if (!effect.isEmpty()) {
 170                 if (filteredStatements == null) {
 171                     filteredStatements = new HashSet<>();
 172                 }
 173                 filteredStatements.addAll(effect);
 174                 substatementsInit.addAll(effect);
 175             }
 176         }
 177
 178         final Stream<? extends StmtContext<?, ?, ?>> effective;
 179         if (filteredStatements != null) {
 180             final Set<StmtContext<?, ?, ?>> filtered = filteredStatements;
 181             effective = effectiveSubstatements.filter(stmt -> !filtered.contains(stmt));
 182         } else {
 183             effective = effectiveSubstatements;
 184         }
 185
 186         substatementsInit.addAll(effective.collect(Collectors.toList()));
 187         return substatementsInit;
 188     }
 189 }