Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 3070x 3070x 3070x 1x 1x 6023x 1x 5917x 5917x 1448x 5917x 1x 738x 738x 738x 738x 738x 738x 738x 738x 738x 738x 738x 738x 738x 738x 2820x 2820x 2820x 2820x 2820x 2820x 2820x 2820x 2820x 2820x 2820x 2820x 2820x 2820x 12x 12x 12x 12x 9x 12x 2808x 3x 3x 3x 3x 1x 3x 2805x 399x 11x 11x 11x 11x 11x 388x 237x 237x 151x 2406x 1133x 897x 897x 897x 526x 897x 236x 236x 1x 236x 1273x 194x 106x 106x 106x 49x 106x 88x 88x 1079x 55x 3x 3x 3x 3x 52x 52x 1024x 208x 115x 115x 115x 55x 115x 93x 93x 816x 98x 18x 18x 18x 8x 18x 80x 1123x 901x 901x 222x 222x 338x 5x 5x 5x 5x 5x 5x 338x 338x 38x 300x 300x 300x 300x 184x 184x 153x 153x 1x 19x 19x 19x 19x 23x 23x 23x 17x 23x 23x 23x 23x 23x 24x 24x 24x 19x 5x 5x 5x 23x 23x 19x 1x 10x 10x 1x 30644x 1x 2239x | /*!
* VisualEditor Document class.
*
* @copyright See AUTHORS.txt
*/
/**
* Generic document.
*
* @class
* @mixes OO.EventEmitter
*
* @constructor
* @param {ve.BranchNode} documentNode Document node
*/
ve.Document = function VeDocument( documentNode ) {
// Mixin constructors
OO.EventEmitter.call( this );
// Properties
this.documentNode = documentNode;
this.documentNode.setDocument( this );
};
/* Inheritance */
OO.mixinClass( ve.Document, OO.EventEmitter );
/* Events */
/**
* A node has been attached with ve.Node#setDocument . Its descendants are guaranteed
* to be attached too (and the event is emitted for descendants first, and for siblings
* in their order in the children list)
*
* @event ve.Document#nodeAttached
* @param {ve.Node} node The node that has been attached
*/
/**
* A node has been detached with ve.Node#setDocument . Its descendants are guaranteed
* to be detached too (and the event is emitted for descendants first, and for siblings
* in their order in the children list)
*
* @event ve.Document#nodeDetached
* @param {ve.Node} node The node that has been detached
*/
/* Methods */
/**
* Get the root of the document's node tree.
*
* @return {ve.BranchNode} Root of node tree
*/
ve.Document.prototype.getDocumentNode = function () {
return this.documentNode;
};
/**
* Get a node at an offset.
*
* @param {number} offset Offset to get node at
* @return {ve.Node|null} Node at offset
*/
ve.Document.prototype.getBranchNodeFromOffset = function ( offset ) {
let node = this.getDocumentNode().getNodeFromOffset( offset );
if ( node && !node.hasChildren() ) {
node = node.getParent();
}
return node;
};
/**
* Gets a list of nodes and the ranges within them that a selection of the document covers.
*
* @param {ve.Range} range Range within document to select nodes
* @param {string} [mode='leaves'] Type of selection to perform:
*
* - `leaves`: Return all leaf nodes in the given range (descends all the way down)
* - `branches`': Return all branch nodes in the given range
* - `covered`: Do not descend into nodes that are entirely covered by the range. The result
* is similar to that of 'leaves' except that if a node is entirely covered, its
* children aren't returned separately.
* - `siblings`: Return a set of adjacent siblings covered by the range (descends as long as the
* range is in a single node)
* @return {Array} List of objects describing nodes in the selection and the ranges therein:
*
* - `node`: Reference to a ve.Node
* - `range`: ve.Range, missing if the entire node is covered
* - `index`: Index of the node in its parent, missing if node has no parent
* - `indexInNode`: If range is a zero-length range between two children of node,
* this is set to the index of the child following range (or to
* `node.children.length + 1` if range is between the last child and
* the end). If range is a zero-length range inside an empty non-content branch node, this is 0.
* Missing in all other cases.
* - `nodeRange`: Range covering the inside of the entire node, not including wrapper
* - `nodeOuterRange`: Range covering the entire node, including wrapper
* - `parentOuterRange`: Outer range of node's parent. Missing if there is no parent
* or if indexInNode is set.
*
* @throws {Error} Invalid mode
* @throws {Error} Invalid start offset
* @throws {Error} Invalid end offset
* @throws {Error} Failed to select any nodes
*/
ve.Document.prototype.selectNodes = function ( range, mode ) {
const doc = this.getDocumentNode(),
start = range.start,
end = range.end,
stack = [ {
// Node we are currently stepping through
// Note each iteration visits a child of node, not node itself
node: doc,
// Index of the child in node we're visiting
index: 0,
// First offset inside node
startOffset: 0
} ];
let retval = [],
currentFrame = stack[ 0 ],
startFound = false;
mode = mode || 'leaves';
Iif ( mode !== 'leaves' && mode !== 'branches' && mode !== 'covered' && mode !== 'siblings' ) {
throw new Error( 'Invalid mode: ' + mode );
}
Iif ( start < 0 || start > doc.getLength() ) {
throw new Error( 'Invalid start offset: ' + start );
}
Iif ( end < 0 || end > doc.getLength() ) {
throw new Error( 'Invalid end offset: ' + end );
}
Iif ( !doc.children || doc.children.length === 0 ) {
// Document has no children. This is weird
const nodeRange = new ve.Range( 0, doc.getLength() );
return [ {
node: doc,
range: new ve.Range( start, end ),
index: 0,
nodeRange: nodeRange,
nodeOuterRange: nodeRange
} ];
}
let left = doc.children[ 0 ].isWrapped() ? 1 : 0;
do {
const node = currentFrame.node.children[ currentFrame.index ];
const prevNode = currentFrame.node.children[ currentFrame.index - 1 ];
let nextNode = currentFrame.node.children[ currentFrame.index + 1 ];
const right = left + node.getLength();
// Is the start inside node?
const startInside = start >= left && start <= right;
// Is the end inside node?
const endInside = end >= left && end <= right;
// Does the node have wrapping elements around it
let isWrapped = node.isWrapped();
// Is there an unwrapped node right before this node?
const isPrevUnwrapped = prevNode ? !prevNode.isWrapped() : false;
// Is there an unwrapped node right after this node?
const isNextUnwrapped = nextNode ? !nextNode.isWrapped() : false;
// Is this node an empty non-content branch node?
const isEmptyBranch = ( node.getLength() === 0 || node.shouldIgnoreChildren() ) &&
!node.isContent() && !node.canContainContent();
// Is the start between prevNode's closing and node or between the parent's opening and node?
const startBetween = ( isWrapped ? start === left - 1 : start === left ) && !isPrevUnwrapped;
// Is the end between node and nextNode's opening or between node and the parent's closing?
const endBetween = ( isWrapped ? end === right + 1 : end === right ) && !isNextUnwrapped;
let parentRange = new ve.Range(
currentFrame.startOffset,
currentFrame.startOffset + currentFrame.node.getLength()
);
let parentFrame;
if ( isWrapped && end === left - 1 && currentFrame.index === 0 ) {
// The selection ends here with an empty range at the beginning of the node
// TODO duplicated code
isWrapped = currentFrame.node.isWrapped();
retval.push( {
node: currentFrame.node,
indexInNode: 0,
range: new ve.Range( end, end ),
nodeRange: parentRange,
nodeOuterRange: new ve.Range(
parentRange.start - isWrapped, parentRange.end + isWrapped
)
} );
parentFrame = stack[ stack.length - 2 ];
if ( parentFrame ) {
retval[ retval.length - 1 ].index = parentFrame.index;
}
return retval;
}
if ( start === end && ( startBetween || endBetween ) && isWrapped ) {
// Empty range in the parent, outside of any child
isWrapped = currentFrame.node.isWrapped();
retval = [ {
node: currentFrame.node,
indexInNode: currentFrame.index + ( endBetween ? 1 : 0 ),
range: new ve.Range( start, end ),
nodeRange: parentRange,
nodeOuterRange: new ve.Range(
parentRange.start - isWrapped, parentRange.end + isWrapped
)
} ];
parentFrame = stack[ stack.length - 2 ];
if ( parentFrame ) {
retval[ 0 ].index = parentFrame.index;
}
return retval;
} else if ( startBetween ) {
// start is between the previous sibling and node
// so the selection covers all or part of node
// Descend if
// - we are in leaves mode, OR
// - we are in covered mode and the end is inside node OR
// - we are in branches mode and node is a branch (can have grandchildren)
// AND
// the node is non-empty and doesn't handle its own children
if ( ( mode === 'leaves' ||
( mode === 'covered' && endInside ) ||
( mode === 'branches' && node.canHaveChildrenNotContent() ) ) &&
node.children && node.children.length && !node.shouldIgnoreChildren()
) {
// Descend into node
currentFrame = {
node: node,
index: 0,
startOffset: left
};
stack.push( currentFrame );
startFound = true;
// If the first child of node has an opening, skip over it
Iif ( node.children[ 0 ].isWrapped() ) {
left++;
}
continue;
} else if ( !endInside ) {
// All of node is covered
retval.push( {
node: node,
// No 'range' because the entire node is covered
index: currentFrame.index,
nodeRange: new ve.Range( left, right ),
nodeOuterRange: new ve.Range( left - isWrapped, right + isWrapped ),
parentOuterRange: new ve.Range(
parentRange.start - currentFrame.node.isWrapped(),
parentRange.end + currentFrame.node.isWrapped()
)
} );
startFound = true;
} else {
// Part of node is covered
return [ {
node: node,
range: new ve.Range( start, end ),
index: currentFrame.index,
nodeRange: new ve.Range( left, right ),
nodeOuterRange: new ve.Range( left - isWrapped, right + isWrapped ),
parentOuterRange: new ve.Range(
parentRange.start - currentFrame.node.isWrapped(),
parentRange.end + currentFrame.node.isWrapped()
)
} ];
}
} else if ( startInside && endInside ) {
if ( node.children && node.children.length &&
( mode !== 'branches' || node.canHaveChildrenNotContent() ) ) {
// Descend into node
currentFrame = {
node: node,
index: 0,
startOffset: left
};
stack.push( currentFrame );
// If the first child of node has an opening, skip over it
if ( node.children[ 0 ].isWrapped() ) {
left++;
}
continue;
} else {
// node is a leaf node and the range is entirely inside it
retval = [ {
node: node,
range: new ve.Range( start, end ),
index: currentFrame.index,
nodeRange: new ve.Range( left, right ),
nodeOuterRange: new ve.Range( left - isWrapped, right + isWrapped ),
parentOuterRange: new ve.Range(
parentRange.start - currentFrame.node.isWrapped(),
parentRange.end + currentFrame.node.isWrapped()
)
} ];
if ( isEmptyBranch ) {
retval[ 0 ].indexInNode = 0;
}
return retval;
}
} else if ( startInside ) {
if ( ( mode === 'leaves' ||
mode === 'covered' ||
( mode === 'branches' && node.canHaveChildrenNotContent() ) ) &&
node.children && node.children.length
) {
// node is a branch node and the start is inside it
// Descend into it
currentFrame = {
node: node,
index: 0,
startOffset: left
};
stack.push( currentFrame );
// If the first child of node has an opening, skip over it
if ( node.children[ 0 ].isWrapped() ) {
left++;
}
continue;
} else {
// node is a leaf node and the start is inside it
// Add to retval and keep going
retval.push( {
node: node,
range: new ve.Range( start, right ),
index: currentFrame.index,
nodeRange: new ve.Range( left, right ),
nodeOuterRange: new ve.Range( left - isWrapped, right + isWrapped ),
parentOuterRange: new ve.Range(
parentRange.start - currentFrame.node.isWrapped(),
parentRange.end + currentFrame.node.isWrapped()
)
} );
startFound = true;
}
} else if ( endBetween ) {
// end is between node and the next sibling
// start is not inside node, so the selection covers
// all of node, then ends
if (
( mode === 'leaves' || ( mode === 'branches' && node.canHaveChildrenNotContent() ) ) &&
node.children && node.children.length
) {
// Descend into node
currentFrame = {
node: node,
index: 0,
startOffset: left
};
stack.push( currentFrame );
// If the first child of node has an opening, skip over it
Iif ( node.children[ 0 ].isWrapped() ) {
left++;
}
continue;
} else {
// All of node is covered
retval.push( {
node: node,
// No 'range' because the entire node is covered
index: currentFrame.index,
nodeRange: new ve.Range( left, right ),
nodeOuterRange: new ve.Range( left - isWrapped, right + isWrapped ),
parentOuterRange: new ve.Range(
parentRange.start - currentFrame.node.isWrapped(),
parentRange.end + currentFrame.node.isWrapped()
)
} );
return retval;
}
} else if ( endInside ) {
if ( ( mode === 'leaves' ||
mode === 'covered' ||
( mode === 'branches' && node.canHaveChildrenNotContent() ) ) &&
node.children && node.children.length
) {
// node is a branch node and the end is inside it
// Descend into it
currentFrame = {
node: node,
index: 0,
startOffset: left
};
stack.push( currentFrame );
// If the first child of node has an opening, skip over it
if ( node.children[ 0 ].isWrapped() ) {
left++;
}
continue;
} else {
// node is a leaf node and the end is inside it
// Add to retval and return
retval.push( {
node: node,
range: new ve.Range( left, end ),
index: currentFrame.index,
nodeRange: new ve.Range( left, right ),
nodeOuterRange: new ve.Range( left - isWrapped, right + isWrapped ),
parentOuterRange: new ve.Range(
parentRange.start - currentFrame.node.isWrapped(),
parentRange.end + currentFrame.node.isWrapped()
)
} );
return retval;
}
} else if ( startFound && end > right ) {
// Neither the start nor the end is inside node, but we found the start earlier,
// so node must be between the start and the end
// Add the entire node, so no range property
if (
( mode === 'leaves' || ( mode === 'branches' && node.canHaveChildrenNotContent() ) ) &&
node.children && node.children.length
) {
// Descend into node
currentFrame = {
node: node,
index: 0,
startOffset: left
};
stack.push( currentFrame );
// If the first child of node has an opening, skip over it
if ( node.children[ 0 ].isWrapped() ) {
left++;
}
continue;
} else {
// All of node is covered
retval.push( {
node: node,
// No 'range' because the entire node is covered
index: currentFrame.index,
nodeRange: new ve.Range( left, right ),
nodeOuterRange: new ve.Range( left - isWrapped, right + isWrapped ),
parentOuterRange: new ve.Range(
parentRange.start - currentFrame.node.isWrapped(),
parentRange.end + currentFrame.node.isWrapped()
)
} );
}
}
// Move to the next node
if ( nextNode ) {
// The next node exists
// Advance the index; the start of the next iteration will essentially
// do node = nextNode;
currentFrame.index++;
// Advance to the first offset inside nextNode
left = right +
// Skip over node's closing, if present
( node.isWrapped() ? 1 : 0 ) +
// Skip over nextNode's opening, if present
( nextNode.isWrapped() ? 1 : 0 );
} else {
// There is no next node, move up the stack until there is one
left = right +
// Skip over node's closing, if present
( node.isWrapped() ? 1 : 0 );
while ( !nextNode ) {
// Check if the start is right past the end of this node, at the end of
// the parent
if ( node.isWrapped() && start === left ) {
// TODO duplicated code
parentRange = new ve.Range( currentFrame.startOffset,
currentFrame.startOffset + currentFrame.node.getLength()
);
isWrapped = currentFrame.node.isWrapped();
retval = [ {
node: currentFrame.node,
indexInNode: currentFrame.index + 1,
range: new ve.Range( left, left ),
nodeRange: parentRange,
nodeOuterRange: new ve.Range(
parentRange.start - isWrapped, parentRange.end + isWrapped
)
} ];
parentFrame = stack[ stack.length - 2 ];
Eif ( parentFrame ) {
retval[ 0 ].index = parentFrame.index;
}
}
// Move up the stack
stack.pop();
if ( stack.length === 0 ) {
// This shouldn't be possible
return retval;
}
currentFrame = stack[ stack.length - 1 ];
currentFrame.index++;
nextNode = currentFrame.node.children[ currentFrame.index ];
// Skip over the parent node's closing
// (this is present for sure, because the parent has children)
left++;
}
// Skip over nextNode's opening if present
Eif ( nextNode.isWrapped() ) {
left++;
}
}
} while ( end >= left - 1 );
Iif ( retval.length === 0 ) {
throw new Error( 'Failed to select any nodes' );
}
return retval;
};
/**
* Get groups of sibling nodes covered by the given range.
*
* @param {ve.Range} range
* @return {Array} Array of objects. Each object has the following keys:
*
* - nodes: Array of sibling nodes covered by a part of range
* - parent: Parent of all of these nodes
* - grandparent: parent's parent
*/
ve.Document.prototype.getCoveredSiblingGroups = function ( range ) {
const leaves = this.selectNodes( range, 'leaves' ),
groups = [];
let lastEndOffset = 0;
for ( let i = 0; i < leaves.length; i++ ) {
Iif ( leaves[ i ].nodeOuterRange.end <= lastEndOffset ) {
// This range is contained within a range we've already processed
continue;
}
let node = leaves[ i ].node;
// Traverse up to a content branch from content elements
if ( node.isContent() ) {
node = node.getParent();
}
const parentNode = node.getParent();
Iif ( !parentNode ) {
break;
}
// Group this with its covered siblings
groups.push( {
parent: parentNode,
grandparent: parentNode.getParent(),
nodes: []
} );
// Seek forward to the last covered sibling
let siblingNode = node;
do {
// Add this to its sibling's group
groups[ groups.length - 1 ].nodes.push( siblingNode );
i++;
if ( leaves[ i ] === undefined ) {
break;
}
// Traverse up to a content branch from content elements
siblingNode = leaves[ i ].node;
Eif ( siblingNode.isContent() ) {
siblingNode = siblingNode.getParent();
}
} while ( siblingNode.getParent() === parentNode );
i--;
lastEndOffset = parentNode.getOuterRange().end;
}
return groups;
};
/**
* Test whether a range lies within a single leaf node.
*
* @param {ve.Range} range The range to test
* @return {boolean} Whether the range lies within a single node
*/
ve.Document.prototype.rangeInsideOneLeafNode = function ( range ) {
const selected = this.selectNodes( range, 'leaves' );
return selected.length === 1 && selected[ 0 ].nodeRange.containsRange( range ) && selected[ 0 ].indexInNode === undefined;
};
/**
* Callback when a node is attached with ve.Node#setDocument
*
* The node and all its children are guaranteed to be attached
*
* @param {ve.Node} node The node attached
* @fires ve.Document#nodeAttached
*/
ve.Document.prototype.nodeAttached = function ( node ) {
this.emit( 'nodeAttached', node );
};
/**
* Callback when a node is attached with ve.Node#setDocument
*
* The node and all its children are guaranteed to be attached
*
* @param {ve.Node} node The node detached
* @fires ve.Document#nodeDetached
*/
ve.Document.prototype.nodeDetached = function ( node ) {
this.emit( 'nodeDetached', node );
};
|