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