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 final 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
  43     private InferenceAction action;
  44     private boolean actionApplied = false;
  45
  46     private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
  47         LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
  48         unsatisfied.add(prereq);
  49         return prereq;
  50     }
  51
  52     private <T> AbstractPrerequisite<T> addMutation(final AbstractPrerequisite<T> mutation) {
  53         LOG.trace("Modifier {} adding mutation {}", this, mutation);
  54         mutations.add(mutation);
  55         return mutation;
  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         final Iterator<AbstractPrerequisite<?>> it = unsatisfied.iterator();
  68         while (it.hasNext()) {
  69             final AbstractPrerequisite<?> prereq = it.next();
  70             if (prereq.isDone()) {
  71                 // We are removing current prerequisite from list.
  72                 LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq);
  73                 it.remove();
  74             }
  75         }
  76         return unsatisfied.isEmpty();
  77     }
  78
  79     boolean isApplied() {
  80         return actionApplied;
  81     }
  82
  83     void failModifier() {
  84         removeSatisfied();
  85         action.prerequisiteFailed(unsatisfied);
  86         action = null;
  87     }
  88
  89     private void applyAction() {
  90         Preconditions.checkState(!actionApplied);
  91         action.apply();
  92         actionApplied = true;
  93     }
  94
  95     @SuppressWarnings({ "unchecked", "rawtypes" })
  96     private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
  97             requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
  98                     final ModelProcessingPhase phase)  {
  99         checkNotRegistered();
 100
 101         try {
 102             AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
 103             addReq(addedToNs);
 104             contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, addedToNs);
 105             return addedToNs;
 106         } catch (SourceException e) {
 107             throw shouldNotHappenProbablyBug(e);
 108         }
 109     }
 110
 111     private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context,
 112             final ModelProcessingPhase phase) {
 113         checkNotRegistered();
 114
 115         try {
 116             PhaseFinished<C> phaseFin = new PhaseFinished<>();
 117             addReq(phaseFin);
 118             contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
 119             return phaseFin;
 120         } catch (SourceException e) {
 121             throw shouldNotHappenProbablyBug(e);
 122         }
 123     }
 124
 125     @SuppressWarnings({ "rawtypes", "unchecked" })
 126     private <K, C extends StmtContext.Mutable<?, ?, ?> , N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
 127             AbstractPrerequisite<C> mutatesCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace,
 128                     final K key, final ModelProcessingPhase phase) {
 129         checkNotRegistered();
 130
 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     @Nonnull
 158     @Override
 159     public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context, final ModelProcessingPhase phase) {
 160         try {
 161             return addMutation(new PhaseMutation<>(contextImpl(context), phase));
 162         } catch (InferenceException e) {
 163             throw shouldNotHappenProbablyBug(e);
 164         }
 165     }
 166
 167     @Nonnull
 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     @Nonnull
 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     @Nonnull
 181     @Override
 182     public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ? extends D, ?> context) {
 183         return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
 184     }
 185
 186     @Nonnull
 187     @Override
 188     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
 189             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 190         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 191     }
 192
 193     @Nonnull
 194     @Override
 195     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D> requiresDeclared(
 196             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 197         final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 198         return rawContext.transform(StmtContext::buildDeclared);
 199     }
 200
 201     @Nonnull
 202     @Override
 203     public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ? extends E> stmt) {
 204         return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
 205     }
 206
 207     @Nonnull
 208     @Override
 209     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
 210             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 211         return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
 212     }
 213
 214     @Nonnull
 215     @Override
 216     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E> requiresEffective(
 217             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 218         final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 219         return rawContext.transform(StmtContext::buildEffective);
 220     }
 221
 222
 223     @Nonnull
 224     @Override
 225     public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
 226             final Class<N> namespace) {
 227         try {
 228             return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
 229         } catch (SourceException e) {
 230             throw shouldNotHappenProbablyBug(e);
 231         }
 232     }
 233
 234     @Nonnull
 235     @Override
 236     public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
 237             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 238         return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 239     }
 240
 241     @Override
 242     public void apply(final InferenceAction action) {
 243         Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
 244         this.action = Preconditions.checkNotNull(action);
 245     }
 246
 247     private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
 248
 249         private boolean done = false;
 250         private T value;
 251
 252         @Override
 253         public final T get() {
 254             Preconditions.checkState(isDone());
 255             return value;
 256         }
 257
 258         final boolean isDone() {
 259             return done;
 260         }
 261
 262         final boolean resolvePrereq(final T value) {
 263             this.value = value;
 264             this.done = true;
 265             return isApplied();
 266         }
 267
 268         final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
 269             return () -> transformation.apply(get());
 270         }
 271
 272         @Override
 273         public final String toString() {
 274             return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 275         }
 276
 277         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 278             return toStringHelper.add("value", value);
 279         }
 280     }
 281
 282     private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
 283         @SuppressWarnings("unchecked")
 284         public PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 285             context.addMutation(phase, this);
 286             resolvePrereq((C) context);
 287         }
 288
 289         @Override
 290         public boolean isFinished() {
 291             return isApplied();
 292         }
 293     }
 294
 295     private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
 296         @SuppressWarnings("unchecked")
 297         @Override
 298         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 299             return resolvePrereq((C) context);
 300         }
 301     }
 302
 303     private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>>  {
 304         public NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
 305             resolvePrereq(ctx);
 306         }
 307     }
 308
 309     private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
 310         private final ModelProcessingPhase phase;
 311
 312         public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(final ModelProcessingPhase phase) {
 313             this.phase = phase;
 314         }
 315
 316         @Override
 317         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
 318                 final Object value) {
 319             StatementContextBase<?, ?, ?> targetContext = (StatementContextBase<?, ?, ?>) value;
 320             targetContext.addPhaseCompletedListener(phase, this);
 321         }
 322
 323         @SuppressWarnings("unchecked")
 324         @Override
 325         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 326             return resolvePrereq((C) context);
 327         }
 328
 329         @Override
 330         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 331             return super.addToStringAttributes(toStringHelper).add("phase", phase);
 332         }
 333     }
 334
 335     private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded, ContextMutation {
 336         private final ModelProcessingPhase modPhase;
 337
 338         public <K, N extends StatementNamespace<K, ?, ?>> PhaseModificationInNamespace(final ModelProcessingPhase phase) {
 339             Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
 340             this.modPhase = phase;
 341         }
 342
 343         @SuppressWarnings("unchecked")
 344         @Override
 345         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
 346                 final Object value) {
 347             StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
 348             targetCtx.addMutation(modPhase, this);
 349             resolvePrereq((C) targetCtx);
 350         }
 351
 352         @Override
 353         public boolean isFinished() {
 354             return isApplied();
 355         }
 356     }
 357 }