| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- 'use strict';
- import TreeWalker from '/ckeditor5/engine/treemodel/treewalker.js';
- import Range from '/ckeditor5/engine/treemodel/range.js';
- import Position from '/ckeditor5/engine/treemodel/position.js';
- import Text from '/ckeditor5/engine/treemodel/text.js';
- import Element from '/ckeditor5/engine/treemodel/element.js';
- /**
- * Writes the contents of the document to an HTML-like string.
- *
- * @param {engine.treeModel.Document} document
- * @param {String} rootName
- * @param {Object} [options]
- * @param {Boolean} [options.selection] Whether to write the selection.
- * @returns {String} The stringified data.
- */
- export function getData( document, rootName, options ) {
- const root = document.getRoot( rootName );
- const walker = new TreeWalker( {
- boundaries: Range.createFromElement( root )
- } );
- let ret = '';
- let lastPosition = Position.createFromParentAndOffset( root, 0 );
- const selection = document.selection;
- options = options || {};
- for ( let value of walker ) {
- if ( options.selection ) {
- ret += writeSelection( value.previousPosition, selection );
- }
- ret += writeItem( value, selection, options );
- lastPosition = value.nextPosition;
- }
- if ( options.selection ) {
- ret += writeSelection( lastPosition, selection );
- }
- return ret;
- }
- /**
- * Sets the contents of the model and the selection in it.
- *
- * @param {engine.treeModel.Document} document
- * @param {String} rootName
- * @param {String} data
- */
- export function setData( document, rootName, data ) {
- let appendTo = document.getRoot( rootName );
- const path = [];
- let selectionStart, selectionEnd, selectionAttributes, textAttributes;
- const handlers = {
- text( token ) {
- appendTo.appendChildren( new Text( token.text, textAttributes ) );
- },
- textStart( token ) {
- textAttributes = token.attributes;
- path.push( '$text' );
- },
- textEnd() {
- if ( path.pop() != '$text' ) {
- throw new Error( 'Parse error - unexpected closing tag.' );
- }
- textAttributes = null;
- },
- openingTag( token ) {
- let el = new Element( token.name, token.attributes );
- appendTo.appendChildren( el );
- appendTo = el;
- path.push( token.name );
- },
- closingTag( token ) {
- if ( path.pop() != token.name ) {
- throw new Error( 'Parse error - unexpected closing tag.' );
- }
- appendTo = appendTo.parent;
- },
- collapsedSelection( token ) {
- document.selection.collapse( appendTo, 'END' );
- document.selection.setAttributesTo( token.attributes );
- },
- selectionStart( token ) {
- selectionStart = Position.createFromParentAndOffset( appendTo, appendTo.getChildCount() );
- selectionAttributes = token.attributes;
- },
- selectionEnd() {
- if ( !selectionStart ) {
- throw new Error( 'Parse error - missing selection start' );
- }
- selectionEnd = Position.createFromParentAndOffset( appendTo, appendTo.getChildCount() );
- document.selection.setRanges(
- [ new Range( selectionStart, selectionEnd ) ],
- selectionAttributes.backward
- );
- delete selectionAttributes.backward;
- document.selection.setAttributesTo( selectionAttributes );
- }
- };
- for ( let token of tokenize( data ) ) {
- handlers[ token.type ]( token );
- }
- if ( path.length ) {
- throw new Error( 'Parse error - missing closing tags: ' + path.join( ', ' ) + '.' );
- }
- if ( selectionStart && !selectionEnd ) {
- throw new Error( 'Parse error - missing selection end.' );
- }
- }
- // -- getData helpers ---------------------------------------------------------
- function writeItem( walkerValue, selection, options ) {
- const type = walkerValue.type;
- const item = walkerValue.item;
- if ( type == 'ELEMENT_START' ) {
- let attrs = writeAttributes( item.getAttributes() );
- if ( attrs ) {
- return `<${ item.name } ${ attrs }>`;
- }
- return `<${ item.name }>`;
- }
- if ( type == 'ELEMENT_END' ) {
- return `</${ item.name }>`;
- }
- return writeText( walkerValue, selection, options );
- }
- function writeText( walkerValue, selection, options ) {
- const item = walkerValue.item;
- const attrs = writeAttributes( item.getAttributes() );
- let text = Array.from( item.text );
- if ( options.selection ) {
- const startIndex = walkerValue.previousPosition.offset + 1;
- const endIndex = walkerValue.nextPosition.offset - 1;
- let index = startIndex;
- while ( index <= endIndex ) {
- // Add the selection marker without changing any indexes, so if second marker must be added
- // in the same loop it does not blow up.
- text[ index - startIndex ] +=
- writeSelection( Position.createFromParentAndOffset( item.commonParent, index ), selection );
- index++;
- }
- }
- text = text.join( '' );
- if ( attrs ) {
- return `<$text ${ attrs }>${ text }</$text>`;
- }
- return text;
- }
- function writeAttributes( attrs ) {
- attrs = Array.from( attrs );
- return attrs.map( attr => attr[ 0 ] + '=' + JSON.stringify( attr[ 1 ] ) ).sort().join( ' ' );
- }
- function writeSelection( currentPosition, selection ) {
- // TODO: This function obviously handles only the first range.
- const range = selection.getFirstRange();
- // Handle end of the selection.
- if ( !selection.isCollapsed && range.end.compareWith( currentPosition ) == 'SAME' ) {
- return '</selection>';
- }
- // Handle no match.
- if ( range.start.compareWith( currentPosition ) != 'SAME' ) {
- return '';
- }
- // Handle beginning of the selection.
- let ret = '<selection';
- const attrs = writeAttributes( selection.getAttributes() );
- // TODO: Once we'll support multiple ranges this will need to check which range it is.
- if ( selection.isBackward ) {
- ret += ' backward';
- }
- if ( attrs ) {
- ret += ' ' + attrs;
- }
- ret += ( selection.isCollapsed ? ' />' : '>' );
- return ret;
- }
- // -- setData helpers ---------------------------------------------------------
- const patterns = {
- selection: /^<(\/?selection)( [^>]*)?>/,
- tag: /^<([^>]+)>/,
- text: /^[^<]+/
- };
- const handlers = {
- selection( match ) {
- const tagName = match[ 1 ];
- const tagExtension = match[ 2 ] || '';
- if ( tagName[ 0 ] == '/' ) {
- return {
- type: 'selectionEnd'
- };
- }
- if ( tagExtension.endsWith( ' /' ) ) {
- return {
- type: 'collapsedSelection',
- attributes: parseAttributes( tagExtension.slice( 1, -2 ) )
- };
- }
- return {
- type: 'selectionStart',
- attributes: parseAttributes( tagExtension.slice( 1 ) )
- };
- },
- tag( match ) {
- const tagContents = match[ 1 ].split( /\s+/ );
- const tagName = tagContents.shift();
- const attrs = tagContents.join( ' ' );
- if ( tagName == '/$text' ) {
- return {
- type: 'textEnd'
- };
- }
- if ( tagName == '$text' ) {
- return {
- type: 'textStart',
- attributes: parseAttributes( attrs )
- };
- }
- if ( tagName[ 0 ] == '/' ) {
- return {
- type: 'closingTag',
- name: tagName.slice( 1 )
- };
- }
- return {
- type: 'openingTag',
- name: tagName,
- attributes: parseAttributes( attrs )
- };
- },
- text( match ) {
- return {
- type: 'text',
- text: match[ 0 ]
- };
- }
- };
- function *tokenize( data ) {
- while ( data ) {
- const consumed = consumeNextToken( data );
- data = consumed.data;
- yield consumed.token;
- }
- }
- function consumeNextToken( data ) {
- let match;
- for ( let patternName in patterns ) {
- match = data.match( patterns[ patternName ] );
- if ( match ) {
- data = data.slice( match[ 0 ].length );
- return {
- token: handlers[ patternName ]( match ),
- data
- };
- }
- }
- throw new Error( 'Parse error - unpexpected token: ' + data + '.' );
- }
- function parseAttributes( attrsString ) {
- attrsString = attrsString.trim();
- if ( !attrsString ) {
- return {};
- }
- const pattern = /(?:backward|(\w+)=("[^"]+"|[^\s]+))\s*/;
- const attrs = {};
- while ( attrsString ) {
- let match = attrsString.match( pattern );
- if ( !match ) {
- throw new Error( 'Parse error - unexpected token: ' + attrsString + '.' );
- }
- if ( match[ 0 ].trim() == 'backward' ) {
- attrs.backward = true;
- } else {
- attrs[ match[ 1 ] ] = JSON.parse( match[ 2 ] );
- }
- attrsString = attrsString.slice( match[ 0 ].length );
- }
- return attrs;
- }
|