model.js 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /**
  6. * @module engine/model/model
  7. */
  8. import Batch from './batch';
  9. import Writer from './writer';
  10. import Schema from './schema';
  11. import Document from './document';
  12. import MarkerCollection from './markercollection';
  13. import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
  14. import mix from '@ckeditor/ckeditor5-utils/src/mix';
  15. import ModelElement from './element';
  16. import ModelRange from './range';
  17. import ModelPosition from './position';
  18. import ModelSelection from './selection';
  19. import OperationFactory from './operation/operationfactory';
  20. import insertContent from './utils/insertcontent';
  21. import deleteContent from './utils/deletecontent';
  22. import modifySelection from './utils/modifyselection';
  23. import getSelectedContent from './utils/getselectedcontent';
  24. import { injectSelectionPostFixer } from './utils/selection-post-fixer';
  25. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  26. // @if CK_DEBUG_ENGINE // const { dumpTrees } = require( '../dev-utils/utils' );
  27. // @if CK_DEBUG_ENGINE // const { OperationReplayer } = require( '../dev-utils/operationreplayer' ).default;
  28. /**
  29. * Editor's data model. Read about the model in the
  30. * {@glink framework/guides/architecture/editing-engine engine architecture guide}.
  31. *
  32. * @mixes module:utils/observablemixin~ObservableMixin
  33. */
  34. export default class Model {
  35. constructor() {
  36. /**
  37. * Model's marker collection.
  38. *
  39. * @readonly
  40. * @member {module:engine/model/markercollection~MarkerCollection}
  41. */
  42. this.markers = new MarkerCollection();
  43. /**
  44. * Model's document.
  45. *
  46. * @readonly
  47. * @member {module:engine/model/document~Document}
  48. */
  49. this.document = new Document( this );
  50. /**
  51. * Model's schema.
  52. *
  53. * @readonly
  54. * @member {module:engine/model/schema~Schema}
  55. */
  56. this.schema = new Schema();
  57. /**
  58. * All callbacks added by {@link module:engine/model/model~Model#change} or
  59. * {@link module:engine/model/model~Model#enqueueChange} methods waiting to be executed.
  60. *
  61. * @private
  62. * @type {Array.<Function>}
  63. */
  64. this._pendingChanges = [];
  65. /**
  66. * The last created and currently used writer instance.
  67. *
  68. * @private
  69. * @member {module:engine/model/writer~Writer}
  70. */
  71. this._currentWriter = null;
  72. [ 'insertContent', 'deleteContent', 'modifySelection', 'getSelectedContent', 'applyOperation' ]
  73. .forEach( methodName => this.decorate( methodName ) );
  74. // Adding operation validation with `highest` priority, so it is called before any other feature would like
  75. // to do anything with the operation. If the operation has incorrect parameters it should throw on the earliest occasion.
  76. this.on( 'applyOperation', ( evt, args ) => {
  77. const operation = args[ 0 ];
  78. operation._validate();
  79. }, { priority: 'highest' } );
  80. // Register some default abstract entities.
  81. this.schema.register( '$root', {
  82. isLimit: true
  83. } );
  84. this.schema.register( '$block', {
  85. allowIn: '$root',
  86. isBlock: true
  87. } );
  88. this.schema.register( '$text', {
  89. allowIn: '$block',
  90. isInline: true
  91. } );
  92. this.schema.register( '$clipboardHolder', {
  93. allowContentOf: '$root',
  94. isLimit: true
  95. } );
  96. this.schema.extend( '$text', { allowIn: '$clipboardHolder' } );
  97. // An element needed by the `upcastElementToMarker` converter.
  98. // This element temporarily represents a marker boundary during the conversion process and is removed
  99. // at the end of the conversion. `UpcastDispatcher` or at least `Conversion` class looks like a
  100. // better place for this registration but both know nothing about `Schema`.
  101. this.schema.register( '$marker' );
  102. this.schema.addChildCheck( ( context, childDefinition ) => {
  103. if ( childDefinition.name === '$marker' ) {
  104. return true;
  105. }
  106. } );
  107. injectSelectionPostFixer( this );
  108. // @if CK_DEBUG_ENGINE // this.on( 'applyOperation', () => {
  109. // @if CK_DEBUG_ENGINE // dumpTrees( this.document, this.document.version );
  110. // @if CK_DEBUG_ENGINE // }, { priority: 'lowest' } );
  111. }
  112. /**
  113. * The `change()` method is the primary way of changing the model. You should use it to modify all document nodes
  114. * (including detached nodes – i.e. nodes not added to the {@link module:engine/model/model~Model#document model document}),
  115. * the {@link module:engine/model/document~Document#selection document's selection}, and
  116. * {@link module:engine/model/model~Model#markers model markers}.
  117. *
  118. * model.change( writer => {
  119. * writer.insertText( 'foo', paragraph, 'end' );
  120. * } );
  121. *
  122. * All changes inside the change block use the same {@link module:engine/model/batch~Batch} so they are combined
  123. * into a single undo step.
  124. *
  125. * model.change( writer => {
  126. * writer.insertText( 'foo', paragraph, 'end' ); // foo.
  127. *
  128. * model.change( writer => {
  129. * writer.insertText( 'bar', paragraph, 'end' ); // foobar.
  130. * } );
  131. *
  132. * writer.insertText( 'bom', paragraph, 'end' ); // foobarbom.
  133. * } );
  134. *
  135. * The callback of the `change()` block is executed synchronously.
  136. *
  137. * You can also return a value from the change block.
  138. *
  139. * const img = model.change( writer => {
  140. * return writer.createElement( 'img' );
  141. * } );
  142. *
  143. * @see #enqueueChange
  144. * @param {Function} callback Callback function which may modify the model.
  145. * @returns {*} Value returned by the callback.
  146. */
  147. change( callback ) {
  148. try {
  149. if ( this._pendingChanges.length === 0 ) {
  150. // If this is the outermost block, create a new batch and start `_runPendingChanges` execution flow.
  151. this._pendingChanges.push( { batch: new Batch(), callback } );
  152. return this._runPendingChanges()[ 0 ];
  153. } else {
  154. // If this is not the outermost block, just execute the callback.
  155. return callback( this._currentWriter );
  156. }
  157. } catch ( err ) {
  158. // @if CK_DEBUG // throw err;
  159. /* istanbul ignore next */
  160. CKEditorError.rethrowUnexpectedError( err, this );
  161. }
  162. }
  163. /**
  164. * The `enqueueChange()` method performs similar task as the {@link #change `change()` method}, with two major differences.
  165. *
  166. * First, the callback of `enqueueChange()` is executed when all other enqueued changes are done. It might be executed
  167. * immediately if it is not nested in any other change block, but if it is nested in another (enqueue)change block,
  168. * it will be delayed and executed after the outermost block.
  169. *
  170. * model.change( writer => {
  171. * console.log( 1 );
  172. *
  173. * model.enqueueChange( writer => {
  174. * console.log( 2 );
  175. * } );
  176. *
  177. * console.log( 3 );
  178. * } ); // Will log: 1, 3, 2.
  179. *
  180. * Second, it lets you define the {@link module:engine/model/batch~Batch} into which you want to add your changes.
  181. * By default, a new batch is created. In the sample above, `change` and `enqueueChange` blocks use a different
  182. * batch (and different {@link module:engine/model/writer~Writer} since each of them operates on the separate batch).
  183. *
  184. * When using the `enqueueChange()` block you can also add some changes to the batch you used before.
  185. *
  186. * model.enqueueChange( batch, writer => {
  187. * writer.insertText( 'foo', paragraph, 'end' );
  188. * } );
  189. *
  190. * The batch instance can be obtained from {@link module:engine/model/writer~Writer#batch the writer}.
  191. *
  192. * @param {module:engine/model/batch~Batch|'transparent'|'default'} batchOrType Batch or batch type should be used in the callback.
  193. * If not defined, a new batch will be created.
  194. * @param {Function} callback Callback function which may modify the model.
  195. */
  196. enqueueChange( batchOrType, callback ) {
  197. try {
  198. if ( typeof batchOrType === 'string' ) {
  199. batchOrType = new Batch( batchOrType );
  200. } else if ( typeof batchOrType == 'function' ) {
  201. callback = batchOrType;
  202. batchOrType = new Batch();
  203. }
  204. this._pendingChanges.push( { batch: batchOrType, callback } );
  205. if ( this._pendingChanges.length == 1 ) {
  206. this._runPendingChanges();
  207. }
  208. } catch ( err ) {
  209. // @if CK_DEBUG // throw err;
  210. /* istanbul ignore next */
  211. CKEditorError.rethrowUnexpectedError( err, this );
  212. }
  213. }
  214. /**
  215. * {@link module:utils/observablemixin~ObservableMixin#decorate Decorated} function for applying
  216. * {@link module:engine/model/operation/operation~Operation operations} to the model.
  217. *
  218. * This is a low-level way of changing the model. It is exposed for very specific use cases (like the undo feature).
  219. * Normally, to modify the model, you will want to use {@link module:engine/model/writer~Writer `Writer`}.
  220. * See also {@glink framework/guides/architecture/editing-engine#changing-the-model Changing the model} section
  221. * of the {@glink framework/guides/architecture/editing-engine Editing architecture} guide.
  222. *
  223. * @param {module:engine/model/operation/operation~Operation} operation The operation to apply.
  224. */
  225. applyOperation( operation ) {
  226. // @if CK_DEBUG_ENGINE // console.log( 'Applying ' + operation );
  227. // @if CK_DEBUG_ENGINE // if ( !this._operationLogs ) {
  228. // @if CK_DEBUG_ENGINE // this._operationLogs = [];
  229. // @if CK_DEBUG_ENGINE // }
  230. // @if CK_DEBUG_ENGINE // this._operationLogs.push( JSON.stringify( operation ) );
  231. // @if CK_DEBUG_ENGINE //if ( !this._appliedOperations ) {
  232. // @if CK_DEBUG_ENGINE // this._appliedOperations = [];
  233. // @if CK_DEBUG_ENGINE //}
  234. // @if CK_DEBUG_ENGINE //this._appliedOperations.push( operation );
  235. operation._execute();
  236. }
  237. // @if CK_DEBUG_ENGINE // getAppliedOperation() {
  238. // @if CK_DEBUG_ENGINE // if ( !this._appliedOperations ) {
  239. // @if CK_DEBUG_ENGINE // return '';
  240. // @if CK_DEBUG_ENGINE // }
  241. // @if CK_DEBUG_ENGINE // return this._appliedOperations.map( JSON.stringify ).join( '-------' );
  242. // @if CK_DEBUG_ENGINE // }
  243. // @if CK_DEBUG_ENGINE // createReplayer( stringifiedOperations ) {
  244. // @if CK_DEBUG_ENGINE // return new OperationReplayer( this, '-------', stringifiedOperations );
  245. // @if CK_DEBUG_ENGINE // }
  246. /**
  247. * Inserts content at the position in the editor specified by the selection, as one would expect the paste
  248. * functionality to work.
  249. *
  250. * This is a high-level method. It takes the {@link #schema schema} into consideration when inserting
  251. * the content, clears the given selection's content before inserting nodes and moves the selection
  252. * to its target position at the end of the process.
  253. * It can split elements, merge them, wrap bare text nodes with paragraphs, etc. &mdash; just like the
  254. * pasting feature should do.
  255. *
  256. * For lower-level methods see {@link module:engine/model/writer~Writer `Writer`}.
  257. *
  258. * This method, unlike {@link module:engine/model/writer~Writer `Writer`}'s methods, does not have to be used
  259. * inside a {@link #change `change()` block}.
  260. *
  261. * # Conversion and schema
  262. *
  263. * Inserting elements and text nodes into the model is not enough to make CKEditor 5 render that content
  264. * to the user. CKEditor 5 implements a model-view-controller architecture and what `model.insertContent()` does
  265. * is only adding nodes to the model. Additionally, you need to define
  266. * {@glink framework/guides/architecture/editing-engine#conversion converters} between the model and view
  267. * and define those nodes in the {@glink framework/guides/architecture/editing-engine#schema schema}.
  268. *
  269. * So, while this method may seem similar to CKEditor 4 `editor.insertHtml()` (in fact, both methods
  270. * are used for paste-like content insertion), the CKEditor 5 method cannot be use to insert arbitrary HTML
  271. * unless converters are defined for all elements and attributes in that HTML.
  272. *
  273. * # Examples
  274. *
  275. * Using `insertContent()` with a manually created model structure:
  276. *
  277. * // Let's create a document fragment containing such content as:
  278. * //
  279. * // <paragraph>foo</paragraph>
  280. * // <blockQuote>
  281. * // <paragraph>bar</paragraph>
  282. * // </blockQuote>
  283. * const docFrag = editor.model.change( writer => {
  284. * const p1 = writer.createElement( 'paragraph' );
  285. * const p2 = writer.createElement( 'paragraph' );
  286. * const blockQuote = writer.createElement( 'blockQuote' );
  287. * const docFrag = writer.createDocumentFragment();
  288. *
  289. * writer.append( p1, docFrag );
  290. * writer.append( blockQuote, docFrag );
  291. * writer.append( p2, blockQuote );
  292. * writer.insertText( 'foo', p1 );
  293. * writer.insertText( 'bar', p2 );
  294. *
  295. * return docFrag;
  296. * } );
  297. *
  298. * // insertContent() does not have to be used in a change() block. It can, though,
  299. * // so this code could be moved to the callback defined above.
  300. * editor.model.insertContent( docFrag );
  301. *
  302. * Using `insertContent()` with an HTML string converted to a model document fragment (similar to the pasting mechanism):
  303. *
  304. * // You can create your own HtmlDataProcessor instance or use editor.data.processor
  305. * // if you have not overridden the default one (which is the HtmlDataProcessor instance).
  306. * const htmlDP = new HtmlDataProcessor();
  307. *
  308. * // Convert an HTML string to a view document fragment:
  309. * const viewFragment = htmlDP.toView( htmlString );
  310. *
  311. * // Convert the view document fragment to a model document fragment
  312. * // in the context of $root. This conversion takes the schema into
  313. * // account so if, for example, the view document fragment contained a bare text node,
  314. * // this text node cannot be a child of $root, so it will be automatically
  315. * // wrapped with a <paragraph>. You can define the context yourself (in the second parameter),
  316. * // and e.g. convert the content like it would happen in a <paragraph>.
  317. * // Note: The clipboard feature uses a custom context called $clipboardHolder
  318. * // which has a loosened schema.
  319. * const modelFragment = editor.data.toModel( viewFragment );
  320. *
  321. * editor.model.insertContent( modelFragment );
  322. *
  323. * By default this method will use the document selection but it can also be used with a position, range or selection instance.
  324. *
  325. * // Insert text at the current document selection position.
  326. * editor.model.change( writer => {
  327. * editor.model.insertContent( writer.createText( 'x' ) );
  328. * } );
  329. *
  330. * // Insert text at a given position - the document selection will not be modified.
  331. * editor.model.change( writer => {
  332. * editor.model.insertContent( writer.createText( 'x' ), doc.getRoot(), 2 );
  333. *
  334. * // Which is a shorthand for:
  335. * editor.model.insertContent( writer.createText( 'x' ), writer.createPositionAt( doc.getRoot(), 2 ) );
  336. * } );
  337. *
  338. * If an instance of {@link module:engine/model/selection~Selection} is passed as `selectable`
  339. * it will be moved to the target position (where the document selection should be moved after the insertion).
  340. *
  341. * editor.model.change( writer => {
  342. * // Insert text replacing the given selection instance.
  343. * const selection = writer.createSelection( paragraph, 'in' );
  344. *
  345. * editor.model.insertContent( writer.createText( 'x' ), selection );
  346. *
  347. * // insertContent() modifies the passed selection instance so it can be used to set the document selection.
  348. * // Note: This is not necessary when you passed the document selection to insertContent().
  349. * writer.setSelection( selection );
  350. * } );
  351. *
  352. * @fires insertContent
  353. * @param {module:engine/model/documentfragment~DocumentFragment|module:engine/model/item~Item} content The content to insert.
  354. * @param {module:engine/model/selection~Selectable} [selectable=model.document.selection]
  355. * The selection into which the content should be inserted. If not provided the current model document selection will be used.
  356. * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] To be used when a model item was passed as `selectable`.
  357. * This param defines a position in relation to that item.
  358. * @returns {module:engine/model/range~Range} Range which contains all the performed changes. This is a range that, if removed,
  359. * would return the model to the state before the insertion. If no changes were preformed by `insertContent`, returns a range collapsed
  360. * at the insertion position.
  361. */
  362. insertContent( content, selectable, placeOrOffset ) {
  363. return insertContent( this, content, selectable, placeOrOffset );
  364. }
  365. /**
  366. * Deletes content of the selection and merge siblings. The resulting selection is always collapsed.
  367. *
  368. * **Note:** For the sake of predictability, the resulting selection should always be collapsed.
  369. * In cases where a feature wants to modify deleting behavior so selection isn't collapsed
  370. * (e.g. a table feature may want to keep row selection after pressing <kbd>Backspace</kbd>),
  371. * then that behavior should be implemented in the view's listener. At the same time, the table feature
  372. * will need to modify this method's behavior too, e.g. to "delete contents and then collapse
  373. * the selection inside the last selected cell" or "delete the row and collapse selection somewhere near".
  374. * That needs to be done in order to ensure that other features which use `deleteContent()` will work well with tables.
  375. *
  376. * @fires deleteContent
  377. * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection} selection
  378. * Selection of which the content should be deleted.
  379. * @param {Object} [options]
  380. * @param {Boolean} [options.leaveUnmerged=false] Whether to merge elements after removing the content of the selection.
  381. *
  382. * For example `<heading1>x[x</heading1><paragraph>y]y</paragraph>` will become:
  383. *
  384. * * `<heading1>x^y</heading1>` with the option disabled (`leaveUnmerged == false`)
  385. * * `<heading1>x^</heading1><paragraph>y</paragraph>` with enabled (`leaveUnmerged == true`).
  386. *
  387. * Note: {@link module:engine/model/schema~Schema#isObject object} and {@link module:engine/model/schema~Schema#isLimit limit}
  388. * elements will not be merged.
  389. *
  390. * @param {Boolean} [options.doNotResetEntireContent=false] Whether to skip replacing the entire content with a
  391. * paragraph when the entire content was selected.
  392. *
  393. * For example `<heading1>[x</heading1><paragraph>y]</paragraph>` will become:
  394. *
  395. * * `<paragraph>^</paragraph>` with the option disabled (`doNotResetEntireContent == false`)
  396. * * `<heading1>^</heading1>` with enabled (`doNotResetEntireContent == true`)
  397. *
  398. * @param {Boolean} [options.doNotAutoparagraph=false] Whether to create a paragraph if after content deletion selection is moved
  399. * to a place where text cannot be inserted.
  400. *
  401. * For example `<paragraph>x</paragraph>[<image src="foo.jpg"></image>]` will become:
  402. *
  403. * * `<paragraph>x</paragraph><paragraph>[]</paragraph>` with the option disabled (`doNotAutoparagraph == false`)
  404. * * `<paragraph>x[]</paragraph>` with the option enabled (`doNotAutoparagraph == true`).
  405. *
  406. * **Note:** if there is no valid position for the selection, the paragraph will always be created:
  407. *
  408. * `[<image src="foo.jpg"></image>]` -> `<paragraph>[]</paragraph>`.
  409. */
  410. deleteContent( selection, options ) {
  411. deleteContent( this, selection, options );
  412. }
  413. /**
  414. * Modifies the selection. Currently, the supported modifications are:
  415. *
  416. * * Extending. The selection focus is moved in the specified `options.direction` with a step specified in `options.unit`.
  417. * Possible values for `unit` are:
  418. * * `'character'` (default) - moves selection by one user-perceived character. In most cases this means moving by one
  419. * character in `String` sense. However, unicode also defines "combing marks". These are special symbols, that combines
  420. * with a symbol before it ("base character") to create one user-perceived character. For example, `q̣̇` is a normal
  421. * letter `q` with two "combining marks": upper dot (`Ux0307`) and lower dot (`Ux0323`). For most actions, i.e. extending
  422. * selection by one position, it is correct to include both "base character" and all of it's "combining marks". That is
  423. * why `'character'` value is most natural and common method of modifying selection.
  424. * * `'codePoint'` - moves selection by one unicode code point. In contrary to, `'character'` unit, this will insert
  425. * selection between "base character" and "combining mark", because "combining marks" have their own unicode code points.
  426. * However, for technical reasons, unicode code points with values above `UxFFFF` are represented in native `String` by
  427. * two characters, called "surrogate pairs". Halves of "surrogate pairs" have a meaning only when placed next to each other.
  428. * For example `𨭎` is represented in `String` by `\uD862\uDF4E`. Both `\uD862` and `\uDF4E` do not have any meaning
  429. * outside the pair (are rendered as ? when alone). Position between them would be incorrect. In this case, selection
  430. * extension will include whole "surrogate pair".
  431. * * `'word'` - moves selection by a whole word.
  432. *
  433. * **Note:** if you extend a forward selection in a backward direction you will in fact shrink it.
  434. *
  435. * @fires modifySelection
  436. * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection} selection
  437. * The selection to modify.
  438. * @param {Object} [options]
  439. * @param {'forward'|'backward'} [options.direction='forward'] The direction in which the selection should be modified.
  440. * @param {'character'|'codePoint'|'word'} [options.unit='character'] The unit by which selection should be modified.
  441. */
  442. modifySelection( selection, options ) {
  443. modifySelection( this, selection, options );
  444. }
  445. /**
  446. * Gets a clone of the selected content.
  447. *
  448. * For example, for the following selection:
  449. *
  450. * ```html
  451. * <paragraph>x</paragraph>
  452. * <blockQuote>
  453. * <paragraph>y</paragraph>
  454. * <heading1>fir[st</heading1>
  455. * </blockQuote>
  456. * <paragraph>se]cond</paragraph>
  457. * <paragraph>z</paragraph>
  458. * ```
  459. *
  460. * It will return a document fragment with such a content:
  461. *
  462. * ```html
  463. * <blockQuote>
  464. * <heading1>st</heading1>
  465. * </blockQuote>
  466. * <paragraph>se</paragraph>
  467. * ```
  468. *
  469. * @fires getSelectedContent
  470. * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection} selection
  471. * The selection of which content will be returned.
  472. * @returns {module:engine/model/documentfragment~DocumentFragment}
  473. */
  474. getSelectedContent( selection ) {
  475. return getSelectedContent( this, selection );
  476. }
  477. /**
  478. * Checks whether the given {@link module:engine/model/range~Range range} or
  479. * {@link module:engine/model/element~Element element} has any meaningful content.
  480. *
  481. * Meaningful content is:
  482. *
  483. * * any text node (`options.ignoreWhitespaces` allows controlling whether this text node must also contain
  484. * any non-whitespace characters),
  485. * * or any {@link module:engine/model/schema~Schema#isObject object element},
  486. * * or any {@link module:engine/model/markercollection~Marker marker} which
  487. * {@link module:engine/model/markercollection~Marker#_affectsData affects data}.
  488. *
  489. * This means that a range containing an empty `<paragraph></paragraph>` is not considered to have a meaningful content.
  490. * However, a range containing an `<image></image>` (which would normally be marked in the schema as an object element)
  491. * is considered non-empty.
  492. *
  493. * @param {module:engine/model/range~Range|module:engine/model/element~Element} rangeOrElement Range or element to check.
  494. * @param {Object} [options]
  495. * @param {Boolean} [options.ignoreWhitespaces] Whether text node with whitespaces only should be considered empty.
  496. * @returns {Boolean}
  497. */
  498. hasContent( rangeOrElement, options ) {
  499. const range = rangeOrElement instanceof ModelElement ? ModelRange._createIn( rangeOrElement ) : rangeOrElement;
  500. if ( range.isCollapsed ) {
  501. return false;
  502. }
  503. // Check if there are any markers which affects data in this given range.
  504. for ( const intersectingMarker of this.markers.getMarkersIntersectingRange( range ) ) {
  505. if ( intersectingMarker.affectsData ) {
  506. return true;
  507. }
  508. }
  509. const { ignoreWhitespaces = false } = options || {};
  510. for ( const item of range.getItems() ) {
  511. if ( item.is( 'textProxy' ) ) {
  512. if ( !ignoreWhitespaces ) {
  513. return true;
  514. } else if ( item.data.search( /\S/ ) !== -1 ) {
  515. return true;
  516. }
  517. } else if ( this.schema.isObject( item ) ) {
  518. return true;
  519. }
  520. }
  521. return false;
  522. }
  523. /**
  524. * Creates a position from the given root and path in that root.
  525. *
  526. * Note: This method is also available as
  527. * {@link module:engine/model/writer~Writer#createPositionFromPath `Writer#createPositionFromPath()`}.
  528. *
  529. * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} root Root of the position.
  530. * @param {Array.<Number>} path Position path. See {@link module:engine/model/position~Position#path}.
  531. * @param {module:engine/model/position~PositionStickiness} [stickiness='toNone'] Position stickiness.
  532. * See {@link module:engine/model/position~PositionStickiness}.
  533. * @returns {module:engine/model/position~Position}
  534. */
  535. createPositionFromPath( root, path, stickiness ) {
  536. return new ModelPosition( root, path, stickiness );
  537. }
  538. /**
  539. * Creates position at the given location. The location can be specified as:
  540. *
  541. * * a {@link module:engine/model/position~Position position},
  542. * * a parent element and offset in that element,
  543. * * a parent element and `'end'` (the position will be set at the end of that element),
  544. * * a {@link module:engine/model/item~Item model item} and `'before'` or `'after'`
  545. * (the position will be set before or after the given model item).
  546. *
  547. * This method is a shortcut to other factory methods such as:
  548. *
  549. * * {@link module:engine/model/model~Model#createPositionBefore `createPositionBefore()`},
  550. * * {@link module:engine/model/model~Model#createPositionAfter `createPositionAfter()`}.
  551. *
  552. * Note: This method is also available as
  553. * {@link module:engine/model/writer~Writer#createPositionAt `Writer#createPositionAt()`},
  554. *
  555. * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
  556. * @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
  557. * first parameter is a {@link module:engine/model/item~Item model item}.
  558. */
  559. createPositionAt( itemOrPosition, offset ) {
  560. return ModelPosition._createAt( itemOrPosition, offset );
  561. }
  562. /**
  563. * Creates a new position after the given {@link module:engine/model/item~Item model item}.
  564. *
  565. * Note: This method is also available as
  566. * {@link module:engine/model/writer~Writer#createPositionAfter `Writer#createPositionAfter()`}.
  567. *
  568. * @param {module:engine/model/item~Item} item Item after which the position should be placed.
  569. * @returns {module:engine/model/position~Position}
  570. */
  571. createPositionAfter( item ) {
  572. return ModelPosition._createAfter( item );
  573. }
  574. /**
  575. * Creates a new position before the given {@link module:engine/model/item~Item model item}.
  576. *
  577. * Note: This method is also available as
  578. * {@link module:engine/model/writer~Writer#createPositionBefore `Writer#createPositionBefore()`}.
  579. *
  580. * @param {module:engine/model/item~Item} item Item before which the position should be placed.
  581. * @returns {module:engine/model/position~Position}
  582. */
  583. createPositionBefore( item ) {
  584. return ModelPosition._createBefore( item );
  585. }
  586. /**
  587. * Creates a range spanning from the `start` position to the `end` position.
  588. *
  589. * Note: This method is also available as
  590. * {@link module:engine/model/writer~Writer#createRange `Writer#createRange()`}:
  591. *
  592. * model.change( writer => {
  593. * const range = writer.createRange( start, end );
  594. * } );
  595. *
  596. * @param {module:engine/model/position~Position} start Start position.
  597. * @param {module:engine/model/position~Position} [end] End position. If not set, the range will be collapsed
  598. * to the `start` position.
  599. * @returns {module:engine/model/range~Range}
  600. */
  601. createRange( start, end ) {
  602. return new ModelRange( start, end );
  603. }
  604. /**
  605. * Creates a range inside the given element which starts before the first child of
  606. * that element and ends after the last child of that element.
  607. *
  608. * Note: This method is also available as
  609. * {@link module:engine/model/writer~Writer#createRangeIn `Writer#createRangeIn()`}:
  610. *
  611. * model.change( writer => {
  612. * const range = writer.createRangeIn( paragraph );
  613. * } );
  614. *
  615. * @param {module:engine/model/element~Element} element Element which is a parent for the range.
  616. * @returns {module:engine/model/range~Range}
  617. */
  618. createRangeIn( element ) {
  619. return ModelRange._createIn( element );
  620. }
  621. /**
  622. * Creates a range that starts before the given {@link module:engine/model/item~Item model item} and ends after it.
  623. *
  624. * Note: This method is also available on `writer` instance as
  625. * {@link module:engine/model/writer~Writer#createRangeOn `Writer.createRangeOn()`}:
  626. *
  627. * model.change( writer => {
  628. * const range = writer.createRangeOn( paragraph );
  629. * } );
  630. *
  631. * @param {module:engine/model/item~Item} item
  632. * @returns {module:engine/model/range~Range}
  633. */
  634. createRangeOn( item ) {
  635. return ModelRange._createOn( item );
  636. }
  637. /**
  638. * Creates a new selection instance based on the given {@link module:engine/model/selection~Selectable selectable}
  639. * or creates an empty selection if no arguments were passed.
  640. *
  641. * Note: This method is also available as
  642. * {@link module:engine/model/writer~Writer#createSelection `Writer#createSelection()`}.
  643. *
  644. * // Creates empty selection without ranges.
  645. * const selection = writer.createSelection();
  646. *
  647. * // Creates selection at the given range.
  648. * const range = writer.createRange( start, end );
  649. * const selection = writer.createSelection( range );
  650. *
  651. * // Creates selection at the given ranges
  652. * const ranges = [ writer.createRange( start1, end2 ), writer.createRange( star2, end2 ) ];
  653. * const selection = writer.createSelection( ranges );
  654. *
  655. * // Creates selection from the other selection.
  656. * // Note: It doesn't copies selection attributes.
  657. * const otherSelection = writer.createSelection();
  658. * const selection = writer.createSelection( otherSelection );
  659. *
  660. * // Creates selection from the given document selection.
  661. * // Note: It doesn't copies selection attributes.
  662. * const documentSelection = model.document.selection;
  663. * const selection = writer.createSelection( documentSelection );
  664. *
  665. * // Creates selection at the given position.
  666. * const position = writer.createPositionFromPath( root, path );
  667. * const selection = writer.createSelection( position );
  668. *
  669. * // Creates selection at the given offset in the given element.
  670. * const paragraph = writer.createElement( 'paragraph' );
  671. * const selection = writer.createSelection( paragraph, offset );
  672. *
  673. * // Creates a range inside an {@link module:engine/model/element~Element element} which starts before the
  674. * // first child of that element and ends after the last child of that element.
  675. * const selection = writer.createSelection( paragraph, 'in' );
  676. *
  677. * // Creates a range on an {@link module:engine/model/item~Item item} which starts before the item and ends
  678. * // just after the item.
  679. * const selection = writer.createSelection( paragraph, 'on' );
  680. *
  681. * // Additional options (`'backward'`) can be specified as the last argument.
  682. *
  683. * // Creates backward selection.
  684. * const selection = writer.createSelection( range, { backward: true } );
  685. *
  686. * @param {module:engine/model/selection~Selectable} selectable
  687. * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection.
  688. * @param {Object} [options]
  689. * @param {Boolean} [options.backward] Sets this selection instance to be backward.
  690. * @returns {module:engine/model/selection~Selection}
  691. */
  692. createSelection( selectable, placeOrOffset, options ) {
  693. return new ModelSelection( selectable, placeOrOffset, options );
  694. }
  695. /**
  696. * Creates a {@link module:engine/model/batch~Batch} instance.
  697. *
  698. * **Note:** In most cases creating a batch instance is not necessary as they are created when using:
  699. *
  700. * * {@link #change `change()`},
  701. * * {@link #enqueueChange `enqueueChange()`}.
  702. *
  703. * @param {'transparent'|'default'} [type='default'] The type of the batch.
  704. * @returns {module:engine/model/batch~Batch}
  705. */
  706. createBatch( type ) {
  707. return new Batch( type );
  708. }
  709. /**
  710. * Creates an `Operation` instance from a JSON object with the operation data (e.g. taken from a parsed JSON string).
  711. *
  712. * This is an alias for {@link module:engine/model/operation/operationfactory~OperationFactory#fromJSON}.
  713. *
  714. * @param {Object} json Deserialized JSON object.
  715. * @returns {module:engine/model/operation/operation~Operation}
  716. */
  717. createOperationFromJSON( json ) {
  718. return OperationFactory.fromJSON( json, this.document );
  719. }
  720. /**
  721. * Removes all events listeners set by model instance and destroys {@link module:engine/model/document~Document}.
  722. */
  723. destroy() {
  724. this.document.destroy();
  725. this.stopListening();
  726. }
  727. /**
  728. * Common part of {@link module:engine/model/model~Model#change} and {@link module:engine/model/model~Model#enqueueChange}
  729. * which calls callbacks and returns array of values returned by these callbacks.
  730. *
  731. * @private
  732. * @returns {Array.<*>} Array of values returned by callbacks.
  733. */
  734. _runPendingChanges() {
  735. const ret = [];
  736. this.fire( '_beforeChanges' );
  737. while ( this._pendingChanges.length ) {
  738. // Create a new writer using batch instance created for this chain of changes.
  739. const currentBatch = this._pendingChanges[ 0 ].batch;
  740. this._currentWriter = new Writer( this, currentBatch );
  741. // Execute changes callback and gather the returned value.
  742. const callbackReturnValue = this._pendingChanges[ 0 ].callback( this._currentWriter );
  743. ret.push( callbackReturnValue );
  744. this.document._handleChangeBlock( this._currentWriter );
  745. this._pendingChanges.shift();
  746. this._currentWriter = null;
  747. }
  748. this.fire( '_afterChanges' );
  749. return ret;
  750. }
  751. /**
  752. * Fired when entering the outermost {@link module:engine/model/model~Model#enqueueChange} or
  753. * {@link module:engine/model/model~Model#change} block.
  754. *
  755. * @protected
  756. * @event _beforeChanges
  757. */
  758. /**
  759. * Fired when leaving the outermost {@link module:engine/model/model~Model#enqueueChange} or
  760. * {@link module:engine/model/model~Model#change} block.
  761. *
  762. * @protected
  763. * @event _afterChanges
  764. */
  765. /**
  766. * Fired every time any {@link module:engine/model/operation/operation~Operation operation} is applied on the model
  767. * using {@link #applyOperation}.
  768. *
  769. * Note that this event is suitable only for very specific use-cases. Use it if you need to listen to every single operation
  770. * applied on the document. However, in most cases {@link module:engine/model/document~Document#event:change} should
  771. * be used.
  772. *
  773. * A few callbacks are already added to this event by engine internal classes:
  774. *
  775. * * with `highest` priority operation is validated,
  776. * * with `normal` priority operation is executed,
  777. * * with `low` priority the {@link module:engine/model/document~Document} updates its version,
  778. * * with `low` priority {@link module:engine/model/liveposition~LivePosition} and {@link module:engine/model/liverange~LiveRange}
  779. * update themselves.
  780. *
  781. * @event applyOperation
  782. * @param {Array} args Arguments of the `applyOperation` which is an array with a single element - applied
  783. * {@link module:engine/model/operation/operation~Operation operation}.
  784. */
  785. /**
  786. * Event fired when {@link #insertContent} method is called.
  787. *
  788. * The {@link #insertContent default action of that method} is implemented as a
  789. * listener to this event so it can be fully customized by the features.
  790. *
  791. * **Note** The `selectable` parameter for the {@link #insertContent} is optional. When `undefined` value is passed the method uses
  792. * `model.document.selection`.
  793. *
  794. * @event insertContent
  795. * @param {Array} args The arguments passed to the original method.
  796. */
  797. /**
  798. * Event fired when {@link #deleteContent} method is called.
  799. *
  800. * The {@link #deleteContent default action of that method} is implemented as a
  801. * listener to this event so it can be fully customized by the features.
  802. *
  803. * @event deleteContent
  804. * @param {Array} args The arguments passed to the original method.
  805. */
  806. /**
  807. * Event fired when {@link #modifySelection} method is called.
  808. *
  809. * The {@link #modifySelection default action of that method} is implemented as a
  810. * listener to this event so it can be fully customized by the features.
  811. *
  812. * @event modifySelection
  813. * @param {Array} args The arguments passed to the original method.
  814. */
  815. /**
  816. * Event fired when {@link #getSelectedContent} method is called.
  817. *
  818. * The {@link #getSelectedContent default action of that method} is implemented as a
  819. * listener to this event so it can be fully customized by the features.
  820. *
  821. * @event getSelectedContent
  822. * @param {Array} args The arguments passed to the original method.
  823. */
  824. }
  825. mix( Model, ObservableMixin );