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 com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static com.google.common.base.Verify.verifyNotNull;
  13 import static java.util.Objects.requireNonNull;
  14 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.EFFECTIVE_MODEL;
  15 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.FULL_DECLARATION;
  16
  17 import com.google.common.base.MoreObjects;
  18 import com.google.common.base.MoreObjects.ToStringHelper;
  19 import java.util.HashSet;
  20 import java.util.Iterator;
  21 import java.util.Set;
  22 import java.util.function.Function;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  25 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  33 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.ContextMutation;
  34 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnNamespaceItemAdded;
  35 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnPhaseFinished;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 final class ModifierImpl implements ModelActionBuilder {
  40     private static final Logger LOG = LoggerFactory.getLogger(ModifierImpl.class);
  41
  42     private final InferenceContext ctx = new InferenceContext() { };
  43
  44     private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
  45     private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
  46
  47     private InferenceAction action;
  48     private boolean actionApplied = false;
  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> @NonNull AbstractPrerequisite<T> addMutation(final @NonNull 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         checkState(action == null, "Action was already registered.");
  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         checkState(!actionApplied);
  91         action.apply(ctx);
  92         actionApplied = true;
  93     }
  94
  95     private <K, C extends StmtContext<?, ?, ?>, N extends StatementNamespace<K, ?, ?>> @NonNull AbstractPrerequisite<C>
  96             requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
  97                     final ModelProcessingPhase phase)  {
  98         checkNotRegistered();
  99
 100         AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
 101         addReq(addedToNs);
 102         contextImpl(context).onNamespaceItemAddedAction(namespace, key, addedToNs);
 103         return addedToNs;
 104     }
 105
 106     private <K, C extends StmtContext<?, ?, ?>, N extends StatementNamespace<K, ?, ?>> @NonNull AbstractPrerequisite<C>
 107             requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace,
 108                     final NamespaceKeyCriterion<K> criterion, final ModelProcessingPhase phase)  {
 109         checkNotRegistered();
 110
 111         AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
 112         addReq(addedToNs);
 113         contextImpl(context).onNamespaceItemAddedAction(namespace, phase, criterion, addedToNs);
 114         return addedToNs;
 115     }
 116
 117     private <C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(final C context,
 118             final ModelProcessingPhase phase) {
 119         checkNotRegistered();
 120
 121         PhaseFinished<C> phaseFin = new PhaseFinished<>();
 122         addReq(phaseFin);
 123         contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
 124         return phaseFin;
 125     }
 126
 127     @SuppressWarnings({ "rawtypes", "unchecked" })
 128     private <K, C extends Mutable<?, ?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
 129             AbstractPrerequisite<C> mutatesCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace,
 130                     final K key, final ModelProcessingPhase phase) {
 131         checkNotRegistered();
 132
 133         final PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(EFFECTIVE_MODEL);
 134         addReq(mod);
 135         addMutation(mod);
 136         contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
 137         return mod;
 138     }
 139
 140     private static StatementContextBase<?, ?, ?> contextImpl(final Object value) {
 141         checkArgument(value instanceof StatementContextBase, "Supplied context %s is not provided by this reactor.",
 142             value);
 143         return StatementContextBase.class.cast(value);
 144     }
 145
 146     boolean tryApply() {
 147         checkState(action != null, "Action was not defined yet.");
 148
 149         if (removeSatisfied()) {
 150             applyAction();
 151             return true;
 152         }
 153         return false;
 154     }
 155
 156     @Override
 157     public <C extends Mutable<?, ?, ?>, T extends C> Prerequisite<C> mutatesCtx(final T context,
 158             final ModelProcessingPhase phase) {
 159         return addMutation(new PhaseMutation<>(contextImpl(context), phase));
 160     }
 161
 162     @Override
 163     public <A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
 164             AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context,
 165                     final ModelProcessingPhase phase) {
 166         return requiresCtxImpl(context, phase);
 167     }
 168
 169
 170     @Override
 171     public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
 172             final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
 173             final ModelProcessingPhase phase) {
 174         return requiresCtxImpl(context, namespace, key, phase);
 175     }
 176
 177     @Override
 178     public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
 179             final StmtContext<?, ?, ?> context, final Class<N> namespace, final NamespaceKeyCriterion<K> criterion,
 180             final ModelProcessingPhase phase) {
 181         return requiresCtxImpl(context, namespace, criterion, phase);
 182     }
 183
 184     @Override
 185     public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
 186             final StmtContext<?, ? extends D, ?> context) {
 187         return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
 188     }
 189
 190     @Override
 191     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D>
 192             requiresDeclared(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 193         final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key,
 194             FULL_DECLARATION);
 195         return rawContext.transform(StmtContext::buildDeclared);
 196     }
 197
 198     @Override
 199     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>>
 200             AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(final StmtContext<?, ?, ?> context,
 201                     final Class<N> namespace, final K key) {
 202         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 203     }
 204
 205     @Override
 206     public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
 207             final StmtContext<?, ?, ? extends E> stmt) {
 208         return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
 209     }
 210
 211     @Override
 212     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E>
 213             requiresEffective(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
 214         final AbstractPrerequisite<StmtContext<?, ?, E>> rawContext = requiresCtxImpl(context, namespace, key,
 215             EFFECTIVE_MODEL);
 216         return rawContext.transform(StmtContext::buildEffective);
 217     }
 218
 219     @Override
 220     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>>
 221             AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(final StmtContext<?, ?, ?> context,
 222                     final Class<N> namespace, final K key) {
 223         return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
 224     }
 225
 226     @Override
 227     public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(
 228             final Mutable<?, ?, ?> context, final Class<N> namespace) {
 229         return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
 230     }
 231
 232     @Override
 233     public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
 234             AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(final StmtContext<?, ?, ?> context,
 235                     final Class<N> namespace, final K key) {
 236         return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 237     }
 238
 239     @Override
 240     public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
 241             AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtxPath(final StmtContext<?, ?, ?> context,
 242                     final Class<N> namespace, final Iterable<K> keys) {
 243         checkNotRegistered();
 244
 245         final PhaseModificationInNamespacePath<Mutable<?, ?, E>, K, N> ret = new PhaseModificationInNamespacePath<>(
 246                 EFFECTIVE_MODEL, keys);
 247         addReq(ret);
 248         addMutation(ret);
 249
 250         ret.hookOnto(context, namespace);
 251         return ret;
 252     }
 253
 254     @Override
 255     @SuppressWarnings("checkstyle:hiddenField")
 256     public void apply(final InferenceAction action) {
 257         checkState(this.action == null, "Action already defined to %s", this.action);
 258         this.action = requireNonNull(action);
 259     }
 260
 261     private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
 262         private boolean done = false;
 263         private T value;
 264
 265         @Override
 266         @SuppressWarnings("checkstyle:hiddenField")
 267         public final T resolve(final InferenceContext ctx) {
 268             checkState(done);
 269             checkArgument(ctx == ModifierImpl.this.ctx);
 270             return verifyNotNull(value, "Attempted to access unavailable prerequisite %s", this);
 271         }
 272
 273         final boolean isDone() {
 274             return done;
 275         }
 276
 277         @SuppressWarnings("checkstyle:hiddenField")
 278         final boolean resolvePrereq(final T value) {
 279             this.value = value;
 280             this.done = true;
 281             return isApplied();
 282         }
 283
 284         final <O> @NonNull Prerequisite<O> transform(final Function<? super T, O> transformation) {
 285             return context -> transformation.apply(resolve(context));
 286         }
 287
 288         @Override
 289         public final String toString() {
 290             return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 291         }
 292
 293         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 294             return toStringHelper.add("value", value);
 295         }
 296     }
 297
 298     private final class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
 299         @SuppressWarnings("unchecked")
 300         PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 301             context.addMutation(phase, this);
 302             resolvePrereq((C) context);
 303         }
 304
 305         @Override
 306         public boolean isFinished() {
 307             return isApplied();
 308         }
 309     }
 310
 311     private final class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 312             implements OnPhaseFinished {
 313         @SuppressWarnings("unchecked")
 314         @Override
 315         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 316                 final ModelProcessingPhase finishedPhase) {
 317             return resolvePrereq((C) context);
 318         }
 319     }
 320
 321     private final class NamespaceMutation<N extends IdentifierNamespace<?, ?>>
 322             extends AbstractPrerequisite<Mutable<?, ?, ?>>  {
 323         NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
 324             resolvePrereq(ctx);
 325         }
 326     }
 327
 328     private final class AddedToNamespace<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 329             implements OnNamespaceItemAdded, OnPhaseFinished {
 330         private final ModelProcessingPhase phase;
 331
 332         AddedToNamespace(final ModelProcessingPhase phase) {
 333             this.phase = requireNonNull(phase);
 334         }
 335
 336         @Override
 337         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
 338                 final Object key, final Object value) {
 339             ((StatementContextBase<?, ?, ?>) value).addPhaseCompletedListener(phase, this);
 340         }
 341
 342         @SuppressWarnings("unchecked")
 343         @Override
 344         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 345                 final ModelProcessingPhase finishedPhase) {
 346             return resolvePrereq((C) context);
 347         }
 348
 349         @Override
 350         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 351             return super.addToStringAttributes(toStringHelper).add("phase", phase);
 352         }
 353     }
 354
 355     private final class PhaseModificationInNamespace<C extends Mutable<?, ?, ?>> extends AbstractPrerequisite<C>
 356             implements OnNamespaceItemAdded, ContextMutation {
 357         private final ModelProcessingPhase modPhase;
 358
 359         PhaseModificationInNamespace(final ModelProcessingPhase phase) {
 360             checkArgument(phase != null, "Model processing phase must not be null");
 361             this.modPhase = phase;
 362         }
 363
 364         @SuppressWarnings("unchecked")
 365         @Override
 366         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
 367                 final Object key, final Object value) {
 368             StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
 369             targetCtx.addMutation(modPhase, this);
 370             resolvePrereq((C) targetCtx);
 371         }
 372
 373         @Override
 374         public boolean isFinished() {
 375             return isApplied();
 376         }
 377     }
 378
 379     private final class PhaseModificationInNamespacePath<C extends Mutable<?, ?, ?>, K,
 380             N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> extends AbstractPrerequisite<C>
 381             implements OnNamespaceItemAdded, ContextMutation {
 382         private final ModelProcessingPhase modPhase;
 383         private final Iterable<K> keys;
 384         private final Iterator<K> it;
 385
 386         PhaseModificationInNamespacePath(final ModelProcessingPhase phase, final Iterable<K> keys) {
 387             this.modPhase = requireNonNull(phase);
 388             this.keys = requireNonNull(keys);
 389             it = keys.iterator();
 390         }
 391
 392         @Override
 393         public boolean isFinished() {
 394             return isApplied();
 395         }
 396
 397         @Override
 398         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
 399                 final Object key, final Object value) {
 400             LOG.debug("Action for {} got key {}", keys, key);
 401
 402             final StatementContextBase<?, ?, ?> target = contextImpl(value);
 403             if (!target.isSupportedByFeatures()) {
 404                 LOG.debug("Key {} in {} is not supported", key, keys);
 405                 resolvePrereq(null);
 406                 action.prerequisiteUnavailable(this);
 407                 return;
 408             }
 409
 410             if (!it.hasNext()) {
 411                 target.addMutation(modPhase, this);
 412                 resolvePrereq((C) value);
 413                 return;
 414             }
 415
 416             hookOnto(target, namespace, it.next());
 417         }
 418
 419         void hookOnto(final StmtContext<?, ?, ?> context, final Class<?> namespace) {
 420             checkArgument(it.hasNext(), "Namespace %s keys may not be empty", namespace);
 421             hookOnto(contextImpl(context), namespace, it.next());
 422         }
 423
 424         @SuppressWarnings("unchecked")
 425         private void hookOnto(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final K key) {
 426             context.onNamespaceItemAddedAction((Class) namespace, requireNonNull(key), this);
 427         }
 428     }
 429 }