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 org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.EFFECTIVE_MODEL;
11 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.FULL_DECLARATION;
13 import com.google.common.base.MoreObjects;
14 import com.google.common.base.MoreObjects.ToStringHelper;
15 import com.google.common.base.Preconditions;
16 import java.util.HashSet;
17 import java.util.Iterator;
19 import java.util.function.Function;
20 import javax.annotation.Nonnull;
21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
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.StatementNamespace;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
30 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
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;
37 final class ModifierImpl implements ModelActionBuilder {
38 private static final Logger LOG = LoggerFactory.getLogger(ModifierImpl.class);
40 private final InferenceContext ctx = new InferenceContext() { };
42 private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
43 private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
45 private InferenceAction action;
46 private boolean actionApplied = false;
48 private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
49 LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
50 unsatisfied.add(prereq);
54 private <T> AbstractPrerequisite<T> addMutation(final AbstractPrerequisite<T> mutation) {
55 LOG.trace("Modifier {} adding mutation {}", this, mutation);
56 mutations.add(mutation);
60 private void checkNotRegistered() {
61 Preconditions.checkState(action == null, "Action was already registered.");
64 private static IllegalStateException shouldNotHappenProbablyBug(final SourceException e) {
65 return new IllegalStateException("Source exception during registering prerequisite. This is probably bug.", e);
68 private boolean removeSatisfied() {
69 final Iterator<AbstractPrerequisite<?>> it = unsatisfied.iterator();
70 while (it.hasNext()) {
71 final AbstractPrerequisite<?> prereq = it.next();
72 if (prereq.isDone()) {
73 // We are removing current prerequisite from list.
74 LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq);
78 return unsatisfied.isEmpty();
87 action.prerequisiteFailed(unsatisfied);
91 private void applyAction() {
92 Preconditions.checkState(!actionApplied);
97 @SuppressWarnings({ "unchecked", "rawtypes" })
98 private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
99 requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
100 final ModelProcessingPhase phase) {
101 checkNotRegistered();
104 AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
106 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, addedToNs);
108 } catch (SourceException e) {
109 throw shouldNotHappenProbablyBug(e);
113 private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context,
114 final ModelProcessingPhase phase) {
115 checkNotRegistered();
118 PhaseFinished<C> phaseFin = new PhaseFinished<>();
120 contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
122 } catch (SourceException e) {
123 throw shouldNotHappenProbablyBug(e);
127 @SuppressWarnings({ "rawtypes", "unchecked" })
128 private <K, C extends StmtContext.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();
134 PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(phase);
137 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
139 } catch (SourceException e) {
140 throw shouldNotHappenProbablyBug(e);
144 private static StatementContextBase<?,?,?> contextImpl(final Object value) {
145 Preconditions.checkArgument(value instanceof StatementContextBase,"Supplied context was not provided by this reactor.");
146 return StatementContextBase.class.cast(value);
150 Preconditions.checkState(action != null, "Action was not defined yet.");
152 if (removeSatisfied()) {
161 public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context, final ModelProcessingPhase phase) {
163 return addMutation(new PhaseMutation<>(contextImpl(context), phase));
164 } catch (InferenceException e) {
165 throw shouldNotHappenProbablyBug(e);
171 public <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>> AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context, final ModelProcessingPhase phase) {
172 return requiresCtxImpl(context, phase);
178 public <K, N extends StatementNamespace<K, ?, ? >> Prerequisite<StmtContext<?,?,?>> requiresCtx(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key, final ModelProcessingPhase phase) {
179 return requiresCtxImpl(context, namespace, key, phase);
184 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ? extends D, ?> context) {
185 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
190 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
191 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
192 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
197 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D> requiresDeclared(
198 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
199 final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
200 return rawContext.transform(StmtContext::buildDeclared);
205 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ? extends E> stmt) {
206 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
211 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
212 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
213 return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
218 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E> requiresEffective(
219 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
220 final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
221 return rawContext.transform(StmtContext::buildEffective);
227 public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
228 final Class<N> namespace) {
230 return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
231 } catch (SourceException e) {
232 throw shouldNotHappenProbablyBug(e);
238 public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
239 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
240 return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
244 public void apply(final InferenceAction action) {
245 Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
246 this.action = Preconditions.checkNotNull(action);
249 private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
251 private boolean done = false;
255 public final T resolve(final InferenceContext ctx) {
256 Preconditions.checkState(done);
257 Preconditions.checkArgument(ctx == ModifierImpl.this.ctx);
261 final boolean isDone() {
265 final boolean resolvePrereq(final T value) {
271 final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
272 return ctx -> transformation.apply(resolve(ctx));
276 public final String toString() {
277 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
280 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
281 return toStringHelper.add("value", value);
285 private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
286 @SuppressWarnings("unchecked")
287 public PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
288 context.addMutation(phase, this);
289 resolvePrereq((C) context);
293 public boolean isFinished() {
298 private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
299 @SuppressWarnings("unchecked")
301 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
302 return resolvePrereq((C) context);
306 private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>> {
307 public NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
312 private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
313 private final ModelProcessingPhase phase;
315 public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(final ModelProcessingPhase phase) {
320 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
321 final Object value) {
322 StatementContextBase<?, ?, ?> targetContext = (StatementContextBase<?, ?, ?>) value;
323 targetContext.addPhaseCompletedListener(phase, this);
326 @SuppressWarnings("unchecked")
328 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
329 return resolvePrereq((C) context);
333 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
334 return super.addToStringAttributes(toStringHelper).add("phase", phase);
338 private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded, ContextMutation {
339 private final ModelProcessingPhase modPhase;
341 public <K, N extends StatementNamespace<K, ?, ?>> PhaseModificationInNamespace(final ModelProcessingPhase phase) {
342 Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
343 this.modPhase = phase;
346 @SuppressWarnings("unchecked")
348 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
349 final Object value) {
350 StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
351 targetCtx.addMutation(modPhase, this);
352 resolvePrereq((C) targetCtx);
356 public boolean isFinished() {