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