| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- 'use strict';
- import TreeWalker from '/ckeditor5/engine/model/treewalker.js';
- import Range from '/ckeditor5/engine/model/range.js';
- import Position from '/ckeditor5/engine/model/position.js';
- import Text from '/ckeditor5/engine/model/text.js';
- import RootElement from '/ckeditor5/engine/model/rootelement.js';
- import Element from '/ckeditor5/engine/model/element.js';
- import DocumentFragment from '/ckeditor5/engine/model/documentfragment.js';
- import Selection from '/ckeditor5/engine/model/selection.js';
- import Document from '/ckeditor5/engine/model/document.js';
- /**
- * Writes the contents of the {@link engine.model.Document Document} to an HTML-like string.
- *
- * @param {engine.model.Document} document
- * @param {Object} [options]
- * @param {Boolean} [options.withoutSelection=false] Whether to write the selection. When set to `true` selection will
- * be not included in returned string.
- * @param {Boolean} [options.rootName='main'] Name of the root from which data should be stringified. If not provided
- * default `main` name will be used.
- * @returns {String} The stringified data.
- */
- export function getData( document, options = {} ) {
- if ( !( document instanceof Document ) ) {
- throw new TypeError( 'Document needs to be an instance of engine.model.Document.' );
- }
- const withoutSelection = !!options.withoutSelection;
- const rootName = options.rootName || 'main';
- const root = document.getRoot( rootName );
- return withoutSelection ? getData._stringify( root ) : getData._stringify( root, document.selection );
- }
- // Set stringify as getData private method - needed for testing/spying.
- getData._stringify = stringify;
- /**
- * Sets the contents of the {@link engine.model.Document Document} provided as HTML-like string.
- * It uses {@link engine.model.Document#enqueueChanges enqueueChanges} method.
- *
- * NOTE:
- * Remember to register elements in {@link engine.model.Document#schema document's schema} before inserting them.
- *
- * @param {engine.model.Document} document
- * @param {String} data HTML-like string to write into Document.
- * @param {Object} options
- * @param {String} [options.rootName='main'] Root name where parsed data will be stored. If not provided, default `main`
- * name will be used.
- * @param {String} [options.batchType='transparent'] Batch type used for inserting elements. See {@link engine.model.Batch#type}.
- */
- export function setData( document, data, options = {} ) {
- if ( !( document instanceof Document ) ) {
- throw new TypeError( 'Document needs to be an instance of engine.model.Document.' );
- }
- let model, selection;
- const result = setData._parse( data );
- if ( result.model && result.selection ) {
- model = result.model;
- selection = result.selection;
- } else {
- model = result;
- }
- // Save to model.
- const modelRoot = document.getRoot( options.rootName || 'main' );
- document.enqueueChanges( () => {
- document.batch( options.batchType || 'transparent' )
- .remove( Range.createFromElement( modelRoot ) )
- .insert( Position.createAt( modelRoot, 0 ), model );
- if ( selection ) {
- const ranges = [];
- for ( let range of selection.getRanges() ) {
- let start, end;
- // Each range returned from `parse()` method has its root placed in DocumentFragment.
- // Here we convert each range to have its root re-calculated properly and be placed inside
- // model document root.
- if ( range.start.parent instanceof DocumentFragment ) {
- start = Position.createFromParentAndOffset( modelRoot, range.start.offset );
- } else {
- start = Position.createFromParentAndOffset( range.start.parent, range.start.offset );
- }
- if ( range.end.parent instanceof DocumentFragment ) {
- end = Position.createFromParentAndOffset( modelRoot, range.end.offset );
- } else {
- end = Position.createFromParentAndOffset( range.end.parent, range.end.offset );
- }
- ranges.push( new Range( start, end ) );
- }
- document.selection.setRanges( ranges, selection.isBackward );
- }
- } );
- }
- // Set parse as setData private method - needed for testing/spying.
- setData._parse = parse;
- /**
- * Converts model nodes to HTML-like string representation.
- *
- * @param {engine.model.RootElement|engine.model.Element|engine.model.Text|
- * engine.model.DocumentFragment} node Node to stringify.
- * @param {engine.model.Selection|engine.model.Position|engine.model.Range} [selectionOrPositionOrRange = null ]
- * Selection instance which ranges will be included in returned string data. If Range instance is provided - it will be
- * converted to selection containing this range. If Position instance is provided - it will be converted to selection
- * containing one range collapsed at this position.
- * @returns {String} HTML-like string representing the model.
- */
- export function stringify( node, selectionOrPositionOrRange = null ) {
- let selection, range;
- if ( node instanceof RootElement || node instanceof DocumentFragment ) {
- range = Range.createFromElement( node );
- } else {
- // Node is detached - create new document fragment.
- if ( !node.parent ) {
- const fragment = new DocumentFragment( node );
- range = Range.createFromElement( fragment );
- } else {
- range = new Range(
- Position.createBefore( node ),
- Position.createAfter( node )
- );
- }
- }
- const walker = new TreeWalker( {
- boundaries: range
- } );
- if ( selectionOrPositionOrRange instanceof Selection ) {
- selection = selectionOrPositionOrRange;
- } else if ( selectionOrPositionOrRange instanceof Range ) {
- selection = new Selection();
- selection.addRange( selectionOrPositionOrRange );
- } else if ( selectionOrPositionOrRange instanceof Position ) {
- selection = new Selection();
- selection.addRange( new Range( selectionOrPositionOrRange, selectionOrPositionOrRange ) );
- }
- let ret = '';
- let lastPosition = Position.createFromPosition( range.start );
- const withSelection = !!selection;
- for ( let value of walker ) {
- if ( withSelection ) {
- ret += writeSelection( value.previousPosition, selection );
- }
- ret += writeItem( value, selection, { selection: withSelection } );
- lastPosition = value.nextPosition;
- }
- if ( withSelection ) {
- ret += writeSelection( lastPosition, selection );
- }
- return ret;
- }
- /**
- * Parses HTML-like string and returns model {@link engine.model.RootElement rootElement}.
- *
- * @param {String} data HTML-like string to be parsed.
- * @param {Object} options
- * @returns {engine.model.Element|engine.model.Text|engine.model.DocumentFragment|Object} Returns parsed model node or
- * object with two fields `model` and `selection` when selection ranges were included in data to parse.
- */
- export function parse( data ) {
- let root, selection;
- let withSelection = false;
- root = new DocumentFragment();
- selection = new Selection();
- const path = [];
- let selectionStart, selectionEnd, selectionAttributes, textAttributes;
- const handlers = {
- text( token ) {
- root.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 );
- root.appendChildren( el );
- root = el;
- path.push( token.name );
- },
- closingTag( token ) {
- if ( path.pop() != token.name ) {
- throw new Error( 'Parse error - unexpected closing tag.' );
- }
- root = root.parent;
- },
- collapsedSelection( token ) {
- withSelection = true;
- selection.collapse( root, 'END' );
- selection.setAttributesTo( token.attributes );
- },
- selectionStart( token ) {
- selectionStart = Position.createFromParentAndOffset( root, root.getChildCount() );
- selectionAttributes = token.attributes;
- },
- selectionEnd() {
- if ( !selectionStart ) {
- throw new Error( 'Parse error - missing selection start.' );
- }
- withSelection = true;
- selectionEnd = Position.createFromParentAndOffset( root, root.getChildCount() );
- selection.setRanges(
- [ new Range( selectionStart, selectionEnd ) ],
- selectionAttributes.backward
- );
- delete selectionAttributes.backward;
- 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.' );
- }
- // If root DocumentFragment contains only one element - return that element.
- if ( root instanceof DocumentFragment && root.getChildCount() == 1 ) {
- root = root.getChild( 0 );
- }
- if ( withSelection ) {
- return {
- model: root,
- selection: selection
- };
- }
- return root;
- }
- // -- 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 - unexpected 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;
- }
|