yang/yang-parser-reactor/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 java.util.Objects.requireNonNull;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.EFFECTIVE_MODEL;
  12 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.FULL_DECLARATION;
  13
  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 java.util.function.Function;
  21 import javax.annotation.Nonnull;
  22 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  23 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  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.NamespaceKeyCriterion;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  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 InferenceContext ctx = new InferenceContext() { };
  41
  42     private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
  43     private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
  44
  45     private InferenceAction action;
  46     private boolean actionApplied = false;
  47
  48     private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
  49         LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
  50         unsatisfied.add(prereq);
  51         return prereq;
  52     }
  53
  54     private <T> AbstractPrerequisite<T> addMutation(final AbstractPrerequisite<T> mutation) {
  55         LOG.trace("Modifier {} adding mutation {}", this, mutation);
  56         mutations.add(mutation);
  57         return mutation;
  58     }
  59
  60     private void checkNotRegistered() {
  61         Preconditions.checkState(action == null, "Action was already registered.");
  62     }
  63
  64     private boolean removeSatisfied() {
  65         final Iterator<AbstractPrerequisite<?>> it = unsatisfied.iterator();
  66         while (it.hasNext()) {
  67             final AbstractPrerequisite<?> prereq = it.next();
  68             if (prereq.isDone()) {
  69                 // We are removing current prerequisite from list.
  70                 LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq);
  71                 it.remove();
  72             }
  73         }
  74         return unsatisfied.isEmpty();
  75     }
  76
  77     boolean isApplied() {
  78         return actionApplied;
  79     }
  80
  81     void failModifier() {
  82         removeSatisfied();
  83         action.prerequisiteFailed(unsatisfied);
  84         action = null;
  85     }
  86
  87     private void applyAction() {
  88         Preconditions.checkState(!actionApplied);
  89         action.apply(ctx);
  90         actionApplied = true;
  91     }
  92
  93     private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
  94             requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
  95                     final ModelProcessingPhase phase)  {
  96         checkNotRegistered();
  97
  98         AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
  99         addReq(addedToNs);
 100         contextImpl(context).onNamespaceItemAddedAction(namespace, key, addedToNs);
 101         return addedToNs;
 102     }
 103
 104     private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
 105             requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace,
 106                     final NamespaceKeyCriterion<K> criterion, final ModelProcessingPhase phase)  {
 107         checkNotRegistered();
 108
 109         AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
 110         addReq(addedToNs);
 111         contextImpl(context).onNamespaceItemAddedAction(namespace, phase, criterion, addedToNs);
 112         return addedToNs;
 113     }
 114
 115     private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context,
 116             final ModelProcessingPhase phase) {
 117         checkNotRegistered();
 118
 119         PhaseFinished<C> phaseFin = new PhaseFinished<>();
 120         addReq(phaseFin);
 121         contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
 122         return phaseFin;
 123     }
 124
 125     @SuppressWarnings({ "rawtypes", "unchecked" })
 126     private <K, C extends StmtContext.Mutable<?, ?, ?>,
 127         N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<C> mutatesCtxImpl(
 128                 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
 129                 final ModelProcessingPhase phase) {
 130         checkNotRegistered();
 131
 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     }
 138
 139     private static StatementContextBase<?,?,?> contextImpl(final Object value) {
 140         Preconditions.checkArgument(value instanceof StatementContextBase,
 141             "Supplied context %s is not provided by this reactor.", value);
 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     @Nonnull
 156     @Override
 157     public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context,
 158             final ModelProcessingPhase phase) {
 159         return addMutation(new PhaseMutation<>(contextImpl(context), phase));
 160     }
 161
 162     @Nonnull
 163     @Override
 164     public <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>>
 165             AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context,
 166                     final ModelProcessingPhase phase) {
 167         return requiresCtxImpl(context, phase);
 168     }
 169
 170
 171     @Nonnull
 172     @Override
 173     public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
 174             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
 175             final ModelProcessingPhase phase) {
 176         return requiresCtxImpl(context, namespace, key, phase);
 177     }
 178
 179     @Nonnull
 180     @Override
 181     public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
 182             final StmtContext<?, ?, ?> context, final Class<N> namespace, final NamespaceKeyCriterion<K> criterion,
 183             final ModelProcessingPhase phase) {
 184         return requiresCtxImpl(context, namespace, criterion, phase);
 185     }
 186
 187     @Nonnull
 188     @Override
 189     public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
 190             final StmtContext<?, ? extends D, ?> context) {
 191         return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
 192     }
 193
 194     @Nonnull
 195     @Override
 196     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D>
 197             requiresDeclared(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 198         final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key,
 199             FULL_DECLARATION);
 200         return rawContext.transform(StmtContext::buildDeclared);
 201     }
 202
 203     @Nonnull
 204     @Override
 205     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>>
 206             AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(final StmtContext<?, ?, ?> context,
 207                     final Class<N> namespace, final K key) {
 208         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 209     }
 210
 211     @Nonnull
 212     @Override
 213     public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
 214             final StmtContext<?, ?, ? extends E> stmt) {
 215         return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
 216     }
 217
 218     @Nonnull
 219     @Override
 220     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E>
 221             requiresEffective(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 222         final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key,
 223             EFFECTIVE_MODEL);
 224         return rawContext.transform(StmtContext::buildEffective);
 225     }
 226
 227     @Nonnull
 228     @Override
 229     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>>
 230             AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(final StmtContext<?, ?, ?> context,
 231                     final Class<N> namespace, final K key) {
 232         return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
 233     }
 234
 235     @Nonnull
 236     @Override
 237     public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(
 238             final Mutable<?, ?, ?> context, final Class<N> namespace) {
 239         return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
 240     }
 241
 242     @Nonnull
 243     @Override
 244     public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
 245             AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(final StmtContext<?, ?, ?> context,
 246                     final Class<N> namespace, final K key) {
 247         return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 248     }
 249
 250     @Override
 251     @SuppressWarnings("checkstyle:hiddenField")
 252     public void apply(final InferenceAction action) {
 253         Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
 254         this.action = Preconditions.checkNotNull(action);
 255     }
 256
 257     private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
 258         private boolean done = false;
 259         private T value;
 260
 261         @Override
 262         @SuppressWarnings("checkstyle:hiddenField")
 263         public final T resolve(final InferenceContext ctx) {
 264             Preconditions.checkState(done);
 265             Preconditions.checkArgument(ctx == ModifierImpl.this.ctx);
 266             return value;
 267         }
 268
 269         final boolean isDone() {
 270             return done;
 271         }
 272
 273         @SuppressWarnings("checkstyle:hiddenField")
 274         final boolean resolvePrereq(final T value) {
 275             this.value = value;
 276             this.done = true;
 277             return isApplied();
 278         }
 279
 280         final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
 281             return context -> transformation.apply(resolve(context));
 282         }
 283
 284         @Override
 285         public final String toString() {
 286             return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 287         }
 288
 289         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 290             return toStringHelper.add("value", value);
 291         }
 292     }
 293
 294     private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
 295         @SuppressWarnings("unchecked")
 296         PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 297             context.addMutation(phase, this);
 298             resolvePrereq((C) context);
 299         }
 300
 301         @Override
 302         public boolean isFinished() {
 303             return isApplied();
 304         }
 305     }
 306
 307     private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 308             implements OnPhaseFinished {
 309         @SuppressWarnings("unchecked")
 310         @Override
 311         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 312                 final ModelProcessingPhase finishedPhase) {
 313             return resolvePrereq((C) context);
 314         }
 315     }
 316
 317     private class NamespaceMutation<N extends IdentifierNamespace<?,?>>
 318             extends AbstractPrerequisite<Mutable<?, ?, ?>>  {
 319         NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
 320             resolvePrereq(ctx);
 321         }
 322     }
 323
 324     private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C>
 325             implements OnNamespaceItemAdded, OnPhaseFinished {
 326         private final ModelProcessingPhase phase;
 327
 328         AddedToNamespace(final ModelProcessingPhase phase) {
 329             this.phase = requireNonNull(phase);
 330         }
 331
 332         @Override
 333         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
 334                 final Object key, final Object value) {
 335             ((StatementContextBase<?, ?, ?>) value).addPhaseCompletedListener(phase, this);
 336         }
 337
 338         @SuppressWarnings("unchecked")
 339         @Override
 340         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 341                 final ModelProcessingPhase finishedPhase) {
 342             return resolvePrereq((C) context);
 343         }
 344
 345         @Override
 346         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 347             return super.addToStringAttributes(toStringHelper).add("phase", phase);
 348         }
 349     }
 350
 351     private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C>
 352             implements OnNamespaceItemAdded, ContextMutation {
 353         private final ModelProcessingPhase modPhase;
 354
 355         PhaseModificationInNamespace(final ModelProcessingPhase phase) {
 356             Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
 357             this.modPhase = phase;
 358         }
 359
 360         @SuppressWarnings("unchecked")
 361         @Override
 362         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
 363                 final Object key, final Object value) {
 364             StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
 365             targetCtx.addMutation(modPhase, this);
 366             resolvePrereq((C) targetCtx);
 367         }
 368
 369         @Override
 370         public boolean isFinished() {
 371             return isApplied();
 372         }
 373     }
 374 }