org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack Maven / Gradle / Ivy
/*
* Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.model.util;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Verify.verify;
import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;
import com.google.common.annotations.Beta;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.MoreObjects;
import com.google.common.base.VerifyException;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import java.util.ArrayDeque;
import java.util.Collection;
import java.util.List;
import java.util.NoSuchElementException;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.concepts.Mutable;
import org.opendaylight.yangtools.rfc8040.model.api.YangDataEffectiveStatement;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.common.UnresolvedQName.Qualified;
import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
import org.opendaylight.yangtools.yang.common.YangDataName;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.opendaylight.yangtools.yang.model.api.EffectiveStatementInference;
import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
import org.opendaylight.yangtools.yang.model.api.PathExpression;
import org.opendaylight.yangtools.yang.model.api.PathExpression.DerefSteps;
import org.opendaylight.yangtools.yang.model.api.PathExpression.LocationPathSteps;
import org.opendaylight.yangtools.yang.model.api.SchemaTreeInference;
import org.opendaylight.yangtools.yang.model.api.Status;
import org.opendaylight.yangtools.yang.model.api.TypeAware;
import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.CaseEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.TypedefAwareEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
import org.opendaylight.yangtools.yang.model.spi.AbstractEffectiveStatementInference;
import org.opendaylight.yangtools.yang.model.spi.DefaultSchemaTreeInference;
import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath;
import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.AxisStep;
import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.QNameStep;
import org.slf4j.LoggerFactory;
/**
* A state tracking utility for walking {@link EffectiveModelContext}'s contents along schema/grouping namespaces. This
* is conceptually a stack, tracking {@link EffectiveStatement}s encountered along traversal.
*
*
* This class is designed for single-threaded uses and does not make any guarantees around concurrent access.
*/
@Beta
public final class SchemaInferenceStack implements Mutable, LeafrefResolver {
/**
* Semantic binding of {@link EffectiveStatementInference} produced by {@link SchemaInferenceStack}. Sequence of
* {@link #statementPath()} is implementation-specific.
*/
@Beta
public static final class Inference extends AbstractEffectiveStatementInference> {
private final ArrayDeque> deque;
private final ModuleEffectiveStatement currentModule;
private final int groupingDepth;
private final boolean clean;
Inference(final @NonNull EffectiveModelContext modelContext, final ArrayDeque> deque,
final ModuleEffectiveStatement currentModule, final int groupingDepth, final boolean clean) {
super(modelContext);
this.deque = requireNonNull(deque);
this.currentModule = currentModule;
this.groupingDepth = groupingDepth;
this.clean = clean;
}
/**
* Create a new {@link Inference} backed by an effective model.
*
* @param modelContext {@link EffectiveModelContext} to which the inference is attached
* @return A new @link Inference}
* @throws NullPointerException if {@code modelContext} is {@code null}
*/
public static @NonNull Inference of(final EffectiveModelContext modelContext) {
return new Inference(modelContext, new ArrayDeque<>(), null, 0, true);
}
/**
* Create a new {@link Inference} backed by an effective model and set up to point and specified data tree node.
*
* @param modelContext {@link EffectiveModelContext} to which the inference is attached
* @param qnames Data tree path qnames
* @return A new @link Inference}
* @throws NullPointerException if any argument is {@code null} or path contains a {@code null} element
* @throws IllegalArgumentException if a path element cannot be found
*/
public static @NonNull Inference ofDataTreePath(final EffectiveModelContext modelContext,
final QName... qnames) {
return qnames.length == 0 ? of(modelContext)
: SchemaInferenceStack.ofDataTreePath(modelContext, qnames).toInference();
}
@Override
public List> statementPath() {
return ImmutableList.copyOf(deque);
}
/**
* Return {@code true} if this inference is empty. This is a more efficient alternative to
* {@code statementPath().isEmpty()}.
*
* @return {@code true} if {@link #statementPath()} returns an empty list
*/
public boolean isEmpty() {
return deque.isEmpty();
}
/**
* Convert this inference into a {@link SchemaInferenceStack}.
*
* @return A new stack
*/
public @NonNull SchemaInferenceStack toSchemaInferenceStack() {
return new SchemaInferenceStack(modelContext(), deque, currentModule, groupingDepth, clean);
}
}
private static final String VERIFY_DEFAULT_SCHEMA_TREE_INFERENCE_PROP =
"org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.verifyDefaultSchemaTreeInference";
private static final boolean VERIFY_DEFAULT_SCHEMA_TREE_INFERENCE =
Boolean.getBoolean(VERIFY_DEFAULT_SCHEMA_TREE_INFERENCE_PROP);
static {
if (VERIFY_DEFAULT_SCHEMA_TREE_INFERENCE) {
LoggerFactory.getLogger(SchemaInferenceStack.class)
.info("SchemaTreeStack.ofInference(DefaultSchemaTreeInference) argument is being verified");
}
}
private final @NonNull EffectiveModelContext modelContext;
private final ArrayDeque> deque;
private @Nullable ModuleEffectiveStatement currentModule;
private int groupingDepth;
// True if there were only steps along grouping and schema tree, hence it is consistent with SchemaNodeIdentifier
// False if we have evidence of a data tree lookup succeeding
private boolean clean;
private SchemaInferenceStack(final EffectiveModelContext effectiveModel, final int expectedSize) {
deque = new ArrayDeque<>(expectedSize);
modelContext = requireNonNull(effectiveModel);
clean = true;
}
private SchemaInferenceStack(final SchemaInferenceStack source) {
deque = source.deque.clone();
modelContext = source.modelContext;
currentModule = source.currentModule;
groupingDepth = source.groupingDepth;
clean = source.clean;
}
private SchemaInferenceStack(final EffectiveModelContext modelContext,
final ArrayDeque> deque, final ModuleEffectiveStatement currentModule,
final int groupingDepth, final boolean clean) {
this.modelContext = requireNonNull(modelContext);
this.deque = deque.clone();
this.currentModule = currentModule;
this.groupingDepth = groupingDepth;
this.clean = clean;
}
private SchemaInferenceStack(final EffectiveModelContext effectiveModel) {
modelContext = requireNonNull(effectiveModel);
deque = new ArrayDeque<>();
clean = true;
}
/**
* Create a new empty stack backed by an effective model.
*
* @param effectiveModel EffectiveModelContext to which this stack is attached
* @return A new stack
* @throws NullPointerException if {@code effectiveModel} is {@code null}
*/
public static @NonNull SchemaInferenceStack of(final EffectiveModelContext effectiveModel) {
return new SchemaInferenceStack(effectiveModel);
}
/**
* Create a new stack backed by an effective model, pointing to specified schema node identified by
* {@link Absolute}.
*
* @param effectiveModel EffectiveModelContext to which this stack is attached
* @return A new stack
* @throws NullPointerException if {@code effectiveModel} is {@code null}
* @throws IllegalArgumentException if {@code path} cannot be resolved in the effective model
*/
public static @NonNull SchemaInferenceStack of(final EffectiveModelContext effectiveModel, final Absolute path) {
final var ret = new SchemaInferenceStack(effectiveModel);
path.getNodeIdentifiers().forEach(ret::enterSchemaTree);
return ret;
}
/**
* Create a new stack from an {@link EffectiveStatementInference}.
*
* @param inference Inference to use for initialization
* @return A new stack
* @throws NullPointerException if {@code inference} is {@code null}
* @throws IllegalArgumentException if {@code inference} implementation is not supported
*/
public static @NonNull SchemaInferenceStack ofInference(final EffectiveStatementInference inference) {
if (inference.statementPath().isEmpty()) {
return new SchemaInferenceStack(inference.modelContext());
}
return switch (inference) {
case SchemaTreeInference sti -> ofInference(sti);
case Inference inf -> inf.toSchemaInferenceStack();
default -> throw new IllegalArgumentException("Unsupported Inference " + inference);
};
}
/**
* Create a new stack from an {@link SchemaTreeInference}.
*
* @param inference SchemaTreeInference to use for initialization
* @return A new stack
* @throws NullPointerException if {@code inference} is {@code null}
* @throws IllegalArgumentException if {@code inference} cannot be resolved to a valid stack
*/
public static @NonNull SchemaInferenceStack ofInference(final SchemaTreeInference inference) {
return inference instanceof DefaultSchemaTreeInference dsti ? ofInference(dsti)
: of(inference.modelContext(), inference.toSchemaNodeIdentifier());
}
/**
* Create a new stack from an {@link DefaultSchemaTreeInference}. The argument is nominally trusted to be an
* accurate representation of the schema tree.
*
*
* Run-time verification of {@code inference} can be enabled by setting the
* {@value #VERIFY_DEFAULT_SCHEMA_TREE_INFERENCE_PROP} system property to {@code true}.
*
* @param inference DefaultSchemaTreeInference to use for initialization
* @return A new stack
* @throws NullPointerException if {@code inference} is {@code null}
* @throws IllegalArgumentException if {@code inference} refers to a missing module or when verification is enabled
* and it does not match its context's schema tree
*/
public static @NonNull SchemaInferenceStack ofInference(final DefaultSchemaTreeInference inference) {
return VERIFY_DEFAULT_SCHEMA_TREE_INFERENCE ? ofUntrusted(inference) : ofTrusted(inference);
}
private static @NonNull SchemaInferenceStack ofTrusted(final DefaultSchemaTreeInference inference) {
final var path = inference.statementPath();
final var ret = new SchemaInferenceStack(inference.modelContext(), path.size());
ret.currentModule = ret.getModule(path.get(0).argument());
ret.deque.addAll(path);
return ret;
}
@VisibleForTesting
static @NonNull SchemaInferenceStack ofUntrusted(final DefaultSchemaTreeInference inference) {
final var ret = of(inference.modelContext(), inference.toSchemaNodeIdentifier());
if (!Iterables.elementsEqual(ret.deque, inference.statementPath())) {
throw new IllegalArgumentException("Provided " + inference + " is not consistent with resolved path "
+ ret.toSchemaTreeInference());
}
return ret;
}
/**
* Create a new stack backed by an effective model and set up to point and specified data tree node.
*
* @param effectiveModel EffectiveModelContext to which this stack is attached
* @return A new stack
* @throws NullPointerException if any argument is {@code null} or path contains a {@code null} element
* @throws IllegalArgumentException if a path element cannot be found
*/
public static @NonNull SchemaInferenceStack ofDataTreePath(final EffectiveModelContext effectiveModel,
final QName... path) {
final var ret = new SchemaInferenceStack(effectiveModel);
for (var qname : path) {
ret.enterDataTree(qname);
}
return ret;
}
/**
* Return the {@link EffectiveModelContext} this stack operates on.
*
* @return the {@link EffectiveModelContext} this stack operates on
*/
public @NonNull EffectiveModelContext modelContext() {
return modelContext;
}
/**
* Create a deep copy of this object.
*
* @return An isolated copy of this object
*/
public @NonNull SchemaInferenceStack copy() {
return new SchemaInferenceStack(this);
}
/**
* Check if this stack is empty.
*
* @return {@code true} if this stack has not entered any node
*/
public boolean isEmpty() {
return deque.isEmpty();
}
/**
* Return the statement at the top of the stack.
*
* @return Top statement
* @throws IllegalStateException if the stack is empty
*/
public @NonNull EffectiveStatement currentStatement() {
return checkNonNullState(deque.peekLast());
}
/**
* Return current module the stack has entered.
*
* @return Current module
* @throws IllegalStateException if the stack is empty
*/
public @NonNull ModuleEffectiveStatement currentModule() {
return checkNonNullState(currentModule);
}
/**
* Check if the stack is in instantiated context. This indicates the stack is non-empty and there are only schema
* tree statements in the stack.
*
* @return {@code false} if the stack is empty or contains a statement which is not a
* {@link SchemaTreeEffectiveStatement}, {@code true} otherwise.
*/
public boolean inInstantiatedContext() {
return groupingDepth == 0 && !deque.isEmpty()
&& deque.stream().allMatch(SchemaTreeEffectiveStatement.class::isInstance);
}
/**
* Check if the stack is in a {@code grouping} context.
*
* @return {@code false} if the stack contains a grouping.
*/
public boolean inGrouping() {
return groupingDepth != 0;
}
/**
* Return the effective {@code status} of the {@link #currentStatement()}, if present. This method operates on
* the effective view of the model and therefore does not reflect status the declaration hierarchy. Most notably
* this YANG snippet:
*
* {@code
* module foo {
* grouping foo {
* status obsolete;
* leaf bar { type string; }
* }
*
* container foo {
* status deprecated;
* uses bar;
* }
*
* uses foo;
* }
* }
*
* will cause this method to report the status of {@code leaf bar} as:
*
* - {@link Status#OBSOLETE} at its original declaration site in {@code grouping foo}
* - {@link Status#DEPRECATED} at its instantiation in {@code container foo}
* - {@link Status#CURRENT} at its instantiation in {@code module foo}
*
*
* @return {@link Status#CURRENT} if {@link #isEmpty()}, or the status of current statement as implied by its direct
* and its ancestors' substaments.
*/
public @NonNull Status effectiveStatus() {
final var it = reconstructDeque().descendingIterator();
while (it.hasNext()) {
final var optStatus = it.next().findFirstEffectiveSubstatementArgument(StatusEffectiveStatement.class);
if (optStatus.isPresent()) {
return optStatus.orElseThrow();
}
}
return Status.CURRENT;
}
/**
* Reset this stack to empty state.
*/
public void clear() {
deque.clear();
currentModule = null;
groupingDepth = 0;
clean = true;
}
/**
* Lookup a {@code choice} by its node identifier and push it to the stack. This step is very similar to
* {@link #enterSchemaTree(QName)}, except it handles the use case where traversal ignores actual {@code case}
* intermediate schema tree children.
*
* @param nodeIdentifier Node identifier of the choice to enter
* @return Resolved choice
* @throws NullPointerException if {@code nodeIdentifier} is {@code null}
* @throws IllegalArgumentException if the corresponding choice cannot be found
*/
public @NonNull ChoiceEffectiveStatement enterChoice(final QName nodeIdentifier) {
final var nodeId = requireNonNull(nodeIdentifier);
final var parent = deque.peekLast();
if (parent instanceof ChoiceEffectiveStatement choice) {
return enterChoice(choice, nodeId);
}
// Fall back to schema tree lookup. Note if it results in non-choice, we rewind before reporting an error
final var result = enterSchemaTree(nodeId);
if (result instanceof ChoiceEffectiveStatement choice) {
return choice;
}
exit();
if (parent != null) {
throw notPresent(parent, "Choice", nodeId);
}
throw new IllegalArgumentException("Choice " + nodeId + " not present");
}
// choice -> choice transition, we have to deal with intermediate case nodes
private @NonNull ChoiceEffectiveStatement enterChoice(final @NonNull ChoiceEffectiveStatement parent,
final @NonNull QName nodeIdentifier) {
for (var stmt : parent.effectiveSubstatements()) {
if (stmt instanceof CaseEffectiveStatement caze) {
final var optMatch = caze.findSchemaTreeNode(nodeIdentifier)
.filter(ChoiceEffectiveStatement.class::isInstance)
.map(ChoiceEffectiveStatement.class::cast);
if (optMatch.isPresent()) {
final var match = optMatch.orElseThrow();
deque.addLast(match);
clean = false;
return match;
}
}
}
throw notPresent(parent, "Choice", nodeIdentifier);
}
/**
* Lookup a {@code grouping} by its node identifier and push it to the stack.
*
* @param nodeIdentifier Node identifier of the grouping to enter
* @return Resolved grouping
* @throws NullPointerException if {@code nodeIdentifier} is {@code null}
* @throws IllegalArgumentException if the corresponding grouping cannot be found
*/
public @NonNull GroupingEffectiveStatement enterGrouping(final QName nodeIdentifier) {
return pushGrouping(requireNonNull(nodeIdentifier));
}
/**
* Lookup a {@code schema tree} child by its node identifier and push it to the stack.
*
* @param nodeIdentifier Node identifier of the schema tree child to enter
* @return Resolved schema tree child
* @throws NullPointerException if {@code nodeIdentifier} is {@code null}
* @throws IllegalArgumentException if the corresponding child cannot be found
*/
public @NonNull SchemaTreeEffectiveStatement enterSchemaTree(final QName nodeIdentifier) {
return pushSchema(requireNonNull(nodeIdentifier));
}
/**
* Lookup a {@code schema tree} node by its schema node identifier and push it to the stack.
*
* @param nodeIdentifier Schema node identifier of the schema tree node to enter
* @return Resolved schema tree node
* @throws NullPointerException if {@code nodeIdentifier} is {@code null}
* @throws IllegalArgumentException if the corresponding node cannot be found
*/
public @NonNull SchemaTreeEffectiveStatement enterSchemaTree(final SchemaNodeIdentifier nodeIdentifier) {
if (nodeIdentifier instanceof Absolute) {
clear();
}
final var it = nodeIdentifier.getNodeIdentifiers().iterator();
SchemaTreeEffectiveStatement ret;
do {
ret = enterSchemaTree(it.next());
} while (it.hasNext());
return ret;
}
/**
* Lookup a {@code schema tree} child by its node identifier and push it to the stack.
*
* @param nodeIdentifier Node identifier of the date tree child to enter
* @return Resolved date tree child
* @throws NullPointerException if {@code nodeIdentifier} is {@code null}
* @throws IllegalArgumentException if the corresponding child cannot be found
*/
public @NonNull DataTreeEffectiveStatement enterDataTree(final QName nodeIdentifier) {
return pushData(requireNonNull(nodeIdentifier));
}
/**
* Lookup a {@code typedef} by its node identifier and push it to the stack.
*
* @param nodeIdentifier Node identifier of the typedef to enter
* @return Resolved typedef
* @throws NullPointerException if {@code nodeIdentifier} is {@code null}
* @throws IllegalArgumentException if the corresponding typedef cannot be found
*/
public @NonNull TypedefEffectiveStatement enterTypedef(final QName nodeIdentifier) {
return pushTypedef(requireNonNull(nodeIdentifier));
}
/**
* Lookup a {@code rc:yang-data} by the module namespace where it is defined and its template name.
*
* @param name Template name
* @return Resolved yang-data
* @throws NullPointerException if any argument is {@code null}
* @throws IllegalArgumentException if the corresponding yang-data cannot be found
* @throws IllegalStateException if this stack is not empty
*/
public @NonNull YangDataEffectiveStatement enterYangData(final YangDataName name) {
if (!isEmpty()) {
throw new IllegalStateException("Cannot lookup yang-data in a non-empty stack");
}
final var checkedName = requireNonNull(name);
final var namespace = name.module();
final var module = modelContext.getModuleStatements().get(namespace);
if (module == null) {
throw new IllegalArgumentException("Module for " + namespace + " not found");
}
final var ret = module.streamEffectiveSubstatements(YangDataEffectiveStatement.class)
.filter(stmt -> checkedName.equals(stmt.argument()))
.findFirst()
.orElseThrow(
() -> new IllegalArgumentException("yang-data " + checkedName.name() + " not present in " + namespace));
deque.addLast(ret);
currentModule = module;
return ret;
}
/**
* Pop the current statement from the stack.
*
* @return Previous statement
* @throws NoSuchElementException if this stack is empty
*/
public @NonNull EffectiveStatement exit() {
final var prev = deque.removeLast();
if (prev instanceof GroupingEffectiveStatement) {
--groupingDepth;
}
if (deque.isEmpty()) {
currentModule = null;
clean = true;
}
return prev;
}
/**
* Pop the current statement from the stack, asserting it is a {@link DataTreeEffectiveStatement} and that
* subsequent {@link #enterDataTree(QName)} will find it again.
*
* @return Previous statement
* @throws NoSuchElementException if this stack is empty
* @throws IllegalStateException if current statement is not a DataTreeEffectiveStatement or if its parent is not
* a {@link DataTreeAwareEffectiveStatement}
*/
public @NonNull DataTreeEffectiveStatement exitToDataTree() {
final var child = exit();
if (!(child instanceof DataTreeEffectiveStatement ret)) {
throw new IllegalStateException("Unexpected current " + child);
}
var parent = deque.peekLast();
while (parent instanceof ChoiceEffectiveStatement || parent instanceof CaseEffectiveStatement) {
deque.pollLast();
parent = deque.peekLast();
}
if (parent == null || parent instanceof DataTreeAwareEffectiveStatement) {
return ret;
}
throw new IllegalStateException("Unexpected parent " + parent);
}
@Override
public TypeDefinition resolveLeafref(final LeafrefTypeDefinition type) {
final var tmp = copy();
var current = type;
while (true) {
final var resolved = tmp.resolvePathExpression(current.getPathStatement());
if (!(resolved instanceof TypeAware typeAware)) {
throw new IllegalStateException("Unexpected result " + resolved + " resultion of " + type);
}
final var result = typeAware.getType();
if (result instanceof LeafrefTypeDefinition leafref) {
if (result == type) {
throw new IllegalArgumentException(
"Resolution of " + type + " loops back onto itself via " + current);
}
current = leafref;
} else {
return result;
}
}
}
/**
* Resolve a {@link PathExpression}.
*
*
* Note if this method throws, this stack may be in an undefined state.
*
* @param path Requested path
* @return Resolved schema tree child
* @throws NullPointerException if {@code path} is {@code null}
* @throws IllegalArgumentException if the target node cannot be found
* @throws VerifyException if path expression is invalid
*/
public @NonNull EffectiveStatement resolvePathExpression(final PathExpression path) {
return switch (path.getSteps()) {
case LocationPathSteps location -> resolveLocationPath(location.getLocationPath());
case DerefSteps deref -> resolveDeref(deref);
};
}
private @NonNull EffectiveStatement resolveDeref(final DerefSteps deref) {
final var leafRefSchemaNode = currentStatement();
final var derefArg = deref.getDerefArgument();
final var derefStmt = resolveLocationPath(derefArg);
if (derefStmt == null) {
// FIXME: dead code?
throw new IllegalArgumentException(
"Cannot find deref(" + derefArg + ") target node in context of %s" + leafRefSchemaNode);
}
if (!(derefStmt instanceof TypedDataSchemaNode typed)) {
throw new IllegalArgumentException(
"deref(" + derefArg + ") resolved to non-typed " + derefStmt + " in context of " + leafRefSchemaNode);
}
// We have a deref() target, decide what to do about it
final var targetType = typed.getType();
if (targetType instanceof InstanceIdentifierTypeDefinition) {
// Static inference breaks down, we cannot determine where this points to
// FIXME: dedicated exception, users can recover from it, derive from IAE
throw new UnsupportedOperationException("Cannot infer instance-identifier reference " + targetType);
}
// deref() is defined only for instance-identifier and leafref types, handle the latter
if (!(targetType instanceof LeafrefTypeDefinition leafref)) {
throw new IllegalArgumentException("Illegal target type " + targetType);
}
final var dereferencedLeafRefPath = leafref.getPathStatement();
final var derefNode = resolvePathExpression(dereferencedLeafRefPath);
// FIXME: revisit these checks
checkArgument(derefStmt != null, "Can not find target node of dereferenced node %s", derefStmt);
checkArgument(derefNode instanceof LeafSchemaNode, "Unexpected %s reference in %s", deref,
dereferencedLeafRefPath);
return resolveLocationPath(deref.getRelativePath());
}
private @NonNull EffectiveStatement resolveLocationPath(final YangLocationPath path) {
// get the default namespace before we clear and loose our deque
final var defaultNamespace = deque.isEmpty() ? null : ((QName) deque.peekLast().argument()).getModule();
if (path.isAbsolute()) {
clear();
}
EffectiveStatement current = null;
for (var step : path.getSteps()) {
final var axis = step.getAxis();
switch (axis) {
case PARENT -> {
verify(step instanceof AxisStep, "Unexpected parent step %s", step);
try {
current = exitToDataTree();
} catch (IllegalStateException | NoSuchElementException e) {
throw new IllegalArgumentException("Illegal parent access in " + path, e);
}
}
case CHILD -> {
if (step instanceof QNameStep qnameStep) {
current = enterChild(qnameStep, defaultNamespace);
} else {
throw new VerifyException("Unexpected child step " + step);
}
}
default -> throw new VerifyException("Unexpected step " + step);
}
}
return verifyNotNull(current);
}
private @NonNull DataTreeEffectiveStatement enterChild(final QNameStep step,
final QNameModule defaultNamespace) {
final var qname = switch (step.getQName()) {
case QName qnameToResolve -> qnameToResolve;
case Unqualified unqual -> {
if (defaultNamespace == null) {
throw new IllegalArgumentException("Can not find target module of step " + step);
}
yield unqual.bindTo(defaultNamespace);
}
case Qualified qual -> throw new VerifyException("Unexpected child step QName " + qual);
};
return enterDataTree(qname);
}
/**
* Return an {@link Inference} equivalent of current state.
*
* @return An {@link Inference}
*/
public @NonNull Inference toInference() {
return new Inference(modelContext, deque.clone(), currentModule, groupingDepth, clean);
}
/**
* Return an {@link SchemaTreeInference} equivalent of current state.
*
* @return An {@link SchemaTreeInference}
* @throws IllegalStateException if current state cannot be converted to a {@link SchemaTreeInference}
*/
public @NonNull SchemaTreeInference toSchemaTreeInference() {
checkInInstantiatedContext();
return DefaultSchemaTreeInference.unsafeOf(modelContext, reconstructDeque().stream()
.map(stmt -> (SchemaTreeEffectiveStatement) stmt)
.collect(ImmutableList.toImmutableList()));
}
private ArrayDeque> reconstructDeque() {
return clean ? deque : reconstructSchemaInferenceStack().deque;
}
/**
* Convert current state into an absolute schema node identifier.
*
* @return Absolute schema node identifier representing current state
* @throws IllegalStateException if current state is not instantiated
*/
public @NonNull Absolute toSchemaNodeIdentifier() {
checkInInstantiatedContext();
return Absolute.of(simplePathFromRoot());
}
private void checkInInstantiatedContext() {
if (!inInstantiatedContext()) {
throw new IllegalStateException("Cannot convert uninstantiated context " + this);
}
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this).add("path", deque).toString();
}
private @NonNull GroupingEffectiveStatement pushGrouping(final @NonNull QName nodeIdentifier) {
final var parent = deque.peekLast();
return parent != null ? pushGrouping(parent, nodeIdentifier) : pushFirstGrouping(nodeIdentifier);
}
private @NonNull GroupingEffectiveStatement pushGrouping(final @NonNull EffectiveStatement parent,
final @NonNull QName nodeIdentifier) {
final var ret = parent.streamEffectiveSubstatements(GroupingEffectiveStatement.class)
.filter(stmt -> nodeIdentifier.equals(stmt.argument()))
.findFirst()
.orElseThrow(() -> notPresent(parent, "Grouping", nodeIdentifier));
deque.addLast(ret);
++groupingDepth;
return ret;
}
private @NonNull GroupingEffectiveStatement pushFirstGrouping(final @NonNull QName nodeIdentifier) {
final var module = getModule(nodeIdentifier);
final var ret = pushGrouping(module, nodeIdentifier);
currentModule = module;
return ret;
}
private @NonNull SchemaTreeEffectiveStatement pushSchema(final @NonNull QName nodeIdentifier) {
final var parent = deque.peekLast();
return parent != null ? pushSchema(parent, nodeIdentifier) : pushFirstSchema(nodeIdentifier);
}
private @NonNull SchemaTreeEffectiveStatement pushSchema(final EffectiveStatement parent,
final @NonNull QName nodeIdentifier) {
if (parent instanceof SchemaTreeAwareEffectiveStatement schemaTreeParent) {
return pushSchema(schemaTreeParent, nodeIdentifier);
}
throw new IllegalStateException("Cannot descend schema tree at " + parent);
}
private @NonNull SchemaTreeEffectiveStatement pushSchema(
final @NonNull SchemaTreeAwareEffectiveStatement parent, final @NonNull QName nodeIdentifier) {
final var ret = parent.findSchemaTreeNode(nodeIdentifier)
.orElseThrow(() -> notPresent(parent, "Schema tree child ", nodeIdentifier));
deque.addLast(ret);
return ret;
}
private @NonNull SchemaTreeEffectiveStatement pushFirstSchema(final @NonNull QName nodeIdentifier) {
final var module = getModule(nodeIdentifier);
final var ret = pushSchema(module, nodeIdentifier);
currentModule = module;
return ret;
}
private @NonNull DataTreeEffectiveStatement pushData(final @NonNull QName nodeIdentifier) {
final var parent = deque.peekLast();
return parent != null ? pushData(parent, nodeIdentifier) : pushFirstData(nodeIdentifier);
}
private @NonNull DataTreeEffectiveStatement pushData(final EffectiveStatement parent,
final @NonNull QName nodeIdentifier) {
if (parent instanceof DataTreeAwareEffectiveStatement dataTreeParent) {
return pushData(dataTreeParent, nodeIdentifier);
}
throw new IllegalStateException("Cannot descend data tree at " + parent);
}
private @NonNull DataTreeEffectiveStatement pushData(final @NonNull DataTreeAwareEffectiveStatement parent,
final @NonNull QName nodeIdentifier) {
final var ret = parent.findDataTreeNode(nodeIdentifier)
.orElseThrow(() -> notPresent(parent, "Data tree child", nodeIdentifier));
deque.addLast(ret);
clean = false;
return ret;
}
private @NonNull DataTreeEffectiveStatement pushFirstData(final @NonNull QName nodeIdentifier) {
final var module = getModule(nodeIdentifier);
final var ret = pushData(module, nodeIdentifier);
currentModule = module;
return ret;
}
private @NonNull TypedefEffectiveStatement pushTypedef(final @NonNull QName nodeIdentifier) {
final var parent = deque.peekLast();
return parent != null ? pushTypedef(parent, nodeIdentifier) : pushFirstTypedef(nodeIdentifier);
}
private @NonNull TypedefEffectiveStatement pushTypedef(final @NonNull EffectiveStatement parent,
final @NonNull QName nodeIdentifier) {
if (parent instanceof TypedefAwareEffectiveStatement aware) {
final var ret = aware.findTypedef(nodeIdentifier)
.orElseThrow(() -> notPresent(parent, "Typedef", nodeIdentifier));
deque.addLast(ret);
return ret;
}
throw notPresent(parent, "Typedef", nodeIdentifier);
}
private @NonNull TypedefEffectiveStatement pushFirstTypedef(final @NonNull QName nodeIdentifier) {
final var module = getModule(nodeIdentifier);
final var ret = pushTypedef(module, nodeIdentifier);
currentModule = module;
return ret;
}
private @NonNull ModuleEffectiveStatement getModule(final @NonNull QName nodeIdentifier) {
final var module = modelContext.getModuleStatements().get(nodeIdentifier.getModule());
if (module == null) {
throw new IllegalArgumentException("Module for " + nodeIdentifier + " not found");
}
return module;
}
// Unified access to queue iteration for addressing purposes. Since we keep 'logical' steps as executed by user
// at this point, conversion to SchemaNodeIdentifier may be needed. We dispatch based on 'clean'.
private Collection simplePathFromRoot() {
return clean ? qnames() : reconstructQNames();
}
private Collection qnames() {
return Collections2.transform(deque, stmt -> {
if (stmt.argument() instanceof QName qname) {
return qname;
}
throw new VerifyException("Unexpected statement " + stmt);
});
}
// So there are some data tree steps in the stack... we essentially need to convert a data tree item into a series
// of schema tree items. This means at least N searches, but after they are done, we get an opportunity to set the
// clean flag.
private Collection reconstructQNames() {
return reconstructSchemaInferenceStack().qnames();
}
private SchemaInferenceStack reconstructSchemaInferenceStack() {
// Let's walk all statements and decipher them into a temporary stack
final var tmp = new SchemaInferenceStack(modelContext, deque.size());
for (var stmt : deque) {
// Order of checks is significant
if (stmt instanceof DataTreeEffectiveStatement dataTree) {
tmp.resolveDataTreeSteps(dataTree.argument());
} else if (stmt instanceof ChoiceEffectiveStatement choice) {
tmp.resolveChoiceSteps(choice.argument());
} else if (stmt instanceof SchemaTreeEffectiveStatement schemaTree) {
tmp.enterSchemaTree(schemaTree.argument());
} else if (stmt instanceof GroupingEffectiveStatement grouping) {
tmp.enterGrouping(grouping.argument());
} else if (stmt instanceof TypedefEffectiveStatement typedef) {
tmp.enterTypedef(typedef.argument());
} else {
throw new VerifyException("Unexpected statement " + stmt);
}
}
// if the sizes match, we did not jump through hoops. let's remember that for future.
if (deque.size() == tmp.deque.size()) {
clean = true;
return this;
}
return tmp;
}
private void resolveChoiceSteps(final @NonNull QName nodeIdentifier) {
final var parent = deque.peekLast();
if (parent instanceof ChoiceEffectiveStatement choice) {
resolveChoiceSteps(choice, nodeIdentifier);
} else {
enterSchemaTree(nodeIdentifier);
}
}
private void resolveChoiceSteps(final @NonNull ChoiceEffectiveStatement parent,
final @NonNull QName nodeIdentifier) {
for (var stmt : parent.effectiveSubstatements()) {
if (stmt instanceof CaseEffectiveStatement caze) {
if (caze.findSchemaTreeNode(nodeIdentifier).orElse(null) instanceof ChoiceEffectiveStatement found) {
deque.addLast(caze);
deque.addLast(found);
return;
}
}
}
throw new VerifyException("Failed to resolve " + nodeIdentifier + " in " + parent);
}
private void resolveDataTreeSteps(final @NonNull QName nodeIdentifier) {
final var parent = deque.peekLast();
switch (parent) {
case null -> {
final var module = getModule(nodeIdentifier);
resolveDataTreeSteps(module, nodeIdentifier);
currentModule = module;
}
case SchemaTreeAwareEffectiveStatement schemaTree -> resolveDataTreeSteps(schemaTree, nodeIdentifier);
default -> throw new VerifyException("Unexpected parent " + parent);
}
}
private void resolveDataTreeSteps(final @NonNull SchemaTreeAwareEffectiveStatement parent,
final @NonNull QName nodeIdentifier) {
// The algebra of identifiers in 'schema tree versus data tree':
// - data tree parents are always schema tree parents
// - data tree children are always schema tree children
// that implies that a data tree parent must satisfy schema tree queries with data tree children,
// so a successful lookup of 'data tree parent -> child' and 'schema tree parent -> child' has to be the same
// for a direct lookup.
final var found = parent.findSchemaTreeNode(nodeIdentifier).orElse(null);
if (found instanceof DataTreeEffectiveStatement) {
// ... and it did, we are done
deque.addLast(found);
return;
}
// Alright, so now it's down to filtering choice/case statements. For that we keep some globally-reused state
// and employ a recursive match.
final var match = new ArrayDeque>();
for (var stmt : parent.effectiveSubstatements()) {
if (stmt instanceof ChoiceEffectiveStatement choice && searchChoice(match, choice, nodeIdentifier)) {
deque.addAll(match);
return;
}
}
throw new VerifyException("Failed to resolve " + nodeIdentifier + " in " + parent);
}
private static boolean searchCase(final @NonNull ArrayDeque> result,
final @NonNull CaseEffectiveStatement parent, final @NonNull QName nodeIdentifier) {
result.addLast(parent);
for (var stmt : parent.effectiveSubstatements()) {
if (stmt instanceof DataTreeEffectiveStatement dataTree && nodeIdentifier.equals(stmt.argument())) {
result.addLast(dataTree);
return true;
}
if (stmt instanceof ChoiceEffectiveStatement choice && searchChoice(result, choice, nodeIdentifier)) {
return true;
}
}
result.removeLast();
return false;
}
private static boolean searchChoice(final @NonNull ArrayDeque> result,
final @NonNull ChoiceEffectiveStatement parent, final @NonNull QName nodeIdentifier) {
result.addLast(parent);
for (var stmt : parent.effectiveSubstatements()) {
if (stmt instanceof CaseEffectiveStatement caze && searchCase(result, caze, nodeIdentifier)) {
return true;
}
}
result.removeLast();
return false;
}
private static @NonNull T checkNonNullState(final @Nullable T obj) {
if (obj == null) {
throw new IllegalStateException("Cannot execute on empty stack");
}
return obj;
}
private static @NonNull IllegalArgumentException notPresent(final @NonNull EffectiveStatement parent,
final @NonNull String name, final QName nodeIdentifier) {
return new IllegalArgumentException(name + " " + nodeIdentifier + " not present in " + describeParent(parent));
}
private static @NonNull String describeParent(final @NonNull EffectiveStatement parent) {
// Add just enough information to be useful without being overly-verbose. Note we want to expose namespace
// information, so that we understand what revisions we are dealing with
return switch (parent) {
case GroupingEffectiveStatement grouping -> "grouping " + grouping.argument();
case ModuleEffectiveStatement module -> "module " + module.argument().bindTo(module.localQNameModule());
case SchemaTreeEffectiveStatement schemaTree -> "schema parent " + schemaTree.argument();
default -> {
// Shorthand for QNames, should provide enough context
final var arg = parent.argument();
yield "parent " + (arg instanceof QName qname ? qname : parent);
}
};
}
}