@termaxjs/editor-core 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +274 -0
- package/dist/buffer/PieceTable.d.ts +31 -0
- package/dist/buffer/PieceTable.d.ts.map +1 -0
- package/dist/buffer/PieceTable.js +365 -0
- package/dist/buffer/PieceTable.js.map +1 -0
- package/dist/buffer/TerminalBuffer.d.ts +45 -0
- package/dist/buffer/TerminalBuffer.d.ts.map +1 -0
- package/dist/buffer/TerminalBuffer.js +166 -0
- package/dist/buffer/TerminalBuffer.js.map +1 -0
- package/dist/collab/AwarenessState.d.ts +30 -0
- package/dist/collab/AwarenessState.d.ts.map +1 -0
- package/dist/collab/AwarenessState.js +76 -0
- package/dist/collab/AwarenessState.js.map +1 -0
- package/dist/collab/CollabProvider.d.ts +45 -0
- package/dist/collab/CollabProvider.d.ts.map +1 -0
- package/dist/collab/CollabProvider.js +153 -0
- package/dist/collab/CollabProvider.js.map +1 -0
- package/dist/coordinates.d.ts +132 -0
- package/dist/coordinates.d.ts.map +1 -0
- package/dist/coordinates.js +651 -0
- package/dist/coordinates.js.map +1 -0
- package/dist/decoration/Decoration.d.ts +36 -0
- package/dist/decoration/Decoration.d.ts.map +1 -0
- package/dist/decoration/Decoration.js +34 -0
- package/dist/decoration/Decoration.js.map +1 -0
- package/dist/decoration/DecorationSet.d.ts +16 -0
- package/dist/decoration/DecorationSet.d.ts.map +1 -0
- package/dist/decoration/DecorationSet.js +54 -0
- package/dist/decoration/DecorationSet.js.map +1 -0
- package/dist/diff/diff.d.ts +27 -0
- package/dist/diff/diff.d.ts.map +1 -0
- package/dist/diff/diff.js +219 -0
- package/dist/diff/diff.js.map +1 -0
- package/dist/index.d.ts +22 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +22 -0
- package/dist/index.js.map +1 -0
- package/dist/layout/HeightMap.d.ts +35 -0
- package/dist/layout/HeightMap.d.ts.map +1 -0
- package/dist/layout/HeightMap.js +95 -0
- package/dist/layout/HeightMap.js.map +1 -0
- package/dist/layout/softWrap.d.ts +23 -0
- package/dist/layout/softWrap.d.ts.map +1 -0
- package/dist/layout/softWrap.js +67 -0
- package/dist/layout/softWrap.js.map +1 -0
- package/dist/state/Annotation.d.ts +22 -0
- package/dist/state/Annotation.d.ts.map +1 -0
- package/dist/state/Annotation.js +38 -0
- package/dist/state/Annotation.js.map +1 -0
- package/dist/state/ChangeSet.d.ts +27 -0
- package/dist/state/ChangeSet.d.ts.map +1 -0
- package/dist/state/ChangeSet.js +162 -0
- package/dist/state/ChangeSet.js.map +1 -0
- package/dist/state/EditorState.d.ts +25 -0
- package/dist/state/EditorState.d.ts.map +1 -0
- package/dist/state/EditorState.js +110 -0
- package/dist/state/EditorState.js.map +1 -0
- package/dist/state/Extension.d.ts +16 -0
- package/dist/state/Extension.d.ts.map +1 -0
- package/dist/state/Extension.js +12 -0
- package/dist/state/Extension.js.map +1 -0
- package/dist/state/Facet.d.ts +13 -0
- package/dist/state/Facet.d.ts.map +1 -0
- package/dist/state/Facet.js +22 -0
- package/dist/state/Facet.js.map +1 -0
- package/dist/state/Keymap.d.ts +22 -0
- package/dist/state/Keymap.d.ts.map +1 -0
- package/dist/state/Keymap.js +10 -0
- package/dist/state/Keymap.js.map +1 -0
- package/dist/state/MultiCursorPaste.d.ts +14 -0
- package/dist/state/MultiCursorPaste.d.ts.map +1 -0
- package/dist/state/MultiCursorPaste.js +18 -0
- package/dist/state/MultiCursorPaste.js.map +1 -0
- package/dist/state/RectangularSelection.d.ts +12 -0
- package/dist/state/RectangularSelection.d.ts.map +1 -0
- package/dist/state/RectangularSelection.js +27 -0
- package/dist/state/RectangularSelection.js.map +1 -0
- package/dist/state/StateField.d.ts +18 -0
- package/dist/state/StateField.d.ts.map +1 -0
- package/dist/state/StateField.js +29 -0
- package/dist/state/StateField.js.map +1 -0
- package/dist/state/Transaction.d.ts +22 -0
- package/dist/state/Transaction.d.ts.map +1 -0
- package/dist/state/Transaction.js +23 -0
- package/dist/state/Transaction.js.map +1 -0
- package/dist/types.d.ts +161 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +6 -0
- package/dist/types.js.map +1 -0
- package/package.json +38 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 cmdworks
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,274 @@
|
|
|
1
|
+
# TermaxCore (`@termaxjs/core`) âš¡
|
|
2
|
+
|
|
3
|
+
> **A standalone, ultra-high-throughput text buffer and terminal streaming engine designed as a superior alternative to Ghostty Web and xterm.js.**
|
|
4
|
+
|
|
5
|
+
`@termaxjs/core` is a zero-dependency, headless, framework-agnostic TypeScript text and terminal streaming engine. It contains no DOM, no React, and no host I/O dependencies: it provides the pure mathematical data structures, coordinate systems, multi-tier buffers, layout engines, and CRDT synchronization primitives that high-performance code editors and terminal emulators rely on.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 🌟 Benchmark Scorecard
|
|
10
|
+
|
|
11
|
+
Measured against real repository source files on Apple Silicon (Node v24). Run via `pnpm bench:terminal` and `pnpm bench:editor`:
|
|
12
|
+
|
|
13
|
+
| Workload / Capability | TermaxCore | Ghostty Web *(Ring Engine)* | xterm.js *(v6)* | Margin |
|
|
14
|
+
|---|---|---|---|---|
|
|
15
|
+
| **5,000 Chunks Ingestion** | **0.40 ms** | 2.16 ms | 21.27 ms | **5.4x faster than Ghostty Web** (53x faster than xterm.js) |
|
|
16
|
+
| **Ingestion Throughput** | **1,792.5 MB/s** | 333.9 MB/s | 33.9 MB/s | **5.36x higher bandwidth** than Ghostty Web |
|
|
17
|
+
| **Packet Append Rate** | **12,447,608 chunks/s** | 2,318,500 chunks/s | 235,104 chunks/s | **5.37x faster packet rate** than Ghostty Web |
|
|
18
|
+
| **5,000 Random Reads (Scrollback)** | **0.73 ms** | 19.66 ms | 5.59 ms | **27x faster than Ghostty Web** (7.6x faster than xterm.js) |
|
|
19
|
+
| **Read Latency** | **0.15 µs / line** | 3.93 µs / line | 1.12 µs / line | Sub-microsecond scrollback inspection |
|
|
20
|
+
| **Typing Latency (10k-line Doc)** | **0.206 ms (206 µs)** | N/A *(stream only)* | N/A | **60x speedup** over legacy string joins |
|
|
21
|
+
| **Line Offset Mapping** | **0.09 µs / query** | N/A | N/A | $O(\log N)$ binary search on cached line starts |
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 📦 Installation
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
pnpm add @termaxjs/core
|
|
29
|
+
# or npm install @termaxjs/core
|
|
30
|
+
# or yarn add @termaxjs/core
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 🧮 Core Primitives Overview
|
|
36
|
+
|
|
37
|
+
| Primitive | Module | Purpose |
|
|
38
|
+
|---|---|---|
|
|
39
|
+
| **`TerminalBuffer`** | `buffer/TerminalBuffer.ts` | High-throughput terminal streaming engine with SIMD newline scanning, typed `Uint32Array` chunk-offset maps, and circular scrollback. Replaces Ghostty Web and xterm.js. |
|
|
40
|
+
| **`PieceTable`** | `buffer/PieceTable.ts` | Deterministic multi-tier edit buffer with consecutive typing coalescing, $O(1)$ tail appends, and single-cursor in-place array mutations. |
|
|
41
|
+
| **`coordinates.ts`** | `coordinates.ts` | UTF-16 code-unit coordinate conversions, selection algebra, multi-cursor insertions, word ranges, and surrogate-pair steps. |
|
|
42
|
+
| **`EditorState`** | `state/EditorState.ts` | Immutable state container managing document text, multi-cursors, extensions, facets, and state fields. |
|
|
43
|
+
| **`DecorationSet`** | `decoration/DecorationSet.ts` | Interval-tree based range decoration engine for token styling, diagnostics, line backgrounds, and widget insertions. |
|
|
44
|
+
| **`HeightMap`** | `layout/HeightMap.ts` | $O(\log N)$ layout calculation engine supporting variable line heights, code widgets, and soft wrapping. |
|
|
45
|
+
| **`CollabProvider`** | `collab/CollabProvider.ts` | Native CRDT collaboration engine with Lamport timestamps and peer awareness state. |
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## 🚀 How to Use TermaxCore
|
|
50
|
+
|
|
51
|
+
### 1. High-Throughput Terminal Streaming (Ghostty Web / xterm.js Alternative)
|
|
52
|
+
|
|
53
|
+
`TerminalBuffer` is designed for stdout streaming bursts (e.g., `pnpm install`, compilation streams, AI agent terminal output). It leverages V8 SIMD `memchr` (`indexOf("\n")`) and pre-allocated `Uint32Array` chunk tables:
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
import { TerminalBuffer } from "@termaxjs/core";
|
|
57
|
+
|
|
58
|
+
// 1. Initialize buffer with a 100,000-line circular scrollback limit
|
|
59
|
+
const terminal = new TerminalBuffer({
|
|
60
|
+
maxLines: 100_000,
|
|
61
|
+
initialCapacity: 65_536,
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
// 2. Stream incoming stdout/PTY packets directly into the buffer
|
|
65
|
+
// Achieves > 1.7 GB/s throughput (over 12,000,000 chunks/second)
|
|
66
|
+
terminal.write("\x1b[38;2;88;166;255m[2026-09-18T12:00:00Z]\x1b[0m \x1b[32m[INFO]\x1b[0m Build started...\n");
|
|
67
|
+
terminal.write("\x1b[33m[WARN]\x1b[0m High memory usage detected\n");
|
|
68
|
+
terminal.write("\x1b[32m[SUCCESS]\x1b[0m Compiled in 42ms\n");
|
|
69
|
+
|
|
70
|
+
// 3. Inspect buffer metrics
|
|
71
|
+
console.log("Total Lines:", terminal.lines); // 3
|
|
72
|
+
console.log("Total Bytes:", terminal.length); // Exact byte count
|
|
73
|
+
console.log("Chunk Count:", terminal.chunkCount); // Number of stored packets
|
|
74
|
+
|
|
75
|
+
// 4. Ultra-fast random line retrieval (0.15 µs latency)
|
|
76
|
+
const lineText = terminal.getLine(0);
|
|
77
|
+
console.log("Line 0:", lineText);
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
#### Key Advantages over Ghostty Web and xterm.js:
|
|
81
|
+
- **Zero Allocation on Non-Newline Chunks**: If a chunk contains no `\n`, it appends into the chunks array with zero line indexing overhead.
|
|
82
|
+
- **Pre-Allocated Typed Arrays**: Line starts are indexed in `Uint32Array` buffers (`lineChunkIndices`, `lineOffsetsInChunk`), completely avoiding object allocation and GC pauses.
|
|
83
|
+
- **Circular Scrollback Bounds**: When line count exceeds `maxLines`, older lines are trimmed using typed array `copyWithin`, preventing browser memory exhaustion.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
### 2. High-Performance Text Buffer (`PieceTable`)
|
|
88
|
+
|
|
89
|
+
`PieceTable` is the functional core for text editing. It guarantees sub-millisecond typing latency by avoiding whole-document string concatenation on sequential keystrokes:
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
import { PieceTable } from "@termaxjs/core";
|
|
93
|
+
|
|
94
|
+
// 1. Load initial document
|
|
95
|
+
const pt = new PieceTable("function greet(name: string): string {\n return 'Hello, ' + name;\n}");
|
|
96
|
+
|
|
97
|
+
console.log("Line Count:", pt.lineCount); // 2
|
|
98
|
+
console.log("Length:", pt.length); // 63
|
|
99
|
+
|
|
100
|
+
// 2. Sequential keystroke insertion
|
|
101
|
+
// Consecutive edits coalesce into the active piece, avoiding O(N^2) piece chain fragmentation
|
|
102
|
+
pt.insert(33, "\n console.log('Greeting requested');");
|
|
103
|
+
|
|
104
|
+
// 3. Delete range
|
|
105
|
+
pt.delete(0, 9); // removes "function "
|
|
106
|
+
|
|
107
|
+
// 4. Retrieve lines and full text
|
|
108
|
+
console.log("Line 1:", pt.getLine(1));
|
|
109
|
+
console.log("Full text:\n", pt.getText());
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
### 3. Bidirectional Coordinate Conversions & Multi-Cursor Transactions
|
|
115
|
+
|
|
116
|
+
All coordinates follow the UTF-16 code unit standard (matching JavaScript `string.length` and browser DOM selections):
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import { offsetToPosition, positionToOffset, applyMultiCursorInsert, type Cursor } from "@termaxjs/core";
|
|
120
|
+
|
|
121
|
+
const lines = [
|
|
122
|
+
"import { useState } from 'react';",
|
|
123
|
+
"const [count, setCount] = useState(0);",
|
|
124
|
+
"console.log(count);"
|
|
125
|
+
];
|
|
126
|
+
|
|
127
|
+
// Offset -> { line, column } (Binary search on cached line starts, 0.09 µs)
|
|
128
|
+
const pos = offsetToPosition(lines, 45);
|
|
129
|
+
console.log("Position:", pos); // { line: 1, column: 10 }
|
|
130
|
+
|
|
131
|
+
// { line, column } -> Character Offset
|
|
132
|
+
const offset = positionToOffset(lines, { line: 2, column: 8 });
|
|
133
|
+
console.log("Offset:", offset); // 80
|
|
134
|
+
|
|
135
|
+
// Multi-Cursor Bulk Edit
|
|
136
|
+
const cursors: Cursor[] = [
|
|
137
|
+
{ anchor: { line: 0, column: 0 }, head: { line: 0, column: 0 } },
|
|
138
|
+
{ anchor: { line: 1, column: 0 }, head: { line: 1, column: 0 } },
|
|
139
|
+
{ anchor: { line: 2, column: 0 }, head: { line: 2, column: 0 } },
|
|
140
|
+
];
|
|
141
|
+
|
|
142
|
+
// Single-cursor edits mutate lines in-place; multi-cursor merges ranges atomically
|
|
143
|
+
const newLines = applyMultiCursorInsert(lines, cursors, "// ");
|
|
144
|
+
console.log("Commented lines:\n", newLines.join("\n"));
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
### 4. Interval-Tree Range Decorations (`DecorationSet`)
|
|
150
|
+
|
|
151
|
+
`DecorationSet` manages syntax tokens, diagnostic squiggles, breakpoints, and inline widgets:
|
|
152
|
+
|
|
153
|
+
```ts
|
|
154
|
+
import { Decoration, DecorationSet } from "@termaxjs/core";
|
|
155
|
+
|
|
156
|
+
// Create decorations
|
|
157
|
+
const errorDeco = Decoration.mark({
|
|
158
|
+
class: "syntax-error-squiggle",
|
|
159
|
+
attributes: { "data-tooltip": "Unresolved variable" }
|
|
160
|
+
});
|
|
161
|
+
|
|
162
|
+
const widgetDeco = Decoration.widget({
|
|
163
|
+
widget: { toDOM: () => document.createElement("span") },
|
|
164
|
+
side: 1
|
|
165
|
+
});
|
|
166
|
+
|
|
167
|
+
// Build an interval decoration set
|
|
168
|
+
let decoSet = DecorationSet.create([
|
|
169
|
+
errorDeco.range(12, 18),
|
|
170
|
+
widgetDeco.range(35, 35),
|
|
171
|
+
]);
|
|
172
|
+
|
|
173
|
+
// Query decorations intersecting a visible viewport window [start, end]
|
|
174
|
+
decoSet.between(10, 30, (from, to, value) => {
|
|
175
|
+
console.log(`Decoration from ${from} to ${to}:`, value);
|
|
176
|
+
});
|
|
177
|
+
|
|
178
|
+
// Map decorations through a text edit transaction
|
|
179
|
+
decoSet = decoSet.map([
|
|
180
|
+
{ from: 0, to: 5, insert: "export " } // shift offsets by +2
|
|
181
|
+
]);
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
### 5. Variable Line Heights & Soft Wrapping (`HeightMap`)
|
|
187
|
+
|
|
188
|
+
For documents containing variable-height lines (such as wrapped text, inline images, code widgets, or diff hunks), `HeightMap` calculates line positions in $O(\log N)$ time:
|
|
189
|
+
|
|
190
|
+
```ts
|
|
191
|
+
import { HeightMap } from "@termaxjs/core";
|
|
192
|
+
|
|
193
|
+
// Initialize heightmap with default line height (e.g. 20px)
|
|
194
|
+
const heightMap = new HeightMap(10_000, 20);
|
|
195
|
+
|
|
196
|
+
// Add custom height overrides (e.g. multi-line diff banner on line 42)
|
|
197
|
+
heightMap.setLineHeight(42, 120);
|
|
198
|
+
|
|
199
|
+
// Query total scroll height
|
|
200
|
+
console.log("Total Height:", heightMap.totalHeight);
|
|
201
|
+
|
|
202
|
+
// Find line at a given vertical pixel offset (for mouse click / scroll targeting)
|
|
203
|
+
const lineAtScroll = heightMap.lineAtHeight(1540);
|
|
204
|
+
console.log("Target Line:", lineAtScroll);
|
|
205
|
+
|
|
206
|
+
// Get exact pixel Y position for a line
|
|
207
|
+
const lineTopY = heightMap.heightAtLine(42);
|
|
208
|
+
console.log("Line 42 top Y:", lineTopY);
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
### 6. CRDT Live Collaboration (`CollabProvider`)
|
|
214
|
+
|
|
215
|
+
`CollabProvider` provides conflict-free peer-to-peer or client-server synchronization:
|
|
216
|
+
|
|
217
|
+
```ts
|
|
218
|
+
import { CollabProvider, AwarenessManager } from "@termaxjs/core";
|
|
219
|
+
|
|
220
|
+
// 1. Initialize collaboration client
|
|
221
|
+
const collab = new CollabProvider("user-alice-uuid", (delta) => {
|
|
222
|
+
// Broadcast delta over WebSocket, WebRTC, or SSE
|
|
223
|
+
socket.send(JSON.stringify({ type: "collab_delta", delta }));
|
|
224
|
+
});
|
|
225
|
+
|
|
226
|
+
// 2. Local edit creates a synchronized change delta
|
|
227
|
+
collab.applyLocalEdit({ from: 10, to: 15, insert: "world" });
|
|
228
|
+
|
|
229
|
+
// 3. Receive remote delta from peer and merge cleanly
|
|
230
|
+
socket.onmessage = (event) => {
|
|
231
|
+
const message = JSON.parse(event.data);
|
|
232
|
+
if (message.type === "collab_delta") {
|
|
233
|
+
collab.applyRemoteDelta(message.delta);
|
|
234
|
+
}
|
|
235
|
+
};
|
|
236
|
+
|
|
237
|
+
// 4. Awareness: Broadcast cursor positions and usernames
|
|
238
|
+
const awareness = new AwarenessManager("user-alice-uuid", "Alice", "#58a6ff");
|
|
239
|
+
awareness.setLocalState({ line: 12, column: 4 });
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## 🦀 Native Rust Engine (`crates/core`)
|
|
245
|
+
|
|
246
|
+
For desktop applications (via Tauri v2) or WebAssembly workers, `@termaxjs/core` pairs with `crates/core`:
|
|
247
|
+
|
|
248
|
+
- **`RopeBuffer`**: Memory-efficient B-tree text rope (`ropey`) executing 50,000 edits in **9.89 ms** (over 5 million edits/sec).
|
|
249
|
+
- **`MmapBuffer`**: Zero-copy memory mapping (`memmap2`) allowing instant access to 100 MB - 10 GB files with **890 µs** strided read latency.
|
|
250
|
+
- **`tokenize_line_text`**: Native Rust syntax tokenizer running at **53.7 MB/s**.
|
|
251
|
+
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
## 🧪 Testing & Verification
|
|
255
|
+
|
|
256
|
+
```bash
|
|
257
|
+
# Run unit and parity test suites (73 tests, 14 suites)
|
|
258
|
+
pnpm test
|
|
259
|
+
|
|
260
|
+
# Run terminal streaming benchmark vs Ghostty Web and xterm.js
|
|
261
|
+
pnpm bench:terminal
|
|
262
|
+
|
|
263
|
+
# Run editor primitives benchmark vs CodeMirror 6
|
|
264
|
+
pnpm bench:editor
|
|
265
|
+
|
|
266
|
+
# Typecheck with strict TypeScript
|
|
267
|
+
pnpm check-types
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
---
|
|
271
|
+
|
|
272
|
+
## 📄 License
|
|
273
|
+
|
|
274
|
+
Apache-2.0 © Termax Contributors
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { Position } from "../types.js";
|
|
2
|
+
export type BufferType = "original" | "add";
|
|
3
|
+
export interface Piece {
|
|
4
|
+
bufferType: BufferType;
|
|
5
|
+
start: number;
|
|
6
|
+
length: number;
|
|
7
|
+
lineFeedCount: number;
|
|
8
|
+
}
|
|
9
|
+
export declare class PieceTable {
|
|
10
|
+
private originalBuffer;
|
|
11
|
+
private addBuffer;
|
|
12
|
+
private pieces;
|
|
13
|
+
private totalLength;
|
|
14
|
+
private totalLines;
|
|
15
|
+
private originalLineStarts;
|
|
16
|
+
private cachedLineStarts;
|
|
17
|
+
private lastInsertedPiece;
|
|
18
|
+
private lastInsertedOffset;
|
|
19
|
+
constructor(initialContent?: string);
|
|
20
|
+
get length(): number;
|
|
21
|
+
get lineCount(): number;
|
|
22
|
+
private getBufferText;
|
|
23
|
+
insert(offset: number, text: string): void;
|
|
24
|
+
delete(offset: number, length: number): void;
|
|
25
|
+
getText(from?: number, length?: number): string;
|
|
26
|
+
private buildOriginalLineStarts;
|
|
27
|
+
private getLineStarts;
|
|
28
|
+
getLine(targetLineIndex: number): string;
|
|
29
|
+
getPositionAt(offset: number): Position;
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=PieceTable.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PieceTable.d.ts","sourceRoot":"","sources":["../../src/buffer/PieceTable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,KAAK,CAAC;AAE5C,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB;AAYD,qBAAa,UAAU;IACrB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,kBAAkB,CAA4B;IACtD,OAAO,CAAC,gBAAgB,CAA4B;IACpD,OAAO,CAAC,iBAAiB,CAAsB;IAC/C,OAAO,CAAC,kBAAkB,CAAc;gBAE5B,cAAc,GAAE,MAAW;IAgBvC,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED,OAAO,CAAC,aAAa;IAKd,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAgI1C,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAsH5C,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;IAgCtD,OAAO,CAAC,uBAAuB;IAY/B,OAAO,CAAC,aAAa;IAkCd,OAAO,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM;IAoBxC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ;CAsB/C"}
|