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 java.util.Objects.requireNonNull;
11 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.EFFECTIVE_MODEL;
12 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.FULL_DECLARATION;
14 import com.google.common.base.MoreObjects;
15 import com.google.common.base.MoreObjects.ToStringHelper;
16 import com.google.common.base.Preconditions;
17 import java.util.HashSet;
18 import java.util.Iterator;
20 import java.util.function.Function;
21 import javax.annotation.Nonnull;
22 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
23 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
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.NamespaceKeyCriterion;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
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 boolean removeSatisfied() {
65 final Iterator<AbstractPrerequisite<?>> it = unsatisfied.iterator();
66 while (it.hasNext()) {
67 final AbstractPrerequisite<?> prereq = it.next();
68 if (prereq.isDone()) {
69 // We are removing current prerequisite from list.
70 LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq);
74 return unsatisfied.isEmpty();
83 action.prerequisiteFailed(unsatisfied);
87 private void applyAction() {
88 Preconditions.checkState(!actionApplied);
93 private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
94 requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
95 final ModelProcessingPhase phase) {
98 AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
100 contextImpl(context).onNamespaceItemAddedAction(namespace, key, addedToNs);
104 private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
105 requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace,
106 final NamespaceKeyCriterion<K> criterion, final ModelProcessingPhase phase) {
107 checkNotRegistered();
109 AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
111 contextImpl(context).onNamespaceItemAddedAction(namespace, phase, criterion, addedToNs);
115 private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context,
116 final ModelProcessingPhase phase) {
117 checkNotRegistered();
119 PhaseFinished<C> phaseFin = new PhaseFinished<>();
121 contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
125 @SuppressWarnings({ "rawtypes", "unchecked" })
126 private <K, C extends StmtContext.Mutable<?, ?, ?>,
127 N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<C> mutatesCtxImpl(
128 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
129 final ModelProcessingPhase phase) {
130 checkNotRegistered();
132 PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(phase);
135 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
139 private static StatementContextBase<?,?,?> contextImpl(final Object value) {
140 Preconditions.checkArgument(value instanceof StatementContextBase,
141 "Supplied context %s is not provided by this reactor.", value);
142 return StatementContextBase.class.cast(value);
146 Preconditions.checkState(action != null, "Action was not defined yet.");
148 if (removeSatisfied()) {
157 public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context,
158 final ModelProcessingPhase phase) {
159 return addMutation(new PhaseMutation<>(contextImpl(context), phase));
164 public <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>>
165 AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context,
166 final ModelProcessingPhase phase) {
167 return requiresCtxImpl(context, phase);
173 public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
174 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
175 final ModelProcessingPhase phase) {
176 return requiresCtxImpl(context, namespace, key, phase);
181 public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
182 final StmtContext<?, ?, ?> context, final Class<N> namespace, final NamespaceKeyCriterion<K> criterion,
183 final ModelProcessingPhase phase) {
184 return requiresCtxImpl(context, namespace, criterion, phase);
189 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
190 final StmtContext<?, ? extends D, ?> context) {
191 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
196 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D>
197 requiresDeclared(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
198 final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key,
200 return rawContext.transform(StmtContext::buildDeclared);
205 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>>
206 AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(final StmtContext<?, ?, ?> context,
207 final Class<N> namespace, final K key) {
208 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
213 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
214 final StmtContext<?, ?, ? extends E> stmt) {
215 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
220 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E>
221 requiresEffective(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
222 final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key,
224 return rawContext.transform(StmtContext::buildEffective);
229 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>>
230 AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(final StmtContext<?, ?, ?> context,
231 final Class<N> namespace, final K key) {
232 return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
237 public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(
238 final Mutable<?, ?, ?> context, final Class<N> namespace) {
239 return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
244 public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
245 AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(final StmtContext<?, ?, ?> context,
246 final Class<N> namespace, final K key) {
247 return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
251 public void apply(final InferenceAction action) {
252 Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
253 this.action = Preconditions.checkNotNull(action);
256 private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
257 private boolean done = false;
261 public final T resolve(final InferenceContext ctx) {
262 Preconditions.checkState(done);
263 Preconditions.checkArgument(ctx == ModifierImpl.this.ctx);
267 final boolean isDone() {
271 final boolean resolvePrereq(final T value) {
277 final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
278 return ctx -> transformation.apply(resolve(ctx));
282 public final String toString() {
283 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
286 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
287 return toStringHelper.add("value", value);
291 private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
292 @SuppressWarnings("unchecked")
293 PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
294 context.addMutation(phase, this);
295 resolvePrereq((C) context);
299 public boolean isFinished() {
304 private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
305 implements OnPhaseFinished {
306 @SuppressWarnings("unchecked")
308 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
309 return resolvePrereq((C) context);
313 private class NamespaceMutation<N extends IdentifierNamespace<?,?>>
314 extends AbstractPrerequisite<Mutable<?, ?, ?>> {
315 NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
320 private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C>
321 implements OnNamespaceItemAdded, OnPhaseFinished {
322 private final ModelProcessingPhase phase;
324 AddedToNamespace(final ModelProcessingPhase phase) {
325 this.phase = requireNonNull(phase);
329 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
330 final Object key, final Object value) {
331 ((StatementContextBase<?, ?, ?>) value).addPhaseCompletedListener(phase, this);
334 @SuppressWarnings("unchecked")
336 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
337 return resolvePrereq((C) context);
341 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
342 return super.addToStringAttributes(toStringHelper).add("phase", phase);
346 private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C>
347 implements OnNamespaceItemAdded, ContextMutation {
348 private final ModelProcessingPhase modPhase;
350 PhaseModificationInNamespace(final ModelProcessingPhase phase) {
351 Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
352 this.modPhase = phase;
355 @SuppressWarnings("unchecked")
357 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
358 final Object key, final Object value) {
359 StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
360 targetCtx.addMutation(modPhase, this);
361 resolvePrereq((C) targetCtx);
365 public boolean isFinished() {