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
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */
use std::cell::Cell;
use dom_struct::dom_struct;
use crate::dom::bindings::codegen::Bindings::NodeBinding::{GetRootNodeOptions, NodeMethods};
use crate::dom::bindings::codegen::Bindings::RangeBinding::RangeMethods;
use crate::dom::bindings::codegen::Bindings::SelectionBinding::SelectionMethods;
use crate::dom::bindings::error::{Error, ErrorResult, Fallible};
use crate::dom::bindings::inheritance::Castable;
use crate::dom::bindings::refcounted::Trusted;
use crate::dom::bindings::reflector::{reflect_dom_object, DomObject, Reflector};
use crate::dom::bindings::root::{Dom, DomRoot, MutNullableDom};
use crate::dom::bindings::str::DOMString;
use crate::dom::document::Document;
use crate::dom::eventtarget::EventTarget;
use crate::dom::node::{window_from_node, Node};
use crate::dom::range::Range;
use crate::script_runtime::CanGc;
use crate::task_source::TaskSource;
#[derive(Clone, Copy, JSTraceable, MallocSizeOf)]
enum Direction {
Forwards,
Backwards,
Directionless,
}
#[dom_struct]
pub struct Selection {
reflector_: Reflector,
document: Dom<Document>,
range: MutNullableDom<Range>,
direction: Cell<Direction>,
task_queued: Cell<bool>,
}
impl Selection {
fn new_inherited(document: &Document) -> Selection {
Selection {
reflector_: Reflector::new(),
document: Dom::from_ref(document),
range: MutNullableDom::new(None),
direction: Cell::new(Direction::Directionless),
task_queued: Cell::new(false),
}
}
pub fn new(document: &Document) -> DomRoot<Selection> {
reflect_dom_object(
Box::new(Selection::new_inherited(document)),
&*document.global(),
CanGc::note(),
)
}
fn set_range(&self, range: &Range) {
// If we are setting to literally the same Range object
// (not just the same positions), then there's nothing changing
// and no task to queue.
if let Some(existing) = self.range.get() {
if &*existing == range {
return;
}
}
self.range.set(Some(range));
range.associate_selection(self);
self.queue_selectionchange_task();
}
fn clear_range(&self) {
// If we already don't have a a Range object, then there's
// nothing changing and no task to queue.
if let Some(range) = self.range.get() {
range.disassociate_selection(self);
self.range.set(None);
self.queue_selectionchange_task();
}
}
pub fn queue_selectionchange_task(&self) {
if self.task_queued.get() {
// Spec doesn't specify not to queue multiple tasks,
// but it's much easier to code range operations if
// change notifications within a method are idempotent.
return;
}
let this = Trusted::new(self);
let window = window_from_node(&*self.document);
window
.task_manager()
.user_interaction_task_source() // w3c/selection-api#117
.queue(
task!(selectionchange_task_steps: move || {
let this = this.root();
this.task_queued.set(false);
this.document.upcast::<EventTarget>().fire_event(atom!("selectionchange"), CanGc::note());
}),
window.upcast(),
)
.expect("Couldn't queue selectionchange task!");
self.task_queued.set(true);
}
fn is_same_root(&self, node: &Node) -> bool {
&*node.GetRootNode(&GetRootNodeOptions::empty()) == self.document.upcast::<Node>()
}
}
impl SelectionMethods<crate::DomTypeHolder> for Selection {
// https://w3c.github.io/selection-api/#dom-selection-anchornode
fn GetAnchorNode(&self) -> Option<DomRoot<Node>> {
if let Some(range) = self.range.get() {
match self.direction.get() {
Direction::Forwards => Some(range.start_container()),
_ => Some(range.end_container()),
}
} else {
None
}
}
// https://w3c.github.io/selection-api/#dom-selection-anchoroffset
fn AnchorOffset(&self) -> u32 {
if let Some(range) = self.range.get() {
match self.direction.get() {
Direction::Forwards => range.start_offset(),
_ => range.end_offset(),
}
} else {
0
}
}
// https://w3c.github.io/selection-api/#dom-selection-focusnode
fn GetFocusNode(&self) -> Option<DomRoot<Node>> {
if let Some(range) = self.range.get() {
match self.direction.get() {
Direction::Forwards => Some(range.end_container()),
_ => Some(range.start_container()),
}
} else {
None
}
}
// https://w3c.github.io/selection-api/#dom-selection-focusoffset
fn FocusOffset(&self) -> u32 {
if let Some(range) = self.range.get() {
match self.direction.get() {
Direction::Forwards => range.end_offset(),
_ => range.start_offset(),
}
} else {
0
}
}
// https://w3c.github.io/selection-api/#dom-selection-iscollapsed
fn IsCollapsed(&self) -> bool {
if let Some(range) = self.range.get() {
range.collapsed()
} else {
true
}
}
// https://w3c.github.io/selection-api/#dom-selection-rangecount
fn RangeCount(&self) -> u32 {
if self.range.get().is_some() {
1
} else {
0
}
}
// https://w3c.github.io/selection-api/#dom-selection-type
fn Type(&self) -> DOMString {
if let Some(range) = self.range.get() {
if range.collapsed() {
DOMString::from("Caret")
} else {
DOMString::from("Range")
}
} else {
DOMString::from("None")
}
}
// https://w3c.github.io/selection-api/#dom-selection-getrangeat
fn GetRangeAt(&self, index: u32) -> Fallible<DomRoot<Range>> {
if index != 0 {
Err(Error::IndexSize)
} else if let Some(range) = self.range.get() {
Ok(DomRoot::from_ref(&range))
} else {
Err(Error::IndexSize)
}
}
// https://w3c.github.io/selection-api/#dom-selection-addrange
fn AddRange(&self, range: &Range) {
// Step 1
if !self.is_same_root(&range.start_container()) {
return;
}
// Step 2
if self.RangeCount() != 0 {
return;
}
// Step 3
self.set_range(range);
// Are we supposed to set Direction here? w3c/selection-api#116
self.direction.set(Direction::Forwards);
}
// https://w3c.github.io/selection-api/#dom-selection-removerange
fn RemoveRange(&self, range: &Range) -> ErrorResult {
if let Some(own_range) = self.range.get() {
if &*own_range == range {
self.clear_range();
return Ok(());
}
}
Err(Error::NotFound)
}
// https://w3c.github.io/selection-api/#dom-selection-removeallranges
fn RemoveAllRanges(&self) {
self.clear_range();
}
// https://w3c.github.io/selection-api/#dom-selection-empty
// TODO: When implementing actual selection UI, this may be the correct
// method to call as the abandon-selection action
fn Empty(&self) {
self.clear_range();
}
// https://w3c.github.io/selection-api/#dom-selection-collapse
fn Collapse(&self, node: Option<&Node>, offset: u32, can_gc: CanGc) -> ErrorResult {
if let Some(node) = node {
if node.is_doctype() {
// w3c/selection-api#118
return Err(Error::InvalidNodeType);
}
if offset > node.len() {
// Step 2
return Err(Error::IndexSize);
}
if !self.is_same_root(node) {
// Step 3
return Ok(());
}
// Steps 4-5
let range = Range::new(&self.document, node, offset, node, offset, can_gc);
// Step 6
self.set_range(&range);
// Are we supposed to set Direction here? w3c/selection-api#116
//
self.direction.set(Direction::Forwards);
} else {
// Step 1
self.clear_range();
}
Ok(())
}
// https://w3c.github.io/selection-api/#dom-selection-setposition
// TODO: When implementing actual selection UI, this may be the correct
// method to call as the start-of-selection action, after a
// selectstart event has fired and not been cancelled.
fn SetPosition(&self, node: Option<&Node>, offset: u32, can_gc: CanGc) -> ErrorResult {
self.Collapse(node, offset, can_gc)
}
// https://w3c.github.io/selection-api/#dom-selection-collapsetostart
fn CollapseToStart(&self, can_gc: CanGc) -> ErrorResult {
if let Some(range) = self.range.get() {
self.Collapse(
Some(&*range.start_container()),
range.start_offset(),
can_gc,
)
} else {
Err(Error::InvalidState)
}
}
// https://w3c.github.io/selection-api/#dom-selection-collapsetoend
fn CollapseToEnd(&self, can_gc: CanGc) -> ErrorResult {
if let Some(range) = self.range.get() {
self.Collapse(Some(&*range.end_container()), range.end_offset(), can_gc)
} else {
Err(Error::InvalidState)
}
}
// https://w3c.github.io/selection-api/#dom-selection-extend
// TODO: When implementing actual selection UI, this may be the correct
// method to call as the continue-selection action
fn Extend(&self, node: &Node, offset: u32, can_gc: CanGc) -> ErrorResult {
if !self.is_same_root(node) {
// Step 1
return Ok(());
}
if let Some(range) = self.range.get() {
if node.is_doctype() {
// w3c/selection-api#118
return Err(Error::InvalidNodeType);
}
if offset > node.len() {
// As with is_doctype, not explicit in selection spec steps here
// but implied by which exceptions are thrown in WPT tests
return Err(Error::IndexSize);
}
// Step 4
if !self.is_same_root(&range.start_container()) {
// Step 5, and its following 8 and 9
self.set_range(&Range::new(
&self.document,
node,
offset,
node,
offset,
can_gc,
));
self.direction.set(Direction::Forwards);
} else {
let old_anchor_node = &*self.GetAnchorNode().unwrap(); // has range, therefore has anchor node
let old_anchor_offset = self.AnchorOffset();
let is_old_anchor_before_or_equal = {
if old_anchor_node == node {
old_anchor_offset <= offset
} else {
old_anchor_node.is_before(node)
}
};
if is_old_anchor_before_or_equal {
// Step 6, and its following 8 and 9
self.set_range(&Range::new(
&self.document,
old_anchor_node,
old_anchor_offset,
node,
offset,
can_gc,
));
self.direction.set(Direction::Forwards);
} else {
// Step 7, and its following 8 and 9
self.set_range(&Range::new(
&self.document,
node,
offset,
old_anchor_node,
old_anchor_offset,
can_gc,
));
self.direction.set(Direction::Backwards);
}
};
} else {
// Step 2
return Err(Error::InvalidState);
}
Ok(())
}
// https://w3c.github.io/selection-api/#dom-selection-setbaseandextent
fn SetBaseAndExtent(
&self,
anchor_node: &Node,
anchor_offset: u32,
focus_node: &Node,
focus_offset: u32,
can_gc: CanGc,
) -> ErrorResult {
// Step 1
if anchor_node.is_doctype() || focus_node.is_doctype() {
// w3c/selection-api#118
return Err(Error::InvalidNodeType);
}
if anchor_offset > anchor_node.len() || focus_offset > focus_node.len() {
return Err(Error::IndexSize);
}
// Step 2
if !self.is_same_root(anchor_node) || !self.is_same_root(focus_node) {
return Ok(());
}
// Steps 5-7
let is_focus_before_anchor = {
if anchor_node == focus_node {
focus_offset < anchor_offset
} else {
focus_node.is_before(anchor_node)
}
};
if is_focus_before_anchor {
self.set_range(&Range::new(
&self.document,
focus_node,
focus_offset,
anchor_node,
anchor_offset,
can_gc,
));
self.direction.set(Direction::Backwards);
} else {
self.set_range(&Range::new(
&self.document,
anchor_node,
anchor_offset,
focus_node,
focus_offset,
can_gc,
));
self.direction.set(Direction::Forwards);
}
Ok(())
}
// https://w3c.github.io/selection-api/#dom-selection-selectallchildren
fn SelectAllChildren(&self, node: &Node, can_gc: CanGc) -> ErrorResult {
if node.is_doctype() {
// w3c/selection-api#118
return Err(Error::InvalidNodeType);
}
if !self.is_same_root(node) {
return Ok(());
}
// Spec wording just says node length here, but WPT specifically
// wants number of children (the main difference is that it's 0
// for cdata).
self.set_range(&Range::new(
&self.document,
node,
0,
node,
node.children_count(),
can_gc,
));
self.direction.set(Direction::Forwards);
Ok(())
}
// https://w3c.github.io/selection-api/#dom-selection-deletecontents
fn DeleteFromDocument(&self) -> ErrorResult {
if let Some(range) = self.range.get() {
// Since the range is changing, it should trigger a
// selectionchange event as it would if if mutated any other way
return range.DeleteContents();
}
Ok(())
}
// https://w3c.github.io/selection-api/#dom-selection-containsnode
fn ContainsNode(&self, node: &Node, allow_partial_containment: bool) -> bool {
// TODO: Spec requires a "visually equivalent to" check, which is
// probably up to a layout query. This is therefore not a full implementation.
if !self.is_same_root(node) {
return false;
}
if let Some(range) = self.range.get() {
let start_node = &*range.start_container();
if !self.is_same_root(start_node) {
// node can't be contained in a range with a different root
return false;
}
if allow_partial_containment {
// Spec seems to be incorrect here, w3c/selection-api#116
if node.is_before(start_node) {
return false;
}
let end_node = &*range.end_container();
if end_node.is_before(node) {
return false;
}
if node == start_node {
return range.start_offset() < node.len();
}
if node == end_node {
return range.end_offset() > 0;
}
true
} else {
if node.is_before(start_node) {
return false;
}
let end_node = &*range.end_container();
if end_node.is_before(node) {
return false;
}
if node == start_node {
return range.start_offset() == 0;
}
if node == end_node {
return range.end_offset() == node.len();
}
true
}
} else {
// No range
false
}
}
// https://w3c.github.io/selection-api/#dom-selection-stringifier
fn Stringifier(&self) -> DOMString {
// The spec as of Jan 31 2020 just says
// "See W3C bug 10583." for this method.
// Stringifying the range seems at least approximately right
// and passes the non-style-dependent case in the WPT tests.
if let Some(range) = self.range.get() {
range.Stringifier()
} else {
DOMString::from("")
}
}
}