model.js 34 KB

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