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
|
/* Ace syntax-highlighting code editor extension for wikiEditor */
/* global ace */
/* eslint-disable no-jquery/no-global-selector */
( function () {
$.wikiEditor.modules.codeEditor = {
/**
* Core Requirements
*/
req: [ 'codeEditor' ],
/**
* Configuration
*/
cfg: {
//
},
/**
* API accessible functions
*/
api: {
//
},
/**
* Event handlers
*/
evt: {
//
},
/**
* Internally used functions
*/
fn: {
}
};
$.wikiEditor.extensions.codeEditor = function ( context ) {
var saveAndExtend,
textSelectionFn,
hasErrorsOnSave = false,
selectedLine = 0,
cookieEnabled,
returnFalse = function () { return false; },
api = new mw.Api();
// Initialize state
cookieEnabled = parseInt( mw.cookie.get( 'codeEditor-' + context.instance + '-showInvisibleChars' ), 10 );
context.showInvisibleChars = ( cookieEnabled === 1 );
cookieEnabled = parseInt( mw.cookie.get( 'codeEditor-' + context.instance + '-lineWrappingActive' ), 10 );
context.lineWrappingActive = ( cookieEnabled === 1 );
context.showSearchReplace = 0;
/*
* Event Handlers
*
* WikiEditor inspects the 'evt' object for event names and uses them if present as additional
* event handlers that fire before the default handling.
* To prevent WikiEditor from running its own handling, handlers should return false.
*
* This is also where we can attach some extra information to the events.
*/
context.evt = $.extend( context.evt, {
keydown: returnFalse,
change: returnFalse,
delayedChange: returnFalse,
cut: returnFalse,
paste: returnFalse,
ready: returnFalse,
codeEditorSubmit: function () {
var form = this;
context.evt.codeEditorSync();
if ( hasErrorsOnSave ) {
hasErrorsOnSave = false;
OO.ui.confirm( mw.msg( 'codeeditor-save-with-errors' ) ).done( function ( confirmed ) {
if ( confirmed ) {
// Programmatic submit doesn't retrigger this event listener
form.submit();
}
} );
return false;
}
return true;
},
codeEditorSave: function () {
var i,
annotations = context.codeEditor.getSession().getAnnotations();
for ( i = 0; i < annotations.length; i++ ) {
if ( annotations[ i ].type === 'error' ) {
hasErrorsOnSave = true;
break;
}
}
},
codeEditorSync: function () {
context.$textarea.val( context.$textarea.textSelection( 'getContents' ) );
}
} );
// Make sure to cast '0' to false
context.codeEditorActive = !!Number( mw.user.options.get( 'usecodeeditor' ) );
/**
* Internally used functions
*/
context.fn = $.extend( context.fn, {
isCodeEditorActive: function () {
return context.codeEditorActive;
},
isShowInvisibleChars: function () {
return context.showInvisibleChars;
},
isLineWrappingActive: function () {
return context.lineWrappingActive;
},
changeCookieValue: function ( cookieName, value ) {
mw.cookie.set(
'codeEditor-' + context.instance + '-' + cookieName,
value
);
},
aceGotoLineColumn: function () {
OO.ui.prompt( mw.msg( 'codeeditor-gotoline-prompt' ), {
textInput: { placeholder: mw.msg( 'codeeditor-gotoline-placeholder' ) }
} ).done( function ( result ) {
var matches, line, column;
if ( !result ) {
return;
}
matches = result.split( ':' );
line = 0;
column = 0;
if ( matches.length > 0 ) {
line = +matches[ 0 ];
if ( isNaN( line ) ) {
return;
} else {
// Lines are zero-indexed
line--;
}
}
if ( matches.length > 1 ) {
column = +matches[ 1 ];
if ( isNaN( column ) ) {
column = 0;
}
}
context.codeEditor.navigateTo( line, column );
// Scroll up a bit to give some context
context.codeEditor.scrollToRow( line - 4 );
} );
},
setupCodeEditorToolbar: function () {
var toggleEditor,
toggleInvisibleChars,
toggleSearchReplace,
toggleLineWrapping,
indent, outdent, gotoLine;
toggleEditor = function ( context ) {
context.codeEditorActive = !context.codeEditorActive;
context.fn.setCodeEditorPreference( context.codeEditorActive );
context.fn.updateCodeEditorToolbarButton();
if ( context.codeEditorActive ) {
// set it back up!
context.fn.setupCodeEditor();
} else {
context.fn.disableCodeEditor();
}
};
toggleInvisibleChars = function ( context ) {
context.showInvisibleChars = !context.showInvisibleChars;
context.fn.changeCookieValue( 'showInvisibleChars', context.showInvisibleChars ? 1 : 0 );
context.fn.updateInvisibleCharsButton();
context.codeEditor.setShowInvisibles( context.showInvisibleChars );
};
toggleSearchReplace = function ( context ) {
context.showSearchReplace = !context.showSearchReplace;
if ( context.showSearchReplace ) {
ace.config.loadModule( 'ace/ext/searchbox', function ( e ) {
// ace.editor.searchBox.show();
e.Search( context.codeEditor, !0 );
} );
} else {
context.codeEditor.searchBox.hide();
}
};
toggleLineWrapping = function ( context ) {
context.lineWrappingActive = !context.lineWrappingActive;
context.fn.changeCookieValue( 'lineWrappingActive', context.lineWrappingActive ? 1 : 0 );
context.fn.updateLineWrappingButton();
context.codeEditor.getSession().setUseWrapMode( context.lineWrappingActive );
};
indent = function ( context ) {
context.codeEditor.execCommand( 'indent' );
};
outdent = function ( context ) {
context.codeEditor.execCommand( 'outdent' );
};
gotoLine = function ( context ) {
context.codeEditor.execCommand( 'gotolinecolumn' );
};
context.api.addToToolbar( context, {
section: 'main',
groups: {
'codeeditor-main': {
tools: {
codeEditor: {
labelMsg: 'codeeditor-toolbar-toggle',
type: 'toggle',
oouiIcon: 'markup',
action: {
type: 'callback',
execute: toggleEditor
}
}
}
},
'codeeditor-format': {
tools: {
indent: {
labelMsg: 'codeeditor-indent',
type: 'button',
oouiIcon: 'indent',
action: {
type: 'callback',
execute: indent
}
},
outdent: {
labelMsg: 'codeeditor-outdent',
type: 'button',
oouiIcon: 'outdent',
action: {
type: 'callback',
execute: outdent
}
}
}
},
'codeeditor-style': {
tools: {
invisibleChars: {
labelMsg: 'codeeditor-invisibleChars-toggle',
type: 'toggle',
oouiIcon: 'pilcrow',
action: {
type: 'callback',
execute: toggleInvisibleChars
}
},
lineWrapping: {
labelMsg: 'codeeditor-lineWrapping-toggle',
type: 'toggle',
oouiIcon: 'wrapping',
action: {
type: 'callback',
execute: toggleLineWrapping
}
},
gotoLine: {
labelMsg: 'codeeditor-gotoline',
type: 'button',
oouiIcon: 'gotoLine',
action: {
type: 'callback',
execute: gotoLine
}
},
toggleSearchReplace: {
labelMsg: 'codeeditor-searchReplace-toggle',
type: 'toggle',
oouiIcon: 'articleSearch',
action: {
type: 'callback',
execute: toggleSearchReplace
}
}
}
}
}
} );
context.fn.updateCodeEditorToolbarButton();
context.fn.updateInvisibleCharsButton();
context.fn.updateLineWrappingButton();
$( '.group-codeeditor-style' ).prependTo( '.section-main' );
$( '.group-codeeditor-format' ).prependTo( '.section-main' );
$( '.group-codeeditor-main' ).prependTo( '.section-main' );
},
updateButtonIcon: function ( targetName, iconFn ) {
var target = '.tool[rel=' + targetName + ']',
$button = context.modules.toolbar.$toolbar.find( target );
$button.data( 'setActive' )( iconFn() );
},
updateCodeEditorToolbarButton: function () {
context.fn.updateButtonIcon( 'codeEditor', context.fn.isCodeEditorActive );
},
updateInvisibleCharsButton: function () {
context.fn.updateButtonIcon( 'invisibleChars', context.fn.isShowInvisibleChars );
},
updateLineWrappingButton: function () {
context.fn.updateButtonIcon( 'lineWrapping', context.fn.isLineWrappingActive );
},
setCodeEditorPreference: function ( prefValue ) {
// Do not try to save options for anonymous user
if ( mw.user.isAnon() ) {
return;
}
// Abort any previous request
api.abort();
api.saveOption( 'usecodeeditor', prefValue ? 1 : 0 )
.fail( function ( code, result ) {
var message;
if ( code === 'http' && result.textStatus === 'abort' ) {
// Request was aborted. Ignore error
return;
}
message = 'Failed to set code editor preference: ' + code;
if ( result.error && result.error.info ) {
message += '\n' + result.error.info;
}
mw.log.warn( message );
} );
},
/**
* Sets up the iframe in place of the textarea to allow more advanced operations
*/
setupCodeEditor: function () {
var $box, lang, basePath, container, editdiv, session;
$box = context.$textarea;
lang = mw.config.get( 'wgCodeEditorCurrentLanguage' );
basePath = mw.config.get( 'wgExtensionAssetsPath', '' );
if ( basePath.slice( 0, 2 ) === '//' ) {
// ACE uses web workers, which have importScripts, which don't like relative links.
// This is a problem only when the assets are on another server, so this rewrite should suffice
// Protocol relative
basePath = window.location.protocol + basePath;
}
ace.config.set( 'basePath', basePath + '/CodeEditor/modules/ace' );
if ( lang ) {
// Ace doesn't like replacing a textarea directly.
// We'll stub this out to sit on top of it...
// line-height is needed to compensate for oddity in WikiEditor extension, which zeroes the line-height on a parent container
// eslint-disable-next-line no-jquery/no-parse-html-literal
container = context.$codeEditorContainer = $( '<div style="position: relative"><div class="editor" style="line-height: 1.5em; top: 0; left: 0; right: 0; bottom: 0; position: absolute;"></div></div>' ).insertAfter( $box );
editdiv = container.find( '.editor' );
$box.css( 'display', 'none' );
container.height( $box.height() );
// Non-lazy loaded dependencies: Enable code completion
ace.require( 'ace/ext/language_tools' );
// Load the editor now
context.codeEditor = ace.edit( editdiv[ 0 ] );
context.codeEditor.getSession().setValue( $box.val() );
$box.textSelection( 'register', textSelectionFn );
// Disable some annoying commands
context.codeEditor.commands.removeCommand( 'replace' ); // ctrl+R
context.codeEditor.commands.removeCommand( 'transposeletters' ); // ctrl+T
context.codeEditor.commands.removeCommand( 'gotoline' ); // ctrl+L
context.codeEditor.setReadOnly( $box.prop( 'readonly' ) );
context.codeEditor.setShowInvisibles( context.showInvisibleChars );
// The options to enable
context.codeEditor.setOptions( {
enableBasicAutocompletion: true,
enableSnippets: true
} );
context.codeEditor.commands.addCommand( {
name: 'gotolinecolumn',
bindKey: { mac: 'Command-Shift-L', windows: 'Ctrl-Alt-L' },
exec: context.fn.aceGotoLineColumn,
readOnly: true
} );
$box.closest( 'form' )
.on( 'submit', context.evt.codeEditorSubmit )
.find( '#wpSave' ).on( 'click', context.evt.codeEditorSave );
session = context.codeEditor.getSession();
// Use proper tabs
session.setUseSoftTabs( false );
session.setUseWrapMode( context.lineWrappingActive );
mw.hook( 'codeEditor.configure' ).fire( session );
ace.config.loadModule( 'ace/ext/modelist', function ( modelist ) {
if ( !modelist || !modelist.modesByName[ lang ] ) {
lang = 'text';
}
session.setMode( 'ace/mode/' + lang );
} );
// Use jQuery UI resizable() so that users can make the box taller
container.resizable( {
handles: 's',
minHeight: $box.height(),
resize: function () {
context.codeEditor.resize();
}
} );
$( '.wikiEditor-ui-toolbar' ).addClass( 'codeEditor-ui-toolbar' );
if ( selectedLine > 0 ) {
// Line numbers in CodeEditor are zero-based
context.codeEditor.navigateTo( selectedLine - 1, 0 );
// Scroll up a bit to give some context
context.codeEditor.scrollToRow( selectedLine - 4 );
}
context.fn.setupStatusBar();
// Let modules know we're ready to start working with the content
context.fn.trigger( 'ready' );
}
},
/**
* Turn off the code editor view and return to the plain textarea.
* May be needed by some folks with funky browsers, or just to compare.
*/
disableCodeEditor: function () {
// Kills it!
context.$textarea.closest( 'form' )
.off( 'submit', context.evt.codeEditorSubmit )
.find( '#wpSave' ).off( 'click', context.evt.codeEditorSave );
// Save contents
context.$textarea.textSelection( 'unregister' );
context.$textarea.val( textSelectionFn.getContents() );
// @todo fetch cursor, scroll position
// Drop the fancy editor widget...
context.fn.removeStatusBar();
context.$codeEditorContainer.remove();
context.$codeEditorContainer = undefined;
context.codeEditor = undefined;
// Restore textarea
context.$textarea.show();
// Restore toolbar
$( '.wikiEditor-ui-toolbar' ).removeClass( 'codeEditor-ui-toolbar' );
// @todo restore cursor, scroll position
},
/**
* Start monitoring the fragment of the current window for hash change
* events. If the hash is already set, handle it as a new event.
*/
codeEditorMonitorFragment: function () {
function onHashChange() {
var regexp, result;
regexp = /#mw-ce-l(\d+)/;
result = regexp.exec( window.location.hash );
if ( result === null ) {
return;
}
selectedLine = parseInt( result[ 1 ], 10 );
if ( context.codeEditor && selectedLine > 0 ) {
// Line numbers in CodeEditor are zero-based
context.codeEditor.navigateTo( selectedLine - 1, 0 );
// Scroll up a bit to give some context
context.codeEditor.scrollToRow( selectedLine - 4 );
}
}
onHashChange();
$( window ).on( 'hashchange', onHashChange );
},
/**
* This creates a Statusbar, that allows you to see a count of the
* errors, warnings and the warning of the current line, as well as
* the position of the cursor.
*/
setupStatusBar: function () {
var shouldUpdateAnnotations,
shouldUpdateSelection,
shouldUpdateLineInfo,
nextAnnotation,
delayedUpdate,
editor = context.codeEditor,
lang = ace.require( 'ace/lib/lang' ),
$errors = $( '<span>' ).addClass( 'codeEditor-status-worker-cell ace_gutter-cell ace_error' ).text( '0' ),
$warnings = $( '<span>' ).addClass( 'codeEditor-status-worker-cell ace_gutter-cell ace_warning' ).text( '0' ),
$infos = $( '<span>' ).addClass( 'codeEditor-status-worker-cell ace_gutter-cell ace_info' ).text( '0' ),
$message = $( '<div>' ).addClass( 'codeEditor-status-message' ),
$lineAndMode = $( '<div>' ).addClass( 'codeEditor-status-line' ),
$workerStatus = $( '<div>' )
.addClass( 'codeEditor-status-worker' )
.attr( 'title', mw.msg( 'codeeditor-next-annotation' ) )
.append( $errors )
.append( $warnings )
.append( $infos );
context.$statusBar = $( '<div>' )
.addClass( 'codeEditor-status' )
.append( $workerStatus )
.append( $message )
.append( $lineAndMode );
/* Help function to concatenate strings with different separators */
function addToStatus( status, str, separator ) {
if ( str ) {
status.push( str, separator || '|' );
}
}
/**
* Update all the information in the status bar
*/
function updateStatusBar() {
var i, c, r,
status,
annotation,
errors = 0,
warnings = 0,
infos = 0,
distance,
shortestDistance = Infinity,
closestAnnotation,
currentLine = editor.selection.lead.row,
annotations = editor.getSession().getAnnotations(),
closestType;
// Reset the next annotation
nextAnnotation = null;
for ( i = 0; i < annotations.length; i++ ) {
annotation = annotations[ i ];
distance = Math.abs( currentLine - annotation.row );
if ( distance < shortestDistance ) {
shortestDistance = distance;
closestAnnotation = annotation;
}
if ( nextAnnotation === null && annotation.row > currentLine ) {
nextAnnotation = annotation;
}
switch ( annotations[ i ].type ) {
case 'error':
errors++;
break;
case 'warning':
warnings++;
break;
case 'info':
infos++;
break;
}
}
// Wrap around to the beginning for nextAnnotation
if ( nextAnnotation === null && annotations.length > 0 ) {
nextAnnotation = annotations[ 0 ];
}
// Update the annotation counts
if ( shouldUpdateAnnotations ) {
$errors.text( errors );
$warnings.text( warnings );
$infos.text( infos );
}
// Show the message of the current line, if we have not already done so
if ( closestAnnotation &&
currentLine === closestAnnotation.row &&
closestAnnotation !== $message.data( 'annotation' ) ) {
$message.data( 'annotation', closestAnnotation );
closestType =
closestAnnotation.type.charAt( 0 ).toUpperCase() +
closestAnnotation.type.slice( 1 );
$message.text( closestType + ': ' + closestAnnotation.text );
} else if ( $message.data( 'annotation' ) !== null &&
( !closestAnnotation || currentLine !== closestAnnotation.row ) ) {
// If we are on a different line without an annotation, then blank the message
$message.data( 'annotation', null );
$message.text( '' );
}
// The cursor position has changed
if ( shouldUpdateSelection || shouldUpdateLineInfo ) {
// Adapted from Ajax.org's ace/ext/statusbar module
status = [];
if ( editor.$vimModeHandler ) {
addToStatus( status, editor.$vimModeHandler.getStatusText() );
} else if ( editor.commands.recording ) {
addToStatus( status, 'REC' );
}
c = editor.selection.lead;
addToStatus( status, ( c.row + 1 ) + ':' + c.column, '' );
if ( !editor.selection.isEmpty() ) {
r = editor.getSelectionRange();
addToStatus( status, '(' + ( r.end.row - r.start.row ) + ':' + ( r.end.column - r.start.column ) + ')' );
}
status.pop();
$lineAndMode.text( status.join( '' ) );
}
shouldUpdateLineInfo = shouldUpdateSelection = shouldUpdateAnnotations = false;
}
// Function to delay/debounce updates for the StatusBar
delayedUpdate = lang.delayedCall( function () {
updateStatusBar( editor );
} );
/**
* Click handler that allows you to skip to the next annotation
*/
$workerStatus.on( 'click', function ( e ) {
if ( nextAnnotation ) {
context.codeEditor.navigateTo( nextAnnotation.row, nextAnnotation.column );
// Scroll up a bit to give some context
context.codeEditor.scrollToRow( nextAnnotation.row - 3 );
e.preventDefault();
}
} );
editor.getSession().on( 'changeAnnotation', function () {
shouldUpdateAnnotations = true;
delayedUpdate.schedule( 100 );
} );
editor.on( 'changeStatus', function () {
shouldUpdateLineInfo = true;
delayedUpdate.schedule( 100 );
} );
editor.on( 'changeSelection', function () {
shouldUpdateSelection = true;
delayedUpdate.schedule( 100 );
} );
// Force update
shouldUpdateLineInfo = shouldUpdateSelection = shouldUpdateAnnotations = true;
updateStatusBar( editor );
context.$statusBar.insertAfter( $( '.wikiEditor-ui-view-wikitext .wikiEditor-ui-bottom' ) );
},
removeStatusBar: function () {
context.codeEditor.getSession().removeListener( 'changeAnnotation' );
context.codeEditor.removeListener( 'changeSelection' );
context.codeEditor.removeListener( 'changeStatus' );
context.nextAnnotation = null;
context.$statusBar = null;
$( '.codeEditor-status' ).remove();
}
} );
/**
* Override the base functions in a way that lets
* us fall back to the originals when we turn off.
*
* @param {Object} base
* @param {Object} extended
*/
saveAndExtend = function ( base, extended ) {
// eslint-disable-next-line no-jquery/no-map-util
$.map( extended, function ( func, name ) {
var orig;
if ( name in base ) {
orig = base[ name ];
base[ name ] = function () {
if ( context.codeEditorActive ) {
return func.apply( this, arguments );
}
if ( orig ) {
return orig.apply( this, arguments );
}
throw new Error( 'CodeEditor: no original function to call for ' + name );
};
} else {
base[ name ] = func;
}
} );
};
saveAndExtend( context.fn, {
saveSelection: function () {
mw.log( 'codeEditor stub function saveSelection called' );
},
restoreSelection: function () {
mw.log( 'codeEditor stub function restoreSelection called' );
},
/**
* Scroll an element to the top of the iframe
*/
scrollToTop: function () {
mw.log( 'codeEditor stub function scrollToTop called' );
}
} );
/**
* Compatibility with the $.textSelection jQuery plug-in. When the iframe is in use, these functions provide
* equivalant functionality to the otherwise textarea-based functionality.
*/
textSelectionFn = {
/* Needed for search/replace */
getContents: function () {
return context.codeEditor.getSession().getValue();
},
setContents: function ( newContents ) {
context.codeEditor.getSession().setValue( newContents );
},
/**
* Gets the currently selected text in the content
* DO NOT CALL THIS DIRECTLY, use $.textSelection( 'functionname', options ) instead
*
* @return {string}
*/
getSelection: function () {
return context.codeEditor.getCopyText();
},
/**
* Inserts text at the begining and end of a text selection, optionally inserting text at the caret when
* selection is empty.
* DO NOT CALL THIS DIRECTLY, use $.textSelection( 'functionname', options ) instead
*
* @param {Object} options
* @return {jQuery}
*/
encapsulateSelection: function ( options ) {
var sel, range, selText, isSample, text;
// Does not yet handle 'ownline', 'splitlines' option
sel = context.codeEditor.getSelection();
range = sel.getRange();
selText = textSelectionFn.getSelection();
isSample = false;
if ( !selText ) {
selText = options.peri;
isSample = true;
} else if ( options.replace ) {
selText = options.peri;
}
text = options.pre;
text += selText;
text += options.post;
context.codeEditor.insert( text );
if ( isSample && options.selectPeri && !options.splitlines ) {
// May esplode if anything has newlines, be warned. :)
range.setStart( range.start.row, range.start.column + options.pre.length );
range.setEnd( range.start.row, range.start.column + selText.length );
sel.setSelectionRange( range );
}
return context.$textarea;
},
/**
* Gets the position (in resolution of bytes not nessecarily characters) in a textarea
* DO NOT CALL THIS DIRECTLY, use $.textSelection( 'functionname', options ) instead
*/
getCaretPosition: function () {
mw.log( 'codeEditor stub function getCaretPosition called' );
},
/**
* Sets the selection of the content
* DO NOT CALL THIS DIRECTLY, use $.textSelection( 'functionname', options ) instead
*
* @param {Object} options
* @return {jQuery}
*/
setSelection: function ( options ) {
var doc, lines, offsetToPos, start, end, sel, range;
// Ace stores positions for ranges as row/column pairs.
// To convert from character offsets, we'll need to iterate through the document
doc = context.codeEditor.getSession().getDocument();
lines = doc.getAllLines();
offsetToPos = function ( offset ) {
var row, col, pos;
row = 0;
col = 0;
pos = 0;
while ( row < lines.length && pos + lines[ row ].length < offset ) {
pos += lines[ row ].length;
pos++; // for the newline
row++;
}
col = offset - pos;
return { row: row, column: col };
};
start = offsetToPos( options.start );
end = offsetToPos( options.end );
sel = context.codeEditor.getSelection();
range = sel.getRange();
range.setStart( start.row, start.column );
range.setEnd( end.row, end.column );
sel.setSelectionRange( range );
return context.$textarea;
},
/**
* Scroll a textarea to the current cursor position. You can set the cursor position with setSelection()
* DO NOT CALL THIS DIRECTLY, use $.textSelection( 'functionname', options ) instead
*
* @return {jQuery}
*/
scrollToCaretPosition: function () {
mw.log( 'codeEditor stub function scrollToCaretPosition called' );
return context.$textarea;
}
};
/* Setup the editor */
context.fn.setupCodeEditorToolbar();
if ( context.codeEditorActive ) {
context.fn.setupCodeEditor();
}
};
}() );
|