| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import Feature from '../core/feature.js';
- import ChangeBuffer from './changebuffer.js';
- import ModelRange from '../engine/model/range.js';
- import ViewPosition from '../engine/view/position.js';
- import ViewText from '../engine/view/text.js';
- import diff from '../utils/diff.js';
- import diffToChanges from '../utils/difftochanges.js';
- import { getCode } from '../utils/keyboard.js';
- /**
- * Handles text input coming from the keyboard or other input methods.
- *
- * @memberOf typing
- * @extends core.Feature
- */
- export default class Input extends Feature {
- /**
- * @inheritDoc
- */
- init() {
- const editor = this.editor;
- const editingView = editor.editing.view;
- /**
- * Typing's change buffer used to group subsequent changes into batches.
- *
- * @protected
- * @member {typing.ChangeBuffer} typing.Input#_buffer
- */
- this._buffer = new ChangeBuffer( editor.document, editor.config.get( 'typing.undoStep' ) || 20 );
- // TODO The above default configuration value should be defined using editor.config.define() once it's fixed.
- this.listenTo( editingView, 'keydown', ( evt, data ) => {
- this._handleKeydown( data );
- }, { priority: 'lowest' } );
- this.listenTo( editingView, 'mutations', ( evt, mutations, viewSelection ) => {
- this._handleMutations( mutations, viewSelection );
- } );
- }
- /**
- * @inheritDoc
- */
- destroy() {
- super.destroy();
- this._buffer.destroy();
- this._buffer = null;
- }
- /**
- * Handles the keydown event. We need to guess whether such keystroke is going to result
- * in typing. If so, then before character insertion happens, any selected content needs
- * to be deleted. Otherwise the default browser deletion mechanism would be
- * triggered, resulting in:
- *
- * * Hundreds of mutations which could not be handled.
- * * But most importantly, loss of control over how the content is being deleted.
- *
- * The method is used in a low-priority listener, hence allowing other listeners (e.g. delete or enter features)
- * to handle the event.
- *
- * @private
- * @param {engine.view.observer.keyObserver.KeyEventData} evtData
- */
- _handleKeydown( evtData ) {
- const doc = this.editor.document;
- if ( isSafeKeystroke( evtData ) || doc.selection.isCollapsed ) {
- return;
- }
- doc.enqueueChanges( () => {
- doc.composer.deleteContents( this._buffer.batch, doc.selection );
- } );
- }
- /**
- * Handles DOM mutations.
- *
- * @param {Array.<engine.view.Document~MutatatedText|engine.view.Document~MutatatedChildren>} mutations
- */
- _handleMutations( mutations, viewSelection ) {
- const doc = this.editor.document;
- const handler = new MutationHandler( this.editor.editing, this._buffer );
- doc.enqueueChanges( () => handler.handle( mutations, viewSelection ) );
- }
- }
- /**
- * Helper class for translating DOM mutations into model changes.
- *
- * @private
- * @member typing.Input
- */
- class MutationHandler {
- /**
- * Creates an instance of the mutation handler.
- *
- * @param {engine.EditingController} editing
- * @param {typing.ChangeBuffer} buffer
- */
- constructor( editing, buffer ) {
- /**
- * The editing controller.
- *
- * @member {engine.EditingController} typing.Input.MutationHandler#editing
- */
- this.editing = editing;
- /**
- * The change buffer.
- *
- * @member {engine.EditingController} typing.Input.MutationHandler#buffer
- */
- this.buffer = buffer;
- /**
- * The number of inserted characters which need to be fed to the {@link #buffer change buffer}
- * on {@link #commit}.
- *
- * @member {Number} typing.Input.MutationHandler#insertedCharacterCount
- */
- this.insertedCharacterCount = 0;
- }
- /**
- * Handles given mutations.
- *
- * @param {Array.<engine.view.Document~MutatatedText|engine.view.Document~MutatatedChildren>} mutations
- */
- handle( mutations, viewSelection ) {
- for ( let mutation of mutations ) {
- // Fortunately it will never be both.
- this._handleTextMutation( mutation, viewSelection );
- this._handleTextNodeInsertion( mutation );
- }
- this.buffer.input( Math.max( this.insertedCharacterCount, 0 ) );
- }
- _handleTextMutation( mutation, viewSelection ) {
- if ( mutation.type != 'text' ) {
- return;
- }
- // Replace inserted by the browser with normal space.
- // We want only normal spaces in the model and in the view. Renderer and DOM Converter will be then responsible
- // for rendering consecutive spaces using , but the model and the view has to be clear.
- // Other feature may introduce inserting non-breakable space on specific key stroke (for example shift + space).
- // However then it will be handled outside of mutations, like enter key is.
- // The replacing is here because it has to be done before `diff` and `diffToChanges` functions, as they
- // take `newText` and compare it to (cleaned up) view.
- // It could also be done in mutation observer too, however if any outside plugin would like to
- // introduce additional events for mutations, they would get already cleaned up version (this may be good or not).
- const newText = mutation.newText.replace( /\u00A0/g, ' ' );
- // To have correct `diffResult`, we also compare view node text data with replaced by space.
- const oldText = mutation.oldText.replace( /\u00A0/g, ' ' );
- const diffResult = diff( oldText, newText );
- // Index where the first change happens. Used to set the position from which nodes will be removed and where will be inserted.
- let firstChangeAt = null;
- // Index where the last change happens. Used to properly count how many characters have to be removed and inserted.
- let lastChangeAt = null;
- // Get `firstChangeAt` and `lastChangeAt`.
- for ( let i = 0; i < diffResult.length; i++ ) {
- const change = diffResult[ i ];
- if ( change != 'equal' ) {
- firstChangeAt = firstChangeAt === null ? i : firstChangeAt;
- lastChangeAt = i;
- }
- }
- // How many characters, starting from `firstChangeAt`, should be removed.
- let deletions = 0;
- // How many characters, starting from `firstChangeAt`, should be inserted (basing on mutation.newText).
- let insertions = 0;
- for ( let i = firstChangeAt; i <= lastChangeAt; i++ ) {
- // If there is no change (equal) or delete, the character is existing in `oldText`. We count it for removing.
- if ( diffResult[ i ] != 'insert' ) {
- deletions++;
- }
- // If there is no change (equal) or insert, the character is existing in `newText`. We count it for inserting.
- if ( diffResult[ i ] != 'delete' ) {
- insertions++;
- }
- }
- // Try setting new model selection according to passed view selection.
- let modelSelectionPosition = null;
- if ( viewSelection ) {
- modelSelectionPosition = this.editing.mapper.toModelPosition( viewSelection.anchor );
- }
- // Get the position in view and model where the changes will happen.
- const viewPos = new ViewPosition( mutation.node, firstChangeAt );
- const modelPos = this.editing.mapper.toModelPosition( viewPos );
- // Remove appropriate number of characters from the model text node.
- if ( deletions > 0 ) {
- const removeRange = ModelRange.createFromPositionAndShift( modelPos, deletions );
- this._remove( removeRange, deletions );
- }
- // Insert appropriate characters basing on `mutation.text`.
- const insertedText = mutation.newText.substr( firstChangeAt, insertions );
- this._insert( modelPos, insertedText );
- // If there was `viewSelection` and it got correctly mapped, collapse selection at found model position.
- if ( modelSelectionPosition ) {
- this.editing.model.selection.collapse( modelSelectionPosition );
- }
- }
- _handleTextNodeInsertion( mutation ) {
- if ( mutation.type != 'children' ) {
- return;
- }
- // One new node.
- if ( mutation.newChildren.length - mutation.oldChildren.length != 1 ) {
- return;
- }
- // Which is text.
- const diffResult = diff( mutation.oldChildren, mutation.newChildren, compareChildNodes );
- const changes = diffToChanges( diffResult, mutation.newChildren );
- // In case of [ delete, insert, insert ] the previous check will not exit.
- if ( changes.length > 1 ) {
- return;
- }
- const change = changes[ 0 ];
- // Which is text.
- if ( !( change.values[ 0 ] instanceof ViewText ) ) {
- return;
- }
- const viewPos = new ViewPosition( mutation.node, change.index );
- const modelPos = this.editing.mapper.toModelPosition( viewPos );
- let insertedText = change.values[ 0 ].data;
- // Replace inserted by the browser with normal space.
- // See comment in `_handleTextMutation`.
- // In this case we don't need to do this before `diff` because we diff whole nodes.
- // Just change in case there are some.
- insertedText = insertedText.replace( /\u00A0/g, ' ' );
- this._insert( modelPos, insertedText );
- this.editing.model.selection.collapse( modelPos.parent, 'end' );
- }
- _insert( position, text ) {
- this.buffer.batch.weakInsert( position, text );
- this.insertedCharacterCount += text.length;
- }
- _remove( range, length ) {
- this.buffer.batch.remove( range );
- this.insertedCharacterCount -= length;
- }
- }
- const safeKeycodes = [
- getCode( 'arrowUp' ),
- getCode( 'arrowRight' ),
- getCode( 'arrowDown' ),
- getCode( 'arrowLeft' ),
- 16, // Shift
- 17, // Ctrl
- 18, // Alt
- 20, // CapsLock
- 27, // Escape
- 33, // PageUp
- 34, // PageDown
- 35, // Home
- 36, // End
- ];
- // Function keys.
- for ( let code = 112; code <= 135; code++ ) {
- safeKeycodes.push( code );
- }
- // Returns `true` if a keystroke should not cause any content change caused by "typing".
- //
- // Note: This implementation is very simple and will need to be refined with time.
- //
- // @param {engine.view.observer.keyObserver.KeyEventData} keyData
- // @returns {Boolean}
- function isSafeKeystroke( keyData ) {
- // Keystrokes which contain Ctrl don't represent typing.
- if ( keyData.ctrlKey ) {
- return true;
- }
- return safeKeycodes.includes( keyData.keyCode );
- }
- // Helper function that compares whether two given view nodes are same. It is used in `diff` when it's passed an array
- // with child nodes.
- function compareChildNodes( oldChild, newChild ) {
- if ( oldChild instanceof ViewText && newChild instanceof ViewText ) {
- return oldChild.data === newChild.data;
- } else {
- return oldChild === newChild;
- }
- }
|