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

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