@codemirror/language 0.19.4 → 0.19.5

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.19.5 (2021-11-17)
+
+### New features
+
+The new function `syntaxTreeAvailable` can be used to check if a fully-parsed syntax tree is available up to a given document position.
+
+The module now exports `syntaxParserRunning`, which tells you whether the background parser is still planning to do more work for a given editor view.
+
 ## 0.19.4 (2021-11-13)
 
 ### New features

package/dist/index.cjs

@@ -181,6 +181,30 @@ function ensureSyntaxTree(state, upto, timeout = 50) {
     let parse = (_a = state.field(Language.state, false)) === null || _a === void 0 ? void 0 : _a.context;
     return !parse ? null : parse.treeLen >= upto || parse.work(timeout, upto) ? parse.tree : null;
 }
+/**
+Queries whether there is a full syntax tree available up to the
+given document position. If there isn't, the background parse
+process _might_ still be working and update the tree further, but
+there is no guarantee of that—the parser will [stop
+working](https://codemirror.net/6/docs/ref/#language.syntaxParserStopped) when it has spent a
+certain amount of time or has moved beyond the visible viewport.
+Always returns false if no language has been enabled.
+*/
+function syntaxTreeAvailable(state, upto = state.doc.length) {
+    var _a;
+    return ((_a = state.field(Language.state, false)) === null || _a === void 0 ? void 0 : _a.context.isDone(upto)) || false;
+}
+/**
+Tells you whether the language parser is planning to do more
+parsing work (in a `requestIdleCallback` pseudo-thread) or has
+stopped running, either because it parsed the entire document,
+because it spent too much time and was cut off, or because there
+is no language parser enabled.
+*/
+function syntaxParserRunning(view) {
+    var _a;
+    return ((_a = view.plugin(parseWorker)) === null || _a === void 0 ? void 0 : _a.isWorking()) || false;
+}
 // Lezer-style Input object for a Text document.
 class DocInput {
     constructor(doc, length = doc.length) {
@@ -491,6 +515,7 @@ const parseWorker = view.ViewPlugin.fromClass(class ParseWorker {
     constructor(view) {
         this.view = view;
         this.working = -1;
+        this.workScheduled = 0;
         // End of the current time chunk
         this.chunkEnd = -1;
         // Milliseconds of budget left for this chunk
@@ -541,7 +566,11 @@ const parseWorker = view.ViewPlugin.fromClass(class ParseWorker {
     }
     checkAsyncSchedule(cx) {
         if (cx.scheduleOn) {
-            cx.scheduleOn.then(() => this.scheduleWork());
+            this.workScheduled++;
+            cx.scheduleOn
+                .then(() => this.scheduleWork())
+                .catch(err => view.logException(this.view.state, err))
+                .then(() => this.workScheduled--);
             cx.scheduleOn = null;
         }
     }
@@ -549,6 +578,9 @@ const parseWorker = view.ViewPlugin.fromClass(class ParseWorker {
         if (this.working >= 0)
             cancelIdle(this.working);
     }
+    isWorking() {
+        return this.working >= 0 || this.workScheduled > 0;
+    }
 }, {
     eventHandlers: { focus() { this.scheduleWork(); } }
 });
@@ -1133,4 +1165,6 @@ exports.indentString = indentString;
 exports.indentUnit = indentUnit;
 exports.language = language;
 exports.languageDataProp = languageDataProp;
+exports.syntaxParserRunning = syntaxParserRunning;
 exports.syntaxTree = syntaxTree;
+exports.syntaxTreeAvailable = syntaxTreeAvailable;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { NodeProp, NodeType, Parser, Tree, TreeFragment, Input, PartialParse, SyntaxNode } from '@lezer/common';
 import { LRParser, ParserConfig } from '@lezer/lr';
 import { Facet, Extension, EditorState } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
 
 /**
 Node prop stored in a grammar's top syntax node to provide the
@@ -139,6 +140,24 @@ up to that point if the tree isn't already available.
 */
 declare function ensureSyntaxTree(state: EditorState, upto: number, timeout?: number): Tree | null;
 /**
+Queries whether there is a full syntax tree available up to the
+given document position. If there isn't, the background parse
+process _might_ still be working and update the tree further, but
+there is no guarantee of that—the parser will [stop
+working](https://codemirror.net/6/docs/ref/#language.syntaxParserStopped) when it has spent a
+certain amount of time or has moved beyond the visible viewport.
+Always returns false if no language has been enabled.
+*/
+declare function syntaxTreeAvailable(state: EditorState, upto?: number): boolean;
+/**
+Tells you whether the language parser is planning to do more
+parsing work (in a `requestIdleCallback` pseudo-thread) or has
+stopped running, either because it parsed the entire document,
+because it spent too much time and was cut off, or because there
+is no language parser enabled.
+*/
+declare function syntaxParserRunning(view: EditorView): boolean;
+/**
 A parse context provided to parsers working on the editor content.
 */
 declare class ParseContext {
@@ -590,4 +609,4 @@ declare function foldable(state: EditorState, lineStart: number, lineEnd: number
     to: number;
 } | null;
 
-export { IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, TreeIndentContext, continuedIndent, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldInside, foldNodeProp, foldService, foldable, getIndentUnit, getIndentation, indentNodeProp, indentOnInput, indentService, indentString, indentUnit, language, languageDataProp, syntaxTree };
+export { IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, TreeIndentContext, continuedIndent, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldInside, foldNodeProp, foldService, foldable, getIndentUnit, getIndentation, indentNodeProp, indentOnInput, indentService, indentString, indentUnit, language, languageDataProp, syntaxParserRunning, syntaxTree, syntaxTreeAvailable };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { NodeProp, Tree, TreeFragment, Parser, NodeType } from '@lezer/common';
 import { StateEffect, StateField, Facet, EditorState } from '@codemirror/state';
-import { ViewPlugin } from '@codemirror/view';
+import { ViewPlugin, logException } from '@codemirror/view';
 import { countColumn } from '@codemirror/text';
 
 /**
@@ -177,6 +177,30 @@ function ensureSyntaxTree(state, upto, timeout = 50) {
     let parse = (_a = state.field(Language.state, false)) === null || _a === void 0 ? void 0 : _a.context;
     return !parse ? null : parse.treeLen >= upto || parse.work(timeout, upto) ? parse.tree : null;
 }
+/**
+Queries whether there is a full syntax tree available up to the
+given document position. If there isn't, the background parse
+process _might_ still be working and update the tree further, but
+there is no guarantee of that—the parser will [stop
+working](https://codemirror.net/6/docs/ref/#language.syntaxParserStopped) when it has spent a
+certain amount of time or has moved beyond the visible viewport.
+Always returns false if no language has been enabled.
+*/
+function syntaxTreeAvailable(state, upto = state.doc.length) {
+    var _a;
+    return ((_a = state.field(Language.state, false)) === null || _a === void 0 ? void 0 : _a.context.isDone(upto)) || false;
+}
+/**
+Tells you whether the language parser is planning to do more
+parsing work (in a `requestIdleCallback` pseudo-thread) or has
+stopped running, either because it parsed the entire document,
+because it spent too much time and was cut off, or because there
+is no language parser enabled.
+*/
+function syntaxParserRunning(view) {
+    var _a;
+    return ((_a = view.plugin(parseWorker)) === null || _a === void 0 ? void 0 : _a.isWorking()) || false;
+}
 // Lezer-style Input object for a Text document.
 class DocInput {
     constructor(doc, length = doc.length) {
@@ -487,6 +511,7 @@ const parseWorker = /*@__PURE__*/ViewPlugin.fromClass(class ParseWorker {
     constructor(view) {
         this.view = view;
         this.working = -1;
+        this.workScheduled = 0;
         // End of the current time chunk
         this.chunkEnd = -1;
         // Milliseconds of budget left for this chunk
@@ -537,7 +562,11 @@ const parseWorker = /*@__PURE__*/ViewPlugin.fromClass(class ParseWorker {
     }
     checkAsyncSchedule(cx) {
         if (cx.scheduleOn) {
-            cx.scheduleOn.then(() => this.scheduleWork());
+            this.workScheduled++;
+            cx.scheduleOn
+                .then(() => this.scheduleWork())
+                .catch(err => logException(this.view.state, err))
+                .then(() => this.workScheduled--);
             cx.scheduleOn = null;
         }
     }
@@ -545,6 +574,9 @@ const parseWorker = /*@__PURE__*/ViewPlugin.fromClass(class ParseWorker {
         if (this.working >= 0)
             cancelIdle(this.working);
     }
+    isWorking() {
+        return this.working >= 0 || this.workScheduled > 0;
+    }
 }, {
     eventHandlers: { focus() { this.scheduleWork(); } }
 });
@@ -1104,4 +1136,4 @@ function foldable(state, lineStart, lineEnd) {
     return syntaxFolding(state, lineStart, lineEnd);
 }
 
-export { IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, TreeIndentContext, continuedIndent, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldInside, foldNodeProp, foldService, foldable, getIndentUnit, getIndentation, indentNodeProp, indentOnInput, indentService, indentString, indentUnit, language, languageDataProp, syntaxTree };
+export { IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, TreeIndentContext, continuedIndent, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldInside, foldNodeProp, foldService, foldable, getIndentUnit, getIndentation, indentNodeProp, indentOnInput, indentService, indentString, indentUnit, language, languageDataProp, syntaxParserRunning, syntaxTree, syntaxTreeAvailable };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/language",
-  "version": "0.19.4",
+  "version": "0.19.5",
   "description": "Language support infrastructure for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",