forked from LadybirdBrowser/ladybird
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRange.cpp
More file actions
1351 lines (1114 loc) · 58.2 KB
/
Copy pathRange.cpp
File metadata and controls
1351 lines (1114 loc) · 58.2 KB
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
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2020, the SerenityOS developers.
* Copyright (c) 2022, Luke Wilde <lukew@serenityos.org>
* Copyright (c) 2022-2023, Andreas Kling <andreas@ladybird.org>
* Copyright (c) 2024-2025, Jelle Raaijmakers <jelle@ladybird.org>
* Copyright (c) 2024-2025, Aliaksandr Kalenik <kalenik.aliaksandr@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <AK/NeverDestroyed.h>
#include <AK/Utf16StringBuilder.h>
#include <LibWeb/Bindings/Intrinsics.h>
#include <LibWeb/Bindings/Range.h>
#include <LibWeb/DOM/Comment.h>
#include <LibWeb/DOM/Document.h>
#include <LibWeb/DOM/DocumentFragment.h>
#include <LibWeb/DOM/DocumentType.h>
#include <LibWeb/DOM/ElementFactory.h>
#include <LibWeb/DOM/Event.h>
#include <LibWeb/DOM/Node.h>
#include <LibWeb/DOM/ProcessingInstruction.h>
#include <LibWeb/DOM/Range.h>
#include <LibWeb/DOM/SelectionchangeEventDispatching.h>
#include <LibWeb/DOM/Text.h>
#include <LibWeb/Geometry/DOMRect.h>
#include <LibWeb/Geometry/DOMRectList.h>
#include <LibWeb/HTML/HTMLHtmlElement.h>
#include <LibWeb/HTML/HTMLScriptElement.h>
#include <LibWeb/HTML/Window.h>
#include <LibWeb/Layout/TextNode.h>
#include <LibWeb/Layout/TextOffsetMapping.h>
#include <LibWeb/Namespace.h>
#include <LibWeb/Painting/PaintableFragment.h>
#include <LibWeb/Painting/PaintableWithLines.h>
#include <LibWeb/Painting/ViewportPaintable.h>
#include <LibWeb/TrustedTypes/RequireTrustedTypesForDirective.h>
#include <LibWeb/TrustedTypes/TrustedTypePolicy.h>
namespace Web::DOM {
GC_DEFINE_ALLOCATOR(Range);
HashTable<Range*>& Range::live_ranges()
{
static NeverDestroyed<HashTable<Range*>> ranges;
return *ranges;
}
GC::Ref<Range> Range::create(HTML::Window& window)
{
return create(window.associated_document());
}
GC::Ref<Range> Range::create(Document& document)
{
auto& realm = document.realm();
return realm.create<Range>(document);
}
GC::Ref<Range> Range::create(GC::Ref<Node> start_container, WebIDL::UnsignedLong start_offset, GC::Ref<Node> end_container, WebIDL::UnsignedLong end_offset)
{
auto& realm = start_container->realm();
return realm.create<Range>(start_container, start_offset, end_container, end_offset);
}
WebIDL::ExceptionOr<GC::Ref<Range>> Range::construct_impl(JS::Realm& realm)
{
auto& window = as<HTML::Window>(realm.global_object());
return create(window);
}
Range::Range(Document& document)
: Range(document, 0, document, 0)
{
}
Range::Range(GC::Ref<Node> start_container, WebIDL::UnsignedLong start_offset, GC::Ref<Node> end_container, WebIDL::UnsignedLong end_offset)
: AbstractRange(start_container, start_offset, end_container, end_offset)
{
VERIFY(start_offset <= start_container->length());
VERIFY(end_offset <= end_container->length());
live_ranges().set(this);
}
Range::~Range() = default;
void Range::finalize()
{
Base::finalize();
live_ranges().remove(this);
}
void Range::initialize(JS::Realm& realm)
{
WEB_SET_PROTOTYPE_FOR_INTERFACE(Range);
Base::initialize(realm);
}
void Range::visit_edges(Cell::Visitor& visitor)
{
Base::visit_edges(visitor);
visitor.visit(m_associated_selection);
}
void Range::set_associated_selection(Badge<Selection::Selection>, GC::Ptr<Selection::Selection> selection)
{
m_associated_selection = selection;
update_associated_selection();
}
void Range::update_associated_selection()
{
auto& document = m_start_container->document();
// NB: Called during selection update after range change.
if (auto viewport = document.unsafe_paintable()) {
if (m_associated_selection)
viewport->recompute_selection_states(*this);
else
viewport->reset_selection_states();
viewport->set_needs_repaint();
}
if (!m_associated_selection)
return;
document.reset_cursor_blink_cycle();
// https://w3c.github.io/selection-api/#selectionchange-event
// When the selection is dissociated with its range, associated with a new range, or the associated range's boundary
// point is mutated either by the user or the content script, the user agent must schedule a selectionchange event
// on document.
schedule_a_selectionchange_event(document, document);
}
// https://dom.spec.whatwg.org/#concept-range-root
GC::Ref<Node> Range::root() const
{
// The root of a live range is the root of its start node.
return m_start_container->root();
}
// https://dom.spec.whatwg.org/#concept-range-bp-position
RelativeBoundaryPointPosition position_of_boundary_point_relative_to_other_boundary_point(BoundaryPoint a, BoundaryPoint b)
{
// 1. Assert: nodeA and nodeB have the same root.
// NOTE: Nodes may not share the same root if they belong to different shadow trees,
// so we assert that they share the same shadow-including root instead.
VERIFY(&a.node->shadow_including_root() == &b.node->shadow_including_root());
// 2. If nodeA is nodeB, then return equal if offsetA is offsetB, before if offsetA is less than offsetB, and after if offsetA is greater than offsetB.
if (a.node == b.node) {
if (a.offset == b.offset)
return RelativeBoundaryPointPosition::Equal;
if (a.offset < b.offset)
return RelativeBoundaryPointPosition::Before;
return RelativeBoundaryPointPosition::After;
}
// 3. If nodeA is following nodeB, then if the position of (nodeB, offsetB) relative to (nodeA, offsetA) is before, return after, and if it is after, return before.
if (a.node->is_following(b.node)) {
auto relative_position = position_of_boundary_point_relative_to_other_boundary_point(b, a);
if (relative_position == RelativeBoundaryPointPosition::Before)
return RelativeBoundaryPointPosition::After;
if (relative_position == RelativeBoundaryPointPosition::After)
return RelativeBoundaryPointPosition::Before;
}
// 4. If nodeA is an ancestor of nodeB:
if (a.node->is_ancestor_of(b.node)) {
// 1. Let child be nodeB.
GC::Ref<Node const> child = b.node;
// 2. While child is not a child of nodeA, set child to its parent.
while (!a.node->is_parent_of(child)) {
auto* parent = child->parent();
VERIFY(parent);
child = *parent;
}
// 3. If child’s index is less than offsetA, then return after.
if (child->index() < a.offset)
return RelativeBoundaryPointPosition::After;
}
// 5. Return before.
return RelativeBoundaryPointPosition::Before;
}
// https://dom.spec.whatwg.org/#concept-range-bp-set
WebIDL::ExceptionOr<void> Range::set_start_or_end(GC::Ref<Node> node, u32 offset, StartOrEnd start_or_end)
{
// To set the start or end of a range to a boundary point (node, offset), run these steps:
// 1. If node is a doctype, then throw an "InvalidNodeTypeError" DOMException.
if (is<DocumentType>(*node))
return WebIDL::InvalidNodeTypeError::create(realm(), "Node cannot be a DocumentType."_utf16);
// 2. If offset is greater than node’s length, then throw an "IndexSizeError" DOMException.
if (offset > node->length())
return WebIDL::IndexSizeError::create(realm(), Utf16String::formatted("Node does not contain a child at offset {}", offset));
// 3. Let bp be the boundary point (node, offset).
if (start_or_end == StartOrEnd::Start) {
// -> If these steps were invoked as "set the start"
// 1. If range’s root is not equal to node’s root, or if bp is after the range’s end, set range’s end to bp.
if (root().ptr() != &node->root() || position_of_boundary_point_relative_to_other_boundary_point({ node, offset }, end()) == RelativeBoundaryPointPosition::After) {
m_end_container = node;
m_end_offset = offset;
}
// 2. Set range’s start to bp.
m_start_container = node;
m_start_offset = offset;
} else {
// -> If these steps were invoked as "set the end"
VERIFY(start_or_end == StartOrEnd::End);
// 1. If range’s root is not equal to node’s root, or if bp is before the range’s start, set range’s start to bp.
if (root().ptr() != &node->root() || position_of_boundary_point_relative_to_other_boundary_point({ node, offset }, start()) == RelativeBoundaryPointPosition::Before) {
m_start_container = node;
m_start_offset = offset;
}
// 2. Set range’s end to bp.
m_end_container = node;
m_end_offset = offset;
}
update_associated_selection();
return {};
}
// https://dom.spec.whatwg.org/#dom-range-setstart
WebIDL::ExceptionOr<void> Range::set_start(GC::Ref<Node> node, WebIDL::UnsignedLong offset)
{
// The setStart(node, offset) method steps are to set the start of this to boundary point (node, offset).
return set_start_or_end(node, offset, StartOrEnd::Start);
}
// https://dom.spec.whatwg.org/#dom-range-setend
WebIDL::ExceptionOr<void> Range::set_end(GC::Ref<Node> node, WebIDL::UnsignedLong offset)
{
// The setEnd(node, offset) method steps are to set the end of this to boundary point (node, offset).
return set_start_or_end(node, offset, StartOrEnd::End);
}
// https://dom.spec.whatwg.org/#dom-range-setstartbefore
WebIDL::ExceptionOr<void> Range::set_start_before(GC::Ref<Node> node)
{
// 1. Let parent be node’s parent.
auto* parent = node->parent();
// 2. If parent is null, then throw an "InvalidNodeTypeError" DOMException.
if (!parent)
return WebIDL::InvalidNodeTypeError::create(realm(), "Given node has no parent."_utf16);
// 3. Set the start of this to boundary point (parent, node’s index).
return set_start_or_end(*parent, node->index(), StartOrEnd::Start);
}
// https://dom.spec.whatwg.org/#dom-range-setstartafter
WebIDL::ExceptionOr<void> Range::set_start_after(GC::Ref<Node> node)
{
// 1. Let parent be node’s parent.
auto* parent = node->parent();
// 2. If parent is null, then throw an "InvalidNodeTypeError" DOMException.
if (!parent)
return WebIDL::InvalidNodeTypeError::create(realm(), "Given node has no parent."_utf16);
// 3. Set the start of this to boundary point (parent, node’s index plus 1).
return set_start_or_end(*parent, node->index() + 1, StartOrEnd::Start);
}
// https://dom.spec.whatwg.org/#dom-range-setendbefore
WebIDL::ExceptionOr<void> Range::set_end_before(GC::Ref<Node> node)
{
// 1. Let parent be node’s parent.
auto* parent = node->parent();
// 2. If parent is null, then throw an "InvalidNodeTypeError" DOMException.
if (!parent)
return WebIDL::InvalidNodeTypeError::create(realm(), "Given node has no parent."_utf16);
// 3. Set the end of this to boundary point (parent, node’s index).
return set_start_or_end(*parent, node->index(), StartOrEnd::End);
}
// https://dom.spec.whatwg.org/#dom-range-setendafter
WebIDL::ExceptionOr<void> Range::set_end_after(GC::Ref<Node> node)
{
// 1. Let parent be node’s parent.
auto* parent = node->parent();
// 2. If parent is null, then throw an "InvalidNodeTypeError" DOMException.
if (!parent)
return WebIDL::InvalidNodeTypeError::create(realm(), "Given node has no parent."_utf16);
// 3. Set the end of this to boundary point (parent, node’s index plus 1).
return set_start_or_end(*parent, node->index() + 1, StartOrEnd::End);
}
// https://dom.spec.whatwg.org/#dom-range-compareboundarypoints
WebIDL::ExceptionOr<WebIDL::Short> Range::compare_boundary_points(WebIDL::UnsignedShort how, Range const& source_range) const
{
// 1. If how is not one of
// - START_TO_START,
// - START_TO_END,
// - END_TO_END, and
// - END_TO_START,
// then throw a "NotSupportedError" DOMException.
if (how != HowToCompareBoundaryPoints::START_TO_START && how != HowToCompareBoundaryPoints::START_TO_END && how != HowToCompareBoundaryPoints::END_TO_END && how != HowToCompareBoundaryPoints::END_TO_START)
return WebIDL::NotSupportedError::create(realm(), Utf16String::formatted("Expected 'how' to be one of START_TO_START (0), START_TO_END (1), END_TO_END (2) or END_TO_START (3), got {}", how));
// 2. If this’s root is not the same as sourceRange’s root, then throw a "WrongDocumentError" DOMException.
if (root() != source_range.root())
return WebIDL::WrongDocumentError::create(realm(), "This range is not in the same tree as the source range."_utf16);
GC::Ptr<Node> this_point_node;
u32 this_point_offset = 0;
GC::Ptr<Node> other_point_node;
u32 other_point_offset = 0;
// 3. If how is:
switch (how) {
case HowToCompareBoundaryPoints::START_TO_START:
// -> START_TO_START:
// Let this point be this’s start. Let other point be sourceRange’s start.
this_point_node = m_start_container;
this_point_offset = m_start_offset;
other_point_node = source_range.m_start_container;
other_point_offset = source_range.m_start_offset;
break;
case HowToCompareBoundaryPoints::START_TO_END:
// -> START_TO_END:
// Let this point be this’s end. Let other point be sourceRange’s start.
this_point_node = m_end_container;
this_point_offset = m_end_offset;
other_point_node = source_range.m_start_container;
other_point_offset = source_range.m_start_offset;
break;
case HowToCompareBoundaryPoints::END_TO_END:
// -> END_TO_END:
// Let this point be this’s end. Let other point be sourceRange’s end.
this_point_node = m_end_container;
this_point_offset = m_end_offset;
other_point_node = source_range.m_end_container;
other_point_offset = source_range.m_end_offset;
break;
case HowToCompareBoundaryPoints::END_TO_START:
// -> END_TO_START:
// Let this point be this’s start. Let other point be sourceRange’s end.
this_point_node = m_start_container;
this_point_offset = m_start_offset;
other_point_node = source_range.m_end_container;
other_point_offset = source_range.m_end_offset;
break;
default:
VERIFY_NOT_REACHED();
}
VERIFY(this_point_node);
VERIFY(other_point_node);
// 4. If the position of this point relative to other point is
auto relative_position = position_of_boundary_point_relative_to_other_boundary_point({ *this_point_node, this_point_offset }, { *other_point_node, other_point_offset });
switch (relative_position) {
case RelativeBoundaryPointPosition::Before:
// -> before
// Return −1.
return -1;
case RelativeBoundaryPointPosition::Equal:
// -> equal
// Return 0.
return 0;
case RelativeBoundaryPointPosition::After:
// -> after
// Return 1.
return 1;
default:
VERIFY_NOT_REACHED();
}
}
// https://dom.spec.whatwg.org/#concept-range-select
WebIDL::ExceptionOr<void> Range::select(GC::Ref<Node> node)
{
// 1. Let parent be node’s parent.
auto* parent = node->parent();
// 2. If parent is null, then throw an "InvalidNodeTypeError" DOMException.
if (!parent)
return WebIDL::InvalidNodeTypeError::create(realm(), "Given node has no parent."_utf16);
// 3. Let index be node’s index.
auto index = node->index();
// 4. Set range’s start to boundary point (parent, index).
m_start_container = *parent;
m_start_offset = index;
// 5. Set range’s end to boundary point (parent, index plus 1).
m_end_container = *parent;
m_end_offset = index + 1;
update_associated_selection();
return {};
}
// https://dom.spec.whatwg.org/#dom-range-selectnode
WebIDL::ExceptionOr<void> Range::select_node(GC::Ref<Node> node)
{
// The selectNode(node) method steps are to select node within this.
return select(node);
}
// https://dom.spec.whatwg.org/#dom-range-collapse
void Range::collapse(bool to_start)
{
// The collapse(toStart) method steps are to, if toStart is true, set end to start; otherwise set start to end.
if (to_start) {
m_end_container = m_start_container;
m_end_offset = m_start_offset;
} else {
m_start_container = m_end_container;
m_start_offset = m_end_offset;
}
update_associated_selection();
}
// https://dom.spec.whatwg.org/#dom-range-selectnodecontents
WebIDL::ExceptionOr<void> Range::select_node_contents(GC::Ref<Node> node)
{
// 1. If node is a doctype, throw an "InvalidNodeTypeError" DOMException.
if (is<DocumentType>(*node))
return WebIDL::InvalidNodeTypeError::create(realm(), "Node cannot be a DocumentType."_utf16);
// 2. Let length be the length of node.
auto length = node->length();
// 3. Set start to the boundary point (node, 0).
m_start_container = node;
m_start_offset = 0;
// 4. Set end to the boundary point (node, length).
m_end_container = node;
m_end_offset = length;
update_associated_selection();
return {};
}
GC::Ref<Range> Range::clone_range() const
{
return shape().realm().create<Range>(const_cast<Node&>(*m_start_container), m_start_offset, const_cast<Node&>(*m_end_container), m_end_offset);
}
// https://dom.spec.whatwg.org/#dom-range-commonancestorcontainer
GC::Ref<Node> Range::common_ancestor_container() const
{
// 1. Let container be start node.
auto container = m_start_container;
// 2. While container is not an inclusive ancestor of end node, let container be container’s parent.
while (!container->is_inclusive_ancestor_of(m_end_container)) {
VERIFY(container->parent());
container = *container->parent();
}
// 3. Return container.
return container;
}
// https://dom.spec.whatwg.org/#dom-range-intersectsnode
bool Range::intersects_node(GC::Ref<Node> node) const
{
// 1. If node’s root is different from this’s root, return false.
if (&node->root() != root().ptr())
return false;
// 2. Let parent be node’s parent.
auto* parent = node->parent();
// 3. If parent is null, return true.
if (!parent)
return true;
// 4. Let offset be node’s index.
WebIDL::UnsignedLong offset = node->index();
// 5. If (parent, offset) is before end and (parent, offset plus 1) is after start, return true
auto relative_position_to_end = position_of_boundary_point_relative_to_other_boundary_point({ *parent, offset }, end());
auto relative_position_to_start = position_of_boundary_point_relative_to_other_boundary_point({ *parent, offset + 1 }, start());
if (relative_position_to_end == RelativeBoundaryPointPosition::Before && relative_position_to_start == RelativeBoundaryPointPosition::After)
return true;
// 6. Return false.
return false;
}
// https://dom.spec.whatwg.org/#dom-range-ispointinrange
WebIDL::ExceptionOr<bool> Range::is_point_in_range(GC::Ref<Node> node, WebIDL::UnsignedLong offset) const
{
// 1. If node’s root is different from this’s root, return false.
if (&node->root() != root().ptr())
return false;
// 2. If node is a doctype, then throw an "InvalidNodeTypeError" DOMException.
if (is<DocumentType>(*node))
return WebIDL::InvalidNodeTypeError::create(realm(), "Node cannot be a DocumentType."_utf16);
// 3. If offset is greater than node’s length, then throw an "IndexSizeError" DOMException.
if (offset > node->length())
return WebIDL::IndexSizeError::create(realm(), Utf16String::formatted("Node does not contain a child at offset {}", offset));
// 4. If (node, offset) is before start or after end, return false.
auto relative_position_to_start = position_of_boundary_point_relative_to_other_boundary_point({ node, offset }, start());
auto relative_position_to_end = position_of_boundary_point_relative_to_other_boundary_point({ node, offset }, end());
if (relative_position_to_start == RelativeBoundaryPointPosition::Before || relative_position_to_end == RelativeBoundaryPointPosition::After)
return false;
// 5. Return true.
return true;
}
// https://dom.spec.whatwg.org/#dom-range-comparepoint
WebIDL::ExceptionOr<WebIDL::Short> Range::compare_point(GC::Ref<Node> node, WebIDL::UnsignedLong offset) const
{
// 1. If node’s root is different from this’s root, then throw a "WrongDocumentError" DOMException.
if (&node->root() != root().ptr())
return WebIDL::WrongDocumentError::create(realm(), "Given node is not in the same document as the range."_utf16);
// 2. If node is a doctype, then throw an "InvalidNodeTypeError" DOMException.
if (is<DocumentType>(*node))
return WebIDL::InvalidNodeTypeError::create(realm(), "Node cannot be a DocumentType."_utf16);
// 3. If offset is greater than node’s length, then throw an "IndexSizeError" DOMException.
if (offset > node->length())
return WebIDL::IndexSizeError::create(realm(), Utf16String::formatted("Node does not contain a child at offset {}", offset));
// 4. If (node, offset) is before start, return −1.
auto relative_position_to_start = position_of_boundary_point_relative_to_other_boundary_point({ node, offset }, start());
if (relative_position_to_start == RelativeBoundaryPointPosition::Before)
return -1;
// 5. If (node, offset) is after end, return 1.
auto relative_position_to_end = position_of_boundary_point_relative_to_other_boundary_point({ node, offset }, end());
if (relative_position_to_end == RelativeBoundaryPointPosition::After)
return 1;
// 6. Return 0.
return 0;
}
// https://dom.spec.whatwg.org/#dom-range-stringifier
Utf16String Range::to_string() const
{
// 1. Let s be the empty string.
Utf16StringBuilder builder;
// 2. If this’s start node is this’s end node and it is a Text node,
// then return the substring of that Text node’s data beginning at this’s start offset and ending at this’s end offset.
auto* start_text = as_if<Text>(*start_container());
if (start_text && start_container() == end_container())
return MUST(start_text->substring_data(start_offset(), end_offset() - start_offset()));
// 3. If this’s start node is a Text node, then append the substring of that node’s data from this’s start offset until the end to s.
if (start_text)
builder.append(MUST(start_text->substring_data(start_offset(), start_text->length_in_utf16_code_units() - start_offset())));
// 4. Append the concatenation of the data of all Text nodes that are contained in this, in tree order, to s.
for_each_contained([&](GC::Ref<Node> node) {
if (auto* text_node = as_if<Text>(*node))
builder.append(text_node->data());
return IterationDecision::Continue;
});
// 5. If this’s end node is a Text node, then append the substring of that node’s data from its start until this’s end offset to s.
if (auto* end_text = as_if<Text>(*end_container()))
builder.append(MUST(end_text->substring_data(0, end_offset())));
// 6. Return s.
return builder.to_string();
}
// https://dom.spec.whatwg.org/#dom-range-extractcontents
WebIDL::ExceptionOr<GC::Ref<DocumentFragment>> Range::extract_contents()
{
return extract();
}
// https://dom.spec.whatwg.org/#concept-range-extract
WebIDL::ExceptionOr<GC::Ref<DocumentFragment>> Range::extract()
{
// 1. Let fragment be a new DocumentFragment node whose node document is range’s start node’s node document.
auto fragment = realm().create<DOM::DocumentFragment>(const_cast<Document&>(start_container()->document()));
// 2. If range is collapsed, then return fragment.
if (collapsed())
return fragment;
// 3. Let originalStartNode, originalStartOffset, originalEndNode, and originalEndOffset be range’s start node,
// start offset, end node, and end offset, respectively.
GC::Ref<Node> original_start_node = m_start_container;
auto original_start_offset = m_start_offset;
GC::Ref<Node> original_end_node = m_end_container;
auto original_end_offset = m_end_offset;
// 4. If originalStartNode is originalEndNode and it is a CharacterData node:
if (original_start_node.ptr() == original_end_node.ptr() && is<CharacterData>(*original_start_node)) {
// 1. Let clone be a clone of originalStartNode.
auto clone = TRY(original_start_node->clone_node());
// 2. Set clone’s data to the result of substringing data of originalStartNode with originalStartOffset and
// originalEndOffset − originalStartOffset.
auto result = TRY(static_cast<CharacterData const&>(*original_start_node).substring_data(original_start_offset, original_end_offset - original_start_offset));
as<CharacterData>(*clone).set_data(move(result));
// 3. Append clone to fragment.
TRY(fragment->append_child(clone));
// 4. Replace data of originalStartNode with originalStartOffset, originalEndOffset − originalStartOffset, and
// the empty string.
TRY(static_cast<CharacterData&>(*original_start_node).replace_data(original_start_offset, original_end_offset - original_start_offset, {}));
// 5. Return fragment.
return fragment;
}
// 5. Let commonAncestor be originalStartNode.
GC::Ref<Node> common_ancestor = original_start_node;
// 6. While commonAncestor is not an inclusive ancestor of originalEndNode: set commonAncestor to its own parent.
while (!common_ancestor->is_inclusive_ancestor_of(original_end_node))
common_ancestor = *common_ancestor->parent_node();
// 7. Let firstPartiallyContainedChild be null.
GC::Ptr<Node> first_partially_contained_child;
// 8. If originalStartNode is not an inclusive ancestor of originalEndNode, then set firstPartiallyContainedChild
// to the first child of commonAncestor that is partially contained in range.
if (!original_start_node->is_inclusive_ancestor_of(original_end_node)) {
for (auto* child = common_ancestor->first_child(); child; child = child->next_sibling()) {
if (partially_contains_node(*child)) {
first_partially_contained_child = child;
break;
}
}
}
// 9. Let lastPartiallyContainedChild be null.
GC::Ptr<Node> last_partially_contained_child;
// 10. If originalEndNode is not an inclusive ancestor of originalStartNode, then set lastPartiallyContainedChild
// to the last child of commonAncestor that is partially contained in range.
if (!original_end_node->is_inclusive_ancestor_of(original_start_node)) {
for (auto* child = common_ancestor->last_child(); child; child = child->previous_sibling()) {
if (partially_contains_node(*child)) {
last_partially_contained_child = child;
break;
}
}
}
// 11. Let containedChildren be a list of all children of commonAncestor that are contained in range, in tree order.
Vector<GC::Ref<Node>> contained_children;
for (Node* node = common_ancestor->first_child(); node; node = node->next_sibling()) {
if (contains_node(*node))
contained_children.append(*node);
}
// 12. If any member of containedChildren is a doctype, then throw a "HierarchyRequestError" DOMException.
for (auto const& child : contained_children) {
if (is<DocumentType>(*child))
return WebIDL::HierarchyRequestError::create(realm(), "Contained child is a DocumentType"_utf16);
}
// 13. Let newNode and newOffset be null.
GC::Ptr<Node> new_node;
size_t new_offset = 0;
// 14. If originalStartNode is an inclusive ancestor of originalEndNode, then set newNode to originalStartNode and
// newOffset to originalStartOffset.
if (original_start_node->is_inclusive_ancestor_of(original_end_node)) {
new_node = original_start_node;
new_offset = original_start_offset;
}
// 15. Otherwise:
else {
// 1. Let referenceNode be originalStartNode.
GC::Ptr<Node> reference_node = original_start_node;
// 2. While referenceNode’s parent is non-null and is not an inclusive ancestor of originalEndNode:
// set referenceNode to its parent.
while (reference_node->parent_node() && !reference_node->parent_node()->is_inclusive_ancestor_of(original_end_node))
reference_node = reference_node->parent_node();
// 3. Set newNode to the parent of referenceNode, and newOffset to referenceNode’s index + 1.
new_node = reference_node->parent_node();
new_offset = reference_node->index() + 1;
}
// 16. Set range’s start and end to (newNode, newOffset).
TRY(set_start(*new_node, new_offset));
TRY(set_end(*new_node, new_offset));
// 17. If firstPartiallyContainedChild is a CharacterData node:
if (first_partially_contained_child && is<CharacterData>(*first_partially_contained_child)) {
// 1. Let clone be a clone of originalStartNode.
auto clone = TRY(original_start_node->clone_node());
// 2. Set the data of clone to the result of substringing data of originalStartNode with originalStartOffset
// and originalStartNode’s length − originalStartOffset.
auto result = TRY(static_cast<CharacterData const&>(*original_start_node).substring_data(original_start_offset, original_start_node->length() - original_start_offset));
as<CharacterData>(*clone).set_data(move(result));
// 3. Append clone to fragment.
TRY(fragment->append_child(clone));
// 4. Replace data of originalStartNode with originalStartOffset, originalStartNode’s length −
// originalStartOffset, and the empty string.
TRY(static_cast<CharacterData&>(*original_start_node).replace_data(original_start_offset, original_start_node->length() - original_start_offset, {}));
}
// 18. Otherwise, if firstPartiallyContainedChild is non-null:
else if (first_partially_contained_child) {
// 1. Let clone be a clone of firstPartiallyContainedChild.
auto clone = TRY(first_partially_contained_child->clone_node());
// 2. Append clone to fragment.
TRY(fragment->append_child(clone));
// 3. Let subrange be a new live range whose start is (originalStartNode, originalStartOffset) and whose end is
// (firstPartiallyContainedChild, firstPartiallyContainedChild’s length).
auto subrange = Range::create(original_start_node, original_start_offset, *first_partially_contained_child, first_partially_contained_child->length());
// 4. Let subfragment be the result of extracting subrange.
auto subfragment = TRY(subrange->extract());
// 5. Append subfragment to clone.
TRY(clone->append_child(subfragment));
}
// 19. For each contained child of containedChildren: append contained child to fragment.
for (auto& contained_child : contained_children) {
TRY(fragment->append_child(contained_child));
}
// 20. If lastPartiallyContainedChild is a CharacterData node:
if (last_partially_contained_child && is<CharacterData>(*last_partially_contained_child)) {
// 1. Let clone be a clone of originalEndNode.
auto clone = TRY(original_end_node->clone_node());
// 2. Set clone’s data to the result of substringing data of originalEndNode with 0 and originalEndOffset.
auto result = TRY(static_cast<CharacterData const&>(*original_end_node).substring_data(0, original_end_offset));
as<CharacterData>(*clone).set_data(move(result));
// 3. Append clone to fragment.
TRY(fragment->append_child(clone));
// 4. Replace data of originalEndNode with 0, originalEndOffset, and the empty string.
TRY(as<CharacterData>(*original_end_node).replace_data(0, original_end_offset, {}));
}
// 21. Otherwise, if lastPartiallyContainedChild is non-null:
else if (last_partially_contained_child) {
// 1. Let clone be a clone of lastPartiallyContainedChild.
auto clone = TRY(last_partially_contained_child->clone_node());
// 2. Append clone to fragment.
TRY(fragment->append_child(clone));
// 3. Let subrange be a new live range whose start is (lastPartiallyContainedChild, 0) and whose end is
// (originalEndNode, originalEndOffset).
auto subrange = Range::create(*last_partially_contained_child, 0, original_end_node, original_end_offset);
// 4. Let subfragment be the result of extracting subrange.
auto subfragment = TRY(subrange->extract());
// 5. Append subfragment to clone.
TRY(clone->append_child(subfragment));
}
// 22. Return fragment.
return fragment;
}
// https://dom.spec.whatwg.org/#contained
bool Range::contains_node(GC::Ref<Node> node) const
{
// A node node is contained in a live range range if node’s root is range’s root,
if (&node->root() != root().ptr())
return false;
// and (node, 0) is after range’s start,
if (position_of_boundary_point_relative_to_other_boundary_point({ node, 0 }, start()) != RelativeBoundaryPointPosition::After)
return false;
// and (node, node’s length) is before range’s end.
if (position_of_boundary_point_relative_to_other_boundary_point({ node, static_cast<WebIDL::UnsignedLong>(node->length()) }, end()) != RelativeBoundaryPointPosition::Before)
return false;
return true;
}
// https://dom.spec.whatwg.org/#partially-contained
bool Range::partially_contains_node(GC::Ref<Node> node) const
{
// A node is partially contained in a live range if it’s an inclusive ancestor of the live range’s start node but
// not its end node, or vice versa.
return node->is_inclusive_ancestor_of(m_start_container) != node->is_inclusive_ancestor_of(m_end_container);
}
// https://dom.spec.whatwg.org/#dom-range-insertnode
WebIDL::ExceptionOr<void> Range::insert_node(GC::Ref<Node> node)
{
return insert(node);
}
// https://dom.spec.whatwg.org/#concept-range-insert
WebIDL::ExceptionOr<void> Range::insert(GC::Ref<Node> node)
{
// 1. If range’s start node is a ProcessingInstruction or Comment node, is a Text node whose parent is null, or is node, then throw a "HierarchyRequestError" DOMException.
if ((is<ProcessingInstruction>(*m_start_container) || is<Comment>(*m_start_container))
|| (is<Text>(*m_start_container) && !m_start_container->parent_node())
|| m_start_container.ptr() == node.ptr()) {
return WebIDL::HierarchyRequestError::create(realm(), "Range has inappropriate start node for insertion"_utf16);
}
// 2. Let referenceNode be null.
GC::Ptr<Node> reference_node;
// 3. If range’s start node is a Text node, set referenceNode to that Text node.
if (is<Text>(*m_start_container)) {
reference_node = m_start_container;
}
// 4. Otherwise, set referenceNode to the child of start node whose index is start offset, and null if there is no such child.
else {
reference_node = m_start_container->child_at_index(m_start_offset);
}
// 5. Let parent be range’s start node if referenceNode is null, and referenceNode’s parent otherwise.
GC::Ptr<Node> parent;
if (!reference_node)
parent = m_start_container;
else
parent = reference_node->parent();
// 6. Ensure pre-insert validity given node, parent, referenceNode, and « ».
TRY(parent->ensure_pre_insert_validity(node->realm(), node, reference_node, Node::ChildrenToExclude::None));
// 7. If range’s start node is a Text node, set referenceNode to the result of splitting it with offset range’s start offset.
if (is<Text>(*m_start_container))
reference_node = TRY(static_cast<Text&>(*m_start_container).split_text(m_start_offset));
// 8. If node is referenceNode, set referenceNode to its next sibling.
if (node == reference_node)
reference_node = reference_node->next_sibling();
// 9. If node’s parent is non-null, then remove node.
if (node->parent())
node->remove();
// 10. Let newOffset be parent’s length if referenceNode is null, and referenceNode’s index otherwise.
size_t new_offset = 0;
if (!reference_node)
new_offset = parent->length();
else
new_offset = reference_node->index();
// 11. Increase newOffset by node’s length if node is a DocumentFragment node, and one otherwise.
if (is<DocumentFragment>(*node))
new_offset += node->length();
else
new_offset += 1;
// 12. Pre-insert node into parent before referenceNode.
(void)TRY(parent->pre_insert(node, reference_node));
// 13. If range is collapsed, then set range’s end to (parent, newOffset).
if (collapsed())
TRY(set_end(*parent, new_offset));
return {};
}
// https://dom.spec.whatwg.org/#dom-range-surroundcontents
WebIDL::ExceptionOr<void> Range::surround_contents(GC::Ref<Node> new_parent)
{
// 1. If a non-Text node is partially contained in this, then throw an "InvalidStateError" DOMException.
Node* start_non_text_node = start_container();
if (is<Text>(*start_non_text_node))
start_non_text_node = start_non_text_node->parent_node();
Node* end_non_text_node = end_container();
if (is<Text>(*end_non_text_node))
end_non_text_node = end_non_text_node->parent_node();
if (start_non_text_node != end_non_text_node)
return WebIDL::InvalidStateError::create(realm(), "Non-Text node is partially contained in range."_utf16);
// 2. If newParent is a Document, DocumentType, or DocumentFragment node, then throw an "InvalidNodeTypeError" DOMException.
if (is<Document>(*new_parent) || is<DocumentType>(*new_parent) || is<DocumentFragment>(*new_parent))
return WebIDL::InvalidNodeTypeError::create(realm(), "Invalid parent node type"_utf16);
// 3. Let fragment be the result of extracting this.
auto fragment = TRY(extract());
// 4. If newParent has children, then replace all with null within newParent.
if (new_parent->has_children())
new_parent->replace_all(nullptr);
// 5. Insert newParent into this.
TRY(insert(new_parent));
// 6. Append fragment to newParent.
(void)TRY(new_parent->append_child(fragment));
// 7. Select newParent within this.
return select(*new_parent);
}
// https://dom.spec.whatwg.org/#dom-range-clonecontents
WebIDL::ExceptionOr<GC::Ref<DocumentFragment>> Range::clone_contents()
{
return clone_the_contents();
}
// https://dom.spec.whatwg.org/#concept-range-clone
WebIDL::ExceptionOr<GC::Ref<DocumentFragment>> Range::clone_the_contents()
{
// 1. Let fragment be a new DocumentFragment node whose node document is range’s start node’s node document.
auto fragment = realm().create<DOM::DocumentFragment>(const_cast<Document&>(start_container()->document()));
// 2. If range is collapsed, then return fragment.
if (collapsed())
return fragment;
// 3. Let original start node, original start offset, original end node, and original end offset
// be range’s start node, start offset, end node, and end offset, respectively.
GC::Ref<Node> original_start_node = m_start_container;
auto original_start_offset = m_start_offset;
GC::Ref<Node> original_end_node = m_end_container;
auto original_end_offset = m_end_offset;
// 4. If original start node is original end node and it is a CharacterData node, then:
if (original_start_node.ptr() == original_end_node.ptr() && is<CharacterData>(*original_start_node)) {
// 1. Let clone be a clone of original start node.
auto clone = TRY(original_start_node->clone_node());
// 2. Set the data of clone to the result of substringing data with node original start node,
// offset original start offset, and count original end offset minus original start offset.
auto result = TRY(static_cast<CharacterData const&>(*original_start_node).substring_data(original_start_offset, original_end_offset - original_start_offset));
as<CharacterData>(*clone).set_data(move(result));
// 3. Append clone to fragment.
TRY(fragment->append_child(clone));
// 4. Return fragment.
return fragment;
}
// 5. Let common ancestor be original start node.
GC::Ref<Node> common_ancestor = original_start_node;
// 6. While common ancestor is not an inclusive ancestor of original end node, set common ancestor to its own parent.
while (!common_ancestor->is_inclusive_ancestor_of(original_end_node))
common_ancestor = *common_ancestor->parent_node();
// 7. Let first partially contained child be null.
GC::Ptr<Node> first_partially_contained_child;
// 8. If original start node is not an inclusive ancestor of original end node,
// set first partially contained child to the first child of common ancestor that is partially contained in range.
if (!original_start_node->is_inclusive_ancestor_of(original_end_node)) {
for (auto* child = common_ancestor->first_child(); child; child = child->next_sibling()) {
if (partially_contains_node(*child)) {
first_partially_contained_child = child;
break;
}
}
}
// 9. Let last partially contained child be null.
GC::Ptr<Node> last_partially_contained_child;
// 10. If original end node is not an inclusive ancestor of original start node,
// set last partially contained child to the last child of common ancestor that is partially contained in range.
if (!original_end_node->is_inclusive_ancestor_of(original_start_node)) {
for (auto* child = common_ancestor->last_child(); child; child = child->previous_sibling()) {