@lezer/common 0.16.0 → 1.0.1

package/dist/index.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 // FIXME profile adding a per-Tree TreeNode cache, validating it by
 // parent pointer
-/// The default maximum length of a `TreeBuffer` node (1024).
+/// The default maximum length of a `TreeBuffer` node.
 const DefaultBufferLength = 1024;
 let nextPropID = 0;
 class Range {
@@ -67,7 +67,7 @@ NodeProp.contextHash = new NodeProp({ perNode: true });
 NodeProp.lookAhead = new NodeProp({ perNode: true });
 /// This per-node prop is used to replace a given node, or part of a
 /// node, with another tree. This is useful to include trees from
-/// different languages.
+/// different languages in mixed-language parsers.
 NodeProp.mounted = new NodeProp({ perNode: true });
 /// A mounted tree, which can be [stored](#common.NodeProp^mounted) on
 /// a tree node to indicate that parts of its content are
@@ -113,6 +113,7 @@ class NodeType {
         this.id = id;
         this.flags = flags;
     }
+    /// Define a node type.
     static define(spec) {
         let props = spec.props && spec.props.length ? Object.create(null) : noProps;
         let flags = (spec.top ? 1 /* Top */ : 0) | (spec.skipped ? 2 /* Skipped */ : 0) |
@@ -194,7 +195,7 @@ class NodeSet {
                 throw new RangeError("Node type ids should correspond to array positions when creating a node set");
     }
     /// Create a copy of this set with some node properties added. The
-    /// arguments to this method should be created with
+    /// arguments to this method can be created with
     /// [`NodeProp.add`](#common.NodeProp.add).
     extend(...props) {
         let newTypes = [];
@@ -320,6 +321,10 @@ class Tree {
     /// position. If 1, it'll move into nodes that start at the
     /// position. With 0, it'll only enter nodes that cover the position
     /// from both sides.
+    ///
+    /// Note that this will not enter
+    /// [overlays](#common.MountedTree.overlay), and you often want
+    /// [`resolveInner`](#common.Tree.resolveInner) instead.
     resolve(pos, side = 0) {
         let node = resolveNode(CachedNode.get(this) || this.topNode, pos, side, false);
         CachedNode.set(this, node);
@@ -404,7 +409,7 @@ class FlatBufferCursor {
 /// Tree buffers contain (type, start, end, endIndex) quads for each
 /// node. In such a buffer, nodes are stored in prefix order (parents
 /// before children, with the endIndex of the parent indicating which
-/// children belong to it)
+/// children belong to it).
 class TreeBuffer {
     /// Create a tree buffer.
     constructor(
@@ -1308,7 +1313,10 @@ class NodeWeakMap {
 /// [`applyChanges`](#common.TreeFragment^applyChanges) method to
 /// update fragments for document changes.
 class TreeFragment {
-    /// Construct a tree fragment.
+    /// Construct a tree fragment. You'll usually want to use
+    /// [`addTree`](#common.TreeFragment^addTree) and
+    /// [`applyChanges`](#common.TreeFragment^applyChanges) instead of
+    /// calling this directly.
     constructor(
     /// The start of the unchanged range pointed to by this fragment.
     /// This refers to an offset in the _updated_ document (as opposed
@@ -1423,11 +1431,6 @@ class StringInput {
 /// function, runs the resulting [inner parses](#common.NestedParse),
 /// and then [mounts](#common.NodeProp^mounted) their results onto the
 /// tree.
-///
-/// The nesting function is passed a cursor to provide context for a
-/// node, but _should not_ move that cursor, only inspect its
-/// properties and optionally access its
-/// [node object](#common.TreeCursor.node).
 function parseMixed(nest) {
     return (parse, input, fragments, ranges) => new MixedParse(parse, nest, input, fragments, ranges);
 }
@@ -1804,14 +1807,14 @@ function enterFragments(mounts, ranges) {
             for (let i = 0, pos = from;; i++) {
                 let last = i == changes.length, end = last ? to : changes[i].from;
                 if (end > pos)
-                    result.push(new TreeFragment(pos, end, mount.tree, -startPos, frag.from >= pos, frag.to <= end));
+                    result.push(new TreeFragment(pos, end, mount.tree, -startPos, frag.from >= pos || frag.openStart, frag.to <= end || frag.openEnd));
                 if (last)
                     break;
                 pos = changes[i].to;
             }
         }
         else {
-            result.push(new TreeFragment(from, to, mount.tree, -startPos, frag.from >= startPos, frag.to <= endPos));
+            result.push(new TreeFragment(from, to, mount.tree, -startPos, frag.from >= startPos || frag.openStart, frag.to <= endPos || frag.openEnd));
         }
     }
     return result;

package/dist/index.js

@@ -1,6 +1,6 @@
 // FIXME profile adding a per-Tree TreeNode cache, validating it by
 // parent pointer
-/// The default maximum length of a `TreeBuffer` node (1024).
+/// The default maximum length of a `TreeBuffer` node.
 const DefaultBufferLength = 1024;
 let nextPropID = 0;
 class Range {
@@ -63,7 +63,7 @@ NodeProp.contextHash = new NodeProp({ perNode: true });
 NodeProp.lookAhead = new NodeProp({ perNode: true });
 /// This per-node prop is used to replace a given node, or part of a
 /// node, with another tree. This is useful to include trees from
-/// different languages.
+/// different languages in mixed-language parsers.
 NodeProp.mounted = new NodeProp({ perNode: true });
 /// A mounted tree, which can be [stored](#common.NodeProp^mounted) on
 /// a tree node to indicate that parts of its content are
@@ -109,6 +109,7 @@ class NodeType {
         this.id = id;
         this.flags = flags;
     }
+    /// Define a node type.
     static define(spec) {
         let props = spec.props && spec.props.length ? Object.create(null) : noProps;
         let flags = (spec.top ? 1 /* Top */ : 0) | (spec.skipped ? 2 /* Skipped */ : 0) |
@@ -190,7 +191,7 @@ class NodeSet {
                 throw new RangeError("Node type ids should correspond to array positions when creating a node set");
     }
     /// Create a copy of this set with some node properties added. The
-    /// arguments to this method should be created with
+    /// arguments to this method can be created with
     /// [`NodeProp.add`](#common.NodeProp.add).
     extend(...props) {
         let newTypes = [];
@@ -316,6 +317,10 @@ class Tree {
     /// position. If 1, it'll move into nodes that start at the
     /// position. With 0, it'll only enter nodes that cover the position
     /// from both sides.
+    ///
+    /// Note that this will not enter
+    /// [overlays](#common.MountedTree.overlay), and you often want
+    /// [`resolveInner`](#common.Tree.resolveInner) instead.
     resolve(pos, side = 0) {
         let node = resolveNode(CachedNode.get(this) || this.topNode, pos, side, false);
         CachedNode.set(this, node);
@@ -400,7 +405,7 @@ class FlatBufferCursor {
 /// Tree buffers contain (type, start, end, endIndex) quads for each
 /// node. In such a buffer, nodes are stored in prefix order (parents
 /// before children, with the endIndex of the parent indicating which
-/// children belong to it)
+/// children belong to it).
 class TreeBuffer {
     /// Create a tree buffer.
     constructor(
@@ -1304,7 +1309,10 @@ class NodeWeakMap {
 /// [`applyChanges`](#common.TreeFragment^applyChanges) method to
 /// update fragments for document changes.
 class TreeFragment {
-    /// Construct a tree fragment.
+    /// Construct a tree fragment. You'll usually want to use
+    /// [`addTree`](#common.TreeFragment^addTree) and
+    /// [`applyChanges`](#common.TreeFragment^applyChanges) instead of
+    /// calling this directly.
     constructor(
     /// The start of the unchanged range pointed to by this fragment.
     /// This refers to an offset in the _updated_ document (as opposed
@@ -1419,11 +1427,6 @@ class StringInput {
 /// function, runs the resulting [inner parses](#common.NestedParse),
 /// and then [mounts](#common.NodeProp^mounted) their results onto the
 /// tree.
-///
-/// The nesting function is passed a cursor to provide context for a
-/// node, but _should not_ move that cursor, only inspect its
-/// properties and optionally access its
-/// [node object](#common.TreeCursor.node).
 function parseMixed(nest) {
     return (parse, input, fragments, ranges) => new MixedParse(parse, nest, input, fragments, ranges);
 }
@@ -1800,14 +1803,14 @@ function enterFragments(mounts, ranges) {
             for (let i = 0, pos = from;; i++) {
                 let last = i == changes.length, end = last ? to : changes[i].from;
                 if (end > pos)
-                    result.push(new TreeFragment(pos, end, mount.tree, -startPos, frag.from >= pos, frag.to <= end));
+                    result.push(new TreeFragment(pos, end, mount.tree, -startPos, frag.from >= pos || frag.openStart, frag.to <= end || frag.openEnd));
                 if (last)
                     break;
                 pos = changes[i].to;
             }
         }
         else {
-            result.push(new TreeFragment(from, to, mount.tree, -startPos, frag.from >= startPos, frag.to <= endPos));
+            result.push(new TreeFragment(from, to, mount.tree, -startPos, frag.from >= startPos || frag.openStart, frag.to <= endPos || frag.openEnd));
         }
     }
     return result;

package/dist/tree.d.ts

@@ -127,6 +127,7 @@ export interface SyntaxNodeRef {
     readonly name: string;
     readonly tree: Tree | null;
     readonly node: SyntaxNode;
+    matchContext(context: readonly string[]): boolean;
 }
 export interface SyntaxNode extends SyntaxNodeRef {
     parent: SyntaxNode | null;
@@ -170,9 +171,9 @@ export declare class TreeNode implements SyntaxNode {
     childBefore(pos: number): TreeNode | BufferNode;
     enter(pos: number, side: -1 | 0 | 1, mode?: number): TreeNode | BufferNode;
     nextSignificantParent(): TreeNode;
-    get parent(): TreeNode;
-    get nextSibling(): TreeNode | BufferNode;
-    get prevSibling(): TreeNode | BufferNode;
+    get parent(): TreeNode | null;
+    get nextSibling(): SyntaxNode | null;
+    get prevSibling(): SyntaxNode | null;
     cursor(mode?: IterMode): TreeCursor;
     get tree(): Tree;
     toTree(): Tree;
@@ -206,7 +207,7 @@ declare class BufferNode implements SyntaxNode {
     childAfter(pos: number): BufferNode;
     childBefore(pos: number): BufferNode;
     enter(pos: number, side: -1 | 0 | 1, mode?: IterMode): BufferNode;
-    get parent(): TreeNode | BufferNode;
+    get parent(): SyntaxNode | null;
     externalSibling(dir: 1 | -1): TreeNode | BufferNode;
     get nextSibling(): SyntaxNode | null;
     get prevSibling(): SyntaxNode | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lezer/common",
-  "version": "0.16.0",
+  "version": "1.0.1",
   "description": "Syntax tree data structure and parser interfaces for the lezer parser",
   "main": "dist/index.cjs",
   "type": "module",