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