2 * Copyright (c) 2015 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.Function;
14 import com.google.common.base.Preconditions;
15 import java.util.HashSet;
16 import java.util.Iterator;
18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
20 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
22 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
28 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
29 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.ContextMutation;
30 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnNamespaceItemAdded;
31 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnPhaseFinished;
33 class ModifierImpl implements ModelActionBuilder {
35 private final ModelProcessingPhase phase;
36 private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>();
37 private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>();
39 private InferenceAction action;
40 private boolean actionApplied = false;
42 ModifierImpl(final ModelProcessingPhase phase) {
43 this.phase = Preconditions.checkNotNull(phase);
46 private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
47 unsatisfied.add(prereq);
51 private <T> AbstractPrerequisite<T> addMutation(final AbstractPrerequisite<T> mutation) {
52 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 Iterator<AbstractPrerequisite<?>> prereq = unsatisfied.iterator();
68 boolean allSatisfied = true;
69 while(prereq.hasNext()) {
70 if(prereq.next().isDone()) {
71 // We are removing current prerequisite from list.
80 ModelProcessingPhase getPhase() {
89 void failModifier() throws InferenceException {
91 action.prerequisiteFailed(unsatisfied);
95 private void applyAction() throws InferenceException {
96 Preconditions.checkState(!actionApplied);
101 @SuppressWarnings({ "unchecked", "rawtypes" })
102 private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,final ModelProcessingPhase phase) {
103 checkNotRegistered();
105 AddedToNamespace<C> addedToNs = new AddedToNamespace<C>(phase);
107 contextImpl(context).onNamespaceItemAddedAction((Class) namespace,key,addedToNs);
109 } catch (SourceException e) {
110 throw shouldNotHappenProbablyBug(e);
114 private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context, final ModelProcessingPhase phase) {
115 Preconditions.checkState(action == null, "Action was already registered.");
117 PhaseFinished<C> phaseFin = new PhaseFinished<C>();
119 contextImpl(context).addPhaseCompletedListener(phase,phaseFin);
121 } catch (SourceException e) {
122 throw shouldNotHappenProbablyBug(e);
126 @SuppressWarnings({ "rawtypes", "unchecked" })
127 private <K, C extends StmtContext.Mutable<?, ?, ?> , N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<C> mutatesCtxImpl(
128 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key, final ModelProcessingPhase phase) {
130 PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<C>(phase);
133 contextImpl(context).onNamespaceItemAddedAction((Class) namespace,key,mod);
135 } catch (SourceException e) {
136 throw shouldNotHappenProbablyBug(e);
140 private static StatementContextBase<?,?,?> contextImpl(final Object value) {
141 Preconditions.checkArgument(value instanceof StatementContextBase,"Supplied context was not provided by this reactor.");
142 return StatementContextBase.class.cast(value);
146 Preconditions.checkState(action != null, "Action was not defined yet.");
148 if (removeSatisfied()) {
156 public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context, final ModelProcessingPhase phase) {
158 return addMutation(new PhaseMutation<C>(contextImpl(context),phase));
159 } catch (InferenceException e) {
160 throw shouldNotHappenProbablyBug(e);
165 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) {
166 return requiresCtxImpl(context, phase);
171 public <K, N extends StatementNamespace<K, ?, ? >> Prerequisite<StmtContext<?,?,?>> requiresCtx(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key, final ModelProcessingPhase phase) {
172 return requiresCtxImpl(context, namespace, key, phase);
176 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ? extends D, ?> context) {
177 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContextUtils.<D>buildDeclared());
181 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
182 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
183 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
187 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D> requiresDeclared(
188 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
189 final AbstractPrerequisite<StmtContext<?,D,?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
190 return rawContext.transform(StmtContextUtils.<D>buildDeclared());
194 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ? extends E> stmt) {
195 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContextUtils.<E>buildEffective());
199 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
200 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
201 return requiresCtxImpl(contextImpl(context),namespace,key, EFFECTIVE_MODEL);
205 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E> requiresEffective(
206 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
207 final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
208 return rawContext.transform(StmtContextUtils.<E>buildEffective());
213 public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
214 final Class<N> namespace) {
216 return addMutation(new NamespaceMutation<N>(contextImpl(context),namespace));
217 } catch (SourceException e) {
218 throw shouldNotHappenProbablyBug(e);
223 public <T extends Mutable<?, ?, ?>> Prerequisite<T> mutatesEffectiveCtx(final T stmt) {
224 return mutatesCtx(stmt, EFFECTIVE_MODEL);
229 public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
230 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
231 return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
237 public void apply(final InferenceAction action) throws InferenceException {
238 this.action = Preconditions.checkNotNull(action);
241 private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
244 private boolean done = false;
248 Preconditions.checkState(isDone());
253 public boolean isDone() {
257 protected boolean resolvePrereq(final T value) throws InferenceException {
263 protected <O> Prerequisite<O> transform(final Function<? super T,O> transformation) {
265 return new Prerequisite<O>() {
269 return transformation.apply(AbstractPrerequisite.this.get());
273 public boolean isDone() {
274 return AbstractPrerequisite.this.isDone();
282 private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
284 @SuppressWarnings("unchecked")
285 public PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) throws InferenceException {
286 context.addMutation(phase, this);
287 resolvePrereq((C) context);
291 public boolean isFinished() {
297 private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
299 @SuppressWarnings("unchecked")
301 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) throws SourceException {
302 return resolvePrereq((C) (context));
306 private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>> {
308 public NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) throws InferenceException {
314 private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
316 private final ModelProcessingPhase phase;
318 public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(final ModelProcessingPhase phase) {
323 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
324 final Object value) throws SourceException {
325 StatementContextBase<?, ?, ?> targetContext = (StatementContextBase<?, ?, ?>) value;
326 targetContext.addPhaseCompletedListener(phase, this);
329 @SuppressWarnings("unchecked")
331 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) throws SourceException {
332 return resolvePrereq((C) context);
337 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) throws SourceException {
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) throws SourceException {
350 StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
351 targetCtx.addMutation(modPhase,this);
352 resolvePrereq((C) targetCtx);
356 public boolean isFinished() {