2 * Copyright (c) 2015, 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.stmt.reactor;
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;
17 import com.google.common.base.MoreObjects;
18 import com.google.common.base.MoreObjects.ToStringHelper;
19 import java.util.ArrayList;
20 import java.util.HashSet;
21 import java.util.Iterator;
22 import java.util.List;
24 import java.util.function.Function;
25 import org.eclipse.jdt.annotation.NonNull;
26 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
27 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.ParserNamespace;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
34 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.ContextMutation;
35 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnNamespaceItemAdded;
36 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnPhaseFinished;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
40 final class ModifierImpl implements ModelActionBuilder {
41 private static final Logger LOG = LoggerFactory.getLogger(ModifierImpl.class);
43 private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
44 private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
45 private final InferenceContext ctx = new InferenceContext() { };
47 private List<Runnable> bootstraps;
48 private InferenceAction action;
49 private boolean actionApplied;
51 private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
52 LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
53 unsatisfied.add(prereq);
57 private <T> @NonNull AbstractPrerequisite<T> addMutation(final @NonNull AbstractPrerequisite<T> mutation) {
58 LOG.trace("Modifier {} adding mutation {}", this, mutation);
59 mutations.add(mutation);
63 private void checkNotRegistered() {
64 checkState(action == null, "Action was already registered.");
67 private boolean removeSatisfied() {
68 final var it = unsatisfied.iterator();
69 while (it.hasNext()) {
70 final var prereq = it.next();
71 if (prereq.isDone()) {
72 // We are removing current prerequisite from list.
73 LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq);
77 return unsatisfied.isEmpty();
86 action.prerequisiteFailed(unsatisfied);
90 private <K, C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(
91 final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace, final K key,
92 final ModelProcessingPhase phase) {
95 final var addedToNs = new AddedToNamespace<C>(this, phase);
97 contextImpl(context).onNamespaceItemAddedAction(namespace, key, addedToNs);
101 private <K, C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(
102 final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace,
103 final NamespaceKeyCriterion<K> criterion, final ModelProcessingPhase phase) {
104 checkNotRegistered();
106 final var addedToNs = new AddedToNamespace<C>(this, phase);
108 contextImpl(context).onNamespaceItemAddedAction(namespace, phase, criterion, addedToNs);
112 private <C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(final C context,
113 final ModelProcessingPhase phase) {
114 checkNotRegistered();
116 final var phaseFin = new PhaseFinished<C>(this);
118 addBootstrap(() -> contextImpl(context).addPhaseCompletedListener(phase, phaseFin));
122 private <K, C extends Mutable<?, ?, ?>> AbstractPrerequisite<C> mutatesCtxImpl(final StmtContext<?, ?, ?> context,
123 final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace, final K key,
124 final ModelProcessingPhase phase) {
125 checkNotRegistered();
127 final var mod = new PhaseModificationInNamespace<C>(this, EFFECTIVE_MODEL);
130 contextImpl(context).onNamespaceItemAddedAction(namespace, key, mod);
134 private static StatementContextBase<?, ?, ?> contextImpl(final Object value) {
135 if (value instanceof StatementContextBase<?, ?, ?> impl) {
138 throw new IllegalArgumentException("Supplied context " + value + " is not provided by this reactor.");
142 checkState(action != null, "Action was not defined yet.");
144 if (removeSatisfied()) {
145 if (!actionApplied) {
147 actionApplied = true;
155 public <C extends Mutable<?, ?, ?>, T extends C> Prerequisite<C> mutatesCtx(final T context,
156 final ModelProcessingPhase phase) {
157 return addMutation(new PhaseMutation<>(this, contextImpl(context), phase));
161 public <A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
162 AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context,
163 final ModelProcessingPhase phase) {
164 return requiresCtxImpl(context, phase);
168 public <K, C extends StmtContext<?, ?, ?>> Prerequisite<C> requiresCtx(final StmtContext<?, ?, ?> context,
169 final ParserNamespace<K, C> namespace, final K key, final ModelProcessingPhase phase) {
170 return requiresCtxImpl(context, namespace, key, phase);
174 public <K, C extends StmtContext<?, ?, ?>> Prerequisite<C> requiresCtx(final StmtContext<?, ?, ?> context,
175 final ParserNamespace<K, C> namespace, final NamespaceKeyCriterion<K> criterion,
176 final ModelProcessingPhase phase) {
177 return requiresCtxImpl(context, namespace, criterion, phase);
181 public <K, C extends StmtContext<?, ?, ?>> Prerequisite<C> requiresEffectiveCtxPath(
182 final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace, final Iterable<K> keys) {
183 checkNotRegistered();
185 final var ret = new PhaseRequirementInNamespacePath<C, K>(this, keys);
187 addBootstrap(() -> ret.hookOnto(context, namespace));
192 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
193 final StmtContext<?, ? extends D, ?> context) {
194 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::declared);
199 public <K, D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ?, ?> context,
200 final ParserNamespace<K, StmtContext<?, ? extends D, ?>> namespace, final K key) {
201 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION).transform(StmtContext::declared);
206 public <K, C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresDeclaredCtx(
207 final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace, final K key) {
208 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
213 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
214 final StmtContext<?, ?, ? extends E> stmt) {
215 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
220 public <K, E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ?> context,
221 final ParserNamespace<K, StmtContext<?, ?, ? extends E>> namespace, final K key) {
222 return requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
227 public <K, C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresEffectiveCtx(
228 final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace, final K key) {
229 return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
234 public Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
235 final ParserNamespace<?, ?> namespace) {
236 return addMutation(new NamespaceMutation(this, contextImpl(context), namespace));
240 public <K, E extends EffectiveStatement<?, ?>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
241 final StmtContext<?, ?, ?> context, final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace,
243 return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
247 public <K, E extends EffectiveStatement<?, ?>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtxPath(
248 final StmtContext<?, ?, ?> context, final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace,
249 final Iterable<K> keys) {
250 checkNotRegistered();
252 final var ret = new PhaseModificationInNamespacePath<Mutable<?, ?, E>, K>(this, keys);
255 addBootstrap(() -> ret.hookOnto(context, namespace));
260 @SuppressWarnings("checkstyle:hiddenField")
261 public void apply(final InferenceAction action) {
262 checkState(this.action == null, "Action already defined to %s", this.action);
263 this.action = requireNonNull(action);
264 if (bootstraps != null) {
265 bootstraps.forEach(Runnable::run);
270 private void addBootstrap(final Runnable bootstrap) {
271 if (bootstraps == null) {
272 bootstraps = new ArrayList<>(1);
274 bootstraps.add(bootstrap);
277 private abstract static class AbstractPrerequisite<T> implements Prerequisite<T> {
278 final @NonNull ModifierImpl modifier;
280 private boolean done = false;
283 AbstractPrerequisite(final ModifierImpl modifier) {
284 this.modifier = requireNonNull(modifier);
288 @SuppressWarnings("checkstyle:hiddenField")
289 public final T resolve(final InferenceContext ctx) {
291 checkArgument(ctx == modifier.ctx);
292 return verifyNotNull(value, "Attempted to access unavailable prerequisite %s", this);
295 final boolean isDone() {
299 @SuppressWarnings("checkstyle:hiddenField")
300 final boolean resolvePrereq(final T value) {
303 return modifier.isApplied();
306 final <O> @NonNull Prerequisite<O> transform(final Function<? super T, O> transformation) {
307 return context -> transformation.apply(resolve(context));
311 public final String toString() {
312 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
315 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
316 return toStringHelper.add("value", value);
320 private abstract static class AbstractPathPrerequisite<C extends StmtContext<?, ?, ?>, K>
321 extends AbstractPrerequisite<C> implements OnNamespaceItemAdded {
322 private final Iterable<K> keys;
323 private final Iterator<K> it;
325 AbstractPathPrerequisite(final ModifierImpl modifier, final Iterable<K> keys) {
327 this.keys = requireNonNull(keys);
328 it = keys.iterator();
332 public final void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
333 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
334 LOG.debug("Action for {} got key {}", keys, key);
336 contextImpl(value).addPhaseCompletedListener(FULL_DECLARATION, (target, ignored) -> {
337 if (target.isSupportedByFeatures()) {
338 nextStep(context, target);
341 // Make sure target's storage notifies us when the next step becomes available.
342 hookOnto(target, namespace, it.next());
343 } else if (resolvePrereq((C) target)) {
347 LOG.debug("Key {} in {} is not supported", key, keys);
349 modifier.action.prerequisiteUnavailable(this);
356 abstract void nextStep(StatementContextBase<?, ?, ?> current, StatementContextBase<?, ?, ?> next);
359 final ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
360 return super.addToStringAttributes(toStringHelper).add("keys", keys);
363 final void hookOnto(final StmtContext<?, ?, ?> context, final ParserNamespace<?, ?> namespace) {
364 checkArgument(it.hasNext(), "Namespace %s keys may not be empty", namespace);
365 hookOnto(contextImpl(context), namespace, it.next());
368 @SuppressWarnings("unchecked")
369 private void hookOnto(final StatementContextBase<?, ?, ?> context, final ParserNamespace<?, ?> namespace,
371 context.onNamespaceItemAddedAction((ParserNamespace) namespace, requireNonNull(key), this);
375 private static final class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
376 @SuppressWarnings("unchecked")
377 PhaseMutation(final ModifierImpl modifier, final StatementContextBase<?, ?, ?> context,
378 final ModelProcessingPhase phase) {
380 context.addMutation(phase, this);
381 resolvePrereq((C) context);
385 public boolean isFinished() {
386 return modifier.isApplied();
390 private static final class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
391 implements OnPhaseFinished {
392 PhaseFinished(final ModifierImpl modifier) {
396 @SuppressWarnings("unchecked")
398 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
399 final ModelProcessingPhase finishedPhase) {
400 return resolvePrereq((C) context) || modifier.tryApply();
404 private static final class NamespaceMutation extends AbstractPrerequisite<Mutable<?, ?, ?>> {
405 NamespaceMutation(final ModifierImpl modifier, final StatementContextBase<?, ?, ?> ctx,
406 final ParserNamespace<?, ?> namespace) {
412 private static final class AddedToNamespace<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
413 implements OnNamespaceItemAdded, OnPhaseFinished {
414 private final ModelProcessingPhase phase;
416 AddedToNamespace(final ModifierImpl modifier, final ModelProcessingPhase phase) {
418 this.phase = requireNonNull(phase);
422 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
423 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
424 contextImpl(value).addPhaseCompletedListener(phase, this);
427 @SuppressWarnings("unchecked")
429 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
430 final ModelProcessingPhase finishedPhase) {
431 return resolvePrereq((C) context) || modifier.tryApply();
435 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
436 return super.addToStringAttributes(toStringHelper).add("phase", phase);
440 private static final class PhaseRequirementInNamespacePath<C extends StmtContext<?, ?, ?>, K>
441 extends AbstractPathPrerequisite<C, K> {
442 PhaseRequirementInNamespacePath(final ModifierImpl modifier, final Iterable<K> keys) {
443 super(modifier, keys);
447 void nextStep(final StatementContextBase<?, ?, ?> current, final StatementContextBase<?, ?, ?> next) {
452 private static final class PhaseModificationInNamespace<C extends Mutable<?, ?, ?>> extends AbstractPrerequisite<C>
453 implements OnNamespaceItemAdded, ContextMutation {
454 private final ModelProcessingPhase modPhase;
456 PhaseModificationInNamespace(final ModifierImpl modifier, final ModelProcessingPhase phase) {
458 checkArgument(phase != null, "Model processing phase must not be null");
459 this.modPhase = phase;
462 @SuppressWarnings("unchecked")
464 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
465 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
466 final var targetCtx = contextImpl(value);
467 targetCtx.addMutation(modPhase, this);
468 resolvePrereq((C) targetCtx);
472 public boolean isFinished() {
473 return modifier.isApplied();
478 * This similar to {@link PhaseModificationInNamespace}, but allows recursive descent until it finds the real
479 * target. The mechanics is driven as a sequence of prerequisites along a path: first we hook onto namespace to
480 * give us the first step. When it does, we hook onto the first item to provide us the second step and so on.
482 private static final class PhaseModificationInNamespacePath<C extends Mutable<?, ?, ?>, K>
483 extends AbstractPathPrerequisite<C, K> implements ContextMutation {
484 PhaseModificationInNamespacePath(final ModifierImpl modifier, final Iterable<K> keys) {
485 super(modifier, keys);
489 public boolean isFinished() {
490 return modifier.isApplied();
494 void nextStep(final StatementContextBase<?, ?, ?> current, final StatementContextBase<?, ?, ?> next) {
495 // Hook onto target: we either have a modification of the target itself or one of its children.
496 next.addMutation(EFFECTIVE_MODEL, this);
497 // We have completed the context -> target step, hence we are no longer directly blocking context from
498 // making forward progress.
499 current.removeMutation(EFFECTIVE_MODEL, this);