@codemirror/language 6.5.0 → 6.7.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 6.7.0 (2023-05-19)
+
+### New features
+
+Export `DocInput` class for feeding editor documents to a Lezer parser.
+
+## 6.6.0 (2023-02-13)
+
+### New features
+
+Syntax-driven language data queries now support sublanguages, which make it possible to return different data for specific parts of the tree produced by a single language.
+
 ## 6.5.0 (2023-02-07)
 
 ### Bug fixes

package/dist/index.cjs

@@ -28,6 +28,11 @@ function defineLanguageFacet(baseData) {
     });
 }
 /**
+Syntax node prop used to register sublanguages. Should be added to
+the top level node type for the language.
+*/
+const sublanguageProp = new common.NodeProp();
+/**
 A language object manages parsing and per-language
 [metadata](https://codemirror.net/6/docs/ref/#state.EditorState.languageDataAt). Parse data is
 managed as a [Lezer](https://lezer.codemirror.net) tree. The class
@@ -64,14 +69,28 @@ class Language {
         this.parser = parser;
         this.extension = [
             language.of(this),
-            state.EditorState.languageData.of((state, pos, side) => state.facet(languageDataFacetAt(state, pos, side)))
+            state.EditorState.languageData.of((state, pos, side) => {
+                let top = topNodeAt(state, pos, side), data = top.type.prop(languageDataProp);
+                if (!data)
+                    return [];
+                let base = state.facet(data), sub = top.type.prop(sublanguageProp);
+                if (sub) {
+                    let innerNode = top.resolve(pos - top.from, side);
+                    for (let sublang of sub)
+                        if (sublang.test(innerNode, state)) {
+                            let data = state.facet(sublang.facet);
+                            return sublang.type == "replace" ? data : data.concat(base);
+                        }
+                }
+                return base;
+            })
         ].concat(extraExtensions);
     }
     /**
     Query whether this language is active at the given position.
     */
     isActiveAt(state, pos, side = -1) {
-        return languageDataFacetAt(state, pos, side) == this.data;
+        return topNodeAt(state, pos, side).type.prop(languageDataProp) == this.data;
     }
     /**
     Find the document regions that were parsed using this language.
@@ -126,16 +145,14 @@ class Language {
 @internal
 */
 Language.setState = state.StateEffect.define();
-function languageDataFacetAt(state, pos, side) {
-    let topLang = state.facet(language);
-    if (!topLang)
-        return null;
-    let facet = topLang.data;
-    if (topLang.allowsNesting) {
-        for (let node = syntaxTree(state).topNode; node; node = node.enter(pos, side, common.IterMode.ExcludeBuffers))
-            facet = node.type.prop(languageDataProp) || facet;
+function topNodeAt(state, pos, side) {
+    let topLang = state.facet(language), tree = syntaxTree(state).topNode;
+    if (!topLang || topLang.allowsNesting) {
+        for (let node = tree; node; node = node.enter(pos, side, common.IterMode.ExcludeBuffers))
+            if (node.type.isTop)
+                tree = node;
     }
-    return facet;
+    return tree;
 }
 /**
 A subclass of [`Language`](https://codemirror.net/6/docs/ref/#language.Language) for use with Lezer
@@ -227,8 +244,15 @@ 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.
+/**
+Lezer-style
+[`Input`](https://lezer.codemirror.net/docs/ref#common.Input)
+object for a [`Text`](https://codemirror.net/6/docs/ref/#state.Text) object.
+*/
 class DocInput {
+    /**
+    Create an input object for the given document.
+    */
     constructor(doc) {
         this.doc = doc;
         this.cursorPos = 0;
@@ -2463,6 +2487,7 @@ function docID(data) {
     return type;
 }
 
+exports.DocInput = DocInput;
 exports.HighlightStyle = HighlightStyle;
 exports.IndentContext = IndentContext;
 exports.LRLanguage = LRLanguage;
@@ -2506,6 +2531,7 @@ exports.indentUnit = indentUnit;
 exports.language = language;
 exports.languageDataProp = languageDataProp;
 exports.matchBrackets = matchBrackets;
+exports.sublanguageProp = sublanguageProp;
 exports.syntaxHighlighting = syntaxHighlighting;
 exports.syntaxParserRunning = syntaxParserRunning;
 exports.syntaxTree = syntaxTree;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { NodeProp, Parser, Tree, TreeFragment, SyntaxNode, NodeType } from '@lezer/common';
+import { NodeProp, SyntaxNode, Parser, Tree, Input, TreeFragment, NodeType } from '@lezer/common';
 import { LRParser, ParserConfig } from '@lezer/lr';
 import * as _codemirror_state from '@codemirror/state';
-import { Facet, Extension, EditorState, StateField, Range } from '@codemirror/state';
+import { Facet, EditorState, Extension, Text, StateField, Range } from '@codemirror/state';
 import { EditorView, DecorationSet, Command, KeyBinding, ViewUpdate, BlockInfo, Decoration } from '@codemirror/view';
 import { Highlighter, Tag } from '@lezer/highlight';
 import { StyleModule, StyleSpec } from 'style-mod';
@@ -31,6 +31,44 @@ declare function defineLanguageFacet(baseData?: {
     [name: string]: any;
 }[]>;
 /**
+Some languages need to return different [language
+data](https://codemirror.net/6/docs/ref/#state.EditorState.languageDataAt) for some parts of their
+tree. Sublanguages, registered by adding a [node
+prop](https://codemirror.net/6/docs/ref/#language.sublanguageProp) to the language's top syntax
+node, provide a mechanism to do this.
+
+(Note that when using nested parsing, where nested syntax is
+parsed by a different parser and has its own top node type, you
+don't need a sublanguage.)
+*/
+interface Sublanguage {
+    /**
+    Determines whether the data provided by this sublanguage should
+    completely replace the regular data or be added to it (with
+    higher-precedence). The default is `"extend"`.
+    */
+    type?: "replace" | "extend";
+    /**
+    A predicate that returns whether the node at the queried
+    position is part of the sublanguage.
+    */
+    test: (node: SyntaxNode, state: EditorState) => boolean;
+    /**
+    The language data facet that holds the sublanguage's data.
+    You'll want to use
+    [`defineLanguageFacet`](https://codemirror.net/6/docs/ref/#language.defineLanguageFacet) to create
+    this.
+    */
+    facet: Facet<{
+        [name: string]: any;
+    }>;
+}
+/**
+Syntax node prop used to register sublanguages. Should be added to
+the top level node type for the language.
+*/
+declare const sublanguageProp: NodeProp<Sublanguage[]>;
+/**
 A language object manages parsing and per-language
 [metadata](https://codemirror.net/6/docs/ref/#state.EditorState.languageDataAt). Parse data is
 managed as a [Lezer](https://lezer.codemirror.net) tree. The class
@@ -174,6 +212,26 @@ is no language parser enabled.
 */
 declare function syntaxParserRunning(view: EditorView): boolean;
 /**
+Lezer-style
+[`Input`](https://lezer.codemirror.net/docs/ref#common.Input)
+object for a [`Text`](https://codemirror.net/6/docs/ref/#state.Text) object.
+*/
+declare class DocInput implements Input {
+    readonly doc: Text;
+    private cursor;
+    private cursorPos;
+    private string;
+    /**
+    Create an input object for the given document.
+    */
+    constructor(doc: Text);
+    get length(): number;
+    private syncTo;
+    chunk(pos: number): string;
+    get lineChunks(): boolean;
+    read(from: number, to: number): string;
+}
+/**
 A parse context provided to parsers working on the editor content.
 */
 declare class ParseContext {
@@ -626,7 +684,7 @@ declare function foldable(state: EditorState, lineStart: number, lineEnd: number
     from: number;
     to: number;
 } | null;
-declare type DocRange = {
+type DocRange = {
     from: number;
     to: number;
 };
@@ -714,7 +772,7 @@ interface FoldConfig {
 Create an extension that configures code folding.
 */
 declare function codeFolding(config?: FoldConfig): Extension;
-declare type Handlers = {
+type Handlers = {
     [event: string]: (view: EditorView, line: BlockInfo, event: Event) => boolean;
 };
 interface FoldGutterConfig {
@@ -1119,4 +1177,4 @@ declare class StreamLanguage<State> extends Language {
     get allowsNesting(): boolean;
 }
 
-export { Config, HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, MatchResult, ParseContext, StreamLanguage, StreamParser, StringStream, TagStyle, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, toggleFold, unfoldAll, unfoldCode, unfoldEffect };
+export { Config, DocInput, HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, MatchResult, ParseContext, StreamLanguage, StreamParser, StringStream, Sublanguage, TagStyle, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, sublanguageProp, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, toggleFold, unfoldAll, unfoldCode, unfoldEffect };

package/dist/index.js

@@ -24,6 +24,11 @@ function defineLanguageFacet(baseData) {
     });
 }
 /**
+Syntax node prop used to register sublanguages. Should be added to
+the top level node type for the language.
+*/
+const sublanguageProp = /*@__PURE__*/new NodeProp();
+/**
 A language object manages parsing and per-language
 [metadata](https://codemirror.net/6/docs/ref/#state.EditorState.languageDataAt). Parse data is
 managed as a [Lezer](https://lezer.codemirror.net) tree. The class
@@ -60,14 +65,28 @@ class Language {
         this.parser = parser;
         this.extension = [
             language.of(this),
-            EditorState.languageData.of((state, pos, side) => state.facet(languageDataFacetAt(state, pos, side)))
+            EditorState.languageData.of((state, pos, side) => {
+                let top = topNodeAt(state, pos, side), data = top.type.prop(languageDataProp);
+                if (!data)
+                    return [];
+                let base = state.facet(data), sub = top.type.prop(sublanguageProp);
+                if (sub) {
+                    let innerNode = top.resolve(pos - top.from, side);
+                    for (let sublang of sub)
+                        if (sublang.test(innerNode, state)) {
+                            let data = state.facet(sublang.facet);
+                            return sublang.type == "replace" ? data : data.concat(base);
+                        }
+                }
+                return base;
+            })
         ].concat(extraExtensions);
     }
     /**
     Query whether this language is active at the given position.
     */
     isActiveAt(state, pos, side = -1) {
-        return languageDataFacetAt(state, pos, side) == this.data;
+        return topNodeAt(state, pos, side).type.prop(languageDataProp) == this.data;
     }
     /**
     Find the document regions that were parsed using this language.
@@ -122,16 +141,14 @@ class Language {
 @internal
 */
 Language.setState = /*@__PURE__*/StateEffect.define();
-function languageDataFacetAt(state, pos, side) {
-    let topLang = state.facet(language);
-    if (!topLang)
-        return null;
-    let facet = topLang.data;
-    if (topLang.allowsNesting) {
-        for (let node = syntaxTree(state).topNode; node; node = node.enter(pos, side, IterMode.ExcludeBuffers))
-            facet = node.type.prop(languageDataProp) || facet;
+function topNodeAt(state, pos, side) {
+    let topLang = state.facet(language), tree = syntaxTree(state).topNode;
+    if (!topLang || topLang.allowsNesting) {
+        for (let node = tree; node; node = node.enter(pos, side, IterMode.ExcludeBuffers))
+            if (node.type.isTop)
+                tree = node;
     }
-    return facet;
+    return tree;
 }
 /**
 A subclass of [`Language`](https://codemirror.net/6/docs/ref/#language.Language) for use with Lezer
@@ -223,8 +240,15 @@ 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.
+/**
+Lezer-style
+[`Input`](https://lezer.codemirror.net/docs/ref#common.Input)
+object for a [`Text`](https://codemirror.net/6/docs/ref/#state.Text) object.
+*/
 class DocInput {
+    /**
+    Create an input object for the given document.
+    */
     constructor(doc) {
         this.doc = doc;
         this.cursorPos = 0;
@@ -2459,4 +2483,4 @@ function docID(data) {
     return type;
 }
 
-export { HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, StreamLanguage, StringStream, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, toggleFold, unfoldAll, unfoldCode, unfoldEffect };
+export { DocInput, HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, StreamLanguage, StringStream, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, sublanguageProp, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, toggleFold, unfoldAll, unfoldCode, unfoldEffect };

package/package.json

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