/
TreeIterators.cs
942 lines (811 loc) · 34.6 KB
/
TreeIterators.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.ComponentModel;
using System.Diagnostics;
using System.Xml.XPath;
namespace System.Xml.Xsl.Runtime
{
/// <summary>
/// Iterate over all descendant content nodes according to XPath descendant axis rules.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct DescendantIterator
{
private XmlNavigatorFilter _filter;
private XPathNavigator? _navCurrent, _navEnd;
private bool _hasFirst;
/// <summary>
/// Initialize the DescendantIterator (no possibility of duplicates).
/// </summary>
public void Create(XPathNavigator input, XmlNavigatorFilter filter, bool orSelf)
{
// Save input node as current node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, input);
_filter = filter;
// Position navEnd to the node at which the descendant scan should terminate
if (input.NodeType == XPathNodeType.Root)
{
_navEnd = null;
}
else
{
_navEnd = XmlQueryRuntime.SyncToNavigator(_navEnd, input);
_navEnd.MoveToNonDescendant();
}
// If self node matches, then return it first
_hasFirst = (orSelf && !_filter.IsFiltered(_navCurrent));
}
/// <summary>
/// Position this iterator to the next descendant node. Return false if there are no more descendant nodes.
/// Return true if the Current property is set to the next node in the iteration.
/// </summary>
public bool MoveNext()
{
if (_hasFirst)
{
_hasFirst = false;
return true;
}
return (_filter.MoveToFollowing(_navCurrent!, _navEnd));
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent!; }
}
}
/// <summary>
/// Iterate over all descendant content nodes according to XPath descendant axis rules. Eliminate duplicates by not
/// querying over nodes that are contained in the subtree of the previous node.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct DescendantMergeIterator
{
private XmlNavigatorFilter _filter;
private XPathNavigator _navCurrent, _navRoot, _navEnd;
private IteratorState _state;
private bool _orSelf;
private enum IteratorState
{
NoPrevious = 0,
NeedCurrent,
NeedDescendant,
}
/// <summary>
/// Initialize the DescendantIterator (merge multiple sets of descendant nodes in document order and remove duplicates).
/// </summary>
public void Create(XmlNavigatorFilter filter, bool orSelf)
{
_filter = filter;
_state = IteratorState.NoPrevious;
_orSelf = orSelf;
}
/// <summary>
/// Position this iterator to the next descendant node. Return IteratorResult.NoMoreNodes if there are no more
/// descendant nodes. Return IteratorResult.NeedInputNode if the next input node needs to be fetched.
/// Return IteratorResult.HaveCurrent if the Current property is set to the next node in the iteration.
/// </summary>
public IteratorResult MoveNext(XPathNavigator input)
{
if (_state != IteratorState.NeedDescendant)
{
if (input == null)
return IteratorResult.NoMoreNodes;
// Descendants of the input node will be duplicates if the input node is in the subtree
// of the previous root.
if (_state != IteratorState.NoPrevious && _navRoot.IsDescendant(input))
return IteratorResult.NeedInputNode;
// Save input node as current node and end of input's tree in navEnd
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, input);
_navRoot = XmlQueryRuntime.SyncToNavigator(_navRoot, input);
_navEnd = XmlQueryRuntime.SyncToNavigator(_navEnd, input);
_navEnd.MoveToNonDescendant();
_state = IteratorState.NeedDescendant;
// If self node matches, then return it
if (_orSelf && !_filter.IsFiltered(input))
return IteratorResult.HaveCurrentNode;
}
if (_filter.MoveToFollowing(_navCurrent, _navEnd))
return IteratorResult.HaveCurrentNode;
// No more descendants, so transition to NeedCurrent state and get the next input node
_state = IteratorState.NeedCurrent;
return IteratorResult.NeedInputNode;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true or IteratorResult.HaveCurrentNode.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
}
/// <summary>
/// Iterate over matching parent node according to XPath parent axis rules.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct ParentIterator
{
private XPathNavigator _navCurrent;
private bool _haveCurrent;
/// <summary>
/// Initialize the ParentIterator.
/// </summary>
public void Create(XPathNavigator context, XmlNavigatorFilter filter)
{
// Save context node as current node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, context);
// Attempt to find a matching parent node
_haveCurrent = (_navCurrent.MoveToParent()) && (!filter.IsFiltered(_navCurrent));
}
/// <summary>
/// Return true if a matching parent node exists and set Current property. Otherwise, return false
/// (Current property is undefined).
/// </summary>
public bool MoveNext()
{
if (_haveCurrent)
{
_haveCurrent = false;
return true;
}
// Iteration is complete
return false;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
}
/// <summary>
/// Iterate over all ancestor nodes according to XPath ancestor axis rules, returning nodes in reverse
/// document order.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct AncestorIterator
{
private XmlNavigatorFilter _filter;
private XPathNavigator _navCurrent;
private bool _haveCurrent;
/// <summary>
/// Initialize the AncestorIterator.
/// </summary>
public void Create(XPathNavigator context, XmlNavigatorFilter filter, bool orSelf)
{
_filter = filter;
// Save context node as current node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, context);
// If self node matches, then next call to MoveNext() should return it
// Otherwise, MoveNext() will fetch next ancestor
_haveCurrent = (orSelf && !_filter.IsFiltered(_navCurrent));
}
/// <summary>
/// Position the iterator on the next matching ancestor node. Return true if such a node exists and
/// set Current property. Otherwise, return false (Current property is undefined).
/// </summary>
public bool MoveNext()
{
if (_haveCurrent)
{
_haveCurrent = false;
return true;
}
while (_navCurrent.MoveToParent())
{
if (!_filter.IsFiltered(_navCurrent))
return true;
}
// Iteration is complete
return false;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
}
/// <summary>
/// Iterate over all ancestor nodes according to XPath ancestor axis rules, but return the nodes in document order.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct AncestorDocOrderIterator
{
private XmlNavigatorStack _stack;
private XPathNavigator _navCurrent;
/// <summary>
/// Initialize the AncestorDocOrderIterator (return ancestor nodes in document order, no possibility of duplicates).
/// </summary>
public void Create(XPathNavigator context, XmlNavigatorFilter filter, bool orSelf)
{
AncestorIterator wrapped = default;
wrapped.Create(context, filter, orSelf);
_stack.Reset();
// Fetch all ancestor nodes in reverse document order and push them onto the stack
while (wrapped.MoveNext())
_stack.Push(wrapped.Current.Clone());
}
/// <summary>
/// Return true if the Current property is set to the next Ancestor node in document order.
/// </summary>
public bool MoveNext()
{
if (_stack.IsEmpty)
return false;
_navCurrent = _stack.Pop();
return true;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
}
/// <summary>
/// Iterate over all following nodes according to XPath following axis rules. These rules specify that
/// descendants are not included, even though they follow the starting node in document order. For the
/// "true" following axis, see FollowingIterator.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct XPathFollowingIterator
{
private XmlNavigatorFilter _filter;
private XPathNavigator _navCurrent;
private bool _needFirst;
/// <summary>
/// Initialize the XPathFollowingIterator (no possibility of duplicates).
/// </summary>
public void Create(XPathNavigator input, XmlNavigatorFilter filter)
{
// Save input node as current node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, input);
_filter = filter;
_needFirst = true;
}
/// <summary>
/// Position this iterator to the next following node. Return false if there are no more following nodes.
/// Return true if the Current property is set to the next node in the iteration.
/// </summary>
public bool MoveNext()
{
if (_needFirst)
{
if (!MoveFirst(_filter, _navCurrent))
return false;
_needFirst = false;
return true;
}
return _filter.MoveToFollowing(_navCurrent, null);
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
/// <summary>
/// Position "nav" to the matching node which follows it in document order but is not a descendant node.
/// Return false if this is no such matching node.
/// </summary>
internal static bool MoveFirst(XmlNavigatorFilter filter, XPathNavigator nav)
{
// Attributes and namespace nodes include descendants of their owner element in the set of following nodes
if (nav.NodeType == XPathNodeType.Attribute || nav.NodeType == XPathNodeType.Namespace)
{
if (!nav.MoveToParent())
{
// Floating attribute or namespace node that has no following nodes
return false;
}
if (!filter.MoveToFollowing(nav, null))
{
// No matching following nodes
return false;
}
}
else
{
// XPath spec doesn't include descendants of the input node in the following axis
if (!nav.MoveToNonDescendant())
// No following nodes
return false;
// If the sibling does not match the node-test, find the next following node that does
if (filter.IsFiltered(nav))
{
if (!filter.MoveToFollowing(nav, null))
{
// No matching following nodes
return false;
}
}
}
// Success
return true;
}
}
/// <summary>
/// Iterate over all following nodes according to XPath following axis rules. Merge multiple sets of following nodes
/// in document order and remove duplicates.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct XPathFollowingMergeIterator
{
private XmlNavigatorFilter _filter;
private IteratorState _state;
private XPathNavigator _navCurrent, _navNext;
private enum IteratorState
{
NeedCandidateCurrent = 0,
HaveCandidateCurrent,
HaveCurrentNeedNext,
HaveCurrentHaveNext,
HaveCurrentNoNext,
};
/// <summary>
/// Initialize the XPathFollowingMergeIterator (merge multiple sets of following nodes in document order and remove duplicates).
/// </summary>
public void Create(XmlNavigatorFilter filter)
{
_filter = filter;
_state = IteratorState.NeedCandidateCurrent;
}
/// <summary>
/// Position this iterator to the next following node. Prune by finding the first input node in
/// document order that has no other input nodes in its subtree. All other input nodes should be
/// discarded. Return IteratorResult.NeedInputNode if the next input node needs to be fetched
/// first. Return IteratorResult.HaveCurrent if the Current property is set to the next node in the
/// iteration.
/// </summary>
public IteratorResult MoveNext(XPathNavigator input)
{
switch (_state)
{
case IteratorState.NeedCandidateCurrent:
// If there are no more input nodes, then iteration is complete
if (input == null)
return IteratorResult.NoMoreNodes;
// Save input node as current node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, input);
// Still must check next input node to see if is a descendant of this one
_state = IteratorState.HaveCandidateCurrent;
return IteratorResult.NeedInputNode;
case IteratorState.HaveCandidateCurrent:
// If there are no more input nodes,
if (input == null)
{
// Then candidate node has been selected, and there are no further input nodes
_state = IteratorState.HaveCurrentNoNext;
return MoveFirst();
}
// If input node is in the subtree of the candidate node, then use the input node instead
if (_navCurrent.IsDescendant(input))
goto case IteratorState.NeedCandidateCurrent;
// Found node on which to perform following scan. Now skip past all input nodes in the same document.
_state = IteratorState.HaveCurrentNeedNext;
goto case IteratorState.HaveCurrentNeedNext;
case IteratorState.HaveCurrentNeedNext:
// If there are no more input nodes,
if (input == null)
{
// Then candidate node has been selected, and there are no further input nodes
_state = IteratorState.HaveCurrentNoNext;
return MoveFirst();
}
// Skip input node unless it's in a different document than the node on which the following scan was performed
if (_navCurrent.ComparePosition(input) != XmlNodeOrder.Unknown)
return IteratorResult.NeedInputNode;
// Next node is in a different document, so save it
_navNext = XmlQueryRuntime.SyncToNavigator(_navNext, input);
_state = IteratorState.HaveCurrentHaveNext;
return MoveFirst();
}
if (!_filter.MoveToFollowing(_navCurrent, null))
return MoveFailed();
return IteratorResult.HaveCurrentNode;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true or IteratorResult.HaveCurrentNode.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
/// <summary>
/// Called when an attempt to move to a following node failed. If a Next node exists, then make that the new
/// candidate current node. Otherwise, iteration is complete.
/// </summary>
private IteratorResult MoveFailed()
{
XPathNavigator navTemp;
Debug.Assert(_state == IteratorState.HaveCurrentHaveNext || _state == IteratorState.HaveCurrentNoNext);
if (_state == IteratorState.HaveCurrentNoNext)
{
// No more nodes, so iteration is complete
_state = IteratorState.NeedCandidateCurrent;
return IteratorResult.NoMoreNodes;
}
// Make next node the new candidate node
_state = IteratorState.HaveCandidateCurrent;
// Swap navigators in order to sometimes avoid creating clones
navTemp = _navCurrent;
_navCurrent = _navNext;
_navNext = navTemp;
return IteratorResult.NeedInputNode;
}
/// <summary>
/// Position this.navCurrent to the node which follows it in document order but is not a descendant node.
/// </summary>
private IteratorResult MoveFirst()
{
Debug.Assert(_state == IteratorState.HaveCurrentHaveNext || _state == IteratorState.HaveCurrentNoNext);
if (!XPathFollowingIterator.MoveFirst(_filter, _navCurrent))
return MoveFailed();
return IteratorResult.HaveCurrentNode;
}
}
/// <summary>
/// Iterate over all content-typed nodes which precede the starting node in document order. Return nodes
/// in reverse document order.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct PrecedingIterator
{
private XmlNavigatorStack _stack;
private XPathNavigator _navCurrent;
/// <summary>
/// Initialize the PrecedingIterator (no possibility of duplicates).
/// </summary>
public void Create(XPathNavigator context, XmlNavigatorFilter filter)
{
// Start at root, which is always first node in the document
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, context);
_navCurrent.MoveToRoot();
_stack.Reset();
// If root node is not the ending node,
if (!_navCurrent.IsSamePosition(context))
{
// Push root onto the stack if it is not filtered
if (!filter.IsFiltered(_navCurrent))
_stack.Push(_navCurrent.Clone());
// Push all matching nodes onto stack
while (filter.MoveToFollowing(_navCurrent, context))
_stack.Push(_navCurrent.Clone());
}
}
/// <summary>
/// Return true if the Current property is set to the next Preceding node in reverse document order.
/// </summary>
public bool MoveNext()
{
if (_stack.IsEmpty)
return false;
_navCurrent = _stack.Pop();
return true;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
}
/// <summary>
/// Iterate over all preceding nodes according to XPath preceding axis rules, returning nodes in reverse
/// document order. These rules specify that ancestors are not included, even though they precede the
/// starting node in document order. For the "true" preceding axis, see PrecedingIterator.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct XPathPrecedingIterator
{
private XmlNavigatorStack _stack;
private XPathNavigator _navCurrent;
/// <summary>
/// Initialize the XPathPrecedingIterator (no possibility of duplicates).
/// </summary>
public void Create(XPathNavigator context, XmlNavigatorFilter filter)
{
XPathPrecedingDocOrderIterator wrapped = default;
wrapped.Create(context, filter);
_stack.Reset();
// Fetch all preceding nodes in document order and push them onto the stack
while (wrapped.MoveNext())
_stack.Push(wrapped.Current.Clone());
}
/// <summary>
/// Return true if the Current property is set to the next Preceding node in reverse document order.
/// </summary>
public bool MoveNext()
{
if (_stack.IsEmpty)
return false;
_navCurrent = _stack.Pop();
return true;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
}
/// <summary>
/// Iterate over all preceding nodes according to XPath preceding axis rules, returning nodes in document order.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct XPathPrecedingDocOrderIterator
{
private XmlNavigatorFilter _filter;
private XPathNavigator _navCurrent;
private XmlNavigatorStack _navStack;
/// <summary>
/// Initialize the XPathPrecedingDocOrderIterator (return preceding nodes in document order, no possibility of duplicates).
/// </summary>
public void Create(XPathNavigator input, XmlNavigatorFilter filter)
{
// Save input node as current node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, input);
_filter = filter;
PushAncestors();
}
/// <summary>
/// Position this iterator to the next preceding node. Return false if there are no more preceding nodes.
/// Return true if the Current property is set to the next node in the iteration.
/// </summary>
public bool MoveNext()
{
if (!_navStack.IsEmpty)
{
while (true)
{
// Move to the next matching node that is before the top node on the stack in document order
if (_filter.MoveToFollowing(_navCurrent, _navStack.Peek()))
// Found match
return true;
// Do not include ancestor nodes as part of the preceding axis
_navCurrent.MoveTo(_navStack.Pop());
// No more preceding matches possible
if (_navStack.IsEmpty)
break;
}
}
return false;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true or
/// IteratorResult.HaveCurrentNode.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
/// <summary>
/// Push all ancestors of this.navCurrent onto a stack. The set of preceding nodes should not contain any of these
/// ancestors.
/// </summary>
private void PushAncestors()
{
_navStack.Reset();
do
{
_navStack.Push(_navCurrent.Clone());
}
while (_navCurrent.MoveToParent());
// Pop the root of the tree, since MoveToFollowing calls will never return it
_navStack.Pop();
}
}
/// <summary>
/// Iterate over all preceding nodes according to XPath preceding axis rules, except that nodes are always
/// returned in document order. Merge multiple sets of preceding nodes in document order and remove duplicates.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct XPathPrecedingMergeIterator
{
private XmlNavigatorFilter _filter;
private IteratorState _state;
private XPathNavigator _navCurrent, _navNext;
private XmlNavigatorStack _navStack;
private enum IteratorState
{
NeedCandidateCurrent = 0,
HaveCandidateCurrent,
HaveCurrentHaveNext,
HaveCurrentNoNext,
}
/// <summary>
/// Initialize the XPathPrecedingMergeIterator (merge multiple sets of preceding nodes in document order and remove duplicates).
/// </summary>
public void Create(XmlNavigatorFilter filter)
{
_filter = filter;
_state = IteratorState.NeedCandidateCurrent;
}
/// <summary>
/// Position this iterator to the next preceding node in document order. Discard all input nodes
/// that are followed by another input node in the same document. This leaves one node per document from
/// which the complete set of preceding nodes can be derived without possibility of duplicates.
/// Return IteratorResult.NeedInputNode if the next input node needs to be fetched first. Return
/// IteratorResult.HaveCurrent if the Current property is set to the next node in the iteration.
/// </summary>
public IteratorResult MoveNext(XPathNavigator input)
{
switch (_state)
{
case IteratorState.NeedCandidateCurrent:
// If there are no more input nodes, then iteration is complete
if (input == null)
return IteratorResult.NoMoreNodes;
// Save input node as current node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, input);
// Scan for additional input nodes within the same document (since they are after navCurrent in docorder)
_state = IteratorState.HaveCandidateCurrent;
return IteratorResult.NeedInputNode;
case IteratorState.HaveCandidateCurrent:
// If there are no more input nodes,
if (input == null)
{
// Then candidate node has been selected, and there are no further input nodes
_state = IteratorState.HaveCurrentNoNext;
}
else
{
// If the input node is in the same document as the current node,
if (_navCurrent.ComparePosition(input) != XmlNodeOrder.Unknown)
{
// Then update the current node and get the next input node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, input);
return IteratorResult.NeedInputNode;
}
// Save the input node as navNext
_navNext = XmlQueryRuntime.SyncToNavigator(_navNext, input);
_state = IteratorState.HaveCurrentHaveNext;
}
PushAncestors();
break;
}
if (!_navStack.IsEmpty)
{
while (true)
{
// Move to the next matching node that is before the top node on the stack in document order
if (_filter.MoveToFollowing(_navCurrent, _navStack.Peek()))
// Found match
return IteratorResult.HaveCurrentNode;
// Do not include ancestor nodes as part of the preceding axis
_navCurrent.MoveTo(_navStack.Pop());
// No more preceding matches possible
if (_navStack.IsEmpty)
break;
}
}
if (_state == IteratorState.HaveCurrentNoNext)
{
// No more nodes, so iteration is complete
_state = IteratorState.NeedCandidateCurrent;
return IteratorResult.NoMoreNodes;
}
// Make next node the current node and start trying to find input node greatest in docorder
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, _navNext);
_state = IteratorState.HaveCandidateCurrent;
return IteratorResult.HaveCurrentNode;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true or
/// IteratorResult.HaveCurrentNode.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
/// <summary>
/// Push all ancestors of this.navCurrent onto a stack. The set of preceding nodes should not contain any of these
/// ancestors.
/// </summary>
private void PushAncestors()
{
Debug.Assert(_state == IteratorState.HaveCurrentHaveNext || _state == IteratorState.HaveCurrentNoNext);
_navStack.Reset();
do
{
_navStack.Push(_navCurrent.Clone());
}
while (_navCurrent.MoveToParent());
// Pop the root of the tree, since MoveToFollowing calls will never return it
_navStack.Pop();
}
}
/// <summary>
/// Iterate over these nodes in document order (filtering out those that do not match the filter test):
/// 1. Starting node
/// 2. All content-typed nodes which follow the starting node until the ending node is reached
/// 3. Ending node
///
/// If the starting node is the same node as the ending node, iterate over the singleton node.
/// If the starting node is after the ending node, or is in a different document, iterate to the
/// end of the document.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public struct NodeRangeIterator
{
private XmlNavigatorFilter _filter;
private XPathNavigator _navCurrent, _navEnd;
private IteratorState _state;
private enum IteratorState
{
HaveCurrent,
NeedCurrent,
HaveCurrentNoNext,
NoNext,
}
/// <summary>
/// Initialize the NodeRangeIterator (no possibility of duplicates).
/// </summary>
public void Create(XPathNavigator start, XmlNavigatorFilter filter, XPathNavigator end)
{
// Save start node as current node and save ending node
_navCurrent = XmlQueryRuntime.SyncToNavigator(_navCurrent, start);
_navEnd = XmlQueryRuntime.SyncToNavigator(_navEnd, end);
_filter = filter;
if (start.IsSamePosition(end))
{
// Start is end, so only return node if it is not filtered
_state = !filter.IsFiltered(start) ? IteratorState.HaveCurrentNoNext : IteratorState.NoNext;
}
else
{
// Return nodes until end is reached
_state = !filter.IsFiltered(start) ? IteratorState.HaveCurrent : IteratorState.NeedCurrent;
}
}
/// <summary>
/// Position this iterator to the next following node. Return false if there are no more following nodes,
/// or if the end node has been reached. Return true if the Current property is set to the next node in
/// the iteration.
/// </summary>
public bool MoveNext()
{
switch (_state)
{
case IteratorState.HaveCurrent:
_state = IteratorState.NeedCurrent;
return true;
case IteratorState.NeedCurrent:
// Move to next following node which matches
if (!_filter.MoveToFollowing(_navCurrent, _navEnd))
{
// No more nodes unless ending node matches
if (_filter.IsFiltered(_navEnd))
{
_state = IteratorState.NoNext;
return false;
}
_navCurrent.MoveTo(_navEnd);
_state = IteratorState.NoNext;
}
return true;
case IteratorState.HaveCurrentNoNext:
_state = IteratorState.NoNext;
return true;
}
Debug.Assert(_state == IteratorState.NoNext, $"Illegal state: {_state}");
return false;
}
/// <summary>
/// Return the current result navigator. This is only defined after MoveNext() has returned true.
/// </summary>
public XPathNavigator Current
{
get { return _navCurrent; }
}
}
}