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 = createModification(phase);
132 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
136 private static StatementContextBase<?, ?, ?> contextImpl(final Object value) {
137 Preconditions.checkArgument(value instanceof StatementContextBase,
138 "Supplied context %s is not provided by this reactor.", value);
139 return StatementContextBase.class.cast(value);
143 Preconditions.checkState(action != null, "Action was not defined yet.");
145 if (removeSatisfied()) {
154 public <C extends Mutable<?, ?, ?>, T extends C> Prerequisite<C> mutatesCtx(final T context,
155 final ModelProcessingPhase phase) {
156 return addMutation(new PhaseMutation<>(contextImpl(context), phase));
161 public <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>>
162 AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context,
163 final ModelProcessingPhase phase) {
164 return requiresCtxImpl(context, phase);
170 public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
171 final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
172 final ModelProcessingPhase phase) {
173 return requiresCtxImpl(context, namespace, key, phase);
178 public <K, N extends StatementNamespace<K, ?, ?>> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(
179 final StmtContext<?, ?, ?> context, final Class<N> namespace, final NamespaceKeyCriterion<K> criterion,
180 final ModelProcessingPhase phase) {
181 return requiresCtxImpl(context, namespace, criterion, phase);
186 public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
187 final StmtContext<?, ? extends D, ?> context) {
188 return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
193 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D>
194 requiresDeclared(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
195 final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key,
197 return rawContext.transform(StmtContext::buildDeclared);
202 public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>>
203 AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(final StmtContext<?, ?, ?> context,
204 final Class<N> namespace, final K key) {
205 return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
210 public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
211 final StmtContext<?, ?, ? extends E> stmt) {
212 return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
217 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E>
218 requiresEffective(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
219 final AbstractPrerequisite<StmtContext<?, ?, E>> rawContext = requiresCtxImpl(context, namespace, key,
221 return rawContext.transform(StmtContext::buildEffective);
226 public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>>
227 AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(final StmtContext<?, ?, ?> context,
228 final Class<N> namespace, final K key) {
229 return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
234 public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(
235 final Mutable<?, ?, ?> context, final Class<N> namespace) {
236 return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
241 public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
242 AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(final StmtContext<?, ?, ?> context,
243 final Class<N> namespace, final K key) {
244 return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
249 @SuppressWarnings({ "rawtypes", "unchecked" })
250 public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
251 AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtxPath(final StmtContext<?, ?, ?> context,
252 final Class<N> namespace, final Iterable<K> keys) {
253 final Iterator<K> it = keys.iterator();
254 Preconditions.checkArgument(it.hasNext(), "Namespace %s keys may not be empty", namespace);
255 checkNotRegistered();
257 final PhaseModificationInNamespace<Mutable<?, ?, E>> ret = createModification(EFFECTIVE_MODEL);
258 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, it.next(),
259 (parent, ns, foundKey, foundValue) -> {
260 checkResult((Mutable<?, ?, E>)foundValue, namespace, it, ret);
265 @SuppressWarnings({ "rawtypes", "unchecked" })
266 private <K, C extends Mutable<?, ?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
267 void mutateNextKey(final StmtContext<?, ?, ?> context, final Class<N> namespace,
268 final Iterator<K> it, final AbstractPrerequisite<C> result) {
269 final PhaseModificationInNamespace<C> mod = createModification(EFFECTIVE_MODEL);
270 contextImpl(context).onNamespaceItemAddedAction((Class) namespace, it.next(),
271 (parent, ns, foundKey, foundValue) -> {
272 checkResult((C) foundValue, namespace, it, result);
273 mod.resolvePrereq((C) foundValue);
277 private <C extends Mutable<?, ?, ?>> PhaseModificationInNamespace<C> createModification(
278 final ModelProcessingPhase phase) {
279 final PhaseModificationInNamespace<C> ret = new PhaseModificationInNamespace<>(EFFECTIVE_MODEL);
285 private <K, C extends Mutable<?, ?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
286 void checkResult(final C context, final Class<N> namespace, final Iterator<K> it,
287 final AbstractPrerequisite<C> result) {
289 mutateNextKey(context, namespace, it, result);
291 result.resolvePrereq(context);
296 @SuppressWarnings("checkstyle:hiddenField")
297 public void apply(final InferenceAction action) {
298 Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
299 this.action = Preconditions.checkNotNull(action);
302 private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
303 private boolean done = false;
307 @SuppressWarnings("checkstyle:hiddenField")
308 public final T resolve(final InferenceContext ctx) {
309 Preconditions.checkState(done);
310 Preconditions.checkArgument(ctx == ModifierImpl.this.ctx);
314 final boolean isDone() {
318 @SuppressWarnings("checkstyle:hiddenField")
319 final boolean resolvePrereq(final T value) {
325 final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
326 return context -> transformation.apply(resolve(context));
330 public final String toString() {
331 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
334 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
335 return toStringHelper.add("value", value);
339 private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
340 @SuppressWarnings("unchecked")
341 PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
342 context.addMutation(phase, this);
343 resolvePrereq((C) context);
347 public boolean isFinished() {
352 private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
353 implements OnPhaseFinished {
354 @SuppressWarnings("unchecked")
356 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
357 final ModelProcessingPhase finishedPhase) {
358 return resolvePrereq((C) context);
362 private class NamespaceMutation<N extends IdentifierNamespace<?, ?>>
363 extends AbstractPrerequisite<Mutable<?, ?, ?>> {
364 NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
369 private class AddedToNamespace<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
370 implements OnNamespaceItemAdded, OnPhaseFinished {
371 private final ModelProcessingPhase phase;
373 AddedToNamespace(final ModelProcessingPhase phase) {
374 this.phase = requireNonNull(phase);
378 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
379 final Object key, final Object value) {
380 ((StatementContextBase<?, ?, ?>) value).addPhaseCompletedListener(phase, this);
383 @SuppressWarnings("unchecked")
385 public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
386 final ModelProcessingPhase finishedPhase) {
387 return resolvePrereq((C) context);
391 ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
392 return super.addToStringAttributes(toStringHelper).add("phase", phase);
396 private class PhaseModificationInNamespace<C extends Mutable<?, ?, ?>> extends AbstractPrerequisite<C>
397 implements OnNamespaceItemAdded, ContextMutation {
398 private final ModelProcessingPhase modPhase;
400 PhaseModificationInNamespace(final ModelProcessingPhase phase) {
401 Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
402 this.modPhase = phase;
405 @SuppressWarnings("unchecked")
407 public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace,
408 final Object key, final Object value) {
409 StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
410 targetCtx.addMutation(modPhase, this);
411 resolvePrereq((C) targetCtx);
415 public boolean isFinished() {