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.HashSet;
20 import java.util.Iterator;
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;
39 final class ModifierImpl implements ModelActionBuilder {
40 private static final Logger LOG = LoggerFactory.getLogger(ModifierImpl.class);
42 private final InferenceContext ctx = new InferenceContext() { };
44 private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
45 private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
47 private InferenceAction action;
48 private boolean actionApplied = false;
50 private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
51 LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
52 unsatisfied.add(prereq);
56 private <T> @NonNull AbstractPrerequisite<T> addMutation(final @NonNull AbstractPrerequisite<T> mutation) {
57 LOG.trace("Modifier {} adding mutation {}", this, mutation);
58 mutations.add(mutation);
62 private void checkNotRegistered() {
63 checkState(action == null, "Action was already registered.");
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);
76 return unsatisfied.isEmpty();
85 action.prerequisiteFailed(unsatisfied);
89 private void applyAction() {
90 checkState(!actionApplied);
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) {
100 AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
102 contextImpl(context).onNamespaceItemAddedAction(namespace, key, addedToNs);
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();
111 AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
113 contextImpl(context).onNamespaceItemAddedAction(namespace, phase, criterion, addedToNs);
117 private <C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(final C context,
118 final ModelProcessingPhase phase) {
119 checkNotRegistered();
121 PhaseFinished<C> phaseFin = new PhaseFinished<>();
123 contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
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();
133 final PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(EFFECTIVE_MODEL);
136 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
140 private static StatementContextBase<?, ?, ?> contextImpl(final Object value) {
141 checkArgument(value instanceof StatementContextBase, "Supplied context %s is not provided by this reactor.",
143 return StatementContextBase.class.cast(value);
147 checkState(action != null, "Action was not defined yet.");
149 if (removeSatisfied()) {
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));
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);
171 public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
172 final StmtContext<?, ?, ?> context, final Class<@NonNull N> namespace, final K key,
173 final ModelProcessingPhase phase) {
174 return requiresCtxImpl(context, namespace, key, phase);
178 public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
179 final StmtContext<?, ?, ?> context, final Class<@NonNull N> namespace,
180 final NamespaceKeyCriterion<K> criterion, final ModelProcessingPhase phase) {
181 return requiresCtxImpl(context, namespace, criterion, phase);
185 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
186 final StmtContext<?, ? extends D, ?> context) {
187 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
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,
195 return rawContext.transform(StmtContext::buildDeclared);
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);
206 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
207 final StmtContext<?, ?, ? extends E> stmt) {
208 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
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,
216 return rawContext.transform(StmtContext::buildEffective);
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);
227 public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(
228 final Mutable<?, ?, ?> context, final Class<N> namespace) {
229 return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
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);
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();
245 final PhaseModificationInNamespacePath<Mutable<?, ?, E>, K, N> ret = new PhaseModificationInNamespacePath<>(
246 EFFECTIVE_MODEL, keys);
250 ret.hookOnto(context, namespace);
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);
261 private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
262 private boolean done = false;
266 @SuppressWarnings("checkstyle:hiddenField")
267 public final T resolve(final InferenceContext ctx) {
269 checkArgument(ctx == ModifierImpl.this.ctx);
270 return verifyNotNull(value, "Attempted to access unavailable prerequisite %s", this);
273 final boolean isDone() {
277 @SuppressWarnings("checkstyle:hiddenField")
278 final boolean resolvePrereq(final T value) {
284 final <O> @NonNull Prerequisite<O> transform(final Function<? super T, O> transformation) {
285 return context -> transformation.apply(resolve(context));
289 public final String toString() {
290 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
293 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
294 return toStringHelper.add("value", value);
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);
306 public boolean isFinished() {
311 private final class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
312 implements OnPhaseFinished {
313 @SuppressWarnings("unchecked")
315 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
316 final ModelProcessingPhase finishedPhase) {
317 return resolvePrereq((C) context);
321 private final class NamespaceMutation<N extends IdentifierNamespace<?, ?>>
322 extends AbstractPrerequisite<Mutable<?, ?, ?>> {
323 NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
328 private final class AddedToNamespace<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
329 implements OnNamespaceItemAdded, OnPhaseFinished {
330 private final ModelProcessingPhase phase;
332 AddedToNamespace(final ModelProcessingPhase phase) {
333 this.phase = requireNonNull(phase);
337 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
338 final Object key, final Object value) {
339 ((StatementContextBase<?, ?, ?>) value).addPhaseCompletedListener(phase, this);
342 @SuppressWarnings("unchecked")
344 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
345 final ModelProcessingPhase finishedPhase) {
346 return resolvePrereq((C) context);
350 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
351 return super.addToStringAttributes(toStringHelper).add("phase", phase);
355 private final class PhaseModificationInNamespace<C extends Mutable<?, ?, ?>> extends AbstractPrerequisite<C>
356 implements OnNamespaceItemAdded, ContextMutation {
357 private final ModelProcessingPhase modPhase;
359 PhaseModificationInNamespace(final ModelProcessingPhase phase) {
360 checkArgument(phase != null, "Model processing phase must not be null");
361 this.modPhase = phase;
364 @SuppressWarnings("unchecked")
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);
374 public boolean isFinished() {
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;
386 PhaseModificationInNamespacePath(final ModelProcessingPhase phase, final Iterable<K> keys) {
387 this.modPhase = requireNonNull(phase);
388 this.keys = requireNonNull(keys);
389 it = keys.iterator();
393 public boolean isFinished() {
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);
402 final StatementContextBase<?, ?, ?> target = contextImpl(value);
403 if (!target.isSupportedByFeatures()) {
404 LOG.debug("Key {} in {} is not supported", key, keys);
406 action.prerequisiteUnavailable(this);
411 target.addMutation(modPhase, this);
412 resolvePrereq((C) value);
416 hookOnto(target, namespace, it.next());
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());
424 @SuppressWarnings("unchecked")
425 private void hookOnto(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final K key) {
426 context.onNamespaceItemAddedAction((Class) namespace, requireNonNull(key), this);