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 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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 | 1x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 1x 1x 1293x 2740x 1x 16270x 1596x 14674x 80x 14594x 1160x 1160x 1160x 1x 2740x 2740x 2740x 1893x 1893x 1893x 1893x 1396x 1396x 1396x 380x 1016x 1016x 1016x 417x 599x 283x 316x 316x 316x 316x 35x 35x 35x 34x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1431x 734x 697x 697x 720x 720x 720x 720x 720x 697x 697x 316x 381x 3011x 3011x 3011x 3011x 5221x 3011x 1431x 1396x 35x 1580x 3011x 2325x 686x 3011x 3011x 3011x 3011x 8792x 8792x 5931x 2861x 533x 533x 533x 533x 533x 2861x 3011x 3011x 3011x 1247x 1247x 1247x 319x 319x 1247x 8x 8x 2740x 2740x 2740x 2740x 2740x 629x 629x 629x 629x 629x 620x 620x 620x 570x 620x 620x 183x 183x 183x 183x 183x 183x 530x 530x 530x 530x 530x 690x 690x 690x 88x 88x 88x 88x 88x 88x 88x 2740x 1827x 1x 1300x 1300x 1293x 1x 1305x 1305x 1305x 1305x 1305x 1305x 1305x 1305x 1305x 1305x 1x 1300x 1300x 3965x 1293x 1x 3976x 2566x 2566x 8240x 1410x 1359x 1783x 1783x 1251x 1251x 532x 532x 618x 618x 532x 532x 1359x 1940x 1940x 1247x 1243x 693x 693x 813x 813x 693x 693x 1x 1294x 1673x 1673x 1294x 379x 84x 295x 295x 295x 379x 1x 18647x 317x 18330x 18330x 18330x 18330x 18330x 8533x 9797x 1x 8619x 8619x 8619x 8383x 8619x 8245x 8245x 8245x 8245x 8245x 8245x 374x 374x 26x 25x 17x 25x 252x 67x 66x 55x 185x 185x 184x 102x 250x 7x 7x 7x 7x 7x 7x 89x 55x 55x 55x 14x 34x 3x 34x 34x 89x 89x 371x 1x 1783x 1783x 1783x 1783x 370x 1783x 283x 1500x 250x 1250x 626x 624x 624x 1x 1940x 1940x 1247x 1247x 693x 693x 1940x 624x 4x 624x 624x 623x 623x 1316x 693x 693x 116x 623x 623x 574x 574x 2x 572x 572x 263x 49x 14x 49x 49x 1x 1x 881x 881x 250x 631x 1x 713x 713x 631x 1x 631x 631x 631x 630x 630x 353x 1x 693x 693x 693x 693x 577x 1x 185x 185x 185x 185x 184x 184x 184x 82x 1x 93x 93x 93x 93x 91x 91x 91x 19x 1x 631x 631x 631x 631x 1x 533x 533x 283x 283x 250x 250x 533x 533x 1x 2470x 2470x 6253x 6253x 3673x 3673x 6253x 2470x 1x 2470x 2470x 1031x 1439x 2470x 815x 622x 815x 1x 19776x 1x 19936x 1x 19773x 1x 19932x 19932x 19932x 1x 39712x 3389x 3389x 3389x 55x 3389x 36323x 5517x 5517x 2043x 30806x 39712x 18500x 21212x 21212x 21212x 1x 39705x 39705x 39705x 56501x 56501x 56501x 56501x 44680x 44680x 1150x 43530x 43530x 43530x 43530x 39990x 3540x 3540x 567x 56501x 56501x 36165x 39705x 1x 1826x 1x 1010x 1x 2612x 1x 786x 786x 244x 542x 2x 1x 816x 816x 816x 816x 816x 1x 815x 1x 814x 755x 755x 1x | /*!
* VisualEditor DataModel TreeModifier class.
*
* @copyright See AUTHORS.txt
*/
/**
* DataModel tree modifier, following the algorithm in T162762.
*
* The top-level process() method applies a transaction to the document in two stages. First,
* calculateTreeOperations() translates the linear transaction into tree operations; then,
* applyTreeOperations() updates both the linear model and the document tree simultaneously.
*
* Each tree operation takes one of the following forms:
*
* { type: 'insertNode', isContent: {boolean}, at: {Path}, element: {OpenElementLinModItem} }
* { type: 'removeNode', isContent: {boolean}, at: {Path}, element: {OpenElementLinModItem} }
* { type: 'moveNode', isContent: {boolean}, from: {Path}, to: {Path} }
* { type: 'insertText', isContent: true, at: {Path}, data: {TextLinModItem[]} }
* { type: 'removeText', isContent: true, at: {Path}, data: {TextLinModItem[]} }
* { type: 'moveText', isContent: true, from: {Path}, to: {Path}, length: {number} }
*
* Note that moveNode/moveText do not specify what content is being moved, and all the Node
* operations always operate on a single node at a time.
*
* {Path} is number[] representing the tree path from the DocumentNode to the position, except
* that within ContentBranchNodes, the offset is the linearized offset of the position.
*
* {OpenElementLinModItem} is the linear model value representing the node being inserted or
* removed, like { type: 'paragraph' } .
*
* {TextLinModItem[]} is the linear model values representing the text, like
* [ 'y', 'o', 'u', ' ', [ 'm', [ 'he4e7c54e2204d10b ] ], [ 'e' 'he4e7c54e2204d10b ] ] .
*
* The isContent flag is true if the operation is taking place inside a ContentBranchNode
* (so it is always true for text).
*
* NOTE: Instances of this class are not recyclable: you can only call .process( tx ) on them once.
*
* @class
* @constructor
*/
ve.dm.TreeModifier = function VeDmTreeModifier() {
// XXX we only need these two for dump() in tests
this.document = null;
this.insertions = null;
/**
* @property {Array} data Live document linear data
*/
this.data = null;
/**
* @property {ve.dm.Node[]} deletions Array (acting as set) of removed nodes
*/
this.deletions = null;
/**
* @property {ve.dm.TreeCursor} remover Tree cursor for removals
*/
this.remover = null;
/**
* @property {ve.dm.TreeCursor} inserter Tree cursor for insertions
*/
this.inserter = null;
/**
* @property {Object[]} treeOps Array of tree ops being built
*/
this.treeOps = null;
/**
* @property {number[]} insertedNodes Nodes to be inserted at context
*/
this.insertedNodes = null;
/**
* @property {number[]} insertedPositions Position within nodes to be inserted
*/
this.insertedPositions = null;
/**
* @property {Object} adjustmentTree Sparse tree, paths as indexes
* @property {number} adjustmentTree.inserted Child items inserted at this position
* @property {number} adjustmentTree.removed Child items removed at this position
* @property {Object} adjustmentTree.i Subtree at position i
*/
this.adjustmentTree = null;
};
OO.initClass( ve.dm.TreeModifier );
// Static methods
/**
* Apply tree operations to document tree and linear data simultaneously
*
* @param {boolean} isReversed Whether the transaction is an undo
* @param {ve.dm.Document} document The document to modify
* @param {Object[]} treeOps The tree operations
*/
ve.dm.TreeModifier.static.applyTreeOperations = function ( isReversed, document, treeOps ) {
for ( let i = 0, iLen = treeOps.length; i < iLen; i++ ) {
this.applyTreeOperation( isReversed, document, treeOps[ i ] );
}
};
/**
* Throw an exception if two pieces of linear data are not equal
*
* @param {Array} actual Document linear data to test
* @param {Array} expected Expected linear data to test against
*/
ve.dm.TreeModifier.static.checkEqualData = function ( actual, expected ) {
function replacer( name, value ) {
// TODO: replace this check with data equality class method checks
if (
name === 'generated' ||
name === 'changesSinceLoad' ||
name === 'originalDomElementsHash' ||
name === 'originalMw' ||
name === 'originalVariantInfo' ||
name === 'mw' ||
name === 'contentsUsed'
) {
return undefined;
}
// Drop .internal that would become empty after the replacements above
if ( name === 'internal' && JSON.stringify( value, replacer ) === '{}' ) {
return undefined;
}
return value;
}
const jActual = JSON.stringify( actual, replacer );
const jExpected = JSON.stringify( expected, replacer );
Iif ( jActual !== jExpected ) {
throw new Error( 'Expected ' + jExpected + ' but got ' + jActual );
}
};
/**
* Apply a tree operation to document tree and linear data simultaneously
*
* @param {boolean} isReversed Whether the transaction is an undo
* @param {ve.dm.Document} document The document to modify
* @param {Object} treeOp The tree operation
*/
ve.dm.TreeModifier.static.applyTreeOperation = function ( isReversed, document, treeOp ) {
const removedNodes = [],
addedNodes = [],
changedBranchNodes = [];
function splice( parentNode ) {
const removed = parentNode.splice.apply( parentNode, Array.prototype.slice.call( arguments, 1 ) );
ve.batchPush( removedNodes, removed );
ve.batchPush( addedNodes, Array.prototype.slice.call( arguments, 3 ) );
return removed;
}
function ensureText( position ) {
const node = position.node,
offset = position.offset;
if ( node.type === 'text' ) {
return position;
}
const pre = node.children[ offset - 1 ];
const post = node.children[ offset ];
if ( post && post.type === 'text' ) {
// Prefer post to pre, because we might want to remove text. (We shouldn't
// really have two adjacent text nodes, though)
return { node: post, offset: 0 };
}
if ( pre && pre.type === 'text' ) {
return { node: pre, offset: pre.length };
}
// There are no adjacent text nodes; insert one
Iif ( !node.hasChildren() ) {
throw new Error( 'Cannot add a child to ' + node.type + ' node' );
}
const newNode = new ve.dm.TextNode( 0 );
splice( node, offset, 0, newNode );
return { node: newNode, offset: 0 };
}
function ensureNotText( position ) {
const node = position.node,
offset = position.offset;
if ( node.type !== 'text' ) {
return position;
}
const parentNode = node.parent;
const parentOffset = node.parent.children.indexOf( node );
Iif ( offset === 0 ) {
// Position before the text node
return { node: parentNode, offset: parentOffset };
}
Iif ( offset === node.length ) {
return { node: parentNode, offset: parentOffset + 1 };
}
// Else we must split the text node
const length = node.length - offset;
node.adjustLength( -length );
const newNode = new ve.dm.TextNode( length );
splice( parentNode, parentOffset + 1, 0, newNode );
return { node: parentNode, offset: parentOffset + 1 };
}
function findContentPosition( node, contentOffset ) {
let i, offset, childLength, child;
if ( contentOffset === 0 ) {
return { node: node, offset: 0 };
}
// Find the child that will take us up to or past the contentOffset
offset = 0;
for ( i = 0; ; i++ ) {
child = node.children[ i ];
Iif ( !child ) {
throw new Error( 'Node does not reach offset' );
}
childLength = child.getOuterLength();
offset += childLength;
if ( offset >= contentOffset ) {
break;
}
}
if ( offset === contentOffset ) {
return { node: node, offset: i + 1 };
}
return { node: child, offset: contentOffset - offset + childLength };
}
function prepareSplice( pathAndOffset, isContent, wantText ) {
const path = pathAndOffset.slice( 0, -1 ),
offset = pathAndOffset[ pathAndOffset.length - 1 ];
let node = document.documentNode;
// Find node
for ( let i = 0, iLen = path.length; i < iLen; i++ ) {
node = node.children[ path[ i ] ];
}
let position;
if ( isContent ) {
// Determine position from (linearized) content offset
if ( wantText ) {
position = ensureText( findContentPosition( node, offset ) );
} else {
position = ensureNotText( findContentPosition( node, offset ) );
}
} else {
position = { node: node, offset: offset };
}
// Get linear offset
if ( position.node.type === 'text' || position.offset === 0 ) {
position.linearOffset = position.node.getRange().start + position.offset;
} else {
position.linearOffset = position.node.children[ position.offset - 1 ].getOuterRange().end;
}
return position;
}
// Increment the change counter on the closest containing branch node at this offset
// (This is used when converting to/from HTML, to decide whether loaded metadata offsets
// need round tripping)
function markBranchNodeChanged( offset ) {
const adj = isReversed ? -1 : 1;
let i = offset - 1;
while ( i >= 0 ) {
const item = document.data.getData( i-- );
if ( !(
ve.dm.LinearData.static.isOpenElementData( item ) &&
ve.dm.nodeFactory.lookup(
ve.dm.LinearData.static.getType( item )
).prototype instanceof ve.dm.BranchNode
) ) {
continue;
}
if ( item.internal && item.internal.changesSinceLoad !== undefined ) {
// Guard against marking the same node twice
Eif ( changedBranchNodes.indexOf( item ) === -1 ) {
const newItem = ve.copy( item );
changedBranchNodes.push( newItem );
newItem.internal.changesSinceLoad += adj;
document.data.splice( i + 1, 1, ve.deepFreeze( newItem ) );
}
}
// This is a branch node boundary, so go no further
break;
}
}
function spliceLinear( offset, remove, insert ) {
const content = ve.batchSplice( document.data, offset, remove, insert ? ve.deepFreeze( insert, true ) : [] );
markBranchNodeChanged( offset );
return content;
}
// Removes empty text node, or joins consecutive text nodes, at offset
function healTextNodes( node, offset ) {
const pre = node.children[ offset - 1 ];
let post = node.children[ offset ];
if ( post && post.type === 'text' && post.length === 0 ) {
// Remove empty text node
splice( node, offset, 1 );
post = node.children[ offset ];
}
if ( pre && post && pre.type === 'text' && post.type === 'text' ) {
pre.adjustLength( post.length );
splice( node, offset, 1 );
}
}
const isTextOp = treeOp.type.slice( -4 ) === 'Text';
const f = treeOp.from && prepareSplice( treeOp.from, treeOp.isContent, isTextOp );
const t = treeOp.to && prepareSplice( treeOp.to, treeOp.isContent, isTextOp );
// eslint-disable-next-line es-x/no-array-string-prototype-at
const a = treeOp.at && prepareSplice( treeOp.at, treeOp.isContent, isTextOp );
// Always adjust linear data before tree, to ensure consistency when node events
// are emitted.
switch ( treeOp.type ) {
case 'removeNode': {
// The node should have no contents, so its outer length should be 2
const data = spliceLinear( a.linearOffset, 2 );
this.checkEqualData( data, [ treeOp.element, { type: '/' + treeOp.element.type } ] );
splice( a.node, a.offset, 1 );
healTextNodes( a.node, a.offset );
break;
}
case 'insertNode': {
spliceLinear( a.linearOffset, 0, [ treeOp.element, { type: '/' + treeOp.element.type } ] );
const nodeToInsert = ve.dm.nodeFactory.createFromElement( treeOp.element );
if ( nodeToInsert instanceof ve.dm.BranchNode ) {
nodeToInsert.setupBlockSlugs();
}
splice( a.node, a.offset, 0, nodeToInsert );
break;
}
case 'moveNode': {
const data = spliceLinear( f.linearOffset, f.node.children[ f.offset ].getOuterLength() );
// No need to use local splice function as we know the node is going
// to be re-inserted immediately.
const movedNode = f.node.splice( f.offset, 1 )[ 0 ];
const adjustment = t.linearOffset > f.linearOffset ? data.length : 0;
spliceLinear( t.linearOffset - adjustment, 0, data );
t.node.splice( t.offset, 0, movedNode );
break;
}
case 'removeText': {
const data = spliceLinear( a.linearOffset, treeOp.data.length );
this.checkEqualData( data, treeOp.data );
a.node.adjustLength( -treeOp.data.length );
healTextNodes( a.node.parent, a.node.parent.children.indexOf( a.node ) );
break;
}
case 'insertText': {
spliceLinear( a.linearOffset, 0, treeOp.data );
a.node.adjustLength( treeOp.data.length );
break;
}
case 'moveText': {
const data = spliceLinear( f.linearOffset, treeOp.length );
f.node.adjustLength( -treeOp.length );
healTextNodes( f.node.parent, f.node.parent.children.indexOf( f.node ) );
const adjustment = t.linearOffset > f.linearOffset ? data.length : 0;
spliceLinear( t.linearOffset - adjustment, 0, data );
t.node.adjustLength( treeOp.length );
break;
}
default:
throw new Error( 'Unknown tree op type: ' + treeOp.type );
}
if ( addedNodes.length || removedNodes.length ) {
document.updateNodesByType( addedNodes, removedNodes );
}
};
/**
* The top level method: modify document tree according to transaction
*
* @param {ve.dm.Document} document The document
* @param {ve.dm.Transaction} transaction The transaction
*/
ve.dm.TreeModifier.prototype.process = function ( document, transaction ) {
this.setup( document );
this.calculateTreeOperations( transaction );
// Prior rollback logic removed: treeOps is now guaranteed to work
this.constructor.static.applyTreeOperations( transaction.isReversed, document, this.treeOps );
};
/**
* Setup state variables
*
* @param {ve.dm.Document} document The document to be processed
*/
ve.dm.TreeModifier.prototype.setup = function ( document ) {
// XXX we only need these two properties for dump() in tests
this.document = document;
this.insertions = [];
// Initialize state
this.data = document.data;
this.deletions = [];
this.remover = new ve.dm.TreeCursor( document.getDocumentNode(), [] );
this.inserter = new ve.dm.TreeCursor( document.getDocumentNode(), this.deletions );
this.treeOps = [];
this.insertedNodes = [];
this.insertedPositions = [];
this.adjustmentTree = { offsetsUsed: [] };
};
/**
* Transform linear operations into tree operations
*
* @param {ve.dm.Transaction} transaction The transaction
*/
ve.dm.TreeModifier.prototype.calculateTreeOperations = function ( transaction ) {
const linearOps = transaction.operations;
for ( let i = 0, iLen = linearOps.length; i < iLen; i++ ) {
this.processLinearOperation( linearOps[ i ] );
}
this.processImplicitFinalRetain();
};
/**
* Translate a linear operation into tree operations
*
* #processImplicitFinalRetain should be called once all operations have been processed
*
* @param {Object} linearOp The linear operation
*/
ve.dm.TreeModifier.prototype.processLinearOperation = function ( linearOp ) {
if ( linearOp.type === 'retain' ) {
let retainLength = linearOp.length;
while ( retainLength > 0 ) {
retainLength -= this.processRetain( retainLength );
}
} else if ( linearOp.type === 'replace' ) {
let i, iLen, item, data;
for ( i = 0, iLen = linearOp.remove.length; i < iLen; i++ ) {
item = linearOp.remove[ i ];
if ( item.type ) {
this.processRemove( item );
continue;
}
// Group the whole current run of text, and process it
data = [ item ];
while ( ++i < iLen && !linearOp.remove[ i ].type ) {
item = linearOp.remove[ i ];
data.push( item );
}
i--;
this.processRemove( data );
}
for ( i = 0, iLen = linearOp.insert.length; i < iLen; i++ ) {
item = linearOp.insert[ i ];
if ( item.type ) {
this.processInsert( item );
continue;
}
// Group the whole current run of text, and process it
data = [ item ];
while ( ++i < iLen && !linearOp.insert[ i ].type ) {
item = linearOp.insert[ i ];
data.push( item );
}
i--;
this.processInsert( data );
}
}
// Else the linear operation type must be 'attribute': do nothing
};
/**
* Retain to the end of the content
*/
ve.dm.TreeModifier.prototype.processImplicitFinalRetain = function () {
// Pretend there is an implicit retain to the end of the document
// TODO: fix our tests so this is unnecessary, then check for exhaustion instead
while ( true ) {
const node = this.remover.node;
if ( !node || (
node === this.remover.root &&
this.remover.offset === node.children.length
) ) {
return;
}
let retainLength;
if ( node.type === 'text' ) {
// Retain all remaining text; if there is no remaining text then
// retain a single offset.
retainLength = Math.max( 1, node.length - this.remover.offset );
} else Iif ( !node.hasChildren() ) {
retainLength = 1;
} else {
const item = node.children[ this.remover.offset ];
retainLength = item ? item.getOuterLength() : 1;
}
this.processRetain( retainLength );
}
};
/**
* Test whether both pointers point to the same location
*
* @return {boolean} True if the paths and offsets are identical
*/
ve.dm.TreeModifier.prototype.cursorsMatch = function () {
if ( this.insertedPositions.length > 0 ) {
return false;
}
const rawRemoverPosition = this.getRawRemoverPosition( {
path: this.remover.path,
offset: this.remover.offset,
node: this.remover.node
} );
const rawInserterPosition = this.getRawInserterPosition();
const adjustedRemoverPosition = this.adjustRemoverPosition( rawRemoverPosition );
const adjustedInserterPosition = this.adjustInserterPosition( rawInserterPosition );
// Optimization: adjustedRemoverPosition and adjustedInserterPosition are very
// often arrays of length 1. This simple check is much faster than a full
// JSON.stringify comparison.
if (
adjustedRemoverPosition.length === 1 && adjustedInserterPosition.length === 1 &&
adjustedRemoverPosition[ 0 ] === adjustedInserterPosition[ 0 ]
) {
return true;
}
return JSON.stringify( adjustedRemoverPosition ) === JSON.stringify( adjustedInserterPosition );
};
/**
* Process the retention of content passed by one step of the remover
*
* If the inserter and remover are at the same place, just skip content.
*
* Else the remover *feeds* the inserter:
* - The inserter plans insertions in the (imagined, hypothetical) document
* - But the only move it can make in the (immutable) real document is to step out of nodes
* - It cannot skip past nodes (other than skipping remaining siblings when stepping out)
* - If the remover steps into a node, the inserter creates a node of the same type
* - If the remover crosses content, it is moved to the inserter
* - If the remover steps out of a node, the inserter steps out of its node
*
* @param {number} maxLength The maximum amount of content to retain
* @return {number} The amount of content retained
*/
ve.dm.TreeModifier.prototype.processRetain = function ( maxLength ) {
const remover = this.remover,
inserter = this.inserter;
if ( this.insertedPositions.length === 0 ) {
this.inserter.crossIgnoredNodes();
}
let removerStep, inserterStep;
if ( this.cursorsMatch() ) {
// Pointers are in the same location, so advance them together.
// This is the only way both pointers can ever enter the same node;
// in any other case, a node entered at an 'open' tag by one pointer
// is marked as either as a deletion or a creation, so the other
// pointer will not follow.
removerStep = remover.stepAtMost( maxLength );
inserterStep = inserter.stepAtMost( maxLength );
Iif ( !removerStep ) {
throw new Error( 'Remover past end' );
}
Iif ( !inserterStep ) {
throw new Error( 'Inserter past end' );
}
Iif ( !this.cursorsMatch() ) {
throw new Error( 'Remover and inserter unexpectedly diverged' );
}
return removerStep.length;
}
// Else pointers are not in the same location (in fact they cannot lie in the
// same node)
removerStep = remover.stepAtMost( maxLength );
switch ( removerStep.type ) {
case 'crosstext':
this.pushMoveTextOp( removerStep );
if ( this.insertedPositions.length ) {
this.insertedPositions[ this.insertedPositions.length - 1 ] += removerStep.length;
}
break;
case 'cross':
if ( removerStep.item.type === 'text' ) {
this.pushMoveTextOp( removerStep );
if ( this.insertedPositions.length ) {
this.insertedPositions[ this.insertedPositions.length - 1 ] += removerStep.item.length;
}
} else {
this.deletions.push( removerStep.item );
this.pushMoveNodeOp( removerStep );
if ( this.insertedPositions.length ) {
this.insertedPositions[ this.insertedPositions.length - 1 ] +=
this.isInsertionContent() ? 2 : 1;
}
}
break;
case 'open': {
this.deletions.push( removerStep.item );
// Clone last open and step in
const element = removerStep.item.getClonedElement( true );
this.pushInsertNodeOp( element );
this.insertedNodes.push( element );
// This 0 position is invalid if element is content (because the offset should be
// linearized), but it will get popped immediately
this.insertedPositions.push( 0 );
break;
}
case 'close':
if ( this.insertedPositions.length ) {
this.insertedNodes.pop();
this.insertedPositions.pop();
if ( this.insertedPositions.length ) {
this.insertedPositions[ this.insertedPositions.length - 1 ] +=
this.isInsertionContent() ? 2 : 1;
}
} else {
if ( inserter.node.type === 'text' ) {
inserter.stepOut();
}
inserterStep = inserter.stepOut();
Iif ( inserterStep.item.type !== removerStep.item.type ) {
throw new Error( 'Expected ' + removerStep.item.type + ', not ' +
inserterStep.item.type );
}
}
this.pushRemoveLastIfInDeletions();
break;
}
return removerStep.length;
};
/**
* Process the removal of some items
*
* @param {Object|Array} itemOrData An open tag, a close tag, or an array of text items
*/
ve.dm.TreeModifier.prototype.processRemove = function ( itemOrData ) {
const cursorsMatch = this.cursorsMatch(),
length = itemOrData.length || 1,
step = this.remover.stepAtMost( length );
if ( cursorsMatch && ( step.type === 'cross' || step.type === 'crosstext' ) ) {
this.inserter.stepAtMost( length );
}
if ( step.type === 'crosstext' ) {
this.pushRemoveTextOp( step );
} else if ( step.type === 'cross' ) {
this.pushRemoveLast();
} else if ( step.type === 'open' ) {
this.deletions.push( step.item );
} else Eif ( step.type === 'close' ) {
this.pushRemoveLastIfInDeletions();
}
};
/**
* Process the insertion an open tag, a close tag, or an array of text items
*
* @param {Object|Array} itemOrData An open tag, a close tag, or an array of text items
*/
ve.dm.TreeModifier.prototype.processInsert = function ( itemOrData ) {
const inserter = this.inserter;
let item, type, data;
if ( itemOrData.type ) {
item = itemOrData;
type = item.type.charAt( 0 ) === '/' ? 'close' : 'open';
} else {
data = itemOrData;
type = 'crosstext';
}
if ( type === 'open' ) {
if ( inserter.node.type === 'text' ) {
// Step past the end of the text node, even if that skips past some
// content (in which case the remover logically must later cross that
// content in either processRemove or processRetain).
inserter.stepOut();
}
const element = ve.copy( item );
this.pushInsertNodeOp( element );
this.insertedNodes.push( element );
// This 0 position is invalid if element is content (because the offset should be
// linearized), but it will get popped immediately
this.insertedPositions.push( 0 );
} else if ( type === 'crosstext' ) {
this.pushInsertTextOp( ve.copy( data ) );
if ( this.insertedPositions.length ) {
this.insertedPositions[ this.insertedPositions.length - 1 ] += data.length;
}
} else Eif ( type === 'close' ) {
if ( this.insertedPositions.length ) {
const insertedNode = this.insertedNodes.pop();
if ( insertedNode.type !== item.type.slice( 1 ) ) {
throw new Error( 'Expected closing for ' + insertedNode.type +
' but got closing for ' + item.type.slice( 1 ) );
}
this.insertedPositions.pop();
if ( this.insertedPositions.length ) {
this.insertedPositions[ this.insertedPositions.length - 1 ] +=
this.isInsertionContent() ? 2 : 1;
}
} else {
// Step past the next close tag, even if that skips past some content (in which
// case the remover logically must later cross that content in either
// processRemove or processRetain).
if ( inserter.node.type === 'text' ) {
inserter.stepOut();
}
const step = inserter.stepOut();
if ( step.item.type !== item.type.slice( 1 ) ) {
throw new Error( 'Expected closing for ' + step.item.type +
' but got closing for ' + item.type.slice( 1 ) );
}
}
}
};
/**
* Push into treeOps the removal of the last remover step, which must be 'cross' or 'close'
*/
ve.dm.TreeModifier.prototype.pushRemoveLast = function () {
const step = this.remover.lastStep;
if ( step.item.type === 'text' ) {
this.pushRemoveTextOp( step );
} else {
this.pushRemoveNodeOp( step );
}
};
/**
* Push into treeOps the removal of the last remover step, if that item marked as deleted
*/
ve.dm.TreeModifier.prototype.pushRemoveLastIfInDeletions = function () {
const i = this.deletions.indexOf( this.remover.lastStep.item );
if ( i !== -1 ) {
this.pushRemoveLast();
}
};
/**
* Push into treeOps the node insertion at the current inserter position
*
* @param {ve.dm.Node} element The element to insert (inserted into treeOps without copying)
*/
ve.dm.TreeModifier.prototype.pushInsertNodeOp = function ( element ) {
const isContent = this.isInsertionContent(),
rawInserterPosition = this.getRawInserterPosition();
this.checkCanInsertNodeType( element.type );
this.treeOps.push( {
type: 'insertNode',
isContent: isContent,
at: this.adjustInserterPosition( rawInserterPosition ),
element: element
} );
if ( this.insertedPositions.length === 0 ) {
this.modifyAdjustmentTree( rawInserterPosition, isContent ? 2 : 1, false );
}
};
/**
* Push into treeOps the text insertion at the current inserter position
*
* @param {Array} data The text data to insert
*/
ve.dm.TreeModifier.prototype.pushInsertTextOp = function ( data ) {
const rawInserterPosition = this.getRawInserterPosition();
this.checkCanInsertText();
this.treeOps.push( {
type: 'insertText',
isContent: true,
at: this.adjustInserterPosition( rawInserterPosition ),
data: data
} );
if ( this.insertedPositions.length === 0 ) {
this.modifyAdjustmentTree( rawInserterPosition, data.length, false );
}
};
/**
* Push into treeOps a move of a node to the current inserter position
*
* @param {ve.dm.TreeCursor.Step} removerStep The remover step over the node
*/
ve.dm.TreeModifier.prototype.pushMoveNodeOp = function ( removerStep ) {
const rawRemoverPosition = this.getRawRemoverPosition( removerStep ),
rawInserterPosition = this.getRawInserterPosition(),
isContent = this.doesTypeTakeContent( removerStep.node.type );
this.checkCanInsertNodeType( removerStep.item.type );
this.treeOps.push( {
type: 'moveNode',
isContent: isContent,
from: this.adjustRemoverPosition( rawRemoverPosition ),
to: this.adjustInserterPosition( rawInserterPosition )
} );
this.modifyAdjustmentTree( rawRemoverPosition, isContent ? -2 : -1, true );
if ( this.insertedPositions.length === 0 ) {
this.modifyAdjustmentTree( rawInserterPosition, isContent ? 2 : 1, false );
}
};
/**
* Push into treeOps a move of some text to the current inserter position
*
* @param {ve.dm.TreeCursor.Step} removerStep The remover step over the text
*/
ve.dm.TreeModifier.prototype.pushMoveTextOp = function ( removerStep ) {
const length = removerStep.type === 'crosstext' ?
removerStep.length :
removerStep.item.getLength(),
rawRemoverPosition = this.getRawRemoverPosition( removerStep ),
rawInserterPosition = this.getRawInserterPosition();
this.checkCanInsertText();
this.treeOps.push( {
type: 'moveText',
isContent: true,
from: this.adjustRemoverPosition( rawRemoverPosition ),
to: this.adjustInserterPosition( rawInserterPosition ),
length: length
} );
this.modifyAdjustmentTree( rawRemoverPosition, -length, false );
if ( this.insertedPositions.length === 0 ) {
this.modifyAdjustmentTree( rawInserterPosition, length, false );
}
};
/**
* Push into treeOps a removal of a node
*
* @param {ve.dm.TreeCursor.Step} removerStep The remover step over the node
*/
ve.dm.TreeModifier.prototype.pushRemoveNodeOp = function ( removerStep ) {
const rawRemoverPosition = this.getRawRemoverPosition( removerStep ),
isContent = this.doesTypeTakeContent( removerStep.node.type );
this.treeOps.push( {
type: 'removeNode',
isContent: isContent,
at: this.adjustRemoverPosition( rawRemoverPosition ),
element: removerStep.item.getClonedElement( true )
} );
this.modifyAdjustmentTree( rawRemoverPosition, isContent ? -2 : -1, true );
};
/**
* Push into treeOps a removal of some text
*
* @param {ve.dm.TreeCursor.Step} removerStep The remover step over the text
*/
ve.dm.TreeModifier.prototype.pushRemoveTextOp = function ( removerStep ) {
const rawRemoverPosition = this.getRawRemoverPosition( removerStep );
let start, end;
if ( removerStep.type === 'crosstext' ) {
start = removerStep.node.getRange().start + removerStep.offset;
end = start + removerStep.length;
} else {
start = removerStep.item.getRange().start;
end = removerStep.item.getRange().end;
}
this.treeOps.push( {
type: 'removeText',
isContent: true,
at: this.adjustRemoverPosition( rawRemoverPosition ),
data: ve.copy( this.data.slice( start, end ) )
} );
this.modifyAdjustmentTree( rawRemoverPosition, start - end, false );
};
/**
* Return adjustment tree node at a given offset path, inserting it if necessary
*
* @param {number[]} position Offset path in the adjustment tree
* @return {Object} The adjustment tree node
*/
ve.dm.TreeModifier.prototype.findOrCreateAdjustmentNode = function ( position ) {
let adjustmentNode = this.adjustmentTree;
for ( let i = 0, len = position.length; i < len; i++ ) {
const offset = position[ i ];
if ( !adjustmentNode[ offset ] ) {
adjustmentNode[ offset ] = { offsetsUsed: [] };
adjustmentNode.offsetsUsed.push( offset );
}
adjustmentNode = adjustmentNode[ offset ];
}
return adjustmentNode;
};
/**
* Modify the adjustment in the adjustment tree at a given offset path
*
* @param {number[]} rawPosition Unadjusted offset path
* @param {number} diff Adjustment at rawPosition
* @param {boolean} deleteDescendants If true, delete all adjustments at paths descending from here
*/
ve.dm.TreeModifier.prototype.modifyAdjustmentTree = function ( rawPosition, diff, deleteDescendants ) {
const adjustmentNode = this.findOrCreateAdjustmentNode( rawPosition );
if ( diff > 0 ) {
adjustmentNode.inserted = ( adjustmentNode.inserted || 0 ) + diff;
} else {
adjustmentNode.removed = ( adjustmentNode.removed || 0 ) - diff;
}
if ( deleteDescendants ) {
adjustmentNode.offsetsUsed.forEach( ( i ) => {
delete adjustmentNode[ i ];
} );
adjustmentNode.offsetsUsed = [];
}
};
/**
* Get the raw position of a node stepped over by the remover
*
* @param {ve.dm.TreeCursor.Step} step Remover step
* @return {number[]} The pathAndOffset, with offsets inside a ContentBranchNode linearized
*/
ve.dm.TreeModifier.prototype.getRawRemoverPosition = function ( step ) {
return this.getRawPosition( step.path, step.offset, step.node );
};
/**
* Get the raw position at the inserter
*
* @return {number[]} The pathAndOffset, with offsets inside a ContentBranchNode linearized
*/
ve.dm.TreeModifier.prototype.getRawInserterPosition = function () {
return this.getRawPosition( this.inserter.path, this.inserter.offset, this.inserter.node );
};
/**
* Get the adjusted position of a raw remover position
*
* @param {number[]} rawPosition The raw remover position
* @return {number[]} Adjusted pathAndOffset, with offsets inside a ContentBranchNode linearized
*/
ve.dm.TreeModifier.prototype.adjustRemoverPosition = function ( rawPosition ) {
return this.getAdjustedPosition( rawPosition, false );
};
/**
* Get the adjusted position of a raw inserter position, XXX
*
* @param {number[]} rawPosition The raw inserter position (must be its current position)
* @return {number[]} Adjusted pathAndOffset, with offsets inside a ContentBranchNode linearized, and including current position within nodes to be inserted, if any
*/
ve.dm.TreeModifier.prototype.adjustInserterPosition = function ( rawPosition ) {
// getAdjustedPosition returns a brand new array, so we can safely modify
// it with batchPush, which is much faster than concat (which creates a new array)
const positions = this.getAdjustedPosition( rawPosition, true );
ve.batchPush( positions, this.insertedPositions );
return positions;
};
/**
* Get the raw position of a node, with offsets inside a ContentBranchNode linearized
*
* @param {number[]} path Path to a node
* @param {number} offset Offset within the node
* @param {ve.dm.Node} node The node
* @return {number[]} The pathAndOffset, with offsets inside a ContentBranchNode linearized
*/
ve.dm.TreeModifier.prototype.getRawPosition = function ( path, offset, node ) {
let i, linearizedOffset;
// No need to check node.parent.hasChildren() below as node.parent
// is a parent so must have children.
if ( node.parent && node.parent.canContainContent() ) {
const numNodesBefore = path[ path.length - 1 ];
linearizedOffset = offset;
for ( i = 0; i < numNodesBefore; i++ ) {
linearizedOffset += node.parent.children[ i ].getOuterLength();
}
path = path.slice( 0, -1 );
} else if ( node.canContainContent() && node.hasChildren() ) {
linearizedOffset = 0;
for ( i = 0; i < offset; i++ ) {
linearizedOffset += node.children[ i ].getOuterLength();
}
} else {
linearizedOffset = offset;
}
if ( !path.length ) {
// Optimization, path is often empty
return [ linearizedOffset ];
}
path = path.slice();
// slice+push is faster than concat
path.push( linearizedOffset );
return path;
};
/**
* Get the adjusted position of a raw position
*
* @param {number[]} position The raw position
* @param {boolean} isInserter True for an inserter position; false for a remover position
* @return {number[]} Adjusted pathAndOffset, with offsets inside a ContentBranchNode linearized
*/
ve.dm.TreeModifier.prototype.getAdjustedPosition = function ( position, isInserter ) {
let node = this.adjustmentTree;
position = position.slice();
// Adjust each offset in the path so inserted nodes are counted
for ( let i = 0, iLen = position.length; i < iLen; i++ ) {
const positionI = position[ i ];
// The loop below is equivalent to:
//
// for ( j = 0, jLen = positionI + 1; j < jLen; j++ ) {
// childNode = node[ j ];
// if ( !childNode ) {
// continue;
// }
// ...
// }
//
// However as `node` is very sparse, it is slow to iterate over
// every position, so just iterate over the positions we have,
// then check the loop conditions later. (T261634)
// An offsetsUsed property is stored on every node instead of
// using a for..in loop as a for..in loop has to re-calculate
// the list of indexes to iterate over.
const jLen = positionI + 1;
const offsetsUsed = node.offsetsUsed;
for ( let k = 0, kLen = offsetsUsed.length; k < kLen; k++ ) {
const j = offsetsUsed[ k ];
if ( j >= jLen ) {
continue;
}
const childNode = node[ j ];
const inserted = childNode.inserted || 0;
const removed = childNode.removed || 0;
if ( i < iLen - 1 || j < jLen - 1 ) {
// This offset is strictly before position
position[ i ] += inserted - removed;
} else {
// This offset is exactly at position
// Don't adjust for removals
position[ i ] += inserted;
// Adjust for insertions, except if we are the inserter and the insertion is incomplete
// (note if insertedNodes.length > 0, then also inserted > 0)
if ( isInserter && this.insertedNodes.length > 0 ) {
// Incomplete means we are inside a (non text) node
position[ i ]--;
}
}
}
node = node[ positionI ];
if ( !node ) {
break;
}
}
return position;
};
/**
* Test whether a node type takes content
*
* @param {string} type The name of a ve.dm.Node type
* @return {boolean} Whether that type takes content
*/
ve.dm.TreeModifier.prototype.doesTypeTakeContent = function ( type ) {
return !!ve.dm.nodeFactory.canNodeContainContent( type );
};
/**
* Test whether the inserter is at a content position
*
* @return {boolean} Whether the inserter is at a content position
*/
ve.dm.TreeModifier.prototype.isInsertionContent = function () {
return this.doesTypeTakeContent( this.getTypeAtInserter() );
};
/**
* Get the type of the node in which the inserter lies
*
* @return {string} The node type
*/
ve.dm.TreeModifier.prototype.getTypeAtInserter = function () {
return this.insertedNodes.length > 0 ?
this.insertedNodes[ this.insertedNodes.length - 1 ].type :
this.inserter.node.type;
};
/**
* Throw an error if the inserter is not in a content position
*
* @throws {Error} Cannot insert text into a foo node
*/
ve.dm.TreeModifier.prototype.checkCanInsertText = function () {
const parentType = this.getTypeAtInserter();
if ( parentType === 'text' ) {
return;
}
if ( !ve.dm.nodeFactory.canNodeContainContent( parentType ) ) {
throw new Error( 'Cannot insert text into a ' + parentType + ' node' );
}
};
/**
* Throw an error if the inserter node cannot take a child of a specified type
*
* @param {string} nodeType The node type
* @throws {Error} Cannot add child
*/
ve.dm.TreeModifier.prototype.checkCanInsertNodeType = function ( nodeType ) {
const parentType = this.getTypeAtInserter(),
nodeClass = ve.dm.nodeFactory.lookup( nodeType ),
parentClass = ve.dm.nodeFactory.lookup( parentType ),
childNodeTypes = parentClass.static.childNodeTypes;
if ( Array.isArray( childNodeTypes ) && childNodeTypes.length === 0 ) {
throw new Error( 'Cannot add a child to ' + parentType + ' node' );
}
if ( nodeClass.static.isContent && !parentClass.static.canContainContent ) {
throw new Error( 'Cannot add content node (' + nodeType + ') to a ' + parentType + ' node' );
}
if ( !nodeClass.static.isMetaData ) {
Iif ( !nodeClass.static.isContent && parentClass.static.canContainContent ) {
throw new Error( 'Cannot add structure node (' + nodeType + ') to a ' + parentType + ' node' );
}
Iif ( Array.isArray( childNodeTypes ) && childNodeTypes.indexOf( nodeType ) === -1 ) {
throw new Error( 'Cannot add a ' + nodeType + ' node to ' + parentType + ' node' );
}
}
};
/* Initialization */
ve.dm.treeModifier = new ve.dm.TreeModifier();
|