wikimedia/mediawiki-extensions-VisualEditor

/*!
 * VisualEditor UserInterface MWWikitextSurface class.
 *
 * @copyright See AUTHORS.txt
 */

/**
 * @class
 * @extends ve.ui.Surface
 *
 * @constructor
 * @param {ve.init.Target} target
 * @param {HTMLDocument|Array|ve.dm.LinearData|ve.dm.Document} dataOrDoc Document data to edit
 * @param {Object} [config] Configuration options
 */
ve.ui.MWWikitextSurface = function VeUiMWWikitextSurface() {
    // Parent constructor
    ve.ui.MWWikitextSurface.super.apply( this, arguments );

    // Initialization
    this.$element.addClass( 've-ui-mwWikitextSurface' );

    this.getView().$element.add( this.$placeholder )
        .removeClass( 've-ui-surface-source-font' )
        // The following classes are used here:
        // * mw-editfont-monospace
        // * mw-editfont-sans-serif
        // * mw-editfont-serif
        .addClass( 'mw-editfont-' + mw.user.options.get( 'editfont' ) );

    // eslint-disable-next-line no-jquery/no-global-selector
    this.$textbox = $( '#wpTextbox1' );
    if ( !this.$textbox.length ) {
        this.$textbox = $( '<textarea>' )
            .attr( 'id', 'wpTextbox1' )
            .addClass( 've-dummyTextbox' );
        // Append a dummy textbox to the surface, so it gets destroyed with it. Wrap it in a hidden
        // element, so that UI of extensions/gadgets that add stuff to the real MediaWiki textbox
        // (e.g. WikiEditor) remains mercifully hidden (T211898).
        this.$element.append(
            $( '<div>' )
                .addClass( 've-dummyTextbox-wrapper oo-ui-element-hidden' )
                .append( this.$textbox )
        );
    } else {
        // Existing textbox may have an API registered
        this.$textbox.textSelection( 'unregister' );
    }

    // Note: Chainable methods (setContents/setSelection) must use
    // non-arrow functions that return this. We can't just return
    // this.$textbox either as the collection could be cloned.
    /* eslint es-x/no-arrow-functions: error */
    const surface = this;
    // Backwards support for the textSelection API
    this.$textbox.textSelection( 'register', {
        getContents: function () {
            return surface.getDom();
        },
        setContents: function ( content ) {
            surface.getModel().getLinearFragment( new ve.Range( 0 ), true ).expandLinearSelection( 'root' ).insertContent( content );
            return this;
        },
        getSelection: function () {
            const range = surface.getModel().getSelection().getCoveringRange();
            if ( !range ) {
                return '';
            }
            return surface.getModel().getDocument().data.getSourceText( range );
        },
        setSelection: function ( options ) {
            surface.getModel().setLinearSelection(
                surface.getModel().getRangeFromSourceOffsets( options.start, options.end )
            );
            return this;
        },
        getCaretPosition: function ( options ) {
            const range = surface.getModel().getSelection().getCoveringRange(),
                surfaceModel = surface.getModel(),
                caretPos = range ? surfaceModel.getSourceOffsetFromOffset( range.start ) : 0;

            return options.startAndEnd ?
                [ caretPos, range ? surfaceModel.getSourceOffsetFromOffset( range.end ) : 0 ] :
                caretPos;
        },
        replaceSelection: function ( value ) {
            surface.getModel().getFragment().insertContent( value );
            return this;
        },
        // encapsulateSelection works automatically when we implement the overrides above
        scrollToCaretPosition: function () {
            surface.scrollSelectionIntoView();
            return this;
        }
    } );
    /* eslint es-x/no-arrow-functions: off */
};

/* Inheritance */

OO.inheritClass( ve.ui.MWWikitextSurface, ve.ui.MWSurface );

/* Methods */

/**
 * @inheritdoc
 */
ve.ui.MWWikitextSurface.prototype.createModel = function ( doc ) {
    return new ve.dm.MWWikitextSurface( doc );
};

/**
 * @inheritdoc
 */
ve.ui.MWWikitextSurface.prototype.createView = function ( model ) {
    return new ve.ce.MWWikitextSurface( model, this );
};

/**
 * @inheritdoc
 */
ve.ui.MWWikitextSurface.prototype.destroy = function () {
    this.$textbox.textSelection( 'unregister' );
    // Parent method
    return ve.ui.MWWikitextSurface.super.prototype.destroy.apply( this, arguments );
};