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.Function;
  14 import com.google.common.base.MoreObjects;
  15 import com.google.common.base.MoreObjects.ToStringHelper;
  16 import com.google.common.base.Preconditions;
  17 import java.util.HashSet;
  18 import java.util.Iterator;
  19 import java.util.Set;
  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         Iterator<AbstractPrerequisite<?>> it = unsatisfied.iterator();
  72         boolean allSatisfied = true;
  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             } else {
  80                 allSatisfied  = false;
  81             }
  82         }
  83         return allSatisfied;
  84     }
  85
  86     ModelProcessingPhase getPhase() {
  87         return phase;
  88     }
  89
  90     boolean isApplied() {
  91         return actionApplied;
  92     }
  93
  94     void failModifier() {
  95         removeSatisfied();
  96         action.prerequisiteFailed(unsatisfied);
  97         action = null;
  98     }
  99
 100     private void applyAction() {
 101         Preconditions.checkState(!actionApplied);
 102         action.apply();
 103         actionApplied = true;
 104     }
 105
 106     @SuppressWarnings({ "unchecked", "rawtypes" })
 107     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)  {
 108         checkNotRegistered();
 109         try {
 110             AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
 111             addReq(addedToNs);
 112             contextImpl(context).onNamespaceItemAddedAction((Class) namespace,key,addedToNs);
 113             return addedToNs;
 114         } catch (SourceException e) {
 115             throw shouldNotHappenProbablyBug(e);
 116         }
 117     }
 118
 119     private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context, final ModelProcessingPhase phase) {
 120         Preconditions.checkState(action == null, "Action was already registered.");
 121         try {
 122             PhaseFinished<C> phaseFin = new PhaseFinished<>();
 123             addReq(phaseFin);
 124             contextImpl(context).addPhaseCompletedListener(phase,phaseFin);
 125             return phaseFin;
 126         } catch (SourceException e) {
 127             throw shouldNotHappenProbablyBug(e);
 128         }
 129     }
 130
 131     @SuppressWarnings({ "rawtypes", "unchecked" })
 132     private <K, C extends StmtContext.Mutable<?, ?, ?> , N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<C> mutatesCtxImpl(
 133                 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key, final ModelProcessingPhase phase) {
 134             try {
 135                 PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(phase);
 136                 addReq(mod);
 137                 addMutation(mod);
 138                 contextImpl(context).onNamespaceItemAddedAction((Class) namespace,key,mod);
 139                 return mod;
 140             } catch (SourceException e) {
 141                 throw shouldNotHappenProbablyBug(e);
 142             }
 143         }
 144
 145     private static StatementContextBase<?,?,?> contextImpl(final Object value) {
 146         Preconditions.checkArgument(value instanceof StatementContextBase,"Supplied context was not provided by this reactor.");
 147         return StatementContextBase.class.cast(value);
 148     }
 149
 150     boolean tryApply() {
 151         Preconditions.checkState(action != null, "Action was not defined yet.");
 152
 153         if (removeSatisfied()) {
 154             applyAction();
 155             return true;
 156         }
 157         return false;
 158     }
 159
 160     @Override
 161     public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context, final ModelProcessingPhase phase) {
 162         try {
 163             return addMutation(new PhaseMutation<>(contextImpl(context), phase));
 164         } catch (InferenceException e) {
 165             throw shouldNotHappenProbablyBug(e);
 166         }
 167     }
 168
 169     @Override
 170     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) {
 171         return requiresCtxImpl(context, phase);
 172     }
 173
 174
 175     @Override
 176     public <K, N extends StatementNamespace<K, ?, ? >> Prerequisite<StmtContext<?,?,?>> requiresCtx(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key, final ModelProcessingPhase phase) {
 177         return requiresCtxImpl(context, namespace, key, phase);
 178     }
 179
 180     @Override
 181     public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ? extends D, ?> context) {
 182         return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
 183     }
 184
 185     @Override
 186     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
 187             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 188         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 189     }
 190
 191     @Override
 192     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D> requiresDeclared(
 193             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 194         final AbstractPrerequisite<StmtContext<?,D,?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 195         return rawContext.transform(StmtContext::buildDeclared);
 196     }
 197
 198     @Override
 199     public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ? extends E> stmt) {
 200         return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
 201     }
 202
 203     @Override
 204     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
 205             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 206         return requiresCtxImpl(contextImpl(context), namespace,key, EFFECTIVE_MODEL);
 207     }
 208
 209     @Override
 210     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E> requiresEffective(
 211             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 212         final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 213         return rawContext.transform(StmtContext::buildEffective);
 214     }
 215
 216
 217     @Override
 218     public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
 219             final Class<N> namespace) {
 220         try {
 221             return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
 222         } catch (SourceException e) {
 223             throw shouldNotHappenProbablyBug(e);
 224         }
 225     }
 226
 227     @Override
 228     public <T extends Mutable<?, ?, ?>> Prerequisite<T> mutatesEffectiveCtx(final T stmt) {
 229         return mutatesCtx(stmt, EFFECTIVE_MODEL);
 230     }
 231
 232    @Override
 233     public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> 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     @Override
 239     public void apply(final InferenceAction action) {
 240         Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
 241         this.action = Preconditions.checkNotNull(action);
 242     }
 243
 244     private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
 245
 246         private boolean done = false;
 247         private T value;
 248
 249         @Override
 250         public final T get() {
 251             Preconditions.checkState(isDone());
 252             return value;
 253         }
 254
 255         @Override
 256         public final boolean isDone() {
 257             return done;
 258         }
 259
 260         final boolean resolvePrereq(final T value) {
 261             this.value = value;
 262             this.done = true;
 263             return isApplied();
 264         }
 265
 266         final <O> Prerequisite<O> transform(final Function<? super T,O> transformation) {
 267             return new Prerequisite<O>() {
 268                 @Override
 269                 public O get() {
 270                     return transformation.apply(AbstractPrerequisite.this.get());
 271                 }
 272
 273                 @Override
 274                 public boolean isDone() {
 275                     return AbstractPrerequisite.this.isDone();
 276                 }
 277             };
 278         }
 279
 280         @Override
 281         public final String toString() {
 282             return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 283         }
 284
 285         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 286             return toStringHelper.add("value", value);
 287         }
 288     }
 289
 290     private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
 291         @SuppressWarnings("unchecked")
 292         public PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 293             context.addMutation(phase, this);
 294             resolvePrereq((C) context);
 295         }
 296
 297         @Override
 298         public boolean isFinished() {
 299             return isApplied();
 300         }
 301     }
 302
 303     private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
 304         @SuppressWarnings("unchecked")
 305         @Override
 306         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 307             return resolvePrereq((C) (context));
 308         }
 309     }
 310
 311     private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends  AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>>  {
 312         public NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
 313             resolvePrereq(ctx);
 314         }
 315     }
 316
 317     private class AddedToNamespace<C extends StmtContext<?,?,?>> extends  AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
 318         private final ModelProcessingPhase phase;
 319
 320         public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(final ModelProcessingPhase phase) {
 321             this.phase = phase;
 322         }
 323
 324         @Override
 325         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
 326                 final Object value) {
 327             StatementContextBase<?, ?, ?> targetContext = (StatementContextBase<?, ?, ?>) value;
 328             targetContext.addPhaseCompletedListener(phase, this);
 329         }
 330
 331         @SuppressWarnings("unchecked")
 332         @Override
 333         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 334             return resolvePrereq((C) context);
 335         }
 336
 337         @Override
 338         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 339             return super.addToStringAttributes(toStringHelper).add("phase", phase);
 340         }
 341     }
 342
 343     private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded, ContextMutation {
 344         private final ModelProcessingPhase modPhase;
 345
 346         public <K, N extends StatementNamespace<K, ?, ?>> PhaseModificationInNamespace(final ModelProcessingPhase phase) {
 347             Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
 348             this.modPhase = phase;
 349         }
 350
 351         @SuppressWarnings("unchecked")
 352         @Override
 353         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
 354                 final Object value) {
 355             StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
 356             targetCtx.addMutation(modPhase, this);
 357             resolvePrereq((C) targetCtx);
 358         }
 359
 360         @Override
 361         public boolean isFinished() {
 362             return isApplied();
 363         }
 364     }
 365 }