/* * Copyright (c) 2015, 2016 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.yangtools.yang.parser.stmt.reactor; import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkState; import static com.google.common.base.Verify.verifyNotNull; import static java.util.Objects.requireNonNull; import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.EFFECTIVE_MODEL; import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.FULL_DECLARATION; import com.google.common.base.MoreObjects; import com.google.common.base.MoreObjects.ToStringHelper; import java.util.HashSet; import java.util.Iterator; import java.util.Set; import java.util.function.Function; import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement; import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace; import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder; import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase; import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion; import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace; import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext; import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable; import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.ContextMutation; import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnNamespaceItemAdded; import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnPhaseFinished; import org.slf4j.Logger; import org.slf4j.LoggerFactory; final class ModifierImpl implements ModelActionBuilder { private static final Logger LOG = LoggerFactory.getLogger(ModifierImpl.class); private final InferenceContext ctx = new InferenceContext() { }; private final Set> unsatisfied = new HashSet<>(1); private final Set> mutations = new HashSet<>(1); private InferenceAction action; private boolean actionApplied = false; private AbstractPrerequisite addReq(final AbstractPrerequisite prereq) { LOG.trace("Modifier {} adding prerequisite {}", this, prereq); unsatisfied.add(prereq); return prereq; } private @NonNull AbstractPrerequisite addMutation(final @NonNull AbstractPrerequisite mutation) { LOG.trace("Modifier {} adding mutation {}", this, mutation); mutations.add(mutation); return mutation; } private void checkNotRegistered() { checkState(action == null, "Action was already registered."); } private boolean removeSatisfied() { final Iterator> it = unsatisfied.iterator(); while (it.hasNext()) { final AbstractPrerequisite prereq = it.next(); if (prereq.isDone()) { // We are removing current prerequisite from list. LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq); it.remove(); } } return unsatisfied.isEmpty(); } boolean isApplied() { return actionApplied; } void failModifier() { removeSatisfied(); action.prerequisiteFailed(unsatisfied); action = null; } private void applyAction() { checkState(!actionApplied); action.apply(ctx); actionApplied = true; } private , N extends StatementNamespace> @NonNull AbstractPrerequisite requiresCtxImpl(final StmtContext context, final Class namespace, final K key, final ModelProcessingPhase phase) { checkNotRegistered(); AddedToNamespace addedToNs = new AddedToNamespace<>(phase); addReq(addedToNs); contextImpl(context).onNamespaceItemAddedAction(namespace, key, addedToNs); return addedToNs; } private , N extends StatementNamespace> @NonNull AbstractPrerequisite requiresCtxImpl(final StmtContext context, final Class namespace, final NamespaceKeyCriterion criterion, final ModelProcessingPhase phase) { checkNotRegistered(); AddedToNamespace addedToNs = new AddedToNamespace<>(phase); addReq(addedToNs); contextImpl(context).onNamespaceItemAddedAction(namespace, phase, criterion, addedToNs); return addedToNs; } private > @NonNull AbstractPrerequisite requiresCtxImpl(final C context, final ModelProcessingPhase phase) { checkNotRegistered(); PhaseFinished phaseFin = new PhaseFinished<>(); addReq(phaseFin); contextImpl(context).addPhaseCompletedListener(phase, phaseFin); return phaseFin; } @SuppressWarnings({ "rawtypes", "unchecked" }) private , N extends IdentifierNamespace>> AbstractPrerequisite mutatesCtxImpl(final StmtContext context, final Class namespace, final K key, final ModelProcessingPhase phase) { checkNotRegistered(); final PhaseModificationInNamespace mod = new PhaseModificationInNamespace<>(EFFECTIVE_MODEL); addReq(mod); addMutation(mod); contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod); return mod; } private static StatementContextBase contextImpl(final Object value) { checkArgument(value instanceof StatementContextBase, "Supplied context %s is not provided by this reactor.", value); return StatementContextBase.class.cast(value); } boolean tryApply() { checkState(action != null, "Action was not defined yet."); if (removeSatisfied()) { applyAction(); return true; } return false; } @Override public , T extends C> Prerequisite mutatesCtx(final T context, final ModelProcessingPhase phase) { return addMutation(new PhaseMutation<>(contextImpl(context), phase)); } @Override public , E extends EffectiveStatement> AbstractPrerequisite> requiresCtx(final StmtContext context, final ModelProcessingPhase phase) { return requiresCtxImpl(context, phase); } @Override public > Prerequisite> requiresCtx( final StmtContext context, final Class<@NonNull N> namespace, final K key, final ModelProcessingPhase phase) { return requiresCtxImpl(context, namespace, key, phase); } @Override public > Prerequisite> requiresCtx( final StmtContext context, final Class<@NonNull N> namespace, final NamespaceKeyCriterion criterion, final ModelProcessingPhase phase) { return requiresCtxImpl(context, namespace, criterion, phase); } @Override public > Prerequisite requiresDeclared( final StmtContext context) { return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared); } @Override @Deprecated public , N extends StatementNamespace> Prerequisite requiresDeclared(final StmtContext context, final Class namespace, final K key) { final AbstractPrerequisite> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION); return rawContext.transform(StmtContext::buildDeclared); } @Override @Deprecated public , N extends StatementNamespace> AbstractPrerequisite> requiresDeclaredCtx(final StmtContext context, final Class namespace, final K key) { return requiresCtxImpl(context, namespace, key, FULL_DECLARATION); } @Override @Deprecated public > Prerequisite requiresEffective( final StmtContext stmt) { return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective); } @Override @Deprecated public , N extends StatementNamespace> Prerequisite requiresEffective(final StmtContext context, final Class namespace, final K key) { final AbstractPrerequisite> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL); return rawContext.transform(StmtContext::buildEffective); } @Override @Deprecated public , N extends StatementNamespace> AbstractPrerequisite> requiresEffectiveCtx(final StmtContext context, final Class namespace, final K key) { return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL); } @Override @Deprecated public > Prerequisite> mutatesNs( final Mutable context, final Class namespace) { return addMutation(new NamespaceMutation<>(contextImpl(context), namespace)); } @Override public , N extends IdentifierNamespace>> AbstractPrerequisite> mutatesEffectiveCtx(final StmtContext context, final Class namespace, final K key) { return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL); } @Override public , N extends IdentifierNamespace>> AbstractPrerequisite> mutatesEffectiveCtxPath(final StmtContext context, final Class namespace, final Iterable keys) { checkNotRegistered(); final PhaseModificationInNamespacePath, K, N> ret = new PhaseModificationInNamespacePath<>( EFFECTIVE_MODEL, keys); addReq(ret); addMutation(ret); ret.hookOnto(context, namespace); return ret; } @Override @SuppressWarnings("checkstyle:hiddenField") public void apply(final InferenceAction action) { checkState(this.action == null, "Action already defined to %s", this.action); this.action = requireNonNull(action); } private abstract class AbstractPrerequisite implements Prerequisite { private boolean done = false; private T value; @Override @SuppressWarnings("checkstyle:hiddenField") public final T resolve(final InferenceContext ctx) { checkState(done); checkArgument(ctx == ModifierImpl.this.ctx); return verifyNotNull(value, "Attempted to access unavailable prerequisite %s", this); } final boolean isDone() { return done; } @SuppressWarnings("checkstyle:hiddenField") final boolean resolvePrereq(final T value) { this.value = value; this.done = true; return isApplied(); } final @NonNull Prerequisite transform(final Function transformation) { return context -> transformation.apply(resolve(context)); } @Override public final String toString() { return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString(); } ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) { return toStringHelper.add("value", value); } } private final class PhaseMutation extends AbstractPrerequisite implements ContextMutation { @SuppressWarnings("unchecked") PhaseMutation(final StatementContextBase context, final ModelProcessingPhase phase) { context.addMutation(phase, this); resolvePrereq((C) context); } @Override public boolean isFinished() { return isApplied(); } } private final class PhaseFinished> extends AbstractPrerequisite implements OnPhaseFinished { @SuppressWarnings("unchecked") @Override public boolean phaseFinished(final StatementContextBase context, final ModelProcessingPhase finishedPhase) { return resolvePrereq((C) context); } } private final class NamespaceMutation> extends AbstractPrerequisite> { NamespaceMutation(final StatementContextBase ctx, final Class namespace) { resolvePrereq(ctx); } } private final class AddedToNamespace> extends AbstractPrerequisite implements OnNamespaceItemAdded, OnPhaseFinished { private final ModelProcessingPhase phase; AddedToNamespace(final ModelProcessingPhase phase) { this.phase = requireNonNull(phase); } @Override public void namespaceItemAdded(final StatementContextBase context, final Class namespace, final Object key, final Object value) { ((StatementContextBase) value).addPhaseCompletedListener(phase, this); } @SuppressWarnings("unchecked") @Override public boolean phaseFinished(final StatementContextBase context, final ModelProcessingPhase finishedPhase) { return resolvePrereq((C) context); } @Override ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) { return super.addToStringAttributes(toStringHelper).add("phase", phase); } } private final class PhaseModificationInNamespace> extends AbstractPrerequisite implements OnNamespaceItemAdded, ContextMutation { private final ModelProcessingPhase modPhase; PhaseModificationInNamespace(final ModelProcessingPhase phase) { checkArgument(phase != null, "Model processing phase must not be null"); this.modPhase = phase; } @SuppressWarnings("unchecked") @Override public void namespaceItemAdded(final StatementContextBase context, final Class namespace, final Object key, final Object value) { StatementContextBase targetCtx = contextImpl(value); targetCtx.addMutation(modPhase, this); resolvePrereq((C) targetCtx); } @Override public boolean isFinished() { return isApplied(); } } private final class PhaseModificationInNamespacePath, K, N extends IdentifierNamespace>> extends AbstractPrerequisite implements OnNamespaceItemAdded, ContextMutation { private final ModelProcessingPhase modPhase; private final Iterable keys; private final Iterator it; PhaseModificationInNamespacePath(final ModelProcessingPhase phase, final Iterable keys) { this.modPhase = requireNonNull(phase); this.keys = requireNonNull(keys); it = keys.iterator(); } @Override public boolean isFinished() { return isApplied(); } @Override public void namespaceItemAdded(final StatementContextBase context, final Class namespace, final Object key, final Object value) { LOG.debug("Action for {} got key {}", keys, key); final StatementContextBase target = contextImpl(value); if (!target.isSupportedByFeatures()) { LOG.debug("Key {} in {} is not supported", key, keys); resolvePrereq(null); action.prerequisiteUnavailable(this); return; } if (!it.hasNext()) { target.addMutation(modPhase, this); resolvePrereq((C) value); return; } hookOnto(target, namespace, it.next()); } void hookOnto(final StmtContext context, final Class namespace) { checkArgument(it.hasNext(), "Namespace %s keys may not be empty", namespace); hookOnto(contextImpl(context), namespace, it.next()); } @SuppressWarnings("unchecked") private void hookOnto(final StatementContextBase context, final Class namespace, final K key) { context.onNamespaceItemAddedAction((Class) namespace, requireNonNull(key), this); } } }