| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- 'use strict';
- import CharacterProxy from './characterproxy.js';
- import TextFragment from './textfragment.js';
- import Element from './element.js';
- import Position from './position.js';
- import CKEditorError from '../ckeditorerror.js';
- /**
- * Position iterator class. It allows to iterate forward and backward over the tree document.
- *
- * @memberOf core.treeModel
- */
- export default class TreeWalker {
- /**
- * Creates a range iterator. All parameters are optional, but you have to specify either `boundaries` or `startPosition`.
- *
- * @param {Object} options Object with configuration.
- * @param {core.treeModel.Range} [options.boundaries] Range to define boundaries of the iterator.
- * @param {core.treeModel.Position} [options.startPosition] Starting position.
- * @param {Boolean} [options.singleCharacters=false] Flag indicating whether all consecutive characters with the same attributes
- * should be returned one by one as multiple {@link core.treeModel.CharacterProxy} (`true`) objects or as one
- * {@link core.treeModel.TextFragment} (`false`).
- * @param {Boolean} [options.shallow=false] Flag indicating whether iterator should enter elements or not. If the
- * iterator is shallow child nodes of any iterated node will not be returned along with `ELEMENT_END` tag.
- * @param {Boolean} [options.ignoreElementEnd=false] Flag indicating whether iterator should ignore `ELEMENT_END`
- * tags. If the option is true walker will not return a parent node of start position. If this option is `true`
- * each {@link core.treeModel.Element} will be returned once, while if the option is `false` they might be returned
- * twice: for `'ELEMENT_START'` and `'ELEMENT_END'`.
- * @constructor
- */
- constructor( options ) {
- if ( !options || ( !options.boundaries && !options.startPosition ) ) {
- /**
- * Neither boundaries nor starting position have been defined.
- *
- * @error tree-walker-no-start-position
- */
- throw new CKEditorError( 'tree-walker-no-start-position: Neither boundaries nor starting position have been defined.' );
- }
- /**
- * Iterator boundaries.
- *
- * When the {@link #next} method is called on the end boundary or the {@link #previous} method
- * on the start boundary, then `{ done: true }` is returned.
- *
- * If boundaries are not defined they are set before first and after last child of the root node.
- *
- * @member {core.treeModel.Range} core.treeModel.TreeWalker#boundaries
- */
- this.boundaries = options.boundaries || null;
- /**
- * End boundary cached for optimization purposes.
- *
- * @private
- * @member {core.treeModel.Element} core.treeModel.TreeWalker#_boundaryEndParent
- */
- this._boundaryEndParent = this.boundaries ? this.boundaries.end.parent : null;
- /**
- * Iterator position. This is always static position, even if the initial position was a
- * {@link core.treeModel.LivePosition live position}.
- *
- * @member {core.treeModel.Position} core.treeModel.TreeWalker#position
- */
- this.position = options.startPosition ?
- Position.createFromPosition( options.startPosition ) :
- Position.createFromPosition( options.boundaries.start );
- /**
- * Flag indicating whether all consecutive characters with the same attributes should be
- * returned as one {@link core.treeModel.CharacterProxy} (`true`) or one by one (`false`).
- *
- * @member {Boolean} core.treeModel.TreeWalker#singleCharacters
- */
- this.singleCharacters = !!options.singleCharacters;
- /**
- * Flag indicating whether iterator should enter elements or not. If the iterator is shallow child nodes of any
- * iterated node will not be returned along with `ELEMENT_END` tag.
- *
- * @member {Boolean} core.treeModel.TreeWalker#shallow
- */
- this.shallow = !!options.shallow;
- /**
- * Flag indicating whether iterator should ignore `ELEMENT_END` tags. If the option is true walker will not
- * return a parent node of the start position. If this option is `true` each {@link core.treeModel.Element} will
- * be returned once, while if the option is `false` they might be returned twice:
- * for `'ELEMENT_START'` and `'ELEMENT_END'`.
- *
- * @member {Boolean} core.treeModel.TreeWalker#ignoreElementEnd
- */
- this.ignoreElementEnd = !!options.ignoreElementEnd;
- /**
- * Parent of the most recently visited node. Cached for optimization purposes.
- *
- * @private
- * @member {core.treeModel.Element} core.treeModel.TreeWalker#_visitedParent
- */
- this._visitedParent = this.position.parent;
- }
- /**
- * Iterator interface.
- */
- [ Symbol.iterator ]() {
- return this;
- }
- /**
- * Makes a step forward in tree model. Moves the {@link #position} to the next position and returns the encountered value.
- *
- * @returns {Object} Object implementing iterator interface, returning information about taken step.
- * @returns {Boolean} return.done True if iterator is done.
- * @returns {core.treeModel.TreeWalkerValue} return.value Information about taken step.
- */
- next() {
- const previousPosition = this.position;
- const position = Position.createFromPosition( this.position );
- const parent = this._visitedParent;
- // We are at the end of the root.
- if ( parent.parent === null && position.offset === parent.getChildCount() ) {
- return { done: true };
- }
- // We reached the walker boundary.
- if ( parent === this._boundaryEndParent && position.offset == this.boundaries.end.offset ) {
- return { done: true };
- }
- const node = parent.getChild( position.offset );
- if ( node instanceof Element ) {
- if ( !this.shallow ) {
- // Manual operations on path internals for optimization purposes. Here and in the rest of the method.
- position.path.push( 0 );
- this._visitedParent = node;
- } else {
- position.offset++;
- }
- this.position = position;
- return formatReturnValue( 'ELEMENT_START', node, previousPosition, position, 1 );
- } else if ( node instanceof CharacterProxy ) {
- if ( this.singleCharacters ) {
- position.offset++;
- this.position = position;
- return formatReturnValue( 'CHARACTER', node, previousPosition, position, 1 );
- } else {
- let charactersCount = node._nodeListText.text.length - node._index;
- let offset = position.offset + charactersCount;
- if ( this._boundaryEndParent == parent && this.boundaries.end.offset < offset ) {
- offset = this.boundaries.end.offset;
- charactersCount = offset - position.offset;
- }
- let textFragment = new TextFragment( node, charactersCount );
- position.offset = offset;
- this.position = position;
- return formatReturnValue( 'TEXT', textFragment, previousPosition, position, charactersCount );
- }
- } else {
- // `node` is not set, we reached the end of current `parent`.
- position.path.pop();
- position.offset++;
- this.position = position;
- this._visitedParent = parent.parent;
- if ( this.ignoreElementEnd ) {
- return this.next();
- } else {
- return formatReturnValue( 'ELEMENT_END', parent, previousPosition, position );
- }
- }
- }
- }
- function formatReturnValue( type, item, previousPosition, nextPosition, length ) {
- return {
- done: false,
- value: {
- type: type,
- item: item,
- previousPosition: previousPosition,
- nextPosition: nextPosition,
- length: length
- }
- };
- }
- /**
- * Type of the step made by {@link core.treeModel.TreeWalker}.
- * Possible values: `'ELEMENT_START'` if walker is at the beginning of a node, `'ELEMENT_END'` if walker is at the end of node,
- * `'CHARACTER'` if walker traversed over a character, or `'TEXT'` if walker traversed over multiple characters (available in
- * character merging mode, see {@link core.treeModel.TreeWalker#constructor}).
- *
- * @typedef {String} core.treeModel.TreeWalkerValueType
- */
- /**
- * Object returned by {@link core.treeModel.TreeWalker} when traversing tree model.
- *
- * @typedef {Object} core.treeModel.TreeWalkerValue
- * @property {core.treeModel.TreeWalkerValueType} type
- * @property {core.treeModel.Item} item Item between old and new positions of {@link core.treeModel.TreeWalker}.
- * @property {core.treeModel.Position} previousPosition Previous position of the iterator. For `'ELEMENT_END'` it is the last
- * position inside the element. For all other types it is the position before the item. Note that it is more
- * efficient to use this position then calculate the position before the node using
- * {@link core.treeModel.Position.createBefore}. It is also more efficient to get the position after node by shifting
- * `previousPosition` by `length`, using {@link core.treeModel.Position#getShiftedBy}, then calculate the position using
- * {@link core.treeModel.Position.createAfter}.
- * @property {core.treeModel.Position} nextPosition Next position of the iterator. For `'ELEMENT_START'` it is the first
- * position inside the element. For all other types it is the position after the item.
- * @property {Number} [length] Length of the item. For `'ELEMENT_START'` and `'CHARACTER'` it is 1. For `'TEXT'` it is
- * the length of the text. For `'ELEMENT_END'` it is undefined.
- */
|