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 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();
131 PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(phase);
134 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
138 private static StatementContextBase<?, ?, ?> contextImpl(final Object value) {
139 Preconditions.checkArgument(value instanceof StatementContextBase,
140 "Supplied context %s is not provided by this reactor.", value);
141 return StatementContextBase.class.cast(value);
145 Preconditions.checkState(action != null, "Action was not defined yet.");
147 if (removeSatisfied()) {
156 public <C extends Mutable<?, ?, ?>, T extends C> Prerequisite<C> mutatesCtx(final T context,
157 final ModelProcessingPhase phase) {
158 return addMutation(new PhaseMutation<>(contextImpl(context), phase));
163 public <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>>
164 AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context,
165 final ModelProcessingPhase phase) {
166 return requiresCtxImpl(context, phase);
172 public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
173 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
174 final ModelProcessingPhase phase) {
175 return requiresCtxImpl(context, namespace, key, phase);
180 public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
181 final StmtContext<?, ?, ?> context, final Class<N> namespace, final NamespaceKeyCriterion<K> criterion,
182 final ModelProcessingPhase phase) {
183 return requiresCtxImpl(context, namespace, criterion, phase);
188 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
189 final StmtContext<?, ? extends D, ?> context) {
190 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
195 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D>
196 requiresDeclared(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
197 final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key,
199 return rawContext.transform(StmtContext::buildDeclared);
204 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>>
205 AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(final StmtContext<?, ?, ?> context,
206 final Class<N> namespace, final K key) {
207 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
212 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
213 final StmtContext<?, ?, ? extends E> stmt) {
214 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
219 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E>
220 requiresEffective(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
221 final AbstractPrerequisite<StmtContext<?, ?, E>> rawContext = requiresCtxImpl(context, namespace, key,
223 return rawContext.transform(StmtContext::buildEffective);
228 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>>
229 AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(final StmtContext<?, ?, ?> context,
230 final Class<N> namespace, final K key) {
231 return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
236 public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(
237 final Mutable<?, ?, ?> context, final Class<N> namespace) {
238 return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
243 public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
244 AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(final StmtContext<?, ?, ?> context,
245 final Class<N> namespace, final K key) {
246 return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
250 @SuppressWarnings("checkstyle:hiddenField")
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 @SuppressWarnings("checkstyle:hiddenField")
262 public final T resolve(final InferenceContext ctx) {
263 Preconditions.checkState(done);
264 Preconditions.checkArgument(ctx == ModifierImpl.this.ctx);
268 final boolean isDone() {
272 @SuppressWarnings("checkstyle:hiddenField")
273 final boolean resolvePrereq(final T value) {
279 final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
280 return context -> transformation.apply(resolve(context));
284 public final String toString() {
285 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
288 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
289 return toStringHelper.add("value", value);
293 private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
294 @SuppressWarnings("unchecked")
295 PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
296 context.addMutation(phase, this);
297 resolvePrereq((C) context);
301 public boolean isFinished() {
306 private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
307 implements OnPhaseFinished {
308 @SuppressWarnings("unchecked")
310 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
311 final ModelProcessingPhase finishedPhase) {
312 return resolvePrereq((C) context);
316 private class NamespaceMutation<N extends IdentifierNamespace<?, ?>>
317 extends AbstractPrerequisite<Mutable<?, ?, ?>> {
318 NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
323 private class AddedToNamespace<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
324 implements OnNamespaceItemAdded, OnPhaseFinished {
325 private final ModelProcessingPhase phase;
327 AddedToNamespace(final ModelProcessingPhase phase) {
328 this.phase = requireNonNull(phase);
332 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
333 final Object key, final Object value) {
334 ((StatementContextBase<?, ?, ?>) value).addPhaseCompletedListener(phase, this);
337 @SuppressWarnings("unchecked")
339 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
340 final ModelProcessingPhase finishedPhase) {
341 return resolvePrereq((C) context);
345 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
346 return super.addToStringAttributes(toStringHelper).add("phase", phase);
350 private class PhaseModificationInNamespace<C extends Mutable<?, ?, ?>> extends AbstractPrerequisite<C>
351 implements OnNamespaceItemAdded, ContextMutation {
352 private final ModelProcessingPhase modPhase;
354 PhaseModificationInNamespace(final ModelProcessingPhase phase) {
355 Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
356 this.modPhase = phase;
359 @SuppressWarnings("unchecked")
361 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
362 final Object key, final Object value) {
363 StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
364 targetCtx.addMutation(modPhase, this);
365 resolvePrereq((C) targetCtx);
369 public boolean isFinished() {