prosemirror-model
Version:
ProseMirror's document model
1,447 lines (1,434 loc) • 124 kB
JavaScript
import OrderedMap from 'orderedmap';
function findDiffStart(a, b, pos) {
for (let i = 0;; i++) {
if (i == a.childCount || i == b.childCount)
return a.childCount == b.childCount ? null : pos;
let childA = a.child(i), childB = b.child(i);
if (childA == childB) {
pos += childA.nodeSize;
continue;
}
if (!childA.sameMarkup(childB))
return pos;
if (childA.isText && childA.text != childB.text) {
for (let j = 0; childA.text[j] == childB.text[j]; j++)
pos++;
return pos;
}
if (childA.content.size || childB.content.size) {
let inner = findDiffStart(childA.content, childB.content, pos + 1);
if (inner != null)
return inner;
}
pos += childA.nodeSize;
}
}
function findDiffEnd(a, b, posA, posB) {
for (let iA = a.childCount, iB = b.childCount;;) {
if (iA == 0 || iB == 0)
return iA == iB ? null : { a: posA, b: posB };
let childA = a.child(--iA), childB = b.child(--iB), size = childA.nodeSize;
if (childA == childB) {
posA -= size;
posB -= size;
continue;
}
if (!childA.sameMarkup(childB))
return { a: posA, b: posB };
if (childA.isText && childA.text != childB.text) {
let same = 0, minSize = Math.min(childA.text.length, childB.text.length);
while (same < minSize && childA.text[childA.text.length - same - 1] == childB.text[childB.text.length - same - 1]) {
same++;
posA--;
posB--;
}
return { a: posA, b: posB };
}
if (childA.content.size || childB.content.size) {
let inner = findDiffEnd(childA.content, childB.content, posA - 1, posB - 1);
if (inner)
return inner;
}
posA -= size;
posB -= size;
}
}
/**
A fragment represents a node's collection of child nodes.
Like nodes, fragments are persistent data structures, and you
should not mutate them or their content. Rather, you create new
instances whenever needed. The API tries to make this easy.
*/
class Fragment {
/**
@internal
*/
constructor(
/**
The child nodes in this fragment.
*/
content, size) {
this.content = content;
this.size = size || 0;
if (size == null)
for (let i = 0; i < content.length; i++)
this.size += content[i].nodeSize;
}
/**
Invoke a callback for all descendant nodes between the given two
positions (relative to start of this fragment). Doesn't descend
into a node when the callback returns `false`.
*/
nodesBetween(from, to, f, nodeStart = 0, parent) {
for (let i = 0, pos = 0; pos < to; i++) {
let child = this.content[i], end = pos + child.nodeSize;
if (end > from && f(child, nodeStart + pos, parent || null, i) !== false && child.content.size) {
let start = pos + 1;
child.nodesBetween(Math.max(0, from - start), Math.min(child.content.size, to - start), f, nodeStart + start);
}
pos = end;
}
}
/**
Call the given callback for every descendant node. `pos` will be
relative to the start of the fragment. The callback may return
`false` to prevent traversal of a given node's children.
*/
descendants(f) {
this.nodesBetween(0, this.size, f);
}
/**
Extract the text between `from` and `to`. See the same method on
[`Node`](https://prosemirror.net/docs/ref/#model.Node.textBetween).
*/
textBetween(from, to, blockSeparator, leafText) {
let text = "", first = true;
this.nodesBetween(from, to, (node, pos) => {
let nodeText = node.isText ? node.text.slice(Math.max(from, pos) - pos, to - pos)
: !node.isLeaf ? ""
: leafText ? (typeof leafText === "function" ? leafText(node) : leafText)
: node.type.spec.leafText ? node.type.spec.leafText(node)
: "";
if (node.isBlock && (node.isLeaf && nodeText || node.isTextblock) && blockSeparator) {
if (first)
first = false;
else
text += blockSeparator;
}
text += nodeText;
}, 0);
return text;
}
/**
Create a new fragment containing the combined content of this
fragment and the other.
*/
append(other) {
if (!other.size)
return this;
if (!this.size)
return other;
let last = this.lastChild, first = other.firstChild, content = this.content.slice(), i = 0;
if (last.isText && last.sameMarkup(first)) {
content[content.length - 1] = last.withText(last.text + first.text);
i = 1;
}
for (; i < other.content.length; i++)
content.push(other.content[i]);
return new Fragment(content, this.size + other.size);
}
/**
Cut out the sub-fragment between the two given positions.
*/
cut(from, to = this.size) {
if (from == 0 && to == this.size)
return this;
let result = [], size = 0;
if (to > from)
for (let i = 0, pos = 0; pos < to; i++) {
let child = this.content[i], end = pos + child.nodeSize;
if (end > from) {
if (pos < from || end > to) {
if (child.isText)
child = child.cut(Math.max(0, from - pos), Math.min(child.text.length, to - pos));
else
child = child.cut(Math.max(0, from - pos - 1), Math.min(child.content.size, to - pos - 1));
}
result.push(child);
size += child.nodeSize;
}
pos = end;
}
return new Fragment(result, size);
}
/**
@internal
*/
cutByIndex(from, to) {
if (from == to)
return Fragment.empty;
if (from == 0 && to == this.content.length)
return this;
return new Fragment(this.content.slice(from, to));
}
/**
Create a new fragment in which the node at the given index is
replaced by the given node.
*/
replaceChild(index, node) {
let current = this.content[index];
if (current == node)
return this;
let copy = this.content.slice();
let size = this.size + node.nodeSize - current.nodeSize;
copy[index] = node;
return new Fragment(copy, size);
}
/**
Create a new fragment by prepending the given node to this
fragment.
*/
addToStart(node) {
return new Fragment([node].concat(this.content), this.size + node.nodeSize);
}
/**
Create a new fragment by appending the given node to this
fragment.
*/
addToEnd(node) {
return new Fragment(this.content.concat(node), this.size + node.nodeSize);
}
/**
Compare this fragment to another one.
*/
eq(other) {
if (this.content.length != other.content.length)
return false;
for (let i = 0; i < this.content.length; i++)
if (!this.content[i].eq(other.content[i]))
return false;
return true;
}
/**
The first child of the fragment, or `null` if it is empty.
*/
get firstChild() { return this.content.length ? this.content[0] : null; }
/**
The last child of the fragment, or `null` if it is empty.
*/
get lastChild() { return this.content.length ? this.content[this.content.length - 1] : null; }
/**
The number of child nodes in this fragment.
*/
get childCount() { return this.content.length; }
/**
Get the child node at the given index. Raise an error when the
index is out of range.
*/
child(index) {
let found = this.content[index];
if (!found)
throw new RangeError("Index " + index + " out of range for " + this);
return found;
}
/**
Get the child node at the given index, if it exists.
*/
maybeChild(index) {
return this.content[index] || null;
}
/**
Call `f` for every child node, passing the node, its offset
into this parent node, and its index.
*/
forEach(f) {
for (let i = 0, p = 0; i < this.content.length; i++) {
let child = this.content[i];
f(child, p, i);
p += child.nodeSize;
}
}
/**
Find the first position at which this fragment and another
fragment differ, or `null` if they are the same.
*/
findDiffStart(other, pos = 0) {
return findDiffStart(this, other, pos);
}
/**
Find the first position, searching from the end, at which this
fragment and the given fragment differ, or `null` if they are
the same. Since this position will not be the same in both
nodes, an object with two separate positions is returned.
*/
findDiffEnd(other, pos = this.size, otherPos = other.size) {
return findDiffEnd(this, other, pos, otherPos);
}
/**
Find the index and inner offset corresponding to a given relative
position in this fragment. The result object will be reused
(overwritten) the next time the function is called. @internal
*/
findIndex(pos, round = -1) {
if (pos == 0)
return retIndex(0, pos);
if (pos == this.size)
return retIndex(this.content.length, pos);
if (pos > this.size || pos < 0)
throw new RangeError(`Position ${pos} outside of fragment (${this})`);
for (let i = 0, curPos = 0;; i++) {
let cur = this.child(i), end = curPos + cur.nodeSize;
if (end >= pos) {
if (end == pos || round > 0)
return retIndex(i + 1, end);
return retIndex(i, curPos);
}
curPos = end;
}
}
/**
Return a debugging string that describes this fragment.
*/
toString() { return "<" + this.toStringInner() + ">"; }
/**
@internal
*/
toStringInner() { return this.content.join(", "); }
/**
Create a JSON-serializeable representation of this fragment.
*/
toJSON() {
return this.content.length ? this.content.map(n => n.toJSON()) : null;
}
/**
Deserialize a fragment from its JSON representation.
*/
static fromJSON(schema, value) {
if (!value)
return Fragment.empty;
if (!Array.isArray(value))
throw new RangeError("Invalid input for Fragment.fromJSON");
return new Fragment(value.map(schema.nodeFromJSON));
}
/**
Build a fragment from an array of nodes. Ensures that adjacent
text nodes with the same marks are joined together.
*/
static fromArray(array) {
if (!array.length)
return Fragment.empty;
let joined, size = 0;
for (let i = 0; i < array.length; i++) {
let node = array[i];
size += node.nodeSize;
if (i && node.isText && array[i - 1].sameMarkup(node)) {
if (!joined)
joined = array.slice(0, i);
joined[joined.length - 1] = node
.withText(joined[joined.length - 1].text + node.text);
}
else if (joined) {
joined.push(node);
}
}
return new Fragment(joined || array, size);
}
/**
Create a fragment from something that can be interpreted as a
set of nodes. For `null`, it returns the empty fragment. For a
fragment, the fragment itself. For a node or array of nodes, a
fragment containing those nodes.
*/
static from(nodes) {
if (!nodes)
return Fragment.empty;
if (nodes instanceof Fragment)
return nodes;
if (Array.isArray(nodes))
return this.fromArray(nodes);
if (nodes.attrs)
return new Fragment([nodes], nodes.nodeSize);
throw new RangeError("Can not convert " + nodes + " to a Fragment" +
(nodes.nodesBetween ? " (looks like multiple versions of prosemirror-model were loaded)" : ""));
}
}
/**
An empty fragment. Intended to be reused whenever a node doesn't
contain anything (rather than allocating a new empty fragment for
each leaf node).
*/
Fragment.empty = new Fragment([], 0);
const found = { index: 0, offset: 0 };
function retIndex(index, offset) {
found.index = index;
found.offset = offset;
return found;
}
function compareDeep(a, b) {
if (a === b)
return true;
if (!(a && typeof a == "object") ||
!(b && typeof b == "object"))
return false;
let array = Array.isArray(a);
if (Array.isArray(b) != array)
return false;
if (array) {
if (a.length != b.length)
return false;
for (let i = 0; i < a.length; i++)
if (!compareDeep(a[i], b[i]))
return false;
}
else {
for (let p in a)
if (!(p in b) || !compareDeep(a[p], b[p]))
return false;
for (let p in b)
if (!(p in a))
return false;
}
return true;
}
/**
A mark is a piece of information that can be attached to a node,
such as it being emphasized, in code font, or a link. It has a
type and optionally a set of attributes that provide further
information (such as the target of the link). Marks are created
through a `Schema`, which controls which types exist and which
attributes they have.
*/
class Mark {
/**
@internal
*/
constructor(
/**
The type of this mark.
*/
type,
/**
The attributes associated with this mark.
*/
attrs) {
this.type = type;
this.attrs = attrs;
}
/**
Given a set of marks, create a new set which contains this one as
well, in the right position. If this mark is already in the set,
the set itself is returned. If any marks that are set to be
[exclusive](https://prosemirror.net/docs/ref/#model.MarkSpec.excludes) with this mark are present,
those are replaced by this one.
*/
addToSet(set) {
let copy, placed = false;
for (let i = 0; i < set.length; i++) {
let other = set[i];
if (this.eq(other))
return set;
if (this.type.excludes(other.type)) {
if (!copy)
copy = set.slice(0, i);
}
else if (other.type.excludes(this.type)) {
return set;
}
else {
if (!placed && other.type.rank > this.type.rank) {
if (!copy)
copy = set.slice(0, i);
copy.push(this);
placed = true;
}
if (copy)
copy.push(other);
}
}
if (!copy)
copy = set.slice();
if (!placed)
copy.push(this);
return copy;
}
/**
Remove this mark from the given set, returning a new set. If this
mark is not in the set, the set itself is returned.
*/
removeFromSet(set) {
for (let i = 0; i < set.length; i++)
if (this.eq(set[i]))
return set.slice(0, i).concat(set.slice(i + 1));
return set;
}
/**
Test whether this mark is in the given set of marks.
*/
isInSet(set) {
for (let i = 0; i < set.length; i++)
if (this.eq(set[i]))
return true;
return false;
}
/**
Test whether this mark has the same type and attributes as
another mark.
*/
eq(other) {
return this == other ||
(this.type == other.type && compareDeep(this.attrs, other.attrs));
}
/**
Convert this mark to a JSON-serializeable representation.
*/
toJSON() {
let obj = { type: this.type.name };
for (let _ in this.attrs) {
obj.attrs = this.attrs;
break;
}
return obj;
}
/**
Deserialize a mark from JSON.
*/
static fromJSON(schema, json) {
if (!json)
throw new RangeError("Invalid input for Mark.fromJSON");
let type = schema.marks[json.type];
if (!type)
throw new RangeError(`There is no mark type ${json.type} in this schema`);
let mark = type.create(json.attrs);
type.checkAttrs(mark.attrs);
return mark;
}
/**
Test whether two sets of marks are identical.
*/
static sameSet(a, b) {
if (a == b)
return true;
if (a.length != b.length)
return false;
for (let i = 0; i < a.length; i++)
if (!a[i].eq(b[i]))
return false;
return true;
}
/**
Create a properly sorted mark set from null, a single mark, or an
unsorted array of marks.
*/
static setFrom(marks) {
if (!marks || Array.isArray(marks) && marks.length == 0)
return Mark.none;
if (marks instanceof Mark)
return [marks];
let copy = marks.slice();
copy.sort((a, b) => a.type.rank - b.type.rank);
return copy;
}
}
/**
The empty set of marks.
*/
Mark.none = [];
/**
Error type raised by [`Node.replace`](https://prosemirror.net/docs/ref/#model.Node.replace) when
given an invalid replacement.
*/
class ReplaceError extends Error {
}
/*
ReplaceError = function(this: any, message: string) {
let err = Error.call(this, message)
;(err as any).__proto__ = ReplaceError.prototype
return err
} as any
ReplaceError.prototype = Object.create(Error.prototype)
ReplaceError.prototype.constructor = ReplaceError
ReplaceError.prototype.name = "ReplaceError"
*/
/**
A slice represents a piece cut out of a larger document. It
stores not only a fragment, but also the depth up to which nodes on
both side are ‘open’ (cut through).
*/
class Slice {
/**
Create a slice. When specifying a non-zero open depth, you must
make sure that there are nodes of at least that depth at the
appropriate side of the fragment—i.e. if the fragment is an
empty paragraph node, `openStart` and `openEnd` can't be greater
than 1.
It is not necessary for the content of open nodes to conform to
the schema's content constraints, though it should be a valid
start/end/middle for such a node, depending on which sides are
open.
*/
constructor(
/**
The slice's content.
*/
content,
/**
The open depth at the start of the fragment.
*/
openStart,
/**
The open depth at the end.
*/
openEnd) {
this.content = content;
this.openStart = openStart;
this.openEnd = openEnd;
}
/**
The size this slice would add when inserted into a document.
*/
get size() {
return this.content.size - this.openStart - this.openEnd;
}
/**
@internal
*/
insertAt(pos, fragment) {
let content = insertInto(this.content, pos + this.openStart, fragment);
return content && new Slice(content, this.openStart, this.openEnd);
}
/**
@internal
*/
removeBetween(from, to) {
return new Slice(removeRange(this.content, from + this.openStart, to + this.openStart), this.openStart, this.openEnd);
}
/**
Tests whether this slice is equal to another slice.
*/
eq(other) {
return this.content.eq(other.content) && this.openStart == other.openStart && this.openEnd == other.openEnd;
}
/**
@internal
*/
toString() {
return this.content + "(" + this.openStart + "," + this.openEnd + ")";
}
/**
Convert a slice to a JSON-serializable representation.
*/
toJSON() {
if (!this.content.size)
return null;
let json = { content: this.content.toJSON() };
if (this.openStart > 0)
json.openStart = this.openStart;
if (this.openEnd > 0)
json.openEnd = this.openEnd;
return json;
}
/**
Deserialize a slice from its JSON representation.
*/
static fromJSON(schema, json) {
if (!json)
return Slice.empty;
let openStart = json.openStart || 0, openEnd = json.openEnd || 0;
if (typeof openStart != "number" || typeof openEnd != "number")
throw new RangeError("Invalid input for Slice.fromJSON");
return new Slice(Fragment.fromJSON(schema, json.content), openStart, openEnd);
}
/**
Create a slice from a fragment by taking the maximum possible
open value on both side of the fragment.
*/
static maxOpen(fragment, openIsolating = true) {
let openStart = 0, openEnd = 0;
for (let n = fragment.firstChild; n && !n.isLeaf && (openIsolating || !n.type.spec.isolating); n = n.firstChild)
openStart++;
for (let n = fragment.lastChild; n && !n.isLeaf && (openIsolating || !n.type.spec.isolating); n = n.lastChild)
openEnd++;
return new Slice(fragment, openStart, openEnd);
}
}
/**
The empty slice.
*/
Slice.empty = new Slice(Fragment.empty, 0, 0);
function removeRange(content, from, to) {
let { index, offset } = content.findIndex(from), child = content.maybeChild(index);
let { index: indexTo, offset: offsetTo } = content.findIndex(to);
if (offset == from || child.isText) {
if (offsetTo != to && !content.child(indexTo).isText)
throw new RangeError("Removing non-flat range");
return content.cut(0, from).append(content.cut(to));
}
if (index != indexTo)
throw new RangeError("Removing non-flat range");
return content.replaceChild(index, child.copy(removeRange(child.content, from - offset - 1, to - offset - 1)));
}
function insertInto(content, dist, insert, parent) {
let { index, offset } = content.findIndex(dist), child = content.maybeChild(index);
if (offset == dist || child.isText) {
if (parent && !parent.canReplace(index, index, insert))
return null;
return content.cut(0, dist).append(insert).append(content.cut(dist));
}
let inner = insertInto(child.content, dist - offset - 1, insert);
return inner && content.replaceChild(index, child.copy(inner));
}
function replace($from, $to, slice) {
if (slice.openStart > $from.depth)
throw new ReplaceError("Inserted content deeper than insertion position");
if ($from.depth - slice.openStart != $to.depth - slice.openEnd)
throw new ReplaceError("Inconsistent open depths");
return replaceOuter($from, $to, slice, 0);
}
function replaceOuter($from, $to, slice, depth) {
let index = $from.index(depth), node = $from.node(depth);
if (index == $to.index(depth) && depth < $from.depth - slice.openStart) {
let inner = replaceOuter($from, $to, slice, depth + 1);
return node.copy(node.content.replaceChild(index, inner));
}
else if (!slice.content.size) {
return close(node, replaceTwoWay($from, $to, depth));
}
else if (!slice.openStart && !slice.openEnd && $from.depth == depth && $to.depth == depth) { // Simple, flat case
let parent = $from.parent, content = parent.content;
return close(parent, content.cut(0, $from.parentOffset).append(slice.content).append(content.cut($to.parentOffset)));
}
else {
let { start, end } = prepareSliceForReplace(slice, $from);
return close(node, replaceThreeWay($from, start, end, $to, depth));
}
}
function checkJoin(main, sub) {
if (!sub.type.compatibleContent(main.type))
throw new ReplaceError("Cannot join " + sub.type.name + " onto " + main.type.name);
}
function joinable($before, $after, depth) {
let node = $before.node(depth);
checkJoin(node, $after.node(depth));
return node;
}
function addNode(child, target) {
let last = target.length - 1;
if (last >= 0 && child.isText && child.sameMarkup(target[last]))
target[last] = child.withText(target[last].text + child.text);
else
target.push(child);
}
function addRange($start, $end, depth, target) {
let node = ($end || $start).node(depth);
let startIndex = 0, endIndex = $end ? $end.index(depth) : node.childCount;
if ($start) {
startIndex = $start.index(depth);
if ($start.depth > depth) {
startIndex++;
}
else if ($start.textOffset) {
addNode($start.nodeAfter, target);
startIndex++;
}
}
for (let i = startIndex; i < endIndex; i++)
addNode(node.child(i), target);
if ($end && $end.depth == depth && $end.textOffset)
addNode($end.nodeBefore, target);
}
function close(node, content) {
node.type.checkContent(content);
return node.copy(content);
}
function replaceThreeWay($from, $start, $end, $to, depth) {
let openStart = $from.depth > depth && joinable($from, $start, depth + 1);
let openEnd = $to.depth > depth && joinable($end, $to, depth + 1);
let content = [];
addRange(null, $from, depth, content);
if (openStart && openEnd && $start.index(depth) == $end.index(depth)) {
checkJoin(openStart, openEnd);
addNode(close(openStart, replaceThreeWay($from, $start, $end, $to, depth + 1)), content);
}
else {
if (openStart)
addNode(close(openStart, replaceTwoWay($from, $start, depth + 1)), content);
addRange($start, $end, depth, content);
if (openEnd)
addNode(close(openEnd, replaceTwoWay($end, $to, depth + 1)), content);
}
addRange($to, null, depth, content);
return new Fragment(content);
}
function replaceTwoWay($from, $to, depth) {
let content = [];
addRange(null, $from, depth, content);
if ($from.depth > depth) {
let type = joinable($from, $to, depth + 1);
addNode(close(type, replaceTwoWay($from, $to, depth + 1)), content);
}
addRange($to, null, depth, content);
return new Fragment(content);
}
function prepareSliceForReplace(slice, $along) {
let extra = $along.depth - slice.openStart, parent = $along.node(extra);
let node = parent.copy(slice.content);
for (let i = extra - 1; i >= 0; i--)
node = $along.node(i).copy(Fragment.from(node));
return { start: node.resolveNoCache(slice.openStart + extra),
end: node.resolveNoCache(node.content.size - slice.openEnd - extra) };
}
/**
You can [_resolve_](https://prosemirror.net/docs/ref/#model.Node.resolve) a position to get more
information about it. Objects of this class represent such a
resolved position, providing various pieces of context
information, and some helper methods.
Throughout this interface, methods that take an optional `depth`
parameter will interpret undefined as `this.depth` and negative
numbers as `this.depth + value`.
*/
class ResolvedPos {
/**
@internal
*/
constructor(
/**
The position that was resolved.
*/
pos,
/**
@internal
*/
path,
/**
The offset this position has into its parent node.
*/
parentOffset) {
this.pos = pos;
this.path = path;
this.parentOffset = parentOffset;
this.depth = path.length / 3 - 1;
}
/**
@internal
*/
resolveDepth(val) {
if (val == null)
return this.depth;
if (val < 0)
return this.depth + val;
return val;
}
/**
The parent node that the position points into. Note that even if
a position points into a text node, that node is not considered
the parent—text nodes are ‘flat’ in this model, and have no content.
*/
get parent() { return this.node(this.depth); }
/**
The root node in which the position was resolved.
*/
get doc() { return this.node(0); }
/**
The ancestor node at the given level. `p.node(p.depth)` is the
same as `p.parent`.
*/
node(depth) { return this.path[this.resolveDepth(depth) * 3]; }
/**
The index into the ancestor at the given level. If this points
at the 3rd node in the 2nd paragraph on the top level, for
example, `p.index(0)` is 1 and `p.index(1)` is 2.
*/
index(depth) { return this.path[this.resolveDepth(depth) * 3 + 1]; }
/**
The index pointing after this position into the ancestor at the
given level.
*/
indexAfter(depth) {
depth = this.resolveDepth(depth);
return this.index(depth) + (depth == this.depth && !this.textOffset ? 0 : 1);
}
/**
The (absolute) position at the start of the node at the given
level.
*/
start(depth) {
depth = this.resolveDepth(depth);
return depth == 0 ? 0 : this.path[depth * 3 - 1] + 1;
}
/**
The (absolute) position at the end of the node at the given
level.
*/
end(depth) {
depth = this.resolveDepth(depth);
return this.start(depth) + this.node(depth).content.size;
}
/**
The (absolute) position directly before the wrapping node at the
given level, or, when `depth` is `this.depth + 1`, the original
position.
*/
before(depth) {
depth = this.resolveDepth(depth);
if (!depth)
throw new RangeError("There is no position before the top-level node");
return depth == this.depth + 1 ? this.pos : this.path[depth * 3 - 1];
}
/**
The (absolute) position directly after the wrapping node at the
given level, or the original position when `depth` is `this.depth + 1`.
*/
after(depth) {
depth = this.resolveDepth(depth);
if (!depth)
throw new RangeError("There is no position after the top-level node");
return depth == this.depth + 1 ? this.pos : this.path[depth * 3 - 1] + this.path[depth * 3].nodeSize;
}
/**
When this position points into a text node, this returns the
distance between the position and the start of the text node.
Will be zero for positions that point between nodes.
*/
get textOffset() { return this.pos - this.path[this.path.length - 1]; }
/**
Get the node directly after the position, if any. If the position
points into a text node, only the part of that node after the
position is returned.
*/
get nodeAfter() {
let parent = this.parent, index = this.index(this.depth);
if (index == parent.childCount)
return null;
let dOff = this.pos - this.path[this.path.length - 1], child = parent.child(index);
return dOff ? parent.child(index).cut(dOff) : child;
}
/**
Get the node directly before the position, if any. If the
position points into a text node, only the part of that node
before the position is returned.
*/
get nodeBefore() {
let index = this.index(this.depth);
let dOff = this.pos - this.path[this.path.length - 1];
if (dOff)
return this.parent.child(index).cut(0, dOff);
return index == 0 ? null : this.parent.child(index - 1);
}
/**
Get the position at the given index in the parent node at the
given depth (which defaults to `this.depth`).
*/
posAtIndex(index, depth) {
depth = this.resolveDepth(depth);
let node = this.path[depth * 3], pos = depth == 0 ? 0 : this.path[depth * 3 - 1] + 1;
for (let i = 0; i < index; i++)
pos += node.child(i).nodeSize;
return pos;
}
/**
Get the marks at this position, factoring in the surrounding
marks' [`inclusive`](https://prosemirror.net/docs/ref/#model.MarkSpec.inclusive) property. If the
position is at the start of a non-empty node, the marks of the
node after it (if any) are returned.
*/
marks() {
let parent = this.parent, index = this.index();
// In an empty parent, return the empty array
if (parent.content.size == 0)
return Mark.none;
// When inside a text node, just return the text node's marks
if (this.textOffset)
return parent.child(index).marks;
let main = parent.maybeChild(index - 1), other = parent.maybeChild(index);
// If the `after` flag is true of there is no node before, make
// the node after this position the main reference.
if (!main) {
let tmp = main;
main = other;
other = tmp;
}
// Use all marks in the main node, except those that have
// `inclusive` set to false and are not present in the other node.
let marks = main.marks;
for (var i = 0; i < marks.length; i++)
if (marks[i].type.spec.inclusive === false && (!other || !marks[i].isInSet(other.marks)))
marks = marks[i--].removeFromSet(marks);
return marks;
}
/**
Get the marks after the current position, if any, except those
that are non-inclusive and not present at position `$end`. This
is mostly useful for getting the set of marks to preserve after a
deletion. Will return `null` if this position is at the end of
its parent node or its parent node isn't a textblock (in which
case no marks should be preserved).
*/
marksAcross($end) {
let after = this.parent.maybeChild(this.index());
if (!after || !after.isInline)
return null;
let marks = after.marks, next = $end.parent.maybeChild($end.index());
for (var i = 0; i < marks.length; i++)
if (marks[i].type.spec.inclusive === false && (!next || !marks[i].isInSet(next.marks)))
marks = marks[i--].removeFromSet(marks);
return marks;
}
/**
The depth up to which this position and the given (non-resolved)
position share the same parent nodes.
*/
sharedDepth(pos) {
for (let depth = this.depth; depth > 0; depth--)
if (this.start(depth) <= pos && this.end(depth) >= pos)
return depth;
return 0;
}
/**
Returns a range based on the place where this position and the
given position diverge around block content. If both point into
the same textblock, for example, a range around that textblock
will be returned. If they point into different blocks, the range
around those blocks in their shared ancestor is returned. You can
pass in an optional predicate that will be called with a parent
node to see if a range into that parent is acceptable.
*/
blockRange(other = this, pred) {
if (other.pos < this.pos)
return other.blockRange(this);
for (let d = this.depth - (this.parent.inlineContent || this.pos == other.pos ? 1 : 0); d >= 0; d--)
if (other.pos <= this.end(d) && (!pred || pred(this.node(d))))
return new NodeRange(this, other, d);
return null;
}
/**
Query whether the given position shares the same parent node.
*/
sameParent(other) {
return this.pos - this.parentOffset == other.pos - other.parentOffset;
}
/**
Return the greater of this and the given position.
*/
max(other) {
return other.pos > this.pos ? other : this;
}
/**
Return the smaller of this and the given position.
*/
min(other) {
return other.pos < this.pos ? other : this;
}
/**
@internal
*/
toString() {
let str = "";
for (let i = 1; i <= this.depth; i++)
str += (str ? "/" : "") + this.node(i).type.name + "_" + this.index(i - 1);
return str + ":" + this.parentOffset;
}
/**
@internal
*/
static resolve(doc, pos) {
if (!(pos >= 0 && pos <= doc.content.size))
throw new RangeError("Position " + pos + " out of range");
let path = [];
let start = 0, parentOffset = pos;
for (let node = doc;;) {
let { index, offset } = node.content.findIndex(parentOffset);
let rem = parentOffset - offset;
path.push(node, index, start + offset);
if (!rem)
break;
node = node.child(index);
if (node.isText)
break;
parentOffset = rem - 1;
start += offset + 1;
}
return new ResolvedPos(pos, path, parentOffset);
}
/**
@internal
*/
static resolveCached(doc, pos) {
let cache = resolveCache.get(doc);
if (cache) {
for (let i = 0; i < cache.elts.length; i++) {
let elt = cache.elts[i];
if (elt.pos == pos)
return elt;
}
}
else {
resolveCache.set(doc, cache = new ResolveCache);
}
let result = cache.elts[cache.i] = ResolvedPos.resolve(doc, pos);
cache.i = (cache.i + 1) % resolveCacheSize;
return result;
}
}
class ResolveCache {
constructor() {
this.elts = [];
this.i = 0;
}
}
const resolveCacheSize = 12, resolveCache = new WeakMap();
/**
Represents a flat range of content, i.e. one that starts and
ends in the same node.
*/
class NodeRange {
/**
Construct a node range. `$from` and `$to` should point into the
same node until at least the given `depth`, since a node range
denotes an adjacent set of nodes in a single parent node.
*/
constructor(
/**
A resolved position along the start of the content. May have a
`depth` greater than this object's `depth` property, since
these are the positions that were used to compute the range,
not re-resolved positions directly at its boundaries.
*/
$from,
/**
A position along the end of the content. See
caveat for [`$from`](https://prosemirror.net/docs/ref/#model.NodeRange.$from).
*/
$to,
/**
The depth of the node that this range points into.
*/
depth) {
this.$from = $from;
this.$to = $to;
this.depth = depth;
}
/**
The position at the start of the range.
*/
get start() { return this.$from.before(this.depth + 1); }
/**
The position at the end of the range.
*/
get end() { return this.$to.after(this.depth + 1); }
/**
The parent node that the range points into.
*/
get parent() { return this.$from.node(this.depth); }
/**
The start index of the range in the parent node.
*/
get startIndex() { return this.$from.index(this.depth); }
/**
The end index of the range in the parent node.
*/
get endIndex() { return this.$to.indexAfter(this.depth); }
}
const emptyAttrs = Object.create(null);
/**
This class represents a node in the tree that makes up a
ProseMirror document. So a document is an instance of `Node`, with
children that are also instances of `Node`.
Nodes are persistent data structures. Instead of changing them, you
create new ones with the content you want. Old ones keep pointing
at the old document shape. This is made cheaper by sharing
structure between the old and new data as much as possible, which a
tree shape like this (without back pointers) makes easy.
**Do not** directly mutate the properties of a `Node` object. See
[the guide](https://prosemirror.net/docs/guide/#doc) for more information.
*/
class Node {
/**
@internal
*/
constructor(
/**
The type of node that this is.
*/
type,
/**
An object mapping attribute names to values. The kind of
attributes allowed and required are
[determined](https://prosemirror.net/docs/ref/#model.NodeSpec.attrs) by the node type.
*/
attrs,
// A fragment holding the node's children.
content,
/**
The marks (things like whether it is emphasized or part of a
link) applied to this node.
*/
marks = Mark.none) {
this.type = type;
this.attrs = attrs;
this.marks = marks;
this.content = content || Fragment.empty;
}
/**
The array of this node's child nodes.
*/
get children() { return this.content.content; }
/**
The size of this node, as defined by the integer-based [indexing
scheme](https://prosemirror.net/docs/guide/#doc.indexing). For text nodes, this is the
amount of characters. For other leaf nodes, it is one. For
non-leaf nodes, it is the size of the content plus two (the
start and end token).
*/
get nodeSize() { return this.isLeaf ? 1 : 2 + this.content.size; }
/**
The number of children that the node has.
*/
get childCount() { return this.content.childCount; }
/**
Get the child node at the given index. Raises an error when the
index is out of range.
*/
child(index) { return this.content.child(index); }
/**
Get the child node at the given index, if it exists.
*/
maybeChild(index) { return this.content.maybeChild(index); }
/**
Call `f` for every child node, passing the node, its offset
into this parent node, and its index.
*/
forEach(f) { this.content.forEach(f); }
/**
Invoke a callback for all descendant nodes recursively between
the given two positions that are relative to start of this
node's content. The callback is invoked with the node, its
position relative to the original node (method receiver),
its parent node, and its child index. When the callback returns
false for a given node, that node's children will not be
recursed over. The last parameter can be used to specify a
starting position to count from.
*/
nodesBetween(from, to, f, startPos = 0) {
this.content.nodesBetween(from, to, f, startPos, this);
}
/**
Call the given callback for every descendant node. Doesn't
descend into a node when the callback returns `false`.
*/
descendants(f) {
this.nodesBetween(0, this.content.size, f);
}
/**
Concatenates all the text nodes found in this fragment and its
children.
*/
get textContent() {
return (this.isLeaf && this.type.spec.leafText)
? this.type.spec.leafText(this)
: this.textBetween(0, this.content.size, "");
}
/**
Get all text between positions `from` and `to`. When
`blockSeparator` is given, it will be inserted to separate text
from different block nodes. If `leafText` is given, it'll be
inserted for every non-text leaf node encountered, otherwise
[`leafText`](https://prosemirror.net/docs/ref/#model.NodeSpec^leafText) will be used.
*/
textBetween(from, to, blockSeparator, leafText) {
return this.content.textBetween(from, to, blockSeparator, leafText);
}
/**
Returns this node's first child, or `null` if there are no
children.
*/
get firstChild() { return this.content.firstChild; }
/**
Returns this node's last child, or `null` if there are no
children.
*/
get lastChild() { return this.content.lastChild; }
/**
Test whether two nodes represent the same piece of document.
*/
eq(other) {
return this == other || (this.sameMarkup(other) && this.content.eq(other.content));
}
/**
Compare the markup (type, attributes, and marks) of this node to
those of another. Returns `true` if both have the same markup.
*/
sameMarkup(other) {
return this.hasMarkup(other.type, other.attrs, other.marks);
}
/**
Check whether this node's markup correspond to the given type,
attributes, and marks.
*/
hasMarkup(type, attrs, marks) {
return this.type == type &&
compareDeep(this.attrs, attrs || type.defaultAttrs || emptyAttrs) &&
Mark.sameSet(this.marks, marks || Mark.none);
}
/**
Create a new node with the same markup as this node, containing
the given content (or empty, if no content is given).
*/
copy(content = null) {
if (content == this.content)
return this;
return new Node(this.type, this.attrs, content, this.marks);
}
/**
Create a copy of this node, with the given set of marks instead
of the node's own marks.
*/
mark(marks) {
return marks == this.marks ? this : new Node(this.type, this.attrs, this.content, marks);
}
/**
Create a copy of this node with only the content between the
given positions. If `to` is not given, it defaults to the end of
the node.
*/
cut(from, to = this.content.size) {
if (from == 0 && to == this.content.size)
return this;
return this.copy(this.content.cut(from, to));
}
/**
Cut out the part of the document between the given positions, and
return it as a `Slice` object.
*/
slice(from, to = this.content.size, includeParents = false) {
if (from == to)
return Slice.empty;
let $from = this.resolve(from), $to = this.resolve(to);
let depth = includeParents ? 0 : $from.sharedDepth(to);
let start = $from.start(depth), node = $from.node(depth);
let content = node.content.cut($from.pos - start, $to.pos - start);
return new Slice(content, $from.depth - depth, $to.depth - depth);
}
/**
Replace the part of the document between the given positions with
the given slice. The slice must 'fit', meaning its open sides
must be able to connect to the surrounding content, and its
content nodes must be valid children for the node they are placed
into. If any of this is violated, an error of type
[`ReplaceError`](https://prosemirror.net/docs/ref/#model.ReplaceError) is thrown.
*/
replace(from, to, slice) {
return replace(this.resolve(from), this.resolve(to), slice);
}
/**
Find the node directly after the given position.
*/
nodeAt(pos) {
for (let node = this;;) {
let { index, offset } = node.content.findIndex(pos);
node = node.maybeChild(index);
if (!node)
return null;
if (offset == pos || node.isText)
return node;
pos -= offset + 1;
}
}
/**
Find the (direct) child node after the given offset, if any,
and return it along with its index and offset relative to this
node.
*/
childAfter(pos) {
let { index, offset } = this.content.findIndex(pos);
return { node: this.content.maybeChild(index), index, offset };
}
/**
Find the (direct) child node before the given offset, if any,
and return it along with its index and offset relative to this
node.
*/
childBefore(pos) {
if (pos == 0)
return { node: null, index: 0, offset: 0 };
let { index, offset } = this.content.findIndex(pos);
if (offset < pos)
return { node: this.content.child(index), index, offset };
let node = this.content.child(index - 1);
return { node, index: index - 1, offset: offset - node.nodeSize };
}
/**
Resolve the given position in the document, returning an
[object](https://prosemirror.net/docs/ref/#model.ResolvedPos) with information about its context.
*/
resolve(pos) { return ResolvedPos.resolveCached(this, pos); }
/**
@internal
*/
resolveNoCache(pos) { return ResolvedPos.resolve(this, pos); }
/**
Test whether a given mark or mark type occurs in this document
between the two given positions.
*/
rangeHasMark(from, to, type) {
let found = false;
if (to > from)
this.nodesBetween(from, to, node => {
if (type.isInSet(node.marks))
found = true;
return !found;
});
return found;
}
/**
True when this is a block (non-inline node)
*/
get isBlock() { return this.type.isBlock; }
/**
True when this is a textblock node, a block node with inline
content.
*/
get isTextblock() { return this.type.isTextblock; }
/**
True when this node allows inline content.
*/
get inlineContent() { return this.type.inlineContent; }
/**
True when this is an inline node (a text node or a node that can
appear among text).
*/
get isInline() { return this.type.isInline; }
/**
True when this is a text node.
*/
get isText() { return this.type.isText; }
/**
True when this is a leaf node.
*/
get isLeaf() { return this.type.isLeaf; }
/**
True when this is an atom, i.e. when it does not have directly
editable content. This is usually the same as `isLeaf`, but can
be configured with the [`atom` property](https://prosemirror.net/docs/ref/#model.NodeSpec.atom)
on a node's spec (typically used when the node is displayed as
an uneditable [node view](https://prosemirror.net/docs/ref/#view.NodeView)).
*/
get isAtom() { return this.type.isAtom; }
/**
Return a string representation of this node for debugging
purposes.
*/
toString() {
if (this.type.spec.toDebugString)
return this.type.spec.toDebugString(this);
let name = this.type.name;
if (this.content.size)
name += "(" + this.content.toStringInner() + ")";
return wrapMarks(this.marks, name);
}
/**
Get the content match in this node at the given index.
*/
contentMatchAt(index) {
let match = this.type.contentMatch.matchFragment(this.content, 0, index);
if (!match)
throw new Error("Called contentMatchAt on a node wi