codemirror-lang-dimacs 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2026 by Johannes Schuster <johannes.c.schuster@proton.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/NOTICE

@@ -0,0 +1,8 @@
+lang-dimacs is licensed under the MIT licence in LICENSE.
+
+The Lezer grammar (dimacs.grammar) and the tests are written by hand. What they accept
+was worked out by reading the DIMACS and solution parser of CaDiCaL
+(https://github.com/arminbiere/cadical, src/parse.cpp; version and checksum in
+spec/SOURCE of the lang-dimacs repository), which is MIT-licensed, Copyright (c) Armin
+Biere and others. No CaDiCaL code is copied. CaDiCaL itself is used only as a test
+oracle and is not distributed.

package/README.md

@@ -1,3 +1,79 @@
-# Temporary Holding Version
+# codemirror-lang-dimacs
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+DIMACS CNF language support for [CodeMirror 6](https://codemirror.net/): a Lezer parser
+for the dialects that [CaDiCaL](https://github.com/arminbiere/cadical) reads, with
+highlighting.
+
+```js
+import {EditorView, basicSetup} from "codemirror"
+import {dimacs} from "codemirror-lang-dimacs"
+
+new EditorView({extensions: [basicSetup, dimacs()], parent: document.body})
+```
+
+For solver output in the SAT competition format (`s` and `v` lines), configure the
+second top rule:
+
+```js
+import {LanguageSupport} from "@codemirror/language"
+import {dimacsLanguage} from "codemirror-lang-dimacs"
+
+new LanguageSupport(dimacsLanguage.configure({top: "Solution"}))
+```
+
+## Scope
+
+- `p cnf <max-var> <num-clauses>` and `p inccnf` files, with comments and, after the
+  clauses, cubes (`a <literals> 0`).
+- Solutions: comments, one status line `s SATISFIABLE`, `s UNSATISFIABLE` or `s UNKNOWN`,
+  then `v` lines.
+
+Not covered: `p sat`, WCNF, QDIMACS, XOR lines, `p knf`. CaDiCaL rejects every problem
+line but `p cnf` and `p inccnf`.
+
+The parser is permissive: it accepts any white space (space, tab, CR, LF) in the problem
+line, cubes after a `p cnf` header, and header counts that do not match the body.
+Checking those is left to a linter; this package has none.
+
+## What CaDiCaL accepts
+
+Read from `src/parse.cpp` of CaDiCaL 3.0.1 (source and checksum in `spec/SOURCE` of the
+repository) and checked against its `cadical` binary with the files in `fixtures/`.
+
+1. Before the problem line, lines starting with `c` are comments, and white space
+   (space, tab, CR, LF) before them is skipped. A header comment must end with a newline.
+2. In a header comment, the text from the first `-` to the end of the line is passed to
+   CaDiCaL as an option; only `--name[=value]` takes effect. Comments after the problem
+   line are not read for options.
+3. Problem line: `p cnf <max-var> <num-clauses>`, or `p inccnf` without numbers, ended by
+   a newline. Between `p` and the format any spaces and tabs; between the format and the
+   numbers any white space (C `isspace`), newlines included. (`--strict` demands single spaces.)
+4. In the body, space, tab, CR and LF separate tokens. A literal is an optional `-` and
+   digits, followed by white space, end of file or `c`. Leading zeros are allowed: `007`
+   is `7`, and `0`, `00` and `-0` all end a clause. Clauses may span lines and share
+   them.
+5. `c` at the start of a token starts a comment to the end of the line, also directly
+   after a literal (`1 -2 0c note`).
+6. `p inccnf` only: the first `a` at the start of a token ends the clauses. Each cube is
+   `a`, literals, `0`; an `a` before that `0` is an error. After a cube's `0` only white
+   space, another `a` or the end of the file may follow, and a comment only if it runs to
+   the end of the file.
+7. `a` in a `p cnf` file is an error.
+8. Unless `--force` is given, the clause count must match and no literal may exceed
+   `<max-var>`.
+9. A solution (`cadical -r`) is: lines starting with `c`, then exactly `s SATISFIABLE`,
+   then lines starting with `v ` holding literals, the last ended by `0`. A comment
+   directly after a literal is an error there. The `cadical` binary itself prints
+   `s SATISFIABLE`, `s UNSATISFIABLE` or `c UNKNOWN`, and exits with 10, 20 or 0.
+
+## Hand-written files
+
+Every source file is hand-written; nothing is generated:
+
+- `src/dimacs.grammar`, `src/dimacs.grammar.d.ts`
+- `src/highlight.ts`, `src/index.ts`
+- `test/dimacs.txt`, `test/solution.txt`, `test/test.js`, `test/fixtures.js`
+- `rollup.config.js`, `tsconfig.json`
+
+The parser in `dist/` is generated from `src/dimacs.grammar` by `@lezer/generator` when
+the package is built.

package/dist/highlight.d.ts

@@ -0,0 +1,2 @@
+import type { NodePropSource } from "@lezer/common";
+export declare const dimacsHighlighting: NodePropSource;

package/dist/index.cjs

@@ -0,0 +1,50 @@
+'use strict';
+
+var lr = require('@lezer/lr');
+var highlight = require('@lezer/highlight');
+var language = require('@codemirror/language');
+
+const dimacsHighlighting = highlight.styleTags({
+    LineComment: highlight.tags.lineComment,
+    "p CubeMarker s v": highlight.tags.keyword,
+    Format: highlight.tags.typeName,
+    Number: highlight.tags.number,
+    PositiveLiteral: highlight.tags.variableName,
+    NegativeLiteral: highlight.tags.special(highlight.tags.variableName),
+    Terminator: highlight.tags.separator,
+    Status: highlight.tags.bool,
+});
+
+// This file was generated by lezer-generator. You probably shouldn't edit it.
+const parser = lr.LRParser.deserialize({
+  version: 14,
+  states: "%dO_QPOOOdQPOOOiYQO'#C_QqQPOOO!PQPO'#CkQ!UQPOOO!ZYQO,58yOOQO,58y,58yOOQO'#Cx'#CxOOQO'#Cq'#CqO!`QPO'#CdOOQO'#Cd'#CdOOQO'#Cp'#CpQqQPOOO!kQPO'#ChOOQO'#Cr'#CrQzQPOOOOQO,59V,59VO!vQPO'#CnOOQO'#Cs'#CsQ!UQPOOO#XYQO1G.eOOQO-E6o-E6oOOQO,59O,59OOOQO-E6n-E6nO#^QPO,59SOOQO,59S,59SOOQO-E6p-E6pO#iQPO,59YOOQO,59Y,59YOOQO-E6q-E6qOOQO7+$P7+$POOQO1G.n1G.nOOQO1G.t1G.t",
+  stateData: "$O~OkOSPOS~OkOS~OSQO~O`SO~OTUOVVO~OXWOYWOZZO]^O~OaaO~OcbO~OUeO~OXWOYWOZgO~OXWOYWOZjO~OXWOYWOZmOcbXhbX~OUoO~OXWOYWOZpO~OXWOYWOZqOcbahba~OXYZ~",
+  goto: "#OmPPPnPPPPqPPPuPPzPP}P!R!X!h!oPPPP!uRROT[R]V_R]`RTPTcTdQ]RRh]SYR]UfYilQi^RlbS`R]Rk`QdTRnd_XRY]^bil",
+  nodeNames: "⚠ LineComment Dimacs ProblemLine p Format Number Format Clause PositiveLiteral NegativeLiteral Terminator Cube CubeMarker Solution StatusLine s Status ValueLine v",
+  maxTerm: 28,
+  propSources: [dimacsHighlighting],
+  skippedNodes: [0,1],
+  repeatNodeCount: 4,
+  tokenData: "(y~R_XY!QYZ!Q]^!Qpq!Q}!O!c!Q!R#P!R![#^!u!v#h!w!x${#T#U%t#V#W%y#]#^'u#d#e(j#g#h(o#j#k(t~!VSk~XY!QYZ!Q]^!Qpq!Q~!fQ!Q!R!l!R![!w~!qQZP!Q!R!l!R![!w~!|PY~!Q![!wR#WQUQZP!Q!R#P!R![#^R#ePUQXP!Q![#^~#kP!c!d#n~#qP!v!w#t~#wP!k!l#z~#}P!u!v$Q~$TP!h!i$W~$ZP!k!l$^~$aP!c!d$d~$gP!d!e$j~$mP!n!o$p~$sP!g!h$v~${Oa~~%OP!p!q%R~%UQ!m!n%[!u!v#h~%_P!p!q%b~%eP!q!r%h~%kP!y!z%n~%qP!p!q$v~%yO]~R&OUPPOY&bZ#b&b#b#c&y#c;'S&b;'S;=`&s<%lO&bP&gSPPOY&bZ;'S&b;'S;=`&s<%lO&bP&vP;=`<%l&bR'OUPPOY&bZ#Y&b#Y#Z'b#Z;'S&b;'S;=`&s<%lO&bR'iSPPTQOY&bZ;'S&b;'S;=`&s<%lO&b~'xP#b#c'{~(OP#V#W(R~(UP#V#W(X~([P#b#c(_~(bP#Y#Z(e~(jOV~~(oOS~~(tO`~~(yOc~",
+  tokenizers: [0, 1],
+  topRules: {"Dimacs":[0,2],"Solution":[1,14]},
+  tokenPrec: 134
+});
+
+/// DIMACS CNF as CaDiCaL reads it (`p cnf` and `p inccnf`). For solver output in the
+/// competition format, use `dimacsLanguage.configure({top: "Solution"})`.
+const dimacsLanguage = language.LRLanguage.define({
+    name: "dimacs",
+    parser,
+    languageData: {
+        commentTokens: { line: "c" },
+    },
+});
+/// DIMACS language support for CodeMirror.
+function dimacs() {
+    return new language.LanguageSupport(dimacsLanguage);
+}
+
+exports.dimacs = dimacs;
+exports.dimacsLanguage = dimacsLanguage;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { LRLanguage, LanguageSupport } from "@codemirror/language";
+export declare const dimacsLanguage: LRLanguage;
+export declare function dimacs(): LanguageSupport;

package/dist/index.js

@@ -0,0 +1,47 @@
+import { LRParser } from '@lezer/lr';
+import { styleTags, tags } from '@lezer/highlight';
+import { LRLanguage, LanguageSupport } from '@codemirror/language';
+
+const dimacsHighlighting = styleTags({
+    LineComment: tags.lineComment,
+    "p CubeMarker s v": tags.keyword,
+    Format: tags.typeName,
+    Number: tags.number,
+    PositiveLiteral: tags.variableName,
+    NegativeLiteral: tags.special(tags.variableName),
+    Terminator: tags.separator,
+    Status: tags.bool,
+});
+
+// This file was generated by lezer-generator. You probably shouldn't edit it.
+const parser = LRParser.deserialize({
+  version: 14,
+  states: "%dO_QPOOOdQPOOOiYQO'#C_QqQPOOO!PQPO'#CkQ!UQPOOO!ZYQO,58yOOQO,58y,58yOOQO'#Cx'#CxOOQO'#Cq'#CqO!`QPO'#CdOOQO'#Cd'#CdOOQO'#Cp'#CpQqQPOOO!kQPO'#ChOOQO'#Cr'#CrQzQPOOOOQO,59V,59VO!vQPO'#CnOOQO'#Cs'#CsQ!UQPOOO#XYQO1G.eOOQO-E6o-E6oOOQO,59O,59OOOQO-E6n-E6nO#^QPO,59SOOQO,59S,59SOOQO-E6p-E6pO#iQPO,59YOOQO,59Y,59YOOQO-E6q-E6qOOQO7+$P7+$POOQO1G.n1G.nOOQO1G.t1G.t",
+  stateData: "$O~OkOSPOS~OkOS~OSQO~O`SO~OTUOVVO~OXWOYWOZZO]^O~OaaO~OcbO~OUeO~OXWOYWOZgO~OXWOYWOZjO~OXWOYWOZmOcbXhbX~OUoO~OXWOYWOZpO~OXWOYWOZqOcbahba~OXYZ~",
+  goto: "#OmPPPnPPPPqPPPuPPzPP}P!R!X!h!oPPPP!uRROT[R]V_R]`RTPTcTdQ]RRh]SYR]UfYilQi^RlbS`R]Rk`QdTRnd_XRY]^bil",
+  nodeNames: "⚠ LineComment Dimacs ProblemLine p Format Number Format Clause PositiveLiteral NegativeLiteral Terminator Cube CubeMarker Solution StatusLine s Status ValueLine v",
+  maxTerm: 28,
+  propSources: [dimacsHighlighting],
+  skippedNodes: [0,1],
+  repeatNodeCount: 4,
+  tokenData: "(y~R_XY!QYZ!Q]^!Qpq!Q}!O!c!Q!R#P!R![#^!u!v#h!w!x${#T#U%t#V#W%y#]#^'u#d#e(j#g#h(o#j#k(t~!VSk~XY!QYZ!Q]^!Qpq!Q~!fQ!Q!R!l!R![!w~!qQZP!Q!R!l!R![!w~!|PY~!Q![!wR#WQUQZP!Q!R#P!R![#^R#ePUQXP!Q![#^~#kP!c!d#n~#qP!v!w#t~#wP!k!l#z~#}P!u!v$Q~$TP!h!i$W~$ZP!k!l$^~$aP!c!d$d~$gP!d!e$j~$mP!n!o$p~$sP!g!h$v~${Oa~~%OP!p!q%R~%UQ!m!n%[!u!v#h~%_P!p!q%b~%eP!q!r%h~%kP!y!z%n~%qP!p!q$v~%yO]~R&OUPPOY&bZ#b&b#b#c&y#c;'S&b;'S;=`&s<%lO&bP&gSPPOY&bZ;'S&b;'S;=`&s<%lO&bP&vP;=`<%l&bR'OUPPOY&bZ#Y&b#Y#Z'b#Z;'S&b;'S;=`&s<%lO&bR'iSPPTQOY&bZ;'S&b;'S;=`&s<%lO&b~'xP#b#c'{~(OP#V#W(R~(UP#V#W(X~([P#b#c(_~(bP#Y#Z(e~(jOV~~(oOS~~(tO`~~(yOc~",
+  tokenizers: [0, 1],
+  topRules: {"Dimacs":[0,2],"Solution":[1,14]},
+  tokenPrec: 134
+});
+
+/// DIMACS CNF as CaDiCaL reads it (`p cnf` and `p inccnf`). For solver output in the
+/// competition format, use `dimacsLanguage.configure({top: "Solution"})`.
+const dimacsLanguage = LRLanguage.define({
+    name: "dimacs",
+    parser,
+    languageData: {
+        commentTokens: { line: "c" },
+    },
+});
+/// DIMACS language support for CodeMirror.
+function dimacs() {
+    return new LanguageSupport(dimacsLanguage);
+}
+
+export { dimacs, dimacsLanguage };

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "codemirror-lang-dimacs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "keywords": [
+    "codemirror",
+    "lezer",
+    "dimacs",
+    "sat"
+  ],
+  "description": "DIMACS CNF language support for CodeMirror, as read by CaDiCaL",
+  "scripts": {
+    "test": "mocha test/test.js test/fixtures.js",
+    "build": "rollup -c && tsc -p tsconfig.json --declaration --emitDeclarationOnly --outDir dist",
+    "prepare": "pnpm run build"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@codemirror/language": "^6.0.0",
+    "@lezer/common": "^1.5.3",
+    "@lezer/highlight": "^1.0.0",
+    "@lezer/lr": "^1.0.0"
+  },
+  "devDependencies": {
+    "@lezer/generator": "^1.0.0",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@types/node": "^26.0.0",
+    "mocha": "^11.7.1",
+    "rollup": "^4.45.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jcschuster/lang-dimacs.git",
+    "directory": "packages/codemirror-lang-dimacs"
+  },
+  "license": "MIT"
+}