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