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 Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
41 private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
43 private InferenceAction action;
44 private boolean actionApplied = false;
46 private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
47 LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
48 unsatisfied.add(prereq);
52 private <T> AbstractPrerequisite<T> addMutation(final AbstractPrerequisite<T> mutation) {
53 LOG.trace("Modifier {} adding mutation {}", this, mutation);
54 mutations.add(mutation);
58 private void checkNotRegistered() {
59 Preconditions.checkState(action == null, "Action was already registered.");
62 private static IllegalStateException shouldNotHappenProbablyBug(final SourceException e) {
63 return new IllegalStateException("Source exception during registering prerequisite. This is probably bug.", e);
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 Preconditions.checkState(!actionApplied);
95 @SuppressWarnings({ "unchecked", "rawtypes" })
96 private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
97 requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
98 final ModelProcessingPhase phase) {
102 AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
104 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, addedToNs);
106 } catch (SourceException e) {
107 throw shouldNotHappenProbablyBug(e);
111 private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context,
112 final ModelProcessingPhase phase) {
113 checkNotRegistered();
116 PhaseFinished<C> phaseFin = new PhaseFinished<>();
118 contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
120 } catch (SourceException e) {
121 throw shouldNotHappenProbablyBug(e);
125 @SuppressWarnings({ "rawtypes", "unchecked" })
126 private <K, C extends StmtContext.Mutable<?, ?, ?> , N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
127 AbstractPrerequisite<C> mutatesCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace,
128 final K key, final ModelProcessingPhase phase) {
129 checkNotRegistered();
132 PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(phase);
135 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
137 } catch (SourceException e) {
138 throw shouldNotHappenProbablyBug(e);
142 private static StatementContextBase<?,?,?> contextImpl(final Object value) {
143 Preconditions.checkArgument(value instanceof StatementContextBase,"Supplied context was not provided by this reactor.");
144 return StatementContextBase.class.cast(value);
148 Preconditions.checkState(action != null, "Action was not defined yet.");
150 if (removeSatisfied()) {
159 public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context, final ModelProcessingPhase phase) {
161 return addMutation(new PhaseMutation<>(contextImpl(context), phase));
162 } catch (InferenceException e) {
163 throw shouldNotHappenProbablyBug(e);
169 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) {
170 return requiresCtxImpl(context, phase);
176 public <K, N extends StatementNamespace<K, ?, ? >> Prerequisite<StmtContext<?,?,?>> requiresCtx(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key, final ModelProcessingPhase phase) {
177 return requiresCtxImpl(context, namespace, key, phase);
182 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ? extends D, ?> context) {
183 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
188 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
189 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
190 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
195 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D> requiresDeclared(
196 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
197 final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
198 return rawContext.transform(StmtContext::buildDeclared);
203 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ? extends E> stmt) {
204 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
209 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
210 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
211 return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
216 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E> requiresEffective(
217 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
218 final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
219 return rawContext.transform(StmtContext::buildEffective);
225 public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
226 final Class<N> namespace) {
228 return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
229 } catch (SourceException e) {
230 throw shouldNotHappenProbablyBug(e);
236 public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
237 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
238 return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
242 public void apply(final InferenceAction action) {
243 Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
244 this.action = Preconditions.checkNotNull(action);
247 private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
249 private boolean done = false;
253 public final T get() {
254 Preconditions.checkState(isDone());
258 final boolean isDone() {
262 final boolean resolvePrereq(final T value) {
268 final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
269 return () -> transformation.apply(get());
273 public final String toString() {
274 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
277 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
278 return toStringHelper.add("value", value);
282 private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
283 @SuppressWarnings("unchecked")
284 public PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
285 context.addMutation(phase, this);
286 resolvePrereq((C) context);
290 public boolean isFinished() {
295 private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
296 @SuppressWarnings("unchecked")
298 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
299 return resolvePrereq((C) context);
303 private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>> {
304 public NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
309 private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
310 private final ModelProcessingPhase phase;
312 public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(final ModelProcessingPhase phase) {
317 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
318 final Object value) {
319 StatementContextBase<?, ?, ?> targetContext = (StatementContextBase<?, ?, ?>) value;
320 targetContext.addPhaseCompletedListener(phase, this);
323 @SuppressWarnings("unchecked")
325 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
326 return resolvePrereq((C) context);
330 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
331 return super.addToStringAttributes(toStringHelper).add("phase", phase);
335 private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded, ContextMutation {
336 private final ModelProcessingPhase modPhase;
338 public <K, N extends StatementNamespace<K, ?, ?>> PhaseModificationInNamespace(final ModelProcessingPhase phase) {
339 Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
340 this.modPhase = phase;
343 @SuppressWarnings("unchecked")
345 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
346 final Object value) {
347 StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
348 targetCtx.addMutation(modPhase, this);
349 resolvePrereq((C) targetCtx);
353 public boolean isFinished() {