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 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 | 1x 551x 551x 238x 87x 464x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 74x 1x 282x 1x 1188x 1188x 1188x 1x 1187x 1207x 914x 273x 1x 60x 123x 60x 60x 60x 60x 60x 1x 1x 1x 1x 18710x 18710x 18710x 18710x 18710x 2882x 15828x 15830x 15830x 181x 15830x 15830x 15828x 1x 16x 16x 16x 16x 16x 13x 13x 16x 10x 10x 24x 6x 3x 16x 31x 16x 16x 1x 3x 1x 41227x 41227x 41227x 41226x 1x 3x 3x 1x 1x 1x 1x 1x 1x 3853x 1x 32x 1x 1x 14x 12x 2x 1x 19x 1x 19x 1x 8x 8x 8x 1x 7x 2x 7x 1x 7x 1x 5x 1x 1x 1x 1x 1x 1x 855x 1x 6x 6x 15x 6x 1x 258x 1x 257x 612x 39x 573x 435x 138x 1x 4234x 4166x 68x 68x 68x 1x 21224x 21224x 6444x 21224x 13310x 5600x 5600x 230x 5370x 5370x 21224x 21224x 18742x 21224x 1x 17212x 374x 16838x 1x 1x 12x 1x 1x 130x 130x 128x 14x 14x 14x 14x 130x 132x 132x 264x 264x 3x 264x 1x 3x 1x 1x 3x 3x 1x 2x 1x 3x 3x 3x 1x 189x 1x 188x 188x 188x 203x 153x 50x 50x 90x 35x 15x 188x 1x 5131x 5131x 1x 5130x 5130x 5130x 8572x 8572x 8572x 62510x 62510x 8572x 1698x 6874x 2x 6872x 3494x 6872x 3430x 27626x 27626x 27645x 100x 3330x 1x 3038x 1x 6993x 6993x 1029x 1029x 1029x 6993x 1x 4105x 4489x 895x 3210x 3210x 1x 3209x 1x 5111x 5111x 1694x 3417x 1x 3468x 3468x 3468x 3468x 3468x 3468x 3468x 3468x 5269x 1637x 1637x 1637x 6x 1631x 1631x 1631x 872x 759x 3632x 738x 738x 738x 738x 738x 2894x 2894x 898x 898x 898x 898x 495x 403x 1996x 1996x 1996x 1996x 1996x 1357x 1x 90x 37x 53x 1x 632x 20x 632x 632x 19x 613x 1x 334x 334x 334x 326x 302x 334x 3x 331x 312x 301x 331x 1x | /*!
* VisualEditor utilities.
*
* @copyright See AUTHORS.txt
*/
/**
* Checks if an object is an instance of one or more classes.
*
* @param {Object} subject Object to check
* @param {Function[]} classes Classes to compare with
* @return {boolean} Object inherits from one or more of the classes
*/
ve.isInstanceOfAny = function ( subject, classes ) {
let i = classes.length;
while ( classes[ --i ] ) {
if ( subject instanceof classes[ i ] ) {
return true;
}
}
return false;
};
/**
* Get a deeply nested property of an object using variadic arguments, protecting against
* undefined property errors.
*
* `quux = OO.getProp( obj, 'foo', 'bar', 'baz' );` is equivalent to `quux = obj.foo.bar.baz;`
* except that the former protects against JS errors if one of the intermediate properties
* is undefined. Instead of throwing an error, this function will return undefined in
* that case.
*
* See https://doc.wikimedia.org/oojs/master/OO.html
*
* @method
* @param {Object} obj
* @param {...any} [keys]
* @return {Object|undefined} obj[arguments[1]][arguments[2]].... or undefined
*/
ve.getProp = OO.getProp;
/**
* Set a deeply nested property of an object using variadic arguments, protecting against
* undefined property errors.
*
* `OO.setProp( obj, 'foo', 'bar', 'baz' );` is equivalent to `obj.foo.bar = baz;` except that
* the former protects against JS errors if one of the intermediate properties is
* undefined. Instead of throwing an error, undefined intermediate properties will be
* initialized to an empty object. If an intermediate property is not an object, or if obj itself
* is not an object, this function will silently abort.
*
* See https://doc.wikimedia.org/oojs/master/OO.html
*
* @method
* @param {Object} obj
* @param {...any} [keys]
* @param {any} [value]
*/
ve.setProp = OO.setProp;
/**
* Delete a deeply nested property of an object using variadic arguments, protecting against
* undefined property errors, and deleting resulting empty objects.
*
* See https://doc.wikimedia.org/oojs/master/OO.html
*
* @method
* @param {Object} obj
* @param {...any} [keys]
*/
ve.deleteProp = OO.deleteProp;
/**
* Create a new object that is an instance of the same
* constructor as the input, inherits from the same object
* and contains the same own properties.
*
* This makes a shallow non-recursive copy of own properties.
* To create a recursive copy of plain objects, use #copy.
*
* var foo = new Person( mom, dad );
* foo.setAge( 21 );
* var foo2 = OO.cloneObject( foo );
* foo.setAge( 22 );
*
* // Then
* foo2 !== foo; // true
* foo2 instanceof Person; // true
* foo2.getAge(); // 21
* foo.getAge(); // 22
*
* See https://doc.wikimedia.org/oojs/master/OO.html
*
* @method
* @param {Object} origin
* @return {Object} Clone of origin
*/
ve.cloneObject = OO.cloneObject;
/**
* Get an array of all property values in an object.
*
* See https://doc.wikimedia.org/oojs/master/OO.html
*
* @method
* @param {Object} obj Object to get values from
* @return {Array} List of object values
*/
ve.getObjectValues = OO.getObjectValues;
/**
* Use binary search to locate an element in a sorted array.
*
* searchFunc is given an element from the array. `searchFunc(elem)` must return a number
* above 0 if the element we're searching for is to the right of (has a higher index than) elem,
* below 0 if it is to the left of elem, or zero if it's equal to elem.
*
* To search for a specific value with a comparator function (a `function cmp(a,b)` that returns
* above 0 if `a > b`, below 0 if `a < b`, and 0 if `a == b`), you can use
* `searchFunc = cmp.bind( null, value )`.
*
* See https://doc.wikimedia.org/oojs/master/OO.html
*
* @method
* @param {Array} arr Array to search in
* @param {Function} searchFunc Search function
* @param {boolean} [forInsertion] If not found, return index where val could be inserted
* @return {number|null} Index where val was found, or null if not found
*/
ve.binarySearch = OO.binarySearch;
/**
* Recursively compare properties between two objects.
*
* A false result may be caused by property inequality or by properties in one object missing from
* the other. An asymmetrical test may also be performed, which checks only that properties in the
* first object are present in the second object, but not the inverse.
*
* If either a or b is null or undefined it will be treated as an empty object.
*
* See https://doc.wikimedia.org/oojs/master/OO.html
*
* @method
* @param {Object|undefined|null} a First object to compare
* @param {Object|undefined|null} b Second object to compare
* @param {boolean} [asymmetrical] Whether to check only that a's values are equal to b's
* (i.e. a is a subset of b)
* @return {boolean} If the objects contain the same values as each other
*/
ve.compare = OO.compare;
/**
* Create a plain deep copy of any kind of object.
*
* Copies are deep, and will either be an object or an array depending on `source`.
*
* See https://doc.wikimedia.org/oojs/master/OO.html
*
* @method
* @param {Object} source Object to copy
* @param {Function} [leafCallback] Applied to leaf values after they are cloned but before they are
* added to the clone
* @param {Function} [nodeCallback] Applied to all values before they are cloned. If the
* nodeCallback returns a value other than undefined, the returned value is used instead of
* attempting to clone.
* @return {Object} Copy of source object
*/
ve.copy = OO.copy;
/**
* @method
* @see OO.ui.debounce
*/
ve.debounce = OO.ui.debounce;
/**
* @method
* @see OO.ui.throttle
*/
ve.throttle = OO.ui.throttle;
/**
* Create a jQuery.Deferred-compatible object
*
* See http://api.jquery.com/jQuery.Deferred/
*
* @method
* @return {jQuery.Deferred}
*/
ve.createDeferred = $.Deferred;
/**
* Create a promise which resolves when the list of promises has resolved
*
* @param {jQuery.Promise[]} promises List of promises
* @return {jQuery.Promise} Promise which resolves when the list of promises has resolved
*/
ve.promiseAll = function ( promises ) {
return $.when.apply( $, promises );
};
/**
* Copy an array of DOM elements, optionally into a different document.
*
* @param {HTMLElement[]} domElements DOM elements to copy
* @param {HTMLDocument} [doc] Document to create the copies in; if unset, simply clone each element
* @return {HTMLElement[]} Copy of domElements with copies of each element
*/
ve.copyDomElements = function ( domElements, doc ) {
return domElements.map( ( domElement ) => doc ? doc.importNode( domElement, true ) : domElement.cloneNode( true ) );
};
/**
* Check if two arrays of DOM elements are equal (according to .isEqualNode())
*
* @param {HTMLElement[]} domElements1 First array of DOM elements
* @param {HTMLElement[]} domElements2 Second array of DOM elements
* @return {boolean} All elements are pairwise equal
*/
ve.isEqualDomElements = function ( domElements1, domElements2 ) {
let i = 0;
const len = domElements1.length;
if ( len !== domElements2.length ) {
return false;
}
for ( ; i < len; i++ ) {
if ( !domElements1[ i ].isEqualNode( domElements2[ i ] ) ) {
return false;
}
}
return true;
};
/**
* Compare two class lists, either whitespace separated strings or arrays
*
* Class lists are equivalent if they contain the same members,
* excluding duplicates and ignoring order.
*
* @param {string[]|string} classList1 First class list
* @param {string[]|string} classList2 Second class list
* @return {boolean} Class lists are equivalent
*/
ve.compareClassLists = function ( classList1, classList2 ) {
const removeEmpty = function ( c ) {
return c !== '';
};
classList1 = Array.isArray( classList1 ) ? classList1 : classList1.trim().split( /\s+/ );
classList2 = Array.isArray( classList2 ) ? classList2 : classList2.trim().split( /\s+/ );
classList1 = classList1.filter( removeEmpty );
classList2 = classList2.filter( removeEmpty );
return ve.compare( OO.unique( classList1 ).sort(), OO.unique( classList2 ).sort() );
};
/**
* Check to see if an object is a plain object (created using "{}" or "new Object").
*
* See http://api.jquery.com/jQuery.isPlainObject/
*
* @method
* @param {Object} obj The object that will be checked to see if it's a plain object
* @return {boolean}
*/
ve.isPlainObject = $.isPlainObject;
/**
* Check to see if an object is empty (contains no properties).
*
* See http://api.jquery.com/jQuery.isEmptyObject/
*
* @method
* @param {Object} obj The object that will be checked to see if it's empty
* @return {boolean}
*/
ve.isEmptyObject = $.isEmptyObject;
/**
* Merge properties of one or more objects into another.
* Preserves original object's inheritance (e.g. Array, Object, whatever).
* In case of array or array-like objects only the indexed properties
* are copied over.
* Beware: If called with only one argument, it will consider
* 'target' as 'source' and 'this' as 'target'. Which means
* ve.extendObject( { a: 1 } ); sets ve.a = 1;
*
* See http://api.jquery.com/jQuery.extend/
*
* @method
* @param {boolean} [recursive=false]
* @param {any} [target] Object that will receive the new properties
* @param {...any} [sources] Variadic list of objects containing properties
* to be merged into the target.
* @return {any} Modified version of first or second argument
*/
ve.extendObject = $.extend;
/**
* Splice one array into another.
*
* This is the equivalent of arr.splice( offset, remove, d1, d2, d3, … ) except that arguments are
* specified as an array rather than separate parameters.
*
* This method has been proven to be faster than using slice and concat to create a new array, but
* performance tests should be conducted on each use of this method to verify this is true for the
* particular use. Also, browsers change fast, never assume anything, always test everything.
*
* Includes a replacement for broken implementations of Array.prototype.splice().
*
* @param {Array|ve.dm.BranchNode} arr Target object (must have `splice` method, object will be modified)
* @param {number} offset Offset in arr to splice at. This MUST NOT be negative, unlike the
* 'index' parameter in Array#splice.
* @param {number} remove Number of elements to remove at the offset. May be zero
* @param {Array} data Array of items to insert at the offset. Must be non-empty if remove=0
* @return {Array} Array of items removed
*/
ve.batchSplice = function ( arr, offset, remove, data ) {
// We need to splice insertion in in batches, because of parameter list length limits which vary
// cross-browser - 1024 seems to be a safe batch size on all browsers
let index = 0,
toRemove = remove,
removed = [];
const batchSize = 1024;
if ( data.length === 0 ) {
// Special case: data is empty, so we're just doing a removal
// The code below won't handle that properly, so we do it here
return arr.splice( offset, remove );
}
while ( index < data.length ) {
// Call arr.splice( offset, remove, i0, i1, i2, …, i1023 );
// Only set remove on the first call, and set it to zero on subsequent calls
const spliced = arr.splice(
index + offset, toRemove, ...data.slice( index, index + batchSize )
);
if ( toRemove > 0 ) {
removed = spliced;
}
index += batchSize;
toRemove = 0;
}
return removed;
};
/**
* Splice one array into another, replicating any holes
*
* Similar to arr.splice( offset, remove, ...data ), except holes in
* data remain holes in arr. Optimized for length changes that are negative, zero, or
* fairly small positive.
*
* @param {Array} arr Array to modify
* @param {number} offset Offset in arr to splice at. This MUST NOT be negative, unlike the
* 'index' parameter in Array#splice.
* @param {number} remove Number of elements to remove at the offset. May be zero
* @param {Array} data Array of items to insert at the offset
* @return {Array} Array of items removed, with holes preserved
*/
ve.sparseSplice = function ( arr, offset, remove, data ) {
const removed = [],
endOffset = offset + remove,
diff = data.length - remove;
Iif ( data === arr ) {
// Pathological case: arr and data are reference-identical
data = data.slice();
}
// Remove content without adjusting length
arr.slice( offset, endOffset ).forEach( ( item, j ) => {
removed[ j ] = item;
delete arr[ offset + j ];
} );
// Adjust length
if ( diff > 0 ) {
// Grow with undefined values, then delete. (This is optimised for diff
// comparatively small: otherwise, it would sometimes be quicker to relocate
// each element of arr that lies above offset).
ve.batchSplice( arr, endOffset, 0, new Array( diff ) );
for ( let i = endOffset + diff - 1; i >= endOffset; i-- ) {
delete arr[ i ];
}
} else if ( diff < 0 ) {
// Shrink
arr.splice( offset, -diff );
}
// Insert new content
data.forEach( ( item, j ) => {
arr[ offset + j ] = item;
} );
// Set removed.length in case there are holes at the end
removed.length = remove;
return removed;
};
/**
* Insert one array into another.
*
* Shortcut for `ve.batchSplice( arr, offset, 0, src )`.
*
* @see ve.batchSplice
* @param {Array|ve.dm.BranchNode} arr Target object (must have `splice` method)
* @param {number} offset Offset in arr where items will be inserted
* @param {Array} src Items to insert at offset
*/
ve.insertIntoArray = function ( arr, offset, src ) {
ve.batchSplice( arr, offset, 0, src );
};
/**
* Push one array into another.
*
* This is the equivalent of arr.push( d1, d2, d3, … ) except that arguments are
* specified as an array rather than separate parameters.
*
* @param {Array|ve.dm.BranchNode} arr Object supporting .push() to insert at the end of the array. Will be modified
* @param {Array} data Array of items to insert.
* @return {number} length of the new array
*/
ve.batchPush = function ( arr, data ) {
// We need to push insertion in batches, because of parameter list length limits which vary
// cross-browser - 1024 seems to be a safe batch size on all browsers
let index = 0;
const batchSize = 1024;
if ( batchSize >= data.length ) {
// Avoid slicing for small lists
return arr.push( ...data );
}
let length;
while ( index < data.length ) {
// Call arr.push( i0, i1, i2, …, i1023 );
length = arr.push( ...data.slice( index, index + batchSize ) );
index += batchSize;
}
return length;
};
/**
* Log data to the console.
*
* This implementation does nothing, to add a real implementation ve.debug needs to be loaded.
*
* @param {...any} [args] Data to log
*/
ve.log = ve.log || function () {
// Don't do anything, this is just a stub
};
/**
* Log error to the console.
*
* This implementation does nothing, to add a real implementation ve.debug needs to be loaded.
*
* @param {...any} [args] Data to log
*/
ve.error = ve.error || function () {
// Don't do anything, this is just a stub
};
/**
* Log an object to the console.
*
* This implementation does nothing, to add a real implementation ve.debug needs to be loaded.
*
* @param {Object} obj
*/
ve.dir = ve.dir || function () {
// Don't do anything, this is just a stub
};
/**
* Deep freeze an object, making it immutable
*
* This implementation does nothing, to add a real implementation ve.freeze needs to be loaded.
*
* @param {Object} obj
* @param {boolean} onlyProperties
* @return {Object}
*/
ve.deepFreeze = ve.deepFreeze || function ( obj ) {
// Don't do anything, this is just a stub
return obj;
};
/**
* Get a localized message.
*
* @param {string} key Message key
* @param {...any} [params] Message parameters
* @return {string} Localized message
*/
ve.msg = function () {
// Avoid using bind because ve.init.platform doesn't exist yet.
// TODO: Fix dependency issues between ve.js and ve.init.platform
return ve.init.platform.getMessage.apply( ve.init.platform, arguments );
};
/**
* Get an HTML localized message with HTML or DOM arguments.
*
* @param {string} key Message key
* @param {...any} [params] Message parameters
* @return {Node[]} Localized message
*/
ve.htmlMsg = function () {
// Avoid using bind because ve.init.platform doesn't exist yet.
// TODO: Fix dependency issues between ve.js and ve.init.platform
return ve.init.platform.getHtmlMessage.apply( ve.init.platform, arguments );
};
/**
* Get platform config value(s)
*
* @param {string|string[]} key Config key, or list of keys
* @return {any|Object} Config value, or keyed object of config values if list of keys provided
*/
ve.config = function () {
return ve.init.platform.getConfig.apply( ve.init.platform, arguments );
};
/**
* Get or set a user config value.
*
* @param {string|string[]|Object} key Config key, list of keys or object mapping keys to values
* @param {any} [value] Value to set, if setting and key is a string
* @return {any|Object|boolean} Config value, keyed object of config values if list of keys provided,
* or success boolean if setting.
*/
ve.userConfig = function ( key ) {
if ( arguments.length <= 1 && ( typeof key === 'string' || Array.isArray( key ) ) ) {
// get( string key )
// get( Array keys )
return ve.init.platform.getUserConfig.apply( ve.init.platform, arguments );
} else {
// set( Object values )
// set( key, value )
return ve.init.platform.setUserConfig.apply( ve.init.platform, arguments );
}
};
/**
* Convert a grapheme cluster offset to a byte offset.
*
* @param {string} text Text in which to calculate offset
* @param {number} clusterOffset Grapheme cluster offset
* @return {number} Byte offset
*/
ve.getByteOffset = function ( text, clusterOffset ) {
return unicodeJS.graphemebreak.splitClusters( text )
.slice( 0, clusterOffset )
.join( '' )
.length;
};
/**
* Convert a byte offset to a grapheme cluster offset.
*
* @param {string} text Text in which to calculate offset
* @param {number} byteOffset Byte offset
* @return {number} Grapheme cluster offset
*/
ve.getClusterOffset = function ( text, byteOffset ) {
return unicodeJS.graphemebreak.splitClusters( text.slice( 0, byteOffset ) ).length;
};
/**
* Get a text substring, taking care not to split grapheme clusters.
*
* @param {string} text Text to take the substring from
* @param {number} start Start offset
* @param {number} end End offset
* @param {boolean} [outer=false] Include graphemes if the offset splits them
* @return {string} Substring of text
*/
ve.graphemeSafeSubstring = function ( text, start, end, outer ) {
// TODO: improve performance by incrementally inspecting characters around the offsets
let unicodeStart = ve.getByteOffset( text, ve.getClusterOffset( text, start ) ),
unicodeEnd = ve.getByteOffset( text, ve.getClusterOffset( text, end ) );
// If the selection collapses and we want an inner, then just return empty
// otherwise we'll end up crossing over start and end
if ( unicodeStart === unicodeEnd && !outer ) {
return '';
}
// The above calculations always move to the right of a multibyte grapheme.
// Depending on the outer flag, we may want to move to the left:
if ( unicodeStart > start && outer ) {
unicodeStart = ve.getByteOffset( text, ve.getClusterOffset( text, start ) - 1 );
}
if ( unicodeEnd > end && !outer ) {
unicodeEnd = ve.getByteOffset( text, ve.getClusterOffset( text, end ) - 1 );
}
return text.slice( unicodeStart, unicodeEnd );
};
/**
* Escape non-word characters so they can be safely used as HTML attribute values.
*
* @param {string} value Attribute value to escape
* @return {string} Escaped attribute value
*/
ve.escapeHtml = ( function () {
function escape( value ) {
switch ( value ) {
case '\'':
return ''';
case '"':
return '"';
case '<':
return '<';
case '>':
return '>';
case '&':
return '&';
}
}
return function ( value ) {
return value.replace( /['"<>&]/g, escape );
};
}() );
/**
* Get the attributes of a DOM element as an object with key/value pairs.
*
* @param {HTMLElement} element
* @return {Object}
*/
ve.getDomAttributes = function ( element ) {
const result = {};
for ( let i = 0; i < element.attributes.length; i++ ) {
result[ element.attributes[ i ].name ] = element.attributes[ i ].value;
}
return result;
};
/**
* Set the attributes of a DOM element as an object with key/value pairs.
*
* Use the `null` or `undefined` value to ensure an attribute's absence.
*
* @param {HTMLElement} element DOM element to apply attributes to
* @param {Object} attributes Attributes to apply
* @param {string[]} [allowedAttributes] List of attributes to exclusively allow (all lowercase names)
*/
ve.setDomAttributes = function ( element, attributes, allowedAttributes ) {
// Duck-typing for attribute setting
if ( !element.setAttribute || !element.removeAttribute ) {
return;
}
for ( const key in attributes ) {
if ( allowedAttributes && allowedAttributes.indexOf( key.toLowerCase() ) === -1 ) {
continue;
}
if ( attributes[ key ] === undefined || attributes[ key ] === null ) {
element.removeAttribute( key );
} else {
element.setAttribute( key, attributes[ key ] );
}
}
};
/**
* Get an HTML representation of a DOM element node, text node or comment node
*
* @param {Node} node The DOM node
* @return {string} HTML representation of the node
*/
ve.getNodeHtml = function ( node ) {
if ( node.nodeType === Node.ELEMENT_NODE ) {
return node.outerHTML;
} else {
const div = document.createElement( 'div' );
div.appendChild( node.cloneNode( true ) );
return div.innerHTML;
}
};
/**
* Build a summary of an HTML element.
*
* Summaries include node name, text, attributes and recursive summaries of children.
* Used for serializing or comparing HTML elements.
*
* @private
* @param {HTMLElement} element Element to summarize
* @param {boolean} [includeHtml=false] Include an HTML summary for element nodes
* @param {Function} [getAttributeSummary] Callback to modify the summary of an attribute
* @param {string} [getAttributeSummary.name] Name of the attribute to modify.
* @param {string} [getAttributeSummary.value] Value to return for the given attribute.
* @return {Object} Summary of element.
*/
ve.getDomElementSummary = function ( element, includeHtml, getAttributeSummary ) {
const summary = {
type: element.nodeName.toLowerCase(),
text: element.textContent,
attributes: {},
children: []
};
if ( includeHtml && element.nodeType === Node.ELEMENT_NODE ) {
summary.html = element.outerHTML;
}
// Gather attributes
if ( element.attributes ) {
for ( let i = 0; i < element.attributes.length; i++ ) {
const name = element.attributes[ i ].name;
if ( name === 'about' ) {
// The about attribute is non-deterministic as we generate a new random
// one whenever a node is cloned (see ve.dm.Node.static.cloneElement).
// Exclude it from node comparisons.
continue;
}
const value = element.attributes[ i ].value;
summary.attributes[ name ] = getAttributeSummary ? getAttributeSummary( name, value ) : value;
}
}
// Summarize children
Eif ( element.childNodes ) {
for ( let i = 0; i < element.childNodes.length; i++ ) {
summary.children.push( ve.getDomElementSummary( element.childNodes[ i ], includeHtml ) );
}
}
return summary;
};
/**
* Callback for #copy to convert nodes to a comparable summary.
*
* @private
* @param {Object} value Value in the object/array
* @return {Object} DOM element summary if value is a node, otherwise just the value
*/
ve.convertDomElements = function ( value ) {
// Use duck typing rather than instanceof Node; the latter doesn't always work correctly
if ( value && value.nodeType ) {
return ve.getDomElementSummary( value );
}
return value;
};
ve.visibleWhitespaceCharacters = {
'\n': '\u21b5', // ↵
'\t': '\u279e' // ➞
};
/**
* Check whether a given node is contentEditable
*
* Handles 'inherit', via checking isContentEditable. Knows to check for text
* nodes, and will return whether the text node's parent is contentEditable.
*
* @param {HTMLElement|Text} node Node to check contenteditable status of
* @return {boolean} Node is contenteditable
*/
ve.isContentEditable = function ( node ) {
return ( node.nodeType === Node.TEXT_NODE ? node.parentNode : node ).isContentEditable;
};
/**
* Filter out metadata elements
*
* @param {Node[]} contents DOM nodes
* @return {Node[]} Filtered DOM nodes
*/
ve.filterMetaElements = function ( contents ) {
// Filter out link and style tags for T52043
// Previously filtered out meta tags, but restore these as they
// can be made visible with CSS.
// As of jQuery 3 we can't use $.not( 'tagName' ) as that doesn't
// match text nodes. Also we can't $.remove these elements as they
// aren't attached to anything.
contents = contents.filter( ( node ) => node.tagName !== 'LINK' && node.tagName !== 'STYLE' );
// Also remove link and style tags nested inside other tags
$( contents ).find( 'link, style' ).remove();
return contents;
};
/**
* Modify a set of DOM elements to resolve attributes in the context of another document.
*
* This performs node.setAttribute( 'attr', nodeInDoc[attr] ); for every node.
*
* Doesn't use jQuery to avoid document switching performance bug
*
* @param {HTMLElement|HTMLElement[]|NodeList|jQuery} elementsOrJQuery Set of DOM elements to modify. Passing a jQuery selector is deprecated.
* @param {HTMLDocument} doc Document to resolve against (different from $elements' .ownerDocument)
* @param {string[]} attrs Attributes to resolve
*/
ve.resolveAttributes = function ( elementsOrJQuery, doc, attrs ) {
// Convert jQuery selections to plain arrays
let elements = elementsOrJQuery.toArray ? elementsOrJQuery.toArray() : elementsOrJQuery;
// Duck typing for array or NodeList :(
if ( elements.length === undefined ) {
elements = [ elements ];
}
let attr;
/**
* Resolves the value of attr to the computed property value.
*
* @private
* @param {HTMLElement} el Element
*/
function resolveAttribute( el ) {
const nodeInDoc = doc.createElement( el.nodeName );
nodeInDoc.setAttribute( attr, el.getAttribute( attr ) );
Eif ( nodeInDoc[ attr ] ) {
el.setAttribute( attr, nodeInDoc[ attr ] );
}
}
for ( let i = 0, iLen = elements.length; i < iLen; i++ ) {
const element = elements[ i ];
for ( let j = 0, jLen = attrs.length; j < jLen; j++ ) {
attr = attrs[ j ];
if ( element.hasAttribute( attr ) ) {
resolveAttribute( element );
}
Array.prototype.forEach.call( element.querySelectorAll( '[' + attr + ']' ), resolveAttribute );
}
}
};
/**
* Make all links within a DOM element open in a new window
*
* @param {HTMLElement} container DOM element to search for links
*/
ve.targetLinksToNewWindow = function ( container ) {
// Make all links open in a new window
Array.prototype.forEach.call( container.querySelectorAll( 'a[href]' ), ( el ) => {
ve.appendToRel( el, 'noopener' );
el.setAttribute( 'target', '_blank' );
} );
};
/**
* Add a value to an element's rel attribute if it's not already present
*
* Rel is like class: it's actually a set, represented as a string. We don't
* want to add the same value to the attribute if this function is called
* repeatedly. This is mostly a placeholder for the relList property someday
* becoming widely supported.
*
* @param {HTMLElement} element DOM element whose attribute should be checked
* @param {string} value New rel value to be added
*/
ve.appendToRel = function ( element, value ) {
const rel = element.getAttribute( 'rel' );
if ( !rel ) {
// Avoid all that string-creation if it's not needed
element.setAttribute( 'rel', value );
} else if ( ( ' ' + rel + ' ' ).indexOf( ' ' + value + ' ' ) === -1 ) {
element.setAttribute( 'rel', rel + ' ' + value );
}
};
/**
* Check if a string is a valid URI component.
*
* A URI component is considered invalid if decodeURIComponent() throws an exception.
*
* @param {string} s String to test
* @return {boolean} decodeURIComponent( s ) did not throw an exception
* @see ve.safeDecodeURIComponent
*/
ve.isUriComponentValid = function ( s ) {
try {
decodeURIComponent( s );
} catch ( e ) {
return false;
}
return true;
};
/**
* Safe version of decodeURIComponent() that doesn't throw exceptions.
*
* If the native decodeURIComponent() call threw an exception, the original string
* will be returned.
*
* @param {string} s String to decode
* @return {string} Decoded string, or same string if decoding failed
* @see ve.isUriComponentValid
*/
ve.safeDecodeURIComponent = function ( s ) {
try {
s = decodeURIComponent( s );
} catch ( e ) {}
return s;
};
/**
* Find the length of the common start sequence of one or more sequences
*
* Items are tested for sameness using === .
*
* @param {Array} sequences Array of sequences (arrays, strings etc)
* @return {number} Common start sequence length (0 if sequences is empty)
*/
ve.getCommonStartSequenceLength = function ( sequences ) {
if ( sequences.length === 0 ) {
return 0;
}
let commonLength = 0;
commonLengthLoop:
while ( true ) {
if ( commonLength >= sequences[ 0 ].length ) {
break;
}
const val = sequences[ 0 ][ commonLength ];
for ( let i = 1, len = sequences.length; i < len; i++ ) {
if (
sequences[ i ].length <= commonLength ||
sequences[ i ][ commonLength ] !== val
) {
break commonLengthLoop;
}
}
commonLength++;
}
return commonLength;
};
/**
* Find the nearest common ancestor of DOM nodes
*
* @param {...Node|null} nodes DOM nodes
* @return {Node|null} Nearest common ancestor; or null if there is none / an argument is null
*/
ve.getCommonAncestor = function ( ...nodes ) {
const nodeCount = nodes.length;
if ( nodeCount === 0 ) {
return null;
}
let minHeight = null;
const chains = [];
// Build every chain
for ( let i = 0; i < nodeCount; i++ ) {
const chain = [];
let node = nodes[ i ];
while ( node !== null ) {
chain.unshift( node );
node = node.parentNode;
}
if ( chain.length === 0 ) {
// nodes[ i ] was null (so no common ancestor)
return null;
}
if ( i > 0 && chain[ 0 ] !== chains[ chains.length - 1 ][ 0 ] ) {
// No common ancestor (different documents or unattached branches)
return null;
}
if ( minHeight === null || minHeight > chain.length ) {
minHeight = chain.length;
}
chains.push( chain );
}
// Step through chains in parallel, until they differ.
// All chains are guaranteed to start with the common document element (or the common root
// of an unattached branch)
for ( let i = 1; i < minHeight; i++ ) {
const node = chains[ 0 ][ i ];
for ( let j = 1; j < nodeCount; j++ ) {
if ( node !== chains[ j ][ i ] ) {
return chains[ 0 ][ i - 1 ];
}
}
}
return chains[ 0 ][ minHeight - 1 ];
};
/**
* Get the index of a node in its parentNode's childNode list
*
* @param {Node} node The node
* @return {number} Index in parentNode's childNode list
*/
ve.parentIndex = function ( node ) {
return Array.prototype.indexOf.call( node.parentNode.childNodes, node );
};
/**
* Get the offset path from ancestor to offset in descendant
*
* @param {Node} ancestor The ancestor node
* @param {Node} node The descendant node
* @param {number} nodeOffset The offset in the descendant node
* @return {number[]} The offset path
*/
ve.getOffsetPath = function ( ancestor, node, nodeOffset ) {
const path = [ nodeOffset ];
while ( node !== ancestor ) {
Iif ( node.parentNode === null ) {
ve.log( node, 'is not a descendant of', ancestor );
throw new Error( 'Not a descendant' );
}
path.unshift( ve.parentIndex( node ) );
node = node.parentNode;
}
return path;
};
/**
* Compare two tuples in lexicographical order.
*
* This function first compares `a[0]` with `b[0]`, then `a[1]` with `b[1]`, etc.
* until it encounters a pair where `a[k] != b[k]`; then returns `a[k] - b[k]`.
*
* If `a[k] == b[k]` for every `k`, this function returns 0.
*
* If a and b are of unequal length, but `a[k] == b[k]` for all `k` that exist in both a and b, then
* this function returns `Infinity` (if a is longer) or `-Infinity` (if b is longer).
*
* @param {number[]} a First tuple
* @param {number[]} b Second tuple
* @return {number} `a[k] - b[k]` where k is the lowest k such that `a[k] != b[k]`
*/
ve.compareTuples = function ( a, b ) {
for ( let i = 0, len = Math.min( a.length, b.length ); i < len; i++ ) {
if ( a[ i ] !== b[ i ] ) {
return a[ i ] - b[ i ];
}
}
Iif ( a.length > b.length ) {
return Infinity;
}
if ( a.length < b.length ) {
return -Infinity;
}
return 0;
};
/**
* Compare two nodes for position in document
*
* Return null if either position is either null or incomparable (e.g. where one of the nodes
* is detached or the nodes are from different documents).
*
* @param {Node|null} node1 First node
* @param {number|null} offset1 First offset
* @param {Node|null} node2 Second node
* @param {number|null} offset2 Second offset
* @return {number|null} negative, zero or positive number, or null if nodes null or incomparable
*/
ve.compareDocumentOrder = function ( node1, offset1, node2, offset2 ) {
const commonAncestor = ve.getCommonAncestor( node1, node2 );
if ( commonAncestor === null ) {
// Signal no common ancestor. In theory we could disallow this case, and check
// the nodes for detachedness and same-documentness before each call, but such
// guard checks would duplicate (either explicitly or implicitly) much of the
// branch traversal performed in this method.
return null;
}
return ve.compareTuples(
ve.getOffsetPath( commonAncestor, node1, offset1 ),
ve.getOffsetPath( commonAncestor, node2, offset2 )
);
};
/**
* @typedef {Object} DomPosition
* @memberof ve
* @property {Node|null} node The node, or null if we stepped past the root node
* @property {number|null} offset The offset, or null if we stepped past the root node
* @property {ve.PositionStep[]} steps Steps taken
*/
/**
* Get the closest matching DOM position in document order (forward or reverse)
*
* A DOM position is represented as an object with "node" and "offset" properties.
*
* The noDescend option can be used to exclude the positions inside certain element nodes; it is
* a jQuery selector/function ( used as a test by $node.is() - see http://api.jquery.com/is/ );
* it defaults to ve.rejectsCursor . Void elements (those matching ve.isVoidElement) are always
* excluded.
*
* As well as the end position, an array of ve.PositionSteps (node traversals) is returned.
* The "stop" option is a boolean-valued function used to test each ve.PositionStep in turn. If
* If it returns true, the position arrived at is returned; else the stepping continues to the
* next matching DOM position. It defaults to ve.isHardCursorStep .
*
* Limitation: some DOM positions cannot actually hold the cursor; e.g. the start of the interior
* of a table node. Browser cursoring jumps over text node/annotation node boundaries as if they
* were invisible, and skips over most grapheme clusters e.g. 'x\u0301' (though not all e.g.
* '\u062D\u0627'). Also, Chromium normalizes cursor focus/offset, when they are set, to the
* start-most such cursor position (Firefox does not).
*
* @param {Object} position Start position
* @param {Node} position.node Start node
* @param {number} position.offset Start offset
* @param {number} direction +1 for forward, -1 for reverse
* @param {Object} options
* @param {Function|string} [options.noDescend] Selector or function: nodes to skip over
* @param {Function} [options.stop] Boolean-valued ve.PositionStep test function
* @return {ve.DomPosition} The adjacent DOM position encountered
* @see ve.isHardCursorStep
*/
ve.adjacentDomPosition = function ( position, direction, options ) {
let node = position.node,
offset = position.offset;
const steps = [];
const noDescend = options.noDescend || ve.rejectsCursor;
const stop = options.stop || ve.isHardCursorStep;
direction = direction < 0 ? -1 : 1;
const forward = ( direction === 1 );
while ( true ) {
// If we're at the node's leading edge, move to the adjacent position in the parent node
if ( offset === ( forward ? node.length || node.childNodes.length : 0 ) ) {
const step = new ve.PositionStep( node, 'leave' );
steps.push( step );
if ( node.parentNode === null ) {
return {
node: null,
offset: null,
steps: steps
};
}
offset = ve.parentIndex( node ) + ( forward ? 1 : 0 );
node = node.parentNode;
if ( stop( step ) ) {
return {
node: node,
offset: offset,
steps: steps
};
}
// Else take another step
continue;
}
// Else we're in the interior of a node
// If we're in a text node, move to the position in this node at the next offset
if ( node.nodeType === Node.TEXT_NODE ) {
const step = new ve.PositionStep(
node,
'internal',
offset - ( forward ? 0 : 1 )
);
steps.push( step );
offset += direction;
Eif ( stop( step ) ) {
return {
node: node,
offset: offset,
steps: steps
};
}
continue;
}
// Else we're in the interior of an element node
const childNode = node.childNodes[ forward ? offset : offset - 1 ];
// Support: Firefox
// If the child is uncursorable, or is an element matching noDescend, do not
// descend into it: instead, return the position just beyond it in the current node
if (
childNode.nodeType === Node.ELEMENT_NODE &&
( ve.isVoidElement( childNode ) || $( childNode ).is( noDescend ) )
) {
const step = new ve.PositionStep( childNode, 'cross' );
steps.push( step );
offset += forward ? 1 : -1;
if ( stop( step ) ) {
return {
node: node,
offset: offset,
steps: steps
};
}
// Else take another step
continue;
}
// Go to the closest offset inside the child node
node = childNode;
offset = forward ? 0 : node.length || node.childNodes.length;
const posStep = new ve.PositionStep( node, 'enter' );
steps.push( posStep );
if ( stop( posStep ) ) {
return {
node: node,
offset: offset,
steps: steps
};
}
}
};
/**
* Test whether a cursor movement step uses up a cursor press
*
* Essentially, this is true unless entering/exiting a contentEditable text/annotation node.
* For instance in <#text>X</#text><b><#text>y</#text></b>
* a single cursor press will jump from just after X to just after Y.
*
* @param {ve.PositionStep} step The cursor movement step to test
* @return {boolean} Whether the cursor movement step uses up a cursor press
* @see ve.adjacentDomPosition
*/
ve.isHardCursorStep = function ( step ) {
if ( step.node.nodeType === Node.TEXT_NODE ) {
return step.type === 'internal';
}
return ve.isBlockElement( step.node ) || ve.rejectsCursor( step.node );
};
/**
* Tests whether an adjacent cursor would be prevented from entering the node
*
* @param {Node} [node] Element node or text node; defaults to "this" if a Node
* @return {boolean} Whether an adjacent cursor would be prevented from entering
*/
ve.rejectsCursor = function ( node ) {
if ( !node && this instanceof Node ) {
node = this;
}
Iif ( node.nodeType === node.TEXT_NODE ) {
return false;
}
if ( ve.isVoidElement( node ) ) {
return true;
}
// We don't need to check whether the ancestor-nearest contenteditable tag is
// false, because if so then there can be no adjacent cursor.
return node.contentEditable === 'false';
};
/**
* @typedef {Object} ChangeOffsets
* @memberof ve
* @return {number} start Offset from start of first changed element
* @return {number} end Offset from end of last changed element (nonoverlapping with start)
*/
/**
* Count the common elements at the start and end of two sequences
*
* @param {Array|string} before The original sequence
* @param {Array|string} after The modified sequence
* @param {Function} [equals] Two-argument comparison returning boolean (defaults to ===)
* @return {ve.ChangeOffsets|null} Change offsets (valid in both sequences), or null if unchanged
*/
ve.countEdgeMatches = function ( before, after, equals ) {
Iif ( !equals ) {
equals = function ( x, y ) {
return x === y;
};
}
let start, end;
const len = Math.min( before.length, after.length );
// Find maximal matching left slice
for ( start = 0; start < len; start++ ) {
if ( !equals( before[ start ], after[ start ] ) ) {
break;
}
}
if ( start === len && before.length === after.length ) {
return null;
}
// Find maximal matching right slice that doesn't overlap the left slice
for ( end = 0; end < len - start; end++ ) {
if ( !equals(
before[ before.length - 1 - end ],
after[ after.length - 1 - end ]
) ) {
break;
}
}
return { start: start, end: end };
};
/**
* Same as Object.entries, because we don't yet presume ES2017
*
* @param {Object} ob The object
* @return {Array[]} Entries, in the form [string, any]
*/
// eslint-disable-next-line es-x/no-object-entries
ve.entries = Object.entries || ( ( ob ) => Object.keys( ob ).map( ( k ) => [ k, ob[ k ] ] ) );
|