T/1172-b Conversion refactor #1206

scofalik · 2017-12-15T09:29:03Z

Suggested merge commit message (convention)

Other: Conversion refactoring. Introduced model.Differ. Changes now will be converted after all changes in a change block are done. Closes ckeditor/ckeditor5#4202.

…n)wrapping and merging.

…alidate()` method.

… `DocumentFragment` (in model and view).

…on()`. Changed: `conversion.Mapper` will not unbind elements that got rebound to other elements.

…del.Differ`.

…red `conversion.ModelConversionDispatcher`.

pjasiun · 2017-12-15T09:33:50Z

src/conversion/mapper.js

@@ -368,7 +379,7 @@ export default class Mapper {
 	 *		We are in the text node so we can simple find the offset.
 	 *		<p>fo<b>ba|r</b>bom</p> -> expected offset: 2, actual offset: 2 -> position found
 	 *
-	 * @private
+	 * @protected


It should be still private.

pjasiun · 2017-12-15T09:35:29Z

src/conversion/mapper.js

 	 * @returns {module:engine/view/position~Position} Corresponding view position.
 	 */
-	toViewPosition( modelPosition ) {
+	toViewPosition( modelPosition, isPhantom = false ) {


Instead of isPhantom -> options.isPhantom.

pjasiun · 2017-12-15T09:36:20Z

src/conversion/model-to-view-converters.js

+		const viewStart = conversionApi.mapper.toViewPosition( data.position );
+
+		const modelEnd = data.position.getShiftedBy( data.length );
+		const viewEnd = conversionApi.mapper.toViewPosition( modelEnd, true );


const viewEnd = conversionApi.mapper.toViewPosition( modelEnd, { isPhantom: true } ); would be more readable.

pjasiun · 2017-12-15T09:42:34Z

src/conversion/model-to-view-converters.js

-
-		// If marker's range is not collapsed - consume all items inside.
-		for ( const value of markerRange ) {
-			if ( !consumable.consume( value.item, eventName ) ) {


Why consume is removed?

For some time there were no consumables and I forgot to bring back this part of code.

pjasiun · 2017-12-15T09:54:05Z

src/conversion/modelconversiondispatcher.js

+				this.convertInsert( Range.createFromPositionAndShift( entry.position, entry.length ) );
+			} else if ( entry.type == 'remove' ) {
+				this.convertRemove( entry.position, entry.length, entry.name );
+			} else {


Comment missing.

pjasiun · 2017-12-15T10:23:30Z

src/model/differ.js

+		// Check all changed elements.
+		for ( const element of this._changesInElement.keys() ) {
+			// If the element is inside other changed element, skip changes in this element.
+			if ( this._isInsertedOrRemoved( element ) ) {


Add comment that it's all about children.

pjasiun · 2017-12-15T10:24:15Z

src/model/differ.js

+			const changes = this._changesInElement.get( element ).sort( ( a, b ) => {
+				if ( a.offset === b.offset ) {
+					if ( a.type != b.type ) {
+						return a.type == 'remove' ? -1 : 1;


Comment needed.

pjasiun · 2017-12-15T10:26:53Z

src/model/differ.js

+
+	for ( const change of changes ) {
+		if ( change.offset > offset ) {
+			actions.push( ...'e'.repeat( change.offset - offset ).split( '' ) );


Comment "fill holes between end of one change and beginning of another with 'e'".

pjasiun · 2017-12-15T10:29:03Z

src/model/differ.js

+// - 'e' for 'equal' - when item at that position did not change,
+// - 'i' for 'insert' - when item at that position was inserted,
+// - 'r' for 'remove' - when item at that position was removed,
+// - 'a' for 'attribute' - when item at that position has it attributes changed.


A single sample would be great.

pjasiun · 2017-12-15T10:33:21Z

src/model/differ.js

+				// Add diff item.
+				diffs.push( {
+					type: 'attribute',
+					position: range.start,


It's strange that I get both position and range.

position is useful for further sorting (as other changes has position too), but I will remove it from the final results. BTW. attribute change item also has length which is not used at all - I will remove it.

It appears that I was wrong, both length and position are used in further processing but also both are not really needed later so they can be removed before changes are returned by getChanges()

pjasiun · 2017-12-15T11:44:12Z

src/model/differ.js

+					old.howMany = inc.offset - old.offset;
+
+					// Unshift to prevent further processing of this change.
+					changes.unshift( { type: 'attribute', offset: incEnd, howMany: howMany - old.howMany, count: this._changeCount++ } );


Comment why you add change in the first place is needed.

And since you unshift because you know that this function is called in the loop, the loop should be moved inside the function.

pjasiun · 2017-12-15T11:48:49Z

src/model/differ.js

+						const howManyAfter = howMany - old.howMany - inc.howMany;
+
+						// Unshift to prevent further processing of this change.
+						changes.unshift( { type: 'attribute', offset: inc.offset, howMany: howManyAfter, count: this._changeCount++ } );


pjasiun · 2017-12-15T11:49:27Z

src/model/differ.js

+						const changeItem = { type: 'attribute', offset: oldEnd, howMany: incEnd - oldEnd, count: this._changeCount++ };
+
+						for ( const oldChange of changes ) {
+							this._handleChange( changeItem, oldChange, changes );


pjasiun · 2017-12-15T13:55:21Z

src/model/differ.js

+	}
+
+	/**
+	 * Calculates diff between old model tree state (before all the buffered operations) and the new model tree state


(before all the buffered operations) -> (since the last {@link #reset})?

pjasiun · 2017-12-15T14:15:37Z

src/conversion/mapper.js

+	 *				return;
+	 *			}
+	 *
+	 *			const sibling = modelPosition.nodeBefore; // Might crash for phantom position that does not exist in model.


modelPosition.nodeBefore -> data.modelPosition.nodeBefore?

pjasiun · 2017-12-15T14:42:10Z

src/conversion/model-to-view-converters.js

 		}
 	};
 }

 /**
- * Function factory, creates a default model-to-view converter for removing {@link module:engine/view/uielement~UIElement ui element}
- * basing on marker remove change.
+ * Function factory, creates a converter that converts model marker add/change/remove to the view.


Add, change?

pjasiun · 2017-12-15T15:06:12Z

src/conversion/modelconversiondispatcher.js

 *			evt.stop();
 *		} );
 *
- * Callback that "overrides" other callback:
+ * Callback that overrides other callback:


I would remove this sample, it is too complicated, after reading it I understand less than before. Instead you could add a regular convresion for attribute->wrap (like bold).

scofalik added 11 commits December 14, 2017 17:28

Changed: view.Writer to better handle attribute elements partial (u…

a04605a

…n)wrapping and merging.

Added: Extracted operation validation from _execute() method to `_v…

eb37501

…alidate()` method.

Changed: view.TreeWalker should always return view.TextProxy.

6779e01

Added: view.TextProxy#offsetSize property.

aba9f63

Tests: Changed marker's background color to make the test more useful.

af329a9

Added: Support for inserting TextProxy instances into Element and…

5e93280

… `DocumentFragment` (in model and view).

Added: Introduced model.Differ.

bdd10cb

Added: Added isPhantom parameter to `conversion.Mapper#toViewPositi…

6f8df3b

…on()`. Changed: `conversion.Mapper` will not unbind elements that got rebound to other elements.

Changed: Refactored conversion.ModelConversionDispatcher to use `mo…

8730039

…del.Differ`.

Changed: Minor changes in model.Document.

2f4759c

Changed: Aligned code to correctly use new model.Differ and refacto…

846519d

…red `conversion.ModelConversionDispatcher`.

pjasiun reviewed Dec 15, 2017

View reviewed changes

scofalik force-pushed the t/1172-b branch 2 times, most recently from c51ce54 to 57d8e04 Compare December 15, 2017 15:37

Changed: Minor changes in code and many clarification comments.

57d8e04

pjasiun merged commit 6479bfd into master Dec 15, 2017

pjasiun deleted the t/1172-b branch December 15, 2017 16:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

T/1172-b Conversion refactor #1206

T/1172-b Conversion refactor #1206

scofalik commented Dec 15, 2017 •

edited by pomek

Loading

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

scofalik Dec 15, 2017

pjasiun Dec 15, 2017 •

edited

Loading

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

scofalik Dec 15, 2017

scofalik Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

pjasiun Dec 15, 2017

T/1172-b Conversion refactor #1206

T/1172-b Conversion refactor #1206

Conversation

scofalik commented Dec 15, 2017 • edited by pomek Loading

Suggested merge commit message (convention)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pjasiun Dec 15, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scofalik commented Dec 15, 2017 •

edited by pomek

Loading

pjasiun Dec 15, 2017 •

edited

Loading