model/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaInferenceStack.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.model.util;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static com.google.common.base.Verify.verify;
  13 import static com.google.common.base.Verify.verifyNotNull;
  14 import static java.util.Objects.requireNonNull;
  15
  16 import com.google.common.annotations.Beta;
  17 import com.google.common.base.MoreObjects;
  18 import com.google.common.base.VerifyException;
  19 import com.google.common.collect.ImmutableList;
  20 import com.google.common.collect.Iterators;
  21 import java.util.ArrayDeque;
  22 import java.util.Deque;
  23 import java.util.Iterator;
  24 import java.util.List;
  25 import java.util.NoSuchElementException;
  26 import java.util.Optional;
  27 import org.eclipse.jdt.annotation.NonNull;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.opendaylight.yangtools.concepts.Mutable;
  30 import org.opendaylight.yangtools.yang.common.AbstractQName;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.common.QNameModule;
  33 import org.opendaylight.yangtools.yang.common.UnqualifiedQName;
  34 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  35 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextProvider;
  36 import org.opendaylight.yangtools.yang.model.api.EffectiveStatementInference;
  37 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.PathExpression;
  39 import org.opendaylight.yangtools.yang.model.api.PathExpression.DerefSteps;
  40 import org.opendaylight.yangtools.yang.model.api.PathExpression.LocationPathSteps;
  41 import org.opendaylight.yangtools.yang.model.api.PathExpression.Steps;
  42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaTreeInference;
  44 import org.opendaylight.yangtools.yang.model.api.TypeAware;
  45 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.CaseEffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  54 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  55 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
  57 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  58 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  59 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  60 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  61 import org.opendaylight.yangtools.yang.model.spi.AbstractEffectiveStatementInference;
  62 import org.opendaylight.yangtools.yang.model.spi.DefaultSchemaTreeInference;
  63 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath;
  64 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.AxisStep;
  65 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.QNameStep;
  66 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.Step;
  67 import org.opendaylight.yangtools.yang.xpath.api.YangXPathAxis;
  68
  69 /**
  70  * A state tracking utility for walking {@link EffectiveModelContext}'s contents along schema/grouping namespaces. This
  71  * is conceptually a stack, tracking {@link EffectiveStatement}s encountered along traversal.
  72  *
  73  * <p>
  74  * This is meant to be a replacement concept for the use of {@link SchemaPath} in various places, notably
  75  * in {@link SchemaContextUtil} methods.
  76  *
  77  * <p>
  78  * This class is designed for single-threaded uses and does not make any guarantees around concurrent access.
  79  */
  80 @Beta
  81 public final class SchemaInferenceStack implements Mutable, EffectiveModelContextProvider, LeafrefResolver {
  82     /**
  83      * Semantic binding of {@link EffectiveStatementInference} produced by {@link SchemaInferenceStack}. Sequence of
  84      * {@link #statementPath()} is implementation-specific.
  85      */
  86     @Beta
  87     public static final class Inference extends AbstractEffectiveStatementInference<EffectiveStatement<?, ?>> {
  88         private final ArrayDeque<EffectiveStatement<?, ?>> deque;
  89         private final ModuleEffectiveStatement currentModule;
  90         private final int groupingDepth;
  91         private final boolean clean;
  92
  93         Inference(final @NonNull EffectiveModelContext modelContext, final ArrayDeque<EffectiveStatement<?, ?>> deque,
  94                 final ModuleEffectiveStatement currentModule, final int groupingDepth, final boolean clean) {
  95             super(modelContext);
  96             this.deque = requireNonNull(deque);
  97             this.currentModule = currentModule;
  98             this.groupingDepth = groupingDepth;
  99             this.clean = clean;
 100         }
 101
 102         /**
 103          * Create a new stack backed by an effective model and set up to point and specified data tree node.
 104          *
 105          * @param effectiveModel EffectiveModelContext to which this stack is attached
 106          * @param qnames Data tree path qnames
 107          * @return A new stack
 108          * @throws NullPointerException if any argument is null or path contains a null element
 109          * @throws IllegalArgumentException if a path element cannot be found
 110          */
 111         public static @NonNull Inference ofDataTreePath(final EffectiveModelContext effectiveModel,
 112                 final QName... qnames) {
 113             return SchemaInferenceStack.ofDataTreePath(effectiveModel, qnames).toInference();
 114         }
 115
 116         @Override
 117         public List<EffectiveStatement<?, ?>> statementPath() {
 118             return ImmutableList.copyOf(deque.descendingIterator());
 119         }
 120
 121         /**
 122          * Convert this inference into a {@link SchemaInferenceStack}.
 123          *
 124          * @return A new stack
 125          */
 126         public @NonNull SchemaInferenceStack toSchemaInferenceStack() {
 127             return new SchemaInferenceStack(getEffectiveModelContext(), deque, currentModule, groupingDepth, clean);
 128         }
 129     }
 130
 131     private final @NonNull EffectiveModelContext effectiveModel;
 132     private final ArrayDeque<EffectiveStatement<?, ?>> deque;
 133
 134     private @Nullable ModuleEffectiveStatement currentModule;
 135     private int groupingDepth;
 136
 137     // True if there were only steps along grouping and schema tree, hence it is consistent with SchemaNodeIdentifier
 138     // False if we have evidence of a data tree lookup succeeding
 139     private boolean clean;
 140
 141     private SchemaInferenceStack(final EffectiveModelContext effectiveModel, final int expectedSize) {
 142         this.deque = new ArrayDeque<>(expectedSize);
 143         this.effectiveModel = requireNonNull(effectiveModel);
 144         this.clean = true;
 145     }
 146
 147     private SchemaInferenceStack(final SchemaInferenceStack source) {
 148         this.deque = source.deque.clone();
 149         this.effectiveModel = source.effectiveModel;
 150         this.currentModule = source.currentModule;
 151         this.groupingDepth = source.groupingDepth;
 152         this.clean = source.clean;
 153     }
 154
 155     private SchemaInferenceStack(final EffectiveModelContext effectiveModel,
 156             final ArrayDeque<EffectiveStatement<?, ?>> deque, final ModuleEffectiveStatement currentModule,
 157             final int groupingDepth, final boolean clean) {
 158         this.effectiveModel = requireNonNull(effectiveModel);
 159         this.deque = deque.clone();
 160         this.currentModule = currentModule;
 161         this.groupingDepth = groupingDepth;
 162         this.clean = clean;
 163     }
 164
 165     private SchemaInferenceStack(final EffectiveModelContext effectiveModel) {
 166         this.effectiveModel = requireNonNull(effectiveModel);
 167         this.deque = new ArrayDeque<>();
 168         this.clean = true;
 169     }
 170
 171     /**
 172      * Create a new empty stack backed by an effective model.
 173      *
 174      * @param effectiveModel EffectiveModelContext to which this stack is attached
 175      * @return A new stack
 176      * @throws NullPointerException if {@code effectiveModel} is null
 177      */
 178     public static @NonNull SchemaInferenceStack of(final EffectiveModelContext effectiveModel) {
 179         return new SchemaInferenceStack(effectiveModel);
 180     }
 181
 182     /**
 183      * Create a new stack backed by an effective model, pointing to specified schema node identified by
 184      * {@link Absolute}.
 185      *
 186      * @param effectiveModel EffectiveModelContext to which this stack is attached
 187      * @return A new stack
 188      * @throws NullPointerException if {@code effectiveModel} is null
 189      * @throws IllegalArgumentException if {@code path} cannot be resolved in the effective model
 190      */
 191     public static @NonNull SchemaInferenceStack of(final EffectiveModelContext effectiveModel, final Absolute path) {
 192         final SchemaInferenceStack ret = new SchemaInferenceStack(effectiveModel);
 193         path.getNodeIdentifiers().forEach(ret::enterSchemaTree);
 194         return ret;
 195     }
 196
 197     /**
 198      * Create a new stack from an {@link EffectiveStatementInference}.
 199      *
 200      * @param inference Inference to use for initialization
 201      * @return A new stack
 202      * @throws NullPointerException if {@code inference} is null
 203      * @throws IllegalArgumentException if {@code inference} implementation is not supported
 204      */
 205     public static @NonNull SchemaInferenceStack ofInference(final EffectiveStatementInference inference) {
 206         if (inference.statementPath().isEmpty()) {
 207             return new SchemaInferenceStack(inference.getEffectiveModelContext());
 208         } else if (inference instanceof SchemaTreeInference) {
 209             return ofInference((SchemaTreeInference) inference);
 210         } else if (inference instanceof Inference) {
 211             return ((Inference) inference).toSchemaInferenceStack();
 212         } else {
 213             throw new IllegalArgumentException("Unsupported Inference " + inference);
 214         }
 215     }
 216
 217     /**
 218      * Create a new stack from an {@link SchemaTreeInference}.
 219      *
 220      * @param inference SchemaTreeInference to use for initialization
 221      * @return A new stack
 222      * @throws NullPointerException if {@code inference} is null
 223      * @throws IllegalArgumentException if {@code inference} cannot be resolved to a valid stack
 224      */
 225     public static @NonNull SchemaInferenceStack ofInference(final SchemaTreeInference inference) {
 226         return of(inference.getEffectiveModelContext(), inference.toSchemaNodeIdentifier());
 227     }
 228
 229     /**
 230      * Create a new stack backed by an effective model and set up to point and specified data tree node.
 231      *
 232      * @param effectiveModel EffectiveModelContext to which this stack is attached
 233      * @return A new stack
 234      * @throws NullPointerException if any argument is null or path contains a null element
 235      * @throws IllegalArgumentException if a path element cannot be found
 236      */
 237     public static @NonNull SchemaInferenceStack ofDataTreePath(final EffectiveModelContext effectiveModel,
 238             final QName... path) {
 239         final SchemaInferenceStack ret = new SchemaInferenceStack(effectiveModel);
 240         for (QName qname : path) {
 241             ret.enterDataTree(qname);
 242         }
 243         return ret;
 244     }
 245
 246     /**
 247      * Create a new stack backed by an effective model, pointing to specified schema node identified by an absolute
 248      * {@link SchemaPath} and its {@link SchemaPath#getPathFromRoot()}.
 249      *
 250      * @param effectiveModel EffectiveModelContext to which this stack is attached
 251      * @return A new stack
 252      * @throws NullPointerException {@code effectiveModel} is null
 253      * @throws IllegalArgumentException if {@code path} cannot be resolved in the effective model or if it is not an
 254      *                                  absolute path.
 255      */
 256     @Deprecated
 257     public static @NonNull SchemaInferenceStack ofInstantiatedPath(final EffectiveModelContext effectiveModel,
 258             final SchemaPath path) {
 259         checkArgument(path.isAbsolute(), "Cannot operate on relative path %s", path);
 260         final SchemaInferenceStack ret = new SchemaInferenceStack(effectiveModel);
 261         path.getPathFromRoot().forEach(ret::enterSchemaTree);
 262         return ret;
 263     }
 264
 265     @Override
 266     public EffectiveModelContext getEffectiveModelContext() {
 267         return effectiveModel;
 268     }
 269
 270     /**
 271      * Create a deep copy of this object.
 272      *
 273      * @return An isolated copy of this object
 274      */
 275     public @NonNull SchemaInferenceStack copy() {
 276         return new SchemaInferenceStack(this);
 277     }
 278
 279     /**
 280      * Check if this stack is empty.
 281      *
 282      * @return True if this stack has not entered any node.
 283      */
 284     public boolean isEmpty() {
 285         return deque.isEmpty();
 286     }
 287
 288     /**
 289      * Return the statement at the top of the stack.
 290      *
 291      * @return Top statement
 292      * @throws IllegalStateException if the stack is empty
 293      */
 294     public @NonNull EffectiveStatement<?, ?> currentStatement() {
 295         return checkNonNullState(deque.peekFirst());
 296     }
 297
 298     /**
 299      * Return current module the stack has entered.
 300      *
 301      * @return Current module
 302      * @throws IllegalStateException if the stack is empty
 303      */
 304     public @NonNull ModuleEffectiveStatement currentModule() {
 305         return checkNonNullState(currentModule);
 306     }
 307
 308     /**
 309      * Check if the stack is in instantiated context. This indicates the stack is non-empty and there are only screma
 310      * tree statements in the stack.
 311      *
 312      * @return False if the stack is empty or contains a statement which is not a {@link SchemaTreeEffectiveStatement},
 313      *         true otherwise.
 314      */
 315     public boolean inInstantiatedContext() {
 316         return groupingDepth == 0 && !deque.isEmpty()
 317             && deque.stream().allMatch(SchemaTreeEffectiveStatement.class::isInstance);
 318     }
 319
 320     /**
 321      * Check if the stack is in a {@code grouping} context.
 322      *
 323      * @return False if the stack contains a grouping.
 324      */
 325     public boolean inGrouping() {
 326         return groupingDepth != 0;
 327     }
 328
 329     /**
 330      * Reset this stack to empty state.
 331      */
 332     public void clear() {
 333         deque.clear();
 334         currentModule = null;
 335         groupingDepth = 0;
 336         clean = true;
 337     }
 338
 339     /**
 340      * Lookup a {@code choice} by its node identifier and push it to the stack. This step is very similar to
 341      * {@link #enterSchemaTree(QName)}, except it handles the use case where traversal ignores actual {@code case}
 342      * intermediate schema tree children.
 343      *
 344      * @param nodeIdentifier Node identifier of the choice to enter
 345      * @return Resolved choice
 346      * @throws NullPointerException if {@code nodeIdentifier} is null
 347      * @throws IllegalArgumentException if the corresponding choice cannot be found
 348      */
 349     public @NonNull ChoiceEffectiveStatement enterChoice(final QName nodeIdentifier) {
 350         final EffectiveStatement<?, ?> parent = deque.peek();
 351         if (parent instanceof ChoiceEffectiveStatement) {
 352             return enterChoice((ChoiceEffectiveStatement) parent, nodeIdentifier);
 353         }
 354
 355         // Fall back to schema tree lookup. Note if it results in non-choice, we rewind before reporting an error
 356         final SchemaTreeEffectiveStatement<?> result = enterSchemaTree(nodeIdentifier);
 357         if (result instanceof ChoiceEffectiveStatement) {
 358             return (ChoiceEffectiveStatement) result;
 359         }
 360         exit();
 361         throw new IllegalArgumentException("Choice " + nodeIdentifier + " not present");
 362     }
 363
 364     // choice -> choice transition, we have to deal with intermediate case nodes
 365     private @NonNull ChoiceEffectiveStatement enterChoice(final ChoiceEffectiveStatement parent,
 366             final QName nodeIdentifier) {
 367         for (EffectiveStatement<?, ?> stmt : parent.effectiveSubstatements()) {
 368             if (stmt instanceof CaseEffectiveStatement) {
 369                 final Optional<ChoiceEffectiveStatement> optMatch = ((CaseEffectiveStatement) stmt)
 370                     .findSchemaTreeNode(nodeIdentifier)
 371                     .filter(ChoiceEffectiveStatement.class::isInstance)
 372                     .map(ChoiceEffectiveStatement.class::cast);
 373                 if (optMatch.isPresent()) {
 374                     final SchemaTreeEffectiveStatement<?> match = optMatch.orElseThrow();
 375                     deque.push(match);
 376                     clean = false;
 377                     return (ChoiceEffectiveStatement) match;
 378                 }
 379             }
 380         }
 381         throw new IllegalArgumentException("Choice " + nodeIdentifier + " not present");
 382     }
 383
 384     /**
 385      * Lookup a {@code grouping} by its node identifier and push it to the stack.
 386      *
 387      * @param nodeIdentifier Node identifier of the grouping to enter
 388      * @return Resolved grouping
 389      * @throws NullPointerException if {@code nodeIdentifier} is null
 390      * @throws IllegalArgumentException if the corresponding grouping cannot be found
 391      */
 392     public @NonNull GroupingEffectiveStatement enterGrouping(final QName nodeIdentifier) {
 393         return pushGrouping(requireNonNull(nodeIdentifier));
 394     }
 395
 396     /**
 397      * Lookup a {@code schema tree} child by its node identifier and push it to the stack.
 398      *
 399      * @param nodeIdentifier Node identifier of the schema tree child to enter
 400      * @return Resolved schema tree child
 401      * @throws NullPointerException if {@code nodeIdentifier} is null
 402      * @throws IllegalArgumentException if the corresponding child cannot be found
 403      */
 404     public @NonNull SchemaTreeEffectiveStatement<?> enterSchemaTree(final QName nodeIdentifier) {
 405         return pushSchema(requireNonNull(nodeIdentifier));
 406     }
 407
 408     /**
 409      * Lookup a {@code schema tree} node by its schema node identifier and push it to the stack.
 410      *
 411      * @param nodeIdentifier Schema node identifier of the schema tree node to enter
 412      * @return Resolved schema tree node
 413      * @throws NullPointerException if {@code nodeIdentifier} is null
 414      * @throws IllegalArgumentException if the corresponding node cannot be found
 415      */
 416     public @NonNull SchemaTreeEffectiveStatement<?> enterSchemaTree(final SchemaNodeIdentifier nodeIdentifier) {
 417         if (nodeIdentifier instanceof Absolute) {
 418             clear();
 419         }
 420
 421         final Iterator<QName> it = nodeIdentifier.getNodeIdentifiers().iterator();
 422         SchemaTreeEffectiveStatement<?> ret;
 423         do {
 424             ret = enterSchemaTree(it.next());
 425         } while (it.hasNext());
 426
 427         return ret;
 428     }
 429
 430     /**
 431      * Lookup a {@code schema tree} child by its node identifier and push it to the stack.
 432      *
 433      * @param nodeIdentifier Node identifier of the date tree child to enter
 434      * @return Resolved date tree child
 435      * @throws NullPointerException if {@code nodeIdentifier} is null
 436      * @throws IllegalArgumentException if the corresponding child cannot be found
 437      */
 438     public @NonNull DataTreeEffectiveStatement<?> enterDataTree(final QName nodeIdentifier) {
 439         return pushData(requireNonNull(nodeIdentifier));
 440     }
 441
 442     /**
 443      * Lookup a {@code typedef} by its node identifier and push it to the stack.
 444      *
 445      * @param nodeIdentifier Node identifier of the typedef to enter
 446      * @return Resolved choice
 447      * @throws NullPointerException if {@code nodeIdentifier} is null
 448      * @throws IllegalArgumentException if the corresponding typedef cannot be found
 449      */
 450     public @NonNull TypedefEffectiveStatement enterTypedef(final QName nodeIdentifier) {
 451         return pushTypedef(requireNonNull(nodeIdentifier));
 452     }
 453
 454     /**
 455      * Pop the current statement from the stack.
 456      *
 457      * @return Previous statement
 458      * @throws NoSuchElementException if this stack is empty
 459      */
 460     public @NonNull EffectiveStatement<?, ?> exit() {
 461         final EffectiveStatement<?, ?> prev = deque.pop();
 462         if (prev instanceof GroupingEffectiveStatement) {
 463             --groupingDepth;
 464         }
 465         if (deque.isEmpty()) {
 466             currentModule = null;
 467             clean = true;
 468         }
 469         return prev;
 470     }
 471
 472     /**
 473      * Pop the current statement from the stack, asserting it is a {@link DataTreeEffectiveStatement} and that
 474      * subsequent {@link #enterDataTree(QName)} will find it again.
 475      *
 476      * @return Previous statement
 477      * @throws NoSuchElementException if this stack is empty
 478      * @throws IllegalStateException if current statement is not a DataTreeEffectiveStatement or if its parent is not
 479      *                               a {@link DataTreeAwareEffectiveStatement}
 480      */
 481     public @NonNull DataTreeEffectiveStatement<?> exitToDataTree() {
 482         final EffectiveStatement<?, ?> child = exit();
 483         checkState(child instanceof DataTreeEffectiveStatement, "Unexpected current %s", child);
 484         final EffectiveStatement<?, ?> parent = deque.peekFirst();
 485         checkState(parent == null || parent instanceof DataTreeAwareEffectiveStatement, "Unexpected parent %s", parent);
 486         return (DataTreeEffectiveStatement<?>) child;
 487     }
 488
 489
 490     @Override
 491     public TypeDefinition<?> resolveLeafref(final LeafrefTypeDefinition type) {
 492         final SchemaInferenceStack tmp = copy();
 493
 494         LeafrefTypeDefinition current = type;
 495         while (true) {
 496             final EffectiveStatement<?, ?> resolved = tmp.resolvePathExpression(current.getPathStatement());
 497             checkState(resolved instanceof TypeAware, "Unexpected result %s resultion of %s", resolved, type);
 498             final TypeDefinition<?> result = ((TypedDataSchemaNode) resolved).getType();
 499             if (result instanceof LeafrefTypeDefinition) {
 500                 checkArgument(result != type, "Resolution of %s loops back onto itself via %s", type, current);
 501                 current = (LeafrefTypeDefinition) result;
 502             } else {
 503                 return result;
 504             }
 505         }
 506     }
 507
 508     /**
 509      * Resolve a {@link PathExpression}.
 510      *
 511      * <p>
 512      * Note if this method throws, this stack may be in an undefined state.
 513      *
 514      * @param path Requested path
 515      * @return Resolved schema tree child
 516      * @throws NullPointerException if {@code path} is null
 517      * @throws IllegalArgumentException if the target node cannot be found
 518      * @throws VerifyException if path expression is invalid
 519      */
 520     public @NonNull EffectiveStatement<?, ?> resolvePathExpression(final PathExpression path) {
 521         final Steps steps = path.getSteps();
 522         if (steps instanceof LocationPathSteps) {
 523             return resolveLocationPath(((LocationPathSteps) steps).getLocationPath());
 524         } else if (steps instanceof DerefSteps) {
 525             return resolveDeref((DerefSteps) steps);
 526         } else {
 527             throw new VerifyException("Unhandled steps " + steps);
 528         }
 529     }
 530
 531     private @NonNull EffectiveStatement<?, ?> resolveDeref(final DerefSteps deref) {
 532         final EffectiveStatement<?, ?> leafRefSchemaNode = currentStatement();
 533         final YangLocationPath.Relative derefArg = deref.getDerefArgument();
 534         final EffectiveStatement<?, ?> derefStmt = resolveLocationPath(derefArg);
 535         checkArgument(derefStmt != null, "Cannot find deref(%s) target node %s in context of %s",
 536                 derefArg, leafRefSchemaNode);
 537         checkArgument(derefStmt instanceof TypedDataSchemaNode, "deref(%s) resolved to non-typed %s", derefArg,
 538                 derefStmt);
 539
 540         // We have a deref() target, decide what to do about it
 541         final TypeDefinition<?> targetType = ((TypedDataSchemaNode) derefStmt).getType();
 542         if (targetType instanceof InstanceIdentifierTypeDefinition) {
 543             // Static inference breaks down, we cannot determine where this points to
 544             // FIXME: dedicated exception, users can recover from it, derive from IAE
 545             throw new UnsupportedOperationException("Cannot infer instance-identifier reference " + targetType);
 546         }
 547
 548         // deref() is defined only for instance-identifier and leafref types, handle the latter
 549         checkArgument(targetType instanceof LeafrefTypeDefinition, "Illegal target type %s", targetType);
 550
 551         final PathExpression dereferencedLeafRefPath = ((LeafrefTypeDefinition) targetType).getPathStatement();
 552         EffectiveStatement<?, ?> derefNode = resolvePathExpression(dereferencedLeafRefPath);
 553         checkArgument(derefStmt != null, "Can not find target node of dereferenced node %s", derefStmt);
 554         checkArgument(derefNode instanceof LeafSchemaNode, "Unexpected %s reference in %s", deref,
 555                 dereferencedLeafRefPath);
 556         return resolveLocationPath(deref.getRelativePath());
 557     }
 558
 559     private @NonNull EffectiveStatement<?, ?> resolveLocationPath(final YangLocationPath path) {
 560         // get the default namespace before we clear and loose our deque
 561         final QNameModule defaultNamespace = deque.isEmpty() ? null : ((QName) deque.peek().argument()).getModule();
 562         if (path.isAbsolute()) {
 563             clear();
 564         }
 565
 566         EffectiveStatement<?, ?> current = null;
 567         for (Step step : path.getSteps()) {
 568             final YangXPathAxis axis = step.getAxis();
 569             switch (axis) {
 570                 case PARENT:
 571                     verify(step instanceof AxisStep, "Unexpected parent step %s", step);
 572                     try {
 573                         current = exitToDataTree();
 574                     } catch (IllegalStateException | NoSuchElementException e) {
 575                         throw new IllegalArgumentException("Illegal parent access in " + path, e);
 576                     }
 577                     break;
 578                 case CHILD:
 579                     verify(step instanceof QNameStep, "Unexpected child step %s", step);
 580                     current = enterChild((QNameStep) step, defaultNamespace);
 581                     break;
 582                 default:
 583                     throw new VerifyException("Unexpected step " + step);
 584             }
 585         }
 586
 587         return verifyNotNull(current);
 588     }
 589
 590     private @NonNull EffectiveStatement<?, ?> enterChild(final QNameStep step, final QNameModule defaultNamespace) {
 591         final AbstractQName toResolve = step.getQName();
 592         final QName qname;
 593         if (toResolve instanceof QName) {
 594             qname = (QName) toResolve;
 595         } else if (toResolve instanceof UnqualifiedQName) {
 596             checkArgument(defaultNamespace != null, "Can not find target module of step %s", step);
 597             qname = ((UnqualifiedQName) toResolve).bindTo(defaultNamespace);
 598         } else {
 599             throw new VerifyException("Unexpected child step QName " + toResolve);
 600         }
 601         return enterDataTree(qname);
 602     }
 603
 604     /**
 605      * Return an {@link Inference} equivalent of current state.
 606      *
 607      * @return An {@link Inference}
 608      */
 609     public @NonNull Inference toInference() {
 610         return new Inference(effectiveModel, deque.clone(), currentModule, groupingDepth, clean);
 611     }
 612
 613     /**
 614      * Return an {@link SchemaTreeInference} equivalent of current state.
 615      *
 616      * @return An {@link SchemaTreeInference}
 617      * @throws IllegalStateException if current state cannot be converted to a {@link SchemaTreeInference}
 618      */
 619     public @NonNull SchemaTreeInference toSchemaTreeInference() {
 620         return DefaultSchemaTreeInference.of(getEffectiveModelContext(), toSchemaNodeIdentifier());
 621     }
 622
 623     /**
 624      * Convert current state into an absolute schema node identifier.
 625      *
 626      * @return Absolute schema node identifier representing current state
 627      * @throws IllegalStateException if current state is not instantiated
 628      */
 629     public @NonNull Absolute toSchemaNodeIdentifier() {
 630         checkState(inInstantiatedContext(), "Cannot convert uninstantiated context %s", this);
 631         return Absolute.of(ImmutableList.<QName>builderWithExpectedSize(deque.size())
 632             .addAll(simplePathFromRoot())
 633             .build());
 634     }
 635
 636     /**
 637      * Convert current state into a SchemaPath.
 638      *
 639      * @return Absolute SchemaPath representing current state
 640      * @throws IllegalStateException if current state is not instantiated
 641      * @deprecated This method is meant only for interoperation with SchemaPath-based APIs.
 642      */
 643     @Deprecated
 644     public @NonNull SchemaPath toSchemaPath() {
 645         SchemaPath ret = SchemaPath.ROOT;
 646         final Iterator<QName> it = simplePathFromRoot();
 647         while (it.hasNext()) {
 648             ret = ret.createChild(it.next());
 649         }
 650         return ret;
 651     }
 652
 653     /**
 654      * Return an iterator along {@link SchemaPath#getPathFromRoot()}. This method is a faster equivalent of
 655      * {@code toSchemaPath().getPathFromRoot().iterator()}.
 656      *
 657      * @return An unmodifiable iterator
 658      */
 659     @Deprecated
 660     public @NonNull Iterator<QName> schemaPathIterator() {
 661         return Iterators.unmodifiableIterator(simplePathFromRoot());
 662     }
 663
 664     @Override
 665     public String toString() {
 666         return MoreObjects.toStringHelper(this).add("stack", deque).toString();
 667     }
 668
 669     private @NonNull GroupingEffectiveStatement pushGrouping(final @NonNull QName nodeIdentifier) {
 670         final EffectiveStatement<?, ?> parent = deque.peekFirst();
 671         return parent != null ? pushGrouping(parent, nodeIdentifier) : pushFirstGrouping(nodeIdentifier);
 672     }
 673
 674     private @NonNull GroupingEffectiveStatement pushGrouping(final @NonNull EffectiveStatement<?, ?> parent,
 675             final @NonNull QName nodeIdentifier) {
 676         final GroupingEffectiveStatement ret = parent.streamEffectiveSubstatements(GroupingEffectiveStatement.class)
 677             .filter(stmt -> nodeIdentifier.equals(stmt.argument()))
 678             .findFirst()
 679             .orElseThrow(() -> new IllegalArgumentException("Grouping " + nodeIdentifier + " not present"));
 680         deque.push(ret);
 681         ++groupingDepth;
 682         return ret;
 683     }
 684
 685     private @NonNull GroupingEffectiveStatement pushFirstGrouping(final @NonNull QName nodeIdentifier) {
 686         final ModuleEffectiveStatement module = getModule(nodeIdentifier);
 687         final GroupingEffectiveStatement ret = pushGrouping(module, nodeIdentifier);
 688         currentModule = module;
 689         return ret;
 690     }
 691
 692     private @NonNull SchemaTreeEffectiveStatement<?> pushSchema(final @NonNull QName nodeIdentifier) {
 693         final EffectiveStatement<?, ?> parent = deque.peekFirst();
 694         return parent != null ? pushSchema(parent, nodeIdentifier) : pushFirstSchema(nodeIdentifier);
 695     }
 696
 697     private @NonNull SchemaTreeEffectiveStatement<?> pushSchema(final EffectiveStatement<?, ?> parent,
 698             final @NonNull QName nodeIdentifier) {
 699         checkState(parent instanceof SchemaTreeAwareEffectiveStatement, "Cannot descend schema tree at %s", parent);
 700         return pushSchema((SchemaTreeAwareEffectiveStatement<?, ?>) parent, nodeIdentifier);
 701     }
 702
 703     private @NonNull SchemaTreeEffectiveStatement<?> pushSchema(
 704             final @NonNull SchemaTreeAwareEffectiveStatement<?, ?> parent, final @NonNull QName nodeIdentifier) {
 705         final SchemaTreeEffectiveStatement<?> ret = parent.findSchemaTreeNode(nodeIdentifier).orElseThrow(
 706             () -> new IllegalArgumentException("Schema tree child " + nodeIdentifier + " not present"));
 707         deque.push(ret);
 708         return ret;
 709     }
 710
 711     private @NonNull SchemaTreeEffectiveStatement<?> pushFirstSchema(final @NonNull QName nodeIdentifier) {
 712         final ModuleEffectiveStatement module = getModule(nodeIdentifier);
 713         final SchemaTreeEffectiveStatement<?> ret = pushSchema(module, nodeIdentifier);
 714         currentModule = module;
 715         return ret;
 716     }
 717
 718     private @NonNull DataTreeEffectiveStatement<?> pushData(final @NonNull QName nodeIdentifier) {
 719         final EffectiveStatement<?, ?> parent = deque.peekFirst();
 720         return parent != null ? pushData(parent, nodeIdentifier) : pushFirstData(nodeIdentifier);
 721     }
 722
 723     private @NonNull DataTreeEffectiveStatement<?> pushData(final EffectiveStatement<?, ?> parent,
 724             final @NonNull QName nodeIdentifier) {
 725         checkState(parent instanceof DataTreeAwareEffectiveStatement, "Cannot descend data tree at %s", parent);
 726         return pushData((DataTreeAwareEffectiveStatement<?, ?>) parent, nodeIdentifier);
 727     }
 728
 729     private @NonNull DataTreeEffectiveStatement<?> pushData(final @NonNull DataTreeAwareEffectiveStatement<?, ?> parent,
 730             final @NonNull QName nodeIdentifier) {
 731         final DataTreeEffectiveStatement<?> ret = parent.findDataTreeNode(nodeIdentifier).orElseThrow(
 732             () -> new IllegalArgumentException("Data tree child " + nodeIdentifier + " not present"));
 733         deque.push(ret);
 734         clean = false;
 735         return ret;
 736     }
 737
 738     private @NonNull DataTreeEffectiveStatement<?> pushFirstData(final @NonNull QName nodeIdentifier) {
 739         final ModuleEffectiveStatement module = getModule(nodeIdentifier);
 740         final DataTreeEffectiveStatement<?> ret = pushData(module, nodeIdentifier);
 741         currentModule = module;
 742         return ret;
 743     }
 744
 745     private @NonNull TypedefEffectiveStatement pushTypedef(final @NonNull QName nodeIdentifier) {
 746         final EffectiveStatement<?, ?> parent = deque.peekFirst();
 747         return parent != null ? pushTypedef(parent, nodeIdentifier) : pushFirstTypedef(nodeIdentifier);
 748     }
 749
 750     private @NonNull TypedefEffectiveStatement pushTypedef(final @NonNull EffectiveStatement<?, ?> parent,
 751             final @NonNull QName nodeIdentifier) {
 752         // TODO: 8.0.0: revisit this once we have TypedefNamespace working
 753         final TypedefEffectiveStatement ret = parent.streamEffectiveSubstatements(TypedefEffectiveStatement.class)
 754             .filter(stmt -> nodeIdentifier.equals(stmt.argument()))
 755             .findFirst()
 756             .orElseThrow(() -> new IllegalArgumentException("Grouping " + nodeIdentifier + " not present"));
 757         deque.push(ret);
 758         return ret;
 759     }
 760
 761     private @NonNull TypedefEffectiveStatement pushFirstTypedef(final @NonNull QName nodeIdentifier) {
 762         final ModuleEffectiveStatement module = getModule(nodeIdentifier);
 763         final TypedefEffectiveStatement ret = pushTypedef(module, nodeIdentifier);
 764         currentModule = module;
 765         return ret;
 766     }
 767
 768     private @NonNull ModuleEffectiveStatement getModule(final @NonNull QName nodeIdentifier) {
 769         final ModuleEffectiveStatement module = effectiveModel.getModuleStatements().get(nodeIdentifier.getModule());
 770         checkArgument(module != null, "Module for %s not found", nodeIdentifier);
 771         return module;
 772     }
 773
 774     // Unified access to queue iteration for addressing purposes. Since we keep 'logical' steps as executed by user
 775     // at this point, conversion to SchemaNodeIdentifier may be needed. We dispatch based on 'clean'.
 776     private Iterator<QName> simplePathFromRoot() {
 777         return clean ? iterateQNames() : reconstructQNames();
 778     }
 779
 780     private Iterator<QName> iterateQNames() {
 781         return Iterators.transform(deque.descendingIterator(), stmt -> {
 782             final Object argument = stmt.argument();
 783             verify(argument instanceof QName, "Unexpected statement %s", stmt);
 784             return (QName) argument;
 785         });
 786     }
 787
 788     // So there are some data tree steps in the stack... we essentially need to convert a data tree item into a series
 789     // of schema tree items. This means at least N searches, but after they are done, we get an opportunity to set the
 790     // clean flag.
 791     private Iterator<QName> reconstructQNames() {
 792         // Let's walk all statements and decipher them into a temporary stack
 793         final SchemaInferenceStack tmp = new SchemaInferenceStack(effectiveModel, deque.size());
 794         final Iterator<EffectiveStatement<?, ?>> it = deque.descendingIterator();
 795         while (it.hasNext()) {
 796             final EffectiveStatement<?, ?> stmt = it.next();
 797             // Order of checks is significant
 798             if (stmt instanceof DataTreeEffectiveStatement) {
 799                 tmp.resolveDataTreeSteps(((DataTreeEffectiveStatement<?>) stmt).argument());
 800             } else if (stmt instanceof ChoiceEffectiveStatement) {
 801                 tmp.resolveChoiceSteps(((ChoiceEffectiveStatement) stmt).argument());
 802             } else if (stmt instanceof SchemaTreeEffectiveStatement) {
 803                 tmp.enterSchemaTree(((SchemaTreeEffectiveStatement<?> )stmt).argument());
 804             } else if (stmt instanceof GroupingEffectiveStatement) {
 805                 tmp.enterGrouping(((GroupingEffectiveStatement) stmt).argument());
 806             } else if (stmt instanceof TypedefEffectiveStatement) {
 807                 tmp.enterTypedef(((TypedefEffectiveStatement) stmt).argument());
 808             } else {
 809                 throw new VerifyException("Unexpected statement " + stmt);
 810             }
 811         }
 812
 813         // if the sizes match, we did not jump through hoops. let's remember that for future.
 814         clean = deque.size() == tmp.deque.size();
 815         return tmp.iterateQNames();
 816     }
 817
 818     private void resolveChoiceSteps(final @NonNull QName nodeIdentifier) {
 819         final EffectiveStatement<?, ?> parent = deque.peekFirst();
 820         if (parent instanceof ChoiceEffectiveStatement) {
 821             resolveChoiceSteps((ChoiceEffectiveStatement) parent, nodeIdentifier);
 822         } else {
 823             enterSchemaTree(nodeIdentifier);
 824         }
 825     }
 826
 827     private void resolveChoiceSteps(final @NonNull ChoiceEffectiveStatement parent,
 828             final @NonNull QName nodeIdentifier) {
 829         for (EffectiveStatement<?, ?> stmt : parent.effectiveSubstatements()) {
 830             if (stmt instanceof CaseEffectiveStatement) {
 831                 final CaseEffectiveStatement caze = (CaseEffectiveStatement) stmt;
 832                 final SchemaTreeEffectiveStatement<?> found = caze.findSchemaTreeNode(nodeIdentifier).orElse(null);
 833                 if (found instanceof ChoiceEffectiveStatement) {
 834                     deque.push(caze);
 835                     deque.push(found);
 836                     return;
 837                 }
 838             }
 839         }
 840         throw new VerifyException("Failed to resolve " + nodeIdentifier + " in " + parent);
 841     }
 842
 843     private void resolveDataTreeSteps(final @NonNull QName nodeIdentifier) {
 844         final EffectiveStatement<?, ?> parent = deque.peekFirst();
 845         if (parent != null) {
 846             verify(parent instanceof SchemaTreeAwareEffectiveStatement, "Unexpected parent %s", parent);
 847             resolveDataTreeSteps((SchemaTreeAwareEffectiveStatement<?, ?>) parent, nodeIdentifier);
 848             return;
 849         }
 850
 851         final ModuleEffectiveStatement module = getModule(nodeIdentifier);
 852         resolveDataTreeSteps(module, nodeIdentifier);
 853         currentModule = module;
 854     }
 855
 856     private void resolveDataTreeSteps(final @NonNull SchemaTreeAwareEffectiveStatement<?, ?> parent,
 857             final @NonNull QName nodeIdentifier) {
 858         // The algebra of identifiers in 'schema tree versus data tree':
 859         // - data tree parents are always schema tree parents
 860         // - data tree children are always schema tree children
 861
 862         // that implies that a data tree parent must satisfy schema tree queries with data tree children,
 863         // so a successful lookup of 'data tree parent -> child' and 'schema tree parent -> child' has to be the same
 864         // for a direct lookup.
 865         final SchemaTreeEffectiveStatement<?> found = parent.findSchemaTreeNode(nodeIdentifier).orElse(null);
 866         if (found instanceof DataTreeEffectiveStatement) {
 867             // ... and it did, we are done
 868             deque.push(found);
 869             return;
 870         }
 871
 872         // Alright, so now it's down to filtering choice/case statements. For that we keep some globally-reused state
 873         // and employ a recursive match.
 874         final Deque<EffectiveStatement<QName, ?>> match = new ArrayDeque<>();
 875         for (EffectiveStatement<?, ?> stmt : parent.effectiveSubstatements()) {
 876             if (stmt instanceof ChoiceEffectiveStatement
 877                 && searchChoice(match, (ChoiceEffectiveStatement) stmt, nodeIdentifier)) {
 878                 match.descendingIterator().forEachRemaining(deque::push);
 879                 return;
 880             }
 881         }
 882
 883         throw new VerifyException("Failed to resolve " + nodeIdentifier + " in " + parent);
 884     }
 885
 886     private static boolean searchCase(final @NonNull Deque<EffectiveStatement<QName, ?>> result,
 887             final @NonNull CaseEffectiveStatement parent, final @NonNull QName nodeIdentifier) {
 888         result.push(parent);
 889         for (EffectiveStatement<?, ?> stmt : parent.effectiveSubstatements()) {
 890             if (stmt instanceof DataTreeEffectiveStatement && nodeIdentifier.equals(stmt.argument())) {
 891                 result.push((DataTreeEffectiveStatement<?>) stmt);
 892                 return true;
 893             }
 894             if (stmt instanceof ChoiceEffectiveStatement
 895                 && searchChoice(result, (ChoiceEffectiveStatement) stmt, nodeIdentifier)) {
 896                 return true;
 897             }
 898         }
 899         result.pop();
 900         return false;
 901     }
 902
 903     private static boolean searchChoice(final @NonNull Deque<EffectiveStatement<QName, ?>> result,
 904             final @NonNull ChoiceEffectiveStatement parent, final @NonNull QName nodeIdentifier) {
 905         result.push(parent);
 906         for (EffectiveStatement<?, ?> stmt : parent.effectiveSubstatements()) {
 907             if (stmt instanceof CaseEffectiveStatement
 908                 && searchCase(result, (CaseEffectiveStatement) stmt, nodeIdentifier)) {
 909                 return true;
 910             }
 911         }
 912         result.pop();
 913         return false;
 914     }
 915
 916     private static <T> @NonNull T checkNonNullState(final @Nullable T obj) {
 917         if (obj == null) {
 918             throw new IllegalStateException("Cannot execute on empty stack");
 919         }
 920         return obj;
 921     }
 922 }