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(ModelProcessingPhase phase) {
43 this.phase = Preconditions.checkNotNull(phase);
46 private <D> AbstractPrerequisite<D> addReq(AbstractPrerequisite<D> prereq) {
47 unsatisfied.add(prereq);
51 private <T> AbstractPrerequisite<T> addMutation(AbstractPrerequisite<T> mutation) {
52 mutations.add(mutation);
58 private void checkNotRegistered() {
59 Preconditions.checkState(action == null, "Action was already registered.");
62 private IllegalStateException shouldNotHappenProbablyBug(SourceException e) {
63 return new IllegalStateException("Source exception during registering prerequisite. This is probably bug.",e);
66 private void tryToResolve() throws InferenceException {
67 if(action == null || isApplied()) {
68 // Action was not yet defined
71 if(removeSatisfied()) {
76 private boolean removeSatisfied() {
77 Iterator<AbstractPrerequisite<?>> prereq = unsatisfied.iterator();
78 boolean allSatisfied = true;
79 while(prereq.hasNext()) {
80 if(prereq.next().isDone()) {
81 // We are removing current prerequisite from list.
90 ModelProcessingPhase getPhase() {
99 void failModifier() throws InferenceException {
101 action.prerequisiteFailed(unsatisfied);
105 private void applyAction() throws InferenceException {
109 } catch (InferenceException e) {
110 actionApplied = false;
113 // Mark all mutations as performed, so context node could move to next.
114 actionApplied = true;
117 @SuppressWarnings({ "unchecked", "rawtypes" })
118 private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(StmtContext<?, ?, ?> context, Class<N> namespace, K key,ModelProcessingPhase phase) {
119 checkNotRegistered();
121 AddedToNamespace<C> addedToNs = new AddedToNamespace<C>(phase);
123 contextImpl(context).onNamespaceItemAddedAction((Class) namespace,key,addedToNs);
125 } catch (SourceException e) {
126 throw shouldNotHappenProbablyBug(e);
130 private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(C context, ModelProcessingPhase phase) {
131 Preconditions.checkState(action == null, "Action was already registered.");
133 PhaseFinished<C> phaseFin = new PhaseFinished<C>();
135 contextImpl(context).addPhaseCompletedListener(phase,phaseFin);
137 } catch (SourceException e) {
138 throw shouldNotHappenProbablyBug(e);
142 @SuppressWarnings({ "rawtypes", "unchecked" })
143 private <K, C extends StmtContext.Mutable<?, ?, ?> , N extends StatementNamespace<K, ?, ? >> AbstractPrerequisite<C> mutatesCtxImpl(
144 StmtContext<?, ?, ?> context, Class<N> namespace, K key, ModelProcessingPhase phase) {
146 PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<C>(phase);
148 contextImpl(context).onNamespaceItemAddedAction((Class) namespace,key,mod);
150 } catch (SourceException e) {
151 throw shouldNotHappenProbablyBug(e);
155 private static StatementContextBase<?,?,?> contextImpl(StmtContext<?,?,?> context) {
156 Preconditions.checkArgument(context instanceof StatementContextBase,"Supplied context was not provided by this reactor.");
157 return StatementContextBase.class.cast(context);
161 public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(CT context, ModelProcessingPhase phase) {
163 return addMutation(new PhaseMutation<C>(contextImpl(context),phase));
164 } catch (InferenceException e) {
165 throw shouldNotHappenProbablyBug(e);
170 public <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>> AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(StmtContext<A, D, E> context, ModelProcessingPhase phase) {
171 return requiresCtxImpl(context, phase);
176 public <K, N extends StatementNamespace<K, ?, ? >> Prerequisite<StmtContext<?,?,?>> requiresCtx(StmtContext<?, ?, ?> context, Class<N> namespace, K key, ModelProcessingPhase phase) {
177 return requiresCtxImpl(context, namespace, key, phase);
181 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(StmtContext<?, ? extends D, ?> context) {
182 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContextUtils.<D>buildDeclared());
186 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
187 StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
188 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
192 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D> requiresDeclared(
193 StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
194 final AbstractPrerequisite<StmtContext<?,D,?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
195 return rawContext.transform(StmtContextUtils.<D>buildDeclared());
199 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(StmtContext<?, ?, ? extends E> stmt) {
200 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContextUtils.<E>buildEffective());
204 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
205 StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
206 return requiresCtxImpl(contextImpl(context),namespace,key, EFFECTIVE_MODEL);
210 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E> requiresEffective(
211 StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
212 final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
213 return rawContext.transform(StmtContextUtils.<E>buildEffective());
218 public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(Mutable<?, ?, ?> context,
219 Class<N> namespace) {
221 return addMutation(new NamespaceMutation<N>(contextImpl(context),namespace));
222 } catch (SourceException e) {
223 throw shouldNotHappenProbablyBug(e);
228 public <T extends Mutable<?, ?, ?>> Prerequisite<T> mutatesEffectiveCtx(T stmt) {
229 return mutatesCtx(stmt, EFFECTIVE_MODEL);
234 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
235 StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
236 return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
242 public void apply(InferenceAction action) throws InferenceException {
243 this.action = Preconditions.checkNotNull(action);
247 private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
250 private boolean done = false;
254 Preconditions.checkState(isDone());
259 public boolean isDone() {
263 protected boolean resolvePrereq(T value) throws InferenceException {
270 protected <O> Prerequisite<O> transform(final Function<? super T,O> transformation) {
272 return new Prerequisite<O>() {
276 return transformation.apply(AbstractPrerequisite.this.get());
280 public boolean isDone() {
281 return AbstractPrerequisite.this.isDone();
289 private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
291 @SuppressWarnings("unchecked")
292 public PhaseMutation(StatementContextBase<?, ?, ?> context, ModelProcessingPhase phase) throws InferenceException {
293 context.addMutation(phase, this);
294 resolvePrereq((C) context);
298 public boolean isFinished() {
304 private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
306 @SuppressWarnings("unchecked")
308 public boolean phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase phase) throws SourceException {
309 return resolvePrereq((C) (context));
313 private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>> {
315 public NamespaceMutation(StatementContextBase<?, ?, ?> ctx, Class<N> namespace) throws InferenceException {
321 private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
323 private final ModelProcessingPhase phase;
325 public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(ModelProcessingPhase phase) {
330 public void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key,
331 Object value) throws SourceException {
332 StatementContextBase<?, ?, ?> targetContext = (StatementContextBase<?, ?, ?>) value;
333 targetContext.addPhaseCompletedListener(phase, this);
336 @SuppressWarnings("unchecked")
338 public boolean phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase phase) throws SourceException {
339 return resolvePrereq((C) context);
344 private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded, ContextMutation {
346 private final ModelProcessingPhase modPhase;
348 public <K, N extends StatementNamespace<K, ?, ?>> PhaseModificationInNamespace(ModelProcessingPhase phase) throws SourceException {
349 Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
350 this.modPhase = phase;
353 @SuppressWarnings("unchecked")
355 public void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key,
356 Object value) throws SourceException {
357 context.addMutation(modPhase,this);
358 resolvePrereq((C) context);
362 public boolean isFinished() {