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