yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/ModifierImpl.java

   1 /*
   2  * Copyright (c) 2015, 2016 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.stmt.reactor;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.EFFECTIVE_MODEL;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.FULL_DECLARATION;
  12
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import com.google.common.base.Preconditions;
  16 import java.util.HashSet;
  17 import java.util.Iterator;
  18 import java.util.Set;
  19 import java.util.function.Function;
  20 import javax.annotation.Nonnull;
  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.IdentifierNamespace;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  30 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  31 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.ContextMutation;
  32 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnNamespaceItemAdded;
  33 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnPhaseFinished;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 class ModifierImpl implements ModelActionBuilder {
  38     private static final Logger LOG = LoggerFactory.getLogger(ModifierImpl.class);
  39
  40     private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
  41     private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
  42     private final ModelProcessingPhase phase;
  43
  44     private InferenceAction action;
  45     private boolean actionApplied = false;
  46
  47     ModifierImpl(final ModelProcessingPhase phase) {
  48         this.phase = Preconditions.checkNotNull(phase);
  49     }
  50
  51     private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
  52         LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
  53         unsatisfied.add(prereq);
  54         return prereq;
  55     }
  56
  57     private <T> AbstractPrerequisite<T> addMutation(final AbstractPrerequisite<T> mutation) {
  58         LOG.trace("Modifier {} adding mutation {}", this, mutation);
  59         mutations.add(mutation);
  60         return mutation;
  61     }
  62
  63     private void checkNotRegistered() {
  64         Preconditions.checkState(action == null, "Action was already registered.");
  65     }
  66
  67     private static IllegalStateException shouldNotHappenProbablyBug(final SourceException e) {
  68         return new IllegalStateException("Source exception during registering prerequisite. This is probably bug.", e);
  69     }
  70
  71     private boolean removeSatisfied() {
  72         final Iterator<AbstractPrerequisite<?>> it = unsatisfied.iterator();
  73         while (it.hasNext()) {
  74             final AbstractPrerequisite<?> prereq = it.next();
  75             if (prereq.isDone()) {
  76                 // We are removing current prerequisite from list.
  77                 LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq);
  78                 it.remove();
  79             }
  80         }
  81         return unsatisfied.isEmpty();
  82     }
  83
  84     ModelProcessingPhase getPhase() {
  85         return phase;
  86     }
  87
  88     boolean isApplied() {
  89         return actionApplied;
  90     }
  91
  92     void failModifier() {
  93         removeSatisfied();
  94         action.prerequisiteFailed(unsatisfied);
  95         action = null;
  96     }
  97
  98     private void applyAction() {
  99         Preconditions.checkState(!actionApplied);
 100         action.apply();
 101         actionApplied = true;
 102     }
 103
 104     @SuppressWarnings({ "unchecked", "rawtypes" })
 105     private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
 106             requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
 107                     final ModelProcessingPhase phase)  {
 108         checkNotRegistered();
 109
 110         try {
 111             AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
 112             addReq(addedToNs);
 113             contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, addedToNs);
 114             return addedToNs;
 115         } catch (SourceException e) {
 116             throw shouldNotHappenProbablyBug(e);
 117         }
 118     }
 119
 120     private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context,
 121             final ModelProcessingPhase phase) {
 122         checkNotRegistered();
 123
 124         try {
 125             PhaseFinished<C> phaseFin = new PhaseFinished<>();
 126             addReq(phaseFin);
 127             contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
 128             return phaseFin;
 129         } catch (SourceException e) {
 130             throw shouldNotHappenProbablyBug(e);
 131         }
 132     }
 133
 134     @SuppressWarnings({ "rawtypes", "unchecked" })
 135     private <K, C extends StmtContext.Mutable<?, ?, ?> , N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
 136             AbstractPrerequisite<C> mutatesCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace,
 137                     final K key, final ModelProcessingPhase phase) {
 138         checkNotRegistered();
 139
 140         try {
 141             PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(phase);
 142             addReq(mod);
 143             addMutation(mod);
 144             contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
 145             return mod;
 146         } catch (SourceException e) {
 147             throw shouldNotHappenProbablyBug(e);
 148         }
 149     }
 150
 151     private static StatementContextBase<?,?,?> contextImpl(final Object value) {
 152         Preconditions.checkArgument(value instanceof StatementContextBase,"Supplied context was not provided by this reactor.");
 153         return StatementContextBase.class.cast(value);
 154     }
 155
 156     boolean tryApply() {
 157         Preconditions.checkState(action != null, "Action was not defined yet.");
 158
 159         if (removeSatisfied()) {
 160             applyAction();
 161             return true;
 162         }
 163         return false;
 164     }
 165
 166     @Nonnull
 167     @Override
 168     public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context, final ModelProcessingPhase phase) {
 169         try {
 170             return addMutation(new PhaseMutation<>(contextImpl(context), phase));
 171         } catch (InferenceException e) {
 172             throw shouldNotHappenProbablyBug(e);
 173         }
 174     }
 175
 176     @Nonnull
 177     @Override
 178     public <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>> AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context, final ModelProcessingPhase phase) {
 179         return requiresCtxImpl(context, phase);
 180     }
 181
 182
 183     @Nonnull
 184     @Override
 185     public <K, N extends StatementNamespace<K, ?, ? >> Prerequisite<StmtContext<?,?,?>> requiresCtx(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key, final ModelProcessingPhase phase) {
 186         return requiresCtxImpl(context, namespace, key, phase);
 187     }
 188
 189     @Nonnull
 190     @Override
 191     public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ? extends D, ?> context) {
 192         return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
 193     }
 194
 195     @Nonnull
 196     @Override
 197     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
 198             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 199         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 200     }
 201
 202     @Nonnull
 203     @Override
 204     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D> requiresDeclared(
 205             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 206         final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 207         return rawContext.transform(StmtContext::buildDeclared);
 208     }
 209
 210     @Nonnull
 211     @Override
 212     public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ? extends E> stmt) {
 213         return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
 214     }
 215
 216     @Nonnull
 217     @Override
 218     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
 219             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 220         return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
 221     }
 222
 223     @Nonnull
 224     @Override
 225     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E> requiresEffective(
 226             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 227         final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 228         return rawContext.transform(StmtContext::buildEffective);
 229     }
 230
 231
 232     @Nonnull
 233     @Override
 234     public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
 235             final Class<N> namespace) {
 236         try {
 237             return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
 238         } catch (SourceException e) {
 239             throw shouldNotHappenProbablyBug(e);
 240         }
 241     }
 242
 243     @Nonnull
 244     @Override
 245     public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
 246             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 247         return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 248     }
 249
 250     @Override
 251     public void apply(final InferenceAction action) {
 252         Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
 253         this.action = Preconditions.checkNotNull(action);
 254     }
 255
 256     private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
 257
 258         private boolean done = false;
 259         private T value;
 260
 261         @Override
 262         public final T get() {
 263             Preconditions.checkState(isDone());
 264             return value;
 265         }
 266
 267         final boolean isDone() {
 268             return done;
 269         }
 270
 271         final boolean resolvePrereq(final T value) {
 272             this.value = value;
 273             this.done = true;
 274             return isApplied();
 275         }
 276
 277         final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
 278             return () -> transformation.apply(get());
 279         }
 280
 281         @Override
 282         public final String toString() {
 283             return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 284         }
 285
 286         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 287             return toStringHelper.add("value", value);
 288         }
 289     }
 290
 291     private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
 292         @SuppressWarnings("unchecked")
 293         public PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 294             context.addMutation(phase, this);
 295             resolvePrereq((C) context);
 296         }
 297
 298         @Override
 299         public boolean isFinished() {
 300             return isApplied();
 301         }
 302     }
 303
 304     private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
 305         @SuppressWarnings("unchecked")
 306         @Override
 307         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 308             return resolvePrereq((C) (context));
 309         }
 310     }
 311
 312     private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>>  {
 313         public NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
 314             resolvePrereq(ctx);
 315         }
 316     }
 317
 318     private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
 319         private final ModelProcessingPhase phase;
 320
 321         public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(final ModelProcessingPhase phase) {
 322             this.phase = phase;
 323         }
 324
 325         @Override
 326         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
 327                 final Object value) {
 328             StatementContextBase<?, ?, ?> targetContext = (StatementContextBase<?, ?, ?>) value;
 329             targetContext.addPhaseCompletedListener(phase, this);
 330         }
 331
 332         @SuppressWarnings("unchecked")
 333         @Override
 334         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 335             return resolvePrereq((C) context);
 336         }
 337
 338         @Override
 339         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 340             return super.addToStringAttributes(toStringHelper).add("phase", phase);
 341         }
 342     }
 343
 344     private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded, ContextMutation {
 345         private final ModelProcessingPhase modPhase;
 346
 347         public <K, N extends StatementNamespace<K, ?, ?>> PhaseModificationInNamespace(final ModelProcessingPhase phase) {
 348             Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
 349             this.modPhase = phase;
 350         }
 351
 352         @SuppressWarnings("unchecked")
 353         @Override
 354         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
 355                 final Object value) {
 356             StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
 357             targetCtx.addMutation(modPhase, this);
 358             resolvePrereq((C) targetCtx);
 359         }
 360
 361         @Override
 362         public boolean isFinished() {
 363             return isApplied();
 364         }
 365     }
 366 }