yonote/yjs
14
0
Fork 0
Code Pull Requests 1 Releases Activity

Items accept origins as IDs

Browse Source
This commit is contained in:
Kevin Jahns
2019-04-05 19:46:18 +02:00
parent 8a7416ad50
commit 7d0c048708
18 changed files with 212 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
src/structs/AbstractItem.js
View File

@@ -12,7 +12,7 @@ import {
addToDeleteSet,
ItemDeleted,
findRootTypeKey,
ID, AbstractType, Y, Transaction // eslint-disable-line
StructStore, ID, AbstractType, Y, Transaction // eslint-disable-line
} from '../internals.js'
import * as error from 'lib0/error.js'
@@ -24,16 +24,23 @@ import * as binary from 'lib0/binary.js'
/**
* Split leftItem into two items
* @param {Transaction} transaction
* @param {StructStore} store
* @param {AbstractItem} leftItem
* @param {number} diff
* @return {AbstractItem}
*/
export const splitItem = (transaction, leftItem, diff) => {
export const splitItem = (store, leftItem, diff) => {
const id = leftItem.id
// create rightItem
const rightItem = leftItem.copy(createID(id.client, id.clock + diff), leftItem, leftItem.rightOrigin, leftItem.parent, leftItem.parentSub)
rightItem.right = leftItem.right
const rightItem = leftItem.copy(
createID(id.client, id.clock + diff),
leftItem,
leftItem.lastId,
leftItem.right,
leftItem.rightOrigin,
leftItem.parent,
leftItem.parentSub
)
if (leftItem.deleted) {
rightItem.deleted = true
}
@@ -43,20 +50,7 @@ export const splitItem = (transaction, leftItem, diff) => {
if (rightItem.right !== null) {
rightItem.right.left = rightItem
}
// update all origins to the right
// search all relevant items to the right and update origin
// if origin is not it foundOrigins, we don't have to search any longer
const foundOrigins = new Set()
foundOrigins.add(leftItem)
let o = rightItem.right
while (o !== null && foundOrigins.has(o.origin)) {
if (o.origin === leftItem) {
o.origin = rightItem
}
foundOrigins.add(o)
o = o.right
}
return leftItem.splitAt(transaction, diff)
return rightItem
}
/**
@@ -66,11 +60,13 @@ export class AbstractItem extends AbstractStruct {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any> | null} parent
* @param {string | null} parentSub
*/
constructor (id, left, right, parent, parentSub) {
constructor (id, left, origin, right, rightOrigin, parent, parentSub) {
if (left !== null) {
parent = left.parent
parentSub = left.parentSub
@@ -83,10 +79,10 @@ export class AbstractItem extends AbstractStruct {
super(id)
/**
* The item that was originally to the left of this item.
* @type {AbstractItem | null}
* @type {ID | null}
* @readonly
*/
this.origin = left
this.origin = origin
/**
* The item that is currently to the left of this item.
* @type {AbstractItem | null}
@@ -100,9 +96,9 @@ export class AbstractItem extends AbstractStruct {
/**
* The item that was originally to the right of this item.
* @readonly
* @type {AbstractItem | null}
* @type {ID | null}
*/
this.rightOrigin = right
this.rightOrigin = rightOrigin
/**
* The parent type.
* @type {AbstractType<any>}
@@ -264,13 +260,15 @@ export class AbstractItem extends AbstractStruct {
* Creates an Item with the same effect as this Item (without position effect)
*
* @param {ID} id
* @param {AbstractItem|null} left
* @param {AbstractItem|null} right
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string|null} parentSub
* @param {string | null} parentSub
* @return {AbstractItem}
*/
copy (id, left, right, parent, parentSub) {
copy (id, left, origin, right, rightOrigin, parent, parentSub) {
throw new Error('unimplemented')
}
@@ -329,7 +327,7 @@ export class AbstractItem extends AbstractStruct {
right = right._right
}
}
this.redone = this.copy(nextID(transaction), left, right, parent, this.parentSub)
this.redone = this.copy(nextID(transaction), left, left === null ? null : left.lastId, right, right === null ? null : right.id, parent, this.parentSub)
this.redone.integrate(transaction)
return true
}
@@ -374,11 +372,11 @@ export class AbstractItem extends AbstractStruct {
*
* This method should only be cally by StructStore.
*
* @param {Transaction} transaction
* @param {StructStore} store
* @param {number} diff
* @return {AbstractItem}
*/
splitAt (transaction, diff) {
splitAt (store, diff) {
throw new Error('unimplemented')
}
@@ -412,9 +410,18 @@ export class AbstractItem extends AbstractStruct {
* @return {GC|ItemDeleted}
*/
gc (y) {
const r = this.parent._item !== null && this.parent._item.deleted
? new GC(this.id, this.length)
: new ItemDeleted(this.id, this.left, this.right, this.parent, this.parentSub, this.length)
let r
if (this.parent._item !== null && this.parent._item.deleted) {
r = new GC(this.id, this.length)
} else {
r = new ItemDeleted(this.id, this.left, this.origin, this.right, this.rightOrigin, this.parent, this.parentSub, this.length)
if (r.left !== null) {
r.left.right = r
}
if (r.right !== null) {
r.right.left = r
}
}
replaceStruct(y.store, this, r)
return r
}
@@ -445,13 +452,13 @@ export class AbstractItem extends AbstractStruct {
encoding.writeUint8(encoder, info)
if (this.origin !== null) {
if (offset === 0) {
writeID(encoder, this.origin.lastId)
writeID(encoder, this.origin)
} else {
writeID(encoder, createID(this.id.client, this.id.clock + offset - 1))
}
}
if (this.rightOrigin !== null) {
writeID(encoder, this.rightOrigin.id)
writeID(encoder, this.rightOrigin)
}
if (this.origin === null && this.rightOrigin === null) {
const parent = this.parent

2
src/structs/GC.js
View File

@@ -34,6 +34,8 @@ export class GC extends AbstractStruct {
return this._len
}
delete () {}
/**
* @param {AbstractStruct} right
* @return {boolean}

18
src/structs/ItemBinary.js
View File

@@ -24,13 +24,15 @@ export class ItemBinary extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
* @param {ArrayBuffer} content
*/
constructor (id, left, right, parent, parentSub, content) {
super(id, left, right, parent, parentSub)
constructor (id, left, origin, right, rightOrigin, parent, parentSub, content) {
super(id, left, origin, right, rightOrigin, parent, parentSub)
this.content = content
}
getContent () {
@@ -39,12 +41,14 @@ export class ItemBinary extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
*/
copy (id, left, right, parent, parentSub) {
return new ItemBinary(id, left, right, parent, parentSub, this.content)
copy (id, left, origin, right, rightOrigin, parent, parentSub) {
return new ItemBinary(id, left, origin, right, rightOrigin, parent, parentSub, this.content)
}
/**
* @param {encoding.Encoder} encoder
@@ -94,8 +98,10 @@ export class ItemBinaryRef extends AbstractItemRef {
return new ItemBinary(
this.id,
this.left === null ? null : getItemCleanEnd(store, transaction, this.left),
this.right === null ? null : getItemCleanStart(store, transaction, this.right),
this.left === null ? null : getItemCleanEnd(store, this.left),
this.left,
this.right === null ? null : getItemCleanStart(store, this.right),
this.right,
parent,
this.parentSub,
this.content

21
src/structs/ItemDeleted.js
View File

@@ -12,6 +12,7 @@ import {
getItemType,
changeItemRefOffset,
GC,
compareIDs,
Transaction, ID, AbstractType // eslint-disable-line
} from '../internals.js'
@@ -24,13 +25,15 @@ export class ItemDeleted extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
* @param {number} length
*/
constructor (id, left, right, parent, parentSub, length) {
super(id, left, right, parent, parentSub)
constructor (id, left, origin, right, rightOrigin, parent, parentSub, length) {
super(id, left, origin, right, rightOrigin, parent, parentSub)
this._len = length
this.deleted = true
}
@@ -40,19 +43,21 @@ export class ItemDeleted extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
*/
copy (id, left, right, parent, parentSub) {
return new ItemDeleted(id, left, right, parent, parentSub, this.length)
copy (id, left, origin, right, rightOrigin, parent, parentSub) {
return new ItemDeleted(id, left, origin, right, rightOrigin, parent, parentSub, this.length)
}
/**
* @param {ItemDeleted} right
* @return {boolean}
*/
mergeWith (right) {
if (right.origin === this && this.right === right) {
if (compareIDs(right.origin, this.lastId) && this.right === right) {
this._len += right.length
return true
}
@@ -113,8 +118,10 @@ export class ItemDeletedRef extends AbstractItemRef {
return new ItemDeleted(
this.id,
this.left === null ? null : getItemCleanEnd(store, transaction, this.left),
this.right === null ? null : getItemCleanStart(store, transaction, this.right),
this.left === null ? null : getItemCleanEnd(store, this.left),
this.left,
this.right === null ? null : getItemCleanStart(store, this.right),
this.right,
parent,
this.parentSub,
this.len

18
src/structs/ItemEmbed.js
View File

@@ -22,24 +22,28 @@ export class ItemEmbed extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
* @param {Object} embed
*/
constructor (id, left, right, parent, parentSub, embed) {
super(id, left, right, parent, parentSub)
constructor (id, left, origin, right, rightOrigin, parent, parentSub, embed) {
super(id, left, origin, right, rightOrigin, parent, parentSub)
this.embed = embed
}
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
*/
copy (id, left, right, parent, parentSub) {
return new ItemEmbed(id, left, right, parent, parentSub, this.embed)
copy (id, left, origin, right, rightOrigin, parent, parentSub) {
return new ItemEmbed(id, left, origin, right, rightOrigin, parent, parentSub, this.embed)
}
/**
* @param {encoding.Encoder} encoder
@@ -89,8 +93,10 @@ export class ItemEmbedRef extends AbstractItemRef {
return new ItemEmbed(
this.id,
this.left === null ? null : getItemCleanEnd(store, transaction, this.left),
this.right === null ? null : getItemCleanStart(store, transaction, this.right),
this.left === null ? null : getItemCleanEnd(store, this.left),
this.left,
this.right === null ? null : getItemCleanStart(store, this.right),
this.right,
parent,
this.parentSub,
this.embed

18
src/structs/ItemFormat.js
View File

@@ -22,26 +22,30 @@ export class ItemFormat extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
* @param {string} key
* @param {any} value
*/
constructor (id, left, right, parent, parentSub, key, value) {
super(id, left, right, parent, parentSub)
constructor (id, left, origin, right, rightOrigin, parent, parentSub, key, value) {
super(id, left, origin, right, rightOrigin, parent, parentSub)
this.key = key
this.value = value
}
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
*/
copy (id, left, right, parent, parentSub) {
return new ItemFormat(id, left, right, parent, parentSub, this.key, this.value)
copy (id, left, origin, right, rightOrigin, parent, parentSub) {
return new ItemFormat(id, left, origin, right, rightOrigin, parent, parentSub, this.key, this.value)
}
get countable () {
return false
@@ -96,8 +100,10 @@ export class ItemFormatRef extends AbstractItemRef {
return new ItemFormat(
this.id,
this.left === null ? null : getItemCleanEnd(store, transaction, this.left),
this.right === null ? null : getItemCleanStart(store, transaction, this.right),
this.left === null ? null : getItemCleanEnd(store, this.left),
this.left,
this.right === null ? null : getItemCleanStart(store, this.right),
this.right,
parent,
this.parentSub,
this.key,

29
src/structs/ItemJSON.js
View File

@@ -10,9 +10,10 @@ import {
getItemType,
splitItem,
changeItemRefOffset,
compareIDs,
GC,
ItemDeleted,
Transaction, ID, AbstractType // eslint-disable-line
StructStore, Transaction, ID, AbstractType // eslint-disable-line
} from '../internals.js'
import * as encoding from 'lib0/encoding.js'
@@ -24,13 +25,15 @@ export class ItemJSON extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
* @param {Array<any>} content
*/
constructor (id, left, right, parent, parentSub, content) {
super(id, left, right, parent, parentSub)
constructor (id, left, origin, right, rightOrigin, parent, parentSub, content) {
super(id, left, origin, right, rightOrigin, parent, parentSub)
/**
* @type {Array<any>}
*/
@@ -39,12 +42,14 @@ export class ItemJSON extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
*/
copy (id, left, right, parent, parentSub) {
return new ItemJSON(id, left, right, parent, parentSub, this.content)
copy (id, left, origin, right, rightOrigin, parent, parentSub) {
return new ItemJSON(id, left, origin, right, rightOrigin, parent, parentSub, this.content)
}
get length () {
return this.content.length
@@ -53,15 +58,15 @@ export class ItemJSON extends AbstractItem {
return this.content
}
/**
* @param {Transaction} transaction
* @param {StructStore} store
* @param {number} diff
*/
splitAt (transaction, diff) {
splitAt (store, diff) {
/**
* @type {ItemJSON}
*/
// @ts-ignore
const right = splitItem(transaction, this, diff)
const right = splitItem(this, diff)
right.content = this.content.splice(diff)
return right
}
@@ -70,7 +75,7 @@ export class ItemJSON extends AbstractItem {
* @return {boolean}
*/
mergeWith (right) {
if (right.origin === this && this.right === right) {
if (compareIDs(right.origin, this.lastId) && this.right === right) {
this.content = this.content.concat(right.content)
return true
}
@@ -144,8 +149,10 @@ export class ItemJSONRef extends AbstractItemRef {
}
return new ItemJSON(
this.id,
this.left === null ? null : getItemCleanEnd(store, transaction, this.left),
this.right === null ? null : getItemCleanStart(store, transaction, this.right),
this.left === null ? null : getItemCleanEnd(store, this.left),
this.left,
this.right === null ? null : getItemCleanStart(store, this.right),
this.right,
parent,
this.parentSub,
this.content

31
src/structs/ItemString.js
View File

@@ -9,27 +9,30 @@ import {
getItemType,
splitItem,
changeItemRefOffset,
compareIDs,
ItemDeleted,
GC,
Transaction, ID, AbstractType // eslint-disable-line
StructStore, Transaction, ID, AbstractType // eslint-disable-line
} from '../internals.js'
import * as encoding from 'lib0/encoding.js'
import * as decoding from 'lib0/decoding.js'
export const structStringRefNumber = 6
// TODO: we can probably try to omit rightOrigin. We can just use .right
export class ItemString extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
* @param {string} string
*/
constructor (id, left, right, parent, parentSub, string) {
super(id, left, right, parent, parentSub)
constructor (id, left, origin, right, rightOrigin, parent, parentSub, string) {
super(id, left, origin, right, rightOrigin, parent, parentSub)
/**
* @type {string}
*/
@@ -38,12 +41,14 @@ export class ItemString extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
*/
copy (id, left, right, parent, parentSub) {
return new ItemString(id, left, right, parent, parentSub, this.string)
copy (id, left, origin, right, rightOrigin, parent, parentSub) {
return new ItemString(id, left, origin, right, rightOrigin, parent, parentSub, this.string)
}
getContent () {
return this.string.split('')
@@ -52,16 +57,16 @@ export class ItemString extends AbstractItem {
return this.string.length
}
/**
* @param {Transaction} transaction
* @param {StructStore} store
* @param {number} diff
* @return {ItemString}
*/
splitAt (transaction, diff) {
splitAt (store, diff) {
/**
* @type {ItemString}
*/
// @ts-ignore
const right = splitItem(transaction, this, diff)
const right = splitItem(store, this, diff)
right.string = this.string.slice(diff)
this.string = this.string.slice(0, diff)
return right
@@ -71,7 +76,7 @@ export class ItemString extends AbstractItem {
* @return {boolean}
*/
mergeWith (right) {
if (right.origin === this && this.right === right) {
if (compareIDs(right.origin, this.lastId) && this.right === right) {
this.string += right.string
return true
}
@@ -132,8 +137,10 @@ export class ItemStringRef extends AbstractItemRef {
return new ItemString(
this.id,
this.left === null ? null : getItemCleanEnd(store, transaction, this.left),
this.right === null ? null : getItemCleanStart(store, transaction, this.right),
this.left === null ? null : getItemCleanEnd(store, this.left),
this.left,
this.right === null ? null : getItemCleanStart(store, this.right),
this.right,
parent,
this.parentSub,
this.string

19
src/structs/ItemType.js
View File

@@ -61,13 +61,15 @@ export class ItemType extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
* @param {AbstractType<any>} type
*/
constructor (id, left, right, parent, parentSub, type) {
super(id, left, right, parent, parentSub)
constructor (id, left, origin, right, rightOrigin, parent, parentSub, type) {
super(id, left, origin, right, rightOrigin, parent, parentSub)
this.type = type
}
@@ -77,13 +79,15 @@ export class ItemType extends AbstractItem {
/**
* @param {ID} id
* @param {AbstractItem | null} left
* @param {ID | null} origin
* @param {AbstractItem | null} right
* @param {ID | null} rightOrigin
* @param {AbstractType<any>} parent
* @param {string | null} parentSub
* @return {AbstractItem} TODO, returns itemtype
*/
copy (id, left, right, parent, parentSub) {
return new ItemType(id, left, right, parent, parentSub, this.type._copy())
copy (id, left, origin, right, rightOrigin, parent, parentSub) {
return new ItemType(id, left, origin, right, rightOrigin, parent, parentSub, this.type._copy())
}
/**
* @param {Transaction} transaction
@@ -189,10 +193,13 @@ export class ItemTypeRef extends AbstractItemRef {
parent = y.get(this.parentYKey)
}
// TODO: we can probably only feed AbstractType with origins
return new ItemType(
this.id,
this.left === null ? null : getItemCleanEnd(store, transaction, this.left),
this.right === null ? null : getItemCleanStart(store, transaction, this.right),
this.left === null ? null : getItemCleanEnd(store, this.left),
this.left,
this.right === null ? null : getItemCleanStart(store, this.right),
this.right,
parent,
this.parentSub,
this.type