@twick/2d 0.13.0 → 0.14.2

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.
Files changed (171) hide show
  1. package/LICENSE +21 -0
  2. package/editor/editor/tsconfig.build.tsbuildinfo +1 -1
  3. package/lib/components/Audio.js +3 -3
  4. package/lib/components/Img.js +23 -23
  5. package/lib/components/Line.js +31 -31
  6. package/lib/components/Media.d.ts +1 -1
  7. package/lib/components/Media.d.ts.map +1 -1
  8. package/lib/components/Media.js +26 -26
  9. package/lib/components/Spline.js +25 -25
  10. package/lib/components/Video.js +3 -3
  11. package/lib/tsconfig.build.tsbuildinfo +1 -1
  12. package/package.json +5 -4
  13. package/src/editor/NodeInspectorConfig.tsx +76 -76
  14. package/src/editor/PreviewOverlayConfig.tsx +67 -67
  15. package/src/editor/Provider.tsx +93 -93
  16. package/src/editor/SceneGraphTabConfig.tsx +81 -81
  17. package/src/editor/icons/CircleIcon.tsx +7 -7
  18. package/src/editor/icons/CodeBlockIcon.tsx +8 -8
  19. package/src/editor/icons/CurveIcon.tsx +7 -7
  20. package/src/editor/icons/GridIcon.tsx +7 -7
  21. package/src/editor/icons/IconMap.ts +35 -35
  22. package/src/editor/icons/ImgIcon.tsx +8 -8
  23. package/src/editor/icons/LayoutIcon.tsx +9 -9
  24. package/src/editor/icons/LineIcon.tsx +7 -7
  25. package/src/editor/icons/NodeIcon.tsx +7 -7
  26. package/src/editor/icons/RayIcon.tsx +7 -7
  27. package/src/editor/icons/RectIcon.tsx +7 -7
  28. package/src/editor/icons/ShapeIcon.tsx +7 -7
  29. package/src/editor/icons/TxtIcon.tsx +8 -8
  30. package/src/editor/icons/VideoIcon.tsx +7 -7
  31. package/src/editor/icons/View2DIcon.tsx +10 -10
  32. package/src/editor/index.ts +17 -17
  33. package/src/editor/tree/DetachedRoot.tsx +23 -23
  34. package/src/editor/tree/NodeElement.tsx +74 -74
  35. package/src/editor/tree/TreeElement.tsx +72 -72
  36. package/src/editor/tree/TreeRoot.tsx +10 -10
  37. package/src/editor/tree/ViewRoot.tsx +20 -20
  38. package/src/editor/tree/index.module.scss +38 -38
  39. package/src/editor/tree/index.ts +3 -3
  40. package/src/editor/tsconfig.build.json +5 -5
  41. package/src/editor/tsconfig.json +12 -12
  42. package/src/editor/tsdoc.json +4 -4
  43. package/src/editor/vite-env.d.ts +1 -1
  44. package/src/lib/code/CodeCursor.ts +445 -445
  45. package/src/lib/code/CodeDiffer.ts +78 -78
  46. package/src/lib/code/CodeFragment.ts +97 -97
  47. package/src/lib/code/CodeHighlighter.ts +75 -75
  48. package/src/lib/code/CodeMetrics.ts +47 -47
  49. package/src/lib/code/CodeRange.test.ts +74 -74
  50. package/src/lib/code/CodeRange.ts +216 -216
  51. package/src/lib/code/CodeScope.ts +101 -101
  52. package/src/lib/code/CodeSelection.ts +24 -24
  53. package/src/lib/code/CodeSignal.ts +327 -327
  54. package/src/lib/code/CodeTokenizer.ts +54 -54
  55. package/src/lib/code/DefaultHighlightStyle.ts +98 -98
  56. package/src/lib/code/LezerHighlighter.ts +113 -113
  57. package/src/lib/code/diff.test.ts +311 -311
  58. package/src/lib/code/diff.ts +319 -319
  59. package/src/lib/code/extractRange.ts +126 -126
  60. package/src/lib/code/index.ts +13 -13
  61. package/src/lib/components/Audio.ts +168 -168
  62. package/src/lib/components/Bezier.ts +105 -105
  63. package/src/lib/components/Circle.ts +266 -266
  64. package/src/lib/components/Code.ts +526 -526
  65. package/src/lib/components/CodeBlock.ts +576 -576
  66. package/src/lib/components/CubicBezier.ts +112 -112
  67. package/src/lib/components/Curve.ts +455 -455
  68. package/src/lib/components/Grid.ts +135 -135
  69. package/src/lib/components/Icon.ts +96 -96
  70. package/src/lib/components/Img.ts +319 -319
  71. package/src/lib/components/Knot.ts +157 -157
  72. package/src/lib/components/Latex.ts +122 -122
  73. package/src/lib/components/Layout.ts +1092 -1092
  74. package/src/lib/components/Line.ts +429 -429
  75. package/src/lib/components/Media.ts +576 -576
  76. package/src/lib/components/Node.ts +1940 -1940
  77. package/src/lib/components/Path.ts +137 -137
  78. package/src/lib/components/Polygon.ts +171 -171
  79. package/src/lib/components/QuadBezier.ts +100 -100
  80. package/src/lib/components/Ray.ts +125 -125
  81. package/src/lib/components/Rect.ts +187 -187
  82. package/src/lib/components/Rive.ts +156 -156
  83. package/src/lib/components/SVG.ts +797 -797
  84. package/src/lib/components/Shape.ts +143 -143
  85. package/src/lib/components/Spline.ts +344 -344
  86. package/src/lib/components/Txt.test.tsx +81 -81
  87. package/src/lib/components/Txt.ts +203 -203
  88. package/src/lib/components/TxtLeaf.ts +205 -205
  89. package/src/lib/components/Video.ts +461 -461
  90. package/src/lib/components/View2D.ts +98 -98
  91. package/src/lib/components/__tests__/children.test.tsx +142 -142
  92. package/src/lib/components/__tests__/clone.test.tsx +126 -126
  93. package/src/lib/components/__tests__/generatorTest.ts +28 -28
  94. package/src/lib/components/__tests__/mockScene2D.ts +45 -45
  95. package/src/lib/components/__tests__/query.test.tsx +122 -122
  96. package/src/lib/components/__tests__/state.test.tsx +60 -60
  97. package/src/lib/components/index.ts +28 -28
  98. package/src/lib/components/types.ts +35 -35
  99. package/src/lib/curves/ArcSegment.ts +159 -159
  100. package/src/lib/curves/CircleSegment.ts +77 -77
  101. package/src/lib/curves/CubicBezierSegment.ts +78 -78
  102. package/src/lib/curves/CurveDrawingInfo.ts +11 -11
  103. package/src/lib/curves/CurvePoint.ts +15 -15
  104. package/src/lib/curves/CurveProfile.ts +7 -7
  105. package/src/lib/curves/KnotInfo.ts +10 -10
  106. package/src/lib/curves/LineSegment.ts +62 -62
  107. package/src/lib/curves/Polynomial.ts +355 -355
  108. package/src/lib/curves/Polynomial2D.ts +62 -62
  109. package/src/lib/curves/PolynomialSegment.ts +124 -124
  110. package/src/lib/curves/QuadBezierSegment.ts +64 -64
  111. package/src/lib/curves/Segment.ts +17 -17
  112. package/src/lib/curves/UniformPolynomialCurveSampler.ts +94 -94
  113. package/src/lib/curves/createCurveProfileLerp.ts +471 -471
  114. package/src/lib/curves/getBezierSplineProfile.ts +223 -223
  115. package/src/lib/curves/getCircleProfile.ts +86 -86
  116. package/src/lib/curves/getPathProfile.ts +178 -178
  117. package/src/lib/curves/getPointAtDistance.ts +21 -21
  118. package/src/lib/curves/getPolylineProfile.test.ts +21 -21
  119. package/src/lib/curves/getPolylineProfile.ts +89 -89
  120. package/src/lib/curves/getRectProfile.ts +139 -139
  121. package/src/lib/curves/index.ts +16 -16
  122. package/src/lib/decorators/canvasStyleSignal.ts +16 -16
  123. package/src/lib/decorators/colorSignal.ts +9 -9
  124. package/src/lib/decorators/compound.ts +72 -72
  125. package/src/lib/decorators/computed.ts +18 -18
  126. package/src/lib/decorators/defaultStyle.ts +18 -18
  127. package/src/lib/decorators/filtersSignal.ts +136 -136
  128. package/src/lib/decorators/index.ts +10 -10
  129. package/src/lib/decorators/initializers.ts +32 -32
  130. package/src/lib/decorators/nodeName.ts +13 -13
  131. package/src/lib/decorators/signal.test.ts +90 -90
  132. package/src/lib/decorators/signal.ts +345 -345
  133. package/src/lib/decorators/spacingSignal.ts +15 -15
  134. package/src/lib/decorators/vector2Signal.ts +30 -30
  135. package/src/lib/globals.d.ts +2 -2
  136. package/src/lib/index.ts +8 -8
  137. package/src/lib/jsx-dev-runtime.ts +2 -2
  138. package/src/lib/jsx-runtime.ts +46 -46
  139. package/src/lib/parse-svg-path.d.ts +14 -14
  140. package/src/lib/partials/Filter.ts +180 -180
  141. package/src/lib/partials/Gradient.ts +102 -102
  142. package/src/lib/partials/Pattern.ts +34 -34
  143. package/src/lib/partials/ShaderConfig.ts +117 -117
  144. package/src/lib/partials/index.ts +4 -4
  145. package/src/lib/partials/types.ts +58 -58
  146. package/src/lib/scenes/Scene2D.ts +242 -242
  147. package/src/lib/scenes/index.ts +3 -3
  148. package/src/lib/scenes/makeScene2D.ts +16 -16
  149. package/src/lib/scenes/useScene2D.ts +6 -6
  150. package/src/lib/tsconfig.build.json +5 -5
  151. package/src/lib/tsconfig.json +10 -10
  152. package/src/lib/tsdoc.json +4 -4
  153. package/src/lib/utils/CanvasUtils.ts +306 -306
  154. package/src/lib/utils/diff.test.ts +453 -453
  155. package/src/lib/utils/diff.ts +148 -148
  156. package/src/lib/utils/index.ts +2 -2
  157. package/src/lib/utils/is.ts +11 -11
  158. package/src/lib/utils/makeSignalExtensions.ts +30 -30
  159. package/src/lib/utils/video/declarations.d.ts +1 -1
  160. package/src/lib/utils/video/ffmpeg-client.ts +50 -50
  161. package/src/lib/utils/video/mp4-parser-manager.ts +72 -72
  162. package/src/lib/utils/video/parser/index.ts +1 -1
  163. package/src/lib/utils/video/parser/parser.ts +257 -257
  164. package/src/lib/utils/video/parser/sampler.ts +72 -72
  165. package/src/lib/utils/video/parser/segment.ts +302 -302
  166. package/src/lib/utils/video/parser/sink.ts +29 -29
  167. package/src/lib/utils/video/parser/utils.ts +31 -31
  168. package/src/tsconfig.base.json +19 -19
  169. package/src/tsconfig.build.json +8 -8
  170. package/src/tsconfig.json +5 -5
  171. package/tsconfig.project.json +7 -7
@@ -1,526 +1,526 @@
1
- import type {
2
- SerializedVector2,
3
- Signal,
4
- SignalValue,
5
- SimpleSignal,
6
- ThreadGenerator,
7
- TimingFunction,
8
- Vector2,
9
- } from '@twick/core';
10
- import {
11
- BBox,
12
- createSignal,
13
- experimentalLog,
14
- map,
15
- unwrap,
16
- useLogger,
17
- useScene,
18
- } from '@twick/core';
19
- import type {
20
- CodeFragmentDrawingInfo,
21
- CodeHighlighter,
22
- CodePoint,
23
- CodeRange,
24
- CodeSelection,
25
- CodeSignal,
26
- PossibleCodeScope,
27
- PossibleCodeSelection,
28
- } from '../code';
29
- import {
30
- CodeCursor,
31
- codeSignal,
32
- CodeSignalContext,
33
- findAllCodeRanges,
34
- isPointInCodeSelection,
35
- lines,
36
- parseCodeSelection,
37
- resolveScope,
38
- } from '../code';
39
- import {computed, initial, nodeName, parser, signal} from '../decorators';
40
- import type {DesiredLength} from '../partials';
41
- import type {ShapeProps} from './Shape';
42
- import {Shape} from './Shape';
43
-
44
- export interface DrawTokenHook {
45
- (
46
- ctx: CanvasRenderingContext2D,
47
- text: string,
48
- position: Vector2,
49
- color: string,
50
- selection: number,
51
- ): void;
52
- }
53
-
54
- /**
55
- * Describes custom drawing logic used by the Code node.
56
- */
57
- export interface DrawHooks {
58
- /**
59
- * Custom drawing logic for individual code tokens.
60
- *
61
- * @example
62
- * ```ts
63
- * token(ctx, text, position, color, selection) {
64
- * const blur = map(3, 0, selection);
65
- * const alpha = map(0.5, 1, selection);
66
- * ctx.globalAlpha *= alpha;
67
- * ctx.filter = `blur(${blur}px)`;
68
- * ctx.fillStyle = color;
69
- * ctx.fillText(text, position.x, position.y);
70
- * }
71
- * ```
72
- */
73
- token: DrawTokenHook;
74
- }
75
-
76
- export interface CodeProps extends ShapeProps {
77
- /**
78
- * {@inheritDoc Code.highlighter}
79
- */
80
- highlighter?: SignalValue<CodeHighlighter | null>;
81
- /**
82
- * {@inheritDoc Code.code}
83
- */
84
- code?: SignalValue<PossibleCodeScope>;
85
- /**
86
- * {@inheritDoc Code.selection}
87
- */
88
- selection?: SignalValue<PossibleCodeSelection>;
89
- /**
90
- * {@inheritDoc Code.drawHooks}
91
- */
92
- drawHooks?: SignalValue<DrawHooks>;
93
- }
94
-
95
- /**
96
- * A node for displaying and animating code.
97
- *
98
- * @experimental
99
- *
100
- * @preview
101
- * ```tsx editor
102
- * import {parser} from '@lezer/javascript';
103
- * import {Code, LezerHighlighter, makeScene2D} from '@twick/2d';
104
- * import {createRef} from '@twick/core';
105
- *
106
- * export default makeScene2D(function* (view) {
107
- * LezerHighlighter.registerParser(parser);
108
- * const code = createRef<Code>();
109
- *
110
- * view.add(
111
- * <Code
112
- * ref={code}
113
- * offset={-1}
114
- * position={view.size().scale(-0.5).add(60)}
115
- * fontFamily={'JetBrains Mono, monospace'}
116
- * fontSize={36}
117
- * code={`\
118
- * function hello() {
119
- * console.log('Hello');
120
- * }`}
121
- * />,
122
- * );
123
- *
124
- * yield* code()
125
- * .code(
126
- * `\
127
- * function hello() {
128
- * console.warn('Hello World');
129
- * }`,
130
- * 1,
131
- * )
132
- * .wait(0.5)
133
- * .back(1)
134
- * .wait(0.5);
135
- * });
136
- * ```
137
- */
138
- @nodeName('CodeBlock')
139
- export class Code extends Shape {
140
- /**
141
- * Create a standalone code signal.
142
- *
143
- * @param initial - The initial code.
144
- * @param highlighter - Custom highlighter to use.
145
- */
146
- public static createSignal(
147
- initial: PossibleCodeScope,
148
- highlighter?: SignalValue<CodeHighlighter>,
149
- ): CodeSignal<void> {
150
- return new CodeSignalContext<void>(
151
- initial,
152
- undefined,
153
- highlighter,
154
- ).toSignal();
155
- }
156
-
157
- public static defaultHighlighter: CodeHighlighter | null = null;
158
- /**
159
- * The code highlighter to use for this code node.
160
- *
161
- * @remarks
162
- * Defaults to a shared {@link code.LezerHighlighter}.
163
- */
164
- @initial(() => Code.defaultHighlighter)
165
- @signal()
166
- public declare readonly highlighter: SimpleSignal<
167
- CodeHighlighter | null,
168
- this
169
- >;
170
-
171
- /**
172
- * The code to display.
173
- */
174
- @codeSignal()
175
- public declare readonly code: CodeSignal<this>;
176
-
177
- /**
178
- * Custom drawing logic for the code.
179
- *
180
- * @remarks
181
- * Check out {@link DrawHooks} for available render hooks.
182
- *
183
- * @example
184
- * Make the unselected code blurry and transparent:
185
- * ```tsx
186
- * <Code
187
- * drawHooks={{
188
- * token(ctx, text, position, color, selection) {
189
- * const blur = map(3, 0, selection);
190
- * const alpha = map(0.5, 1, selection);
191
- * ctx.globalAlpha *= alpha;
192
- * ctx.filter = `blur(${blur}px)`;
193
- * ctx.fillStyle = color;
194
- * ctx.fillText(text, position.x, position.y);
195
- * },
196
- * }}
197
- * // ...
198
- * />
199
- * ```
200
- */
201
- @initial<DrawHooks>({
202
- token(ctx, text, position, color, selection) {
203
- ctx.fillStyle = color;
204
- ctx.globalAlpha *= map(0.2, 1, selection);
205
- ctx.fillText(text, position.x, position.y);
206
- },
207
- })
208
- @signal()
209
- public declare readonly drawHooks: SimpleSignal<DrawHooks, this>;
210
-
211
- protected setDrawHooks(value: DrawHooks) {
212
- if (
213
- !useScene().experimentalFeatures &&
214
- value !== this.drawHooks.context.getInitial()
215
- ) {
216
- useLogger().log({
217
- ...experimentalLog(`Code uses experimental draw hooks.`),
218
- inspect: this.key,
219
- });
220
- } else {
221
- this.drawHooks.context.setter(value);
222
- }
223
- }
224
-
225
- /**
226
- * The currently selected code range.
227
- *
228
- * @remarks
229
- * Either a single {@link code.CodeRange} or an array of them
230
- * describing which parts of the code should be visually emphasized.
231
- *
232
- * You can use {@link code.word} and
233
- * {@link code.lines} to quickly create ranges.
234
- *
235
- * @example
236
- * The following will select the word "console" in the code.
237
- * Both lines and columns are 0-based. So it will select a 7-character-long
238
- * (`7`) word in the second line (`1`) starting at the third character (`2`).
239
- * ```tsx
240
- * <Code
241
- * selection={word(1, 2, 7)}
242
- * code={`\
243
- * function hello() => {
244
- * console.log('Hello');
245
- * }`}
246
- * // ...
247
- * />
248
- * ```
249
- */
250
- @initial(lines(0, Infinity))
251
- @parser(parseCodeSelection)
252
- @signal()
253
- public declare readonly selection: Signal<
254
- PossibleCodeSelection,
255
- CodeSelection,
256
- this
257
- >;
258
- public oldSelection: CodeSelection | null = null;
259
- public selectionProgress = createSignal<number | null>(null);
260
- protected *tweenSelection(
261
- value: CodeRange[],
262
- duration: number,
263
- timingFunction: TimingFunction,
264
- ): ThreadGenerator {
265
- this.oldSelection = this.selection();
266
- this.selection(value);
267
- this.selectionProgress(0);
268
- yield* this.selectionProgress(1, duration, timingFunction);
269
- this.selectionProgress(null);
270
- this.oldSelection = null;
271
- }
272
-
273
- /**
274
- * Get the currently displayed code as a string.
275
- */
276
- @computed()
277
- public parsed(): string {
278
- return resolveScope(this.code(), scope => unwrap(scope.progress) > 0.5);
279
- }
280
-
281
- @computed()
282
- public highlighterCache() {
283
- const highlighter = this.highlighter();
284
- if (!highlighter || !highlighter.initialize()) return null;
285
- const code = this.code();
286
- const before = resolveScope(code, false);
287
- const after = resolveScope(code, true);
288
-
289
- return {
290
- before: highlighter.prepare(before),
291
- after: highlighter.prepare(after),
292
- };
293
- }
294
-
295
- private cursorCache: CodeCursor | undefined;
296
- private get cursor() {
297
- this.cursorCache ??= new CodeCursor(this);
298
- return this.cursorCache;
299
- }
300
-
301
- public constructor(props: CodeProps) {
302
- super({
303
- fontFamily: 'monospace',
304
- ...props,
305
- });
306
- }
307
-
308
- /**
309
- * Create a child code signal.
310
- *
311
- * @param initial - The initial code.
312
- */
313
- public createSignal(initial: PossibleCodeScope): CodeSignal<this> {
314
- return new CodeSignalContext<this>(
315
- initial,
316
- this,
317
- this.highlighter,
318
- ).toSignal();
319
- }
320
-
321
- /**
322
- * Find all code ranges that match the given pattern.
323
- *
324
- * @param pattern - Either a string or a regular expression to match.
325
- */
326
- public findAllRanges(pattern: string | RegExp): CodeRange[] {
327
- return findAllCodeRanges(this.parsed(), pattern);
328
- }
329
-
330
- /**
331
- * Find the first code range that matches the given pattern.
332
- *
333
- * @param pattern - Either a string or a regular expression to match.
334
- */
335
- public findFirstRange(pattern: string | RegExp): CodeRange {
336
- return (
337
- findAllCodeRanges(this.parsed(), pattern, 1)[0] ?? [
338
- [0, 0],
339
- [0, 0],
340
- ]
341
- );
342
- }
343
-
344
- /**
345
- * Find the last code range that matches the given pattern.
346
- *
347
- * @param pattern - Either a string or a regular expression to match.
348
- */
349
- public findLastRange(pattern: string | RegExp): CodeRange {
350
- return (
351
- findAllCodeRanges(this.parsed(), pattern).at(-1) ?? [
352
- [0, 0],
353
- [0, 0],
354
- ]
355
- );
356
- }
357
-
358
- /**
359
- * Return the bounding box of the given point (character) in the code.
360
- *
361
- * @remarks
362
- * The returned bound box is in local space of the `Code` node.
363
- *
364
- * @param point - The point to get the bounding box for.
365
- */
366
- public getPointBbox(point: CodePoint): BBox {
367
- const [line, column] = point;
368
- const drawingInfo = this.drawingInfo();
369
- let match: CodeFragmentDrawingInfo | undefined;
370
- for (const info of drawingInfo.fragments) {
371
- if (info.cursor.y < line) {
372
- match = info;
373
- continue;
374
- }
375
-
376
- if (info.cursor.y === line && info.cursor.x < column) {
377
- match = info;
378
- continue;
379
- }
380
-
381
- break;
382
- }
383
-
384
- if (!match) return new BBox();
385
-
386
- const size = this.computedSize();
387
- return new BBox(
388
- match.position
389
- .sub(size.scale(0.5))
390
- .addX(match.characterSize.x * (column - match.cursor.x)),
391
- match.characterSize,
392
- );
393
- }
394
-
395
- /**
396
- * Return bounding boxes of all characters in the selection.
397
- *
398
- * @remarks
399
- * The returned bound boxes are in local space of the `Code` node.
400
- * Each line of code has a separate bounding box.
401
- *
402
- * @param selection - The selection to get the bounding boxes for.
403
- */
404
- public getSelectionBbox(selection: PossibleCodeSelection): BBox[] {
405
- const size = this.computedSize();
406
- const range = parseCodeSelection(selection);
407
- const drawingInfo = this.drawingInfo();
408
- const bboxes: BBox[] = [];
409
-
410
- let current: BBox | null = null;
411
- let line = 0;
412
- let column = 0;
413
- for (const info of drawingInfo.fragments) {
414
- if (info.cursor.y !== line) {
415
- line = info.cursor.y;
416
- if (current) {
417
- bboxes.push(current);
418
- current = null;
419
- }
420
- }
421
-
422
- column = info.cursor.x;
423
- for (let i = 0; i < info.text.length; i++) {
424
- if (isPointInCodeSelection([line, column], range)) {
425
- const bbox = new BBox(
426
- info.position
427
- .sub(size.scale(0.5))
428
- .addX(info.characterSize.x * (column - info.cursor.x)),
429
- info.characterSize,
430
- );
431
- if (!current) {
432
- current = bbox;
433
- } else {
434
- current = current.union(bbox);
435
- }
436
- } else if (current) {
437
- bboxes.push(current);
438
- current = null;
439
- }
440
-
441
- column++;
442
- }
443
- }
444
-
445
- if (current) {
446
- bboxes.push(current);
447
- }
448
-
449
- return bboxes;
450
- }
451
-
452
- @computed()
453
- protected drawingInfo() {
454
- this.requestFontUpdate();
455
- const context = this.cacheCanvas();
456
- const code = this.code();
457
-
458
- context.save();
459
- this.applyStyle(context);
460
- this.applyText(context);
461
- this.cursor.setupDraw(context);
462
- this.cursor.drawScope(code);
463
- const info = this.cursor.getDrawingInfo();
464
- context.restore();
465
-
466
- return info;
467
- }
468
-
469
- protected override desiredSize(): SerializedVector2<DesiredLength> {
470
- this.requestFontUpdate();
471
- const context = this.cacheCanvas();
472
- const code = this.code();
473
-
474
- context.save();
475
- this.applyStyle(context);
476
- this.applyText(context);
477
- this.cursor.setupMeasure(context);
478
- this.cursor.measureSize(code);
479
- const size = this.cursor.getSize();
480
- context.restore();
481
-
482
- return size;
483
- }
484
-
485
- protected override async draw(
486
- context: CanvasRenderingContext2D,
487
- ): Promise<void> {
488
- this.requestFontUpdate();
489
- this.applyStyle(context);
490
- this.applyText(context);
491
- const size = this.computedSize();
492
- const drawingInfo = this.drawingInfo();
493
-
494
- context.save();
495
- context.translate(
496
- -size.width / 2,
497
- -size.height / 2 + drawingInfo.verticalOffset,
498
- );
499
-
500
- const drawHooks = this.drawHooks();
501
- for (const info of drawingInfo.fragments) {
502
- context.save();
503
- context.globalAlpha *= info.alpha;
504
- drawHooks.token(context, info.text, info.position, info.fill, info.time);
505
- context.restore();
506
- }
507
-
508
- context.restore();
509
-
510
- await this.drawChildren(context);
511
- }
512
-
513
- protected override applyText(context: CanvasRenderingContext2D) {
514
- super.applyText(context);
515
- context.font = this.styles.font;
516
- context.textBaseline = 'top';
517
- if ('letterSpacing' in context) {
518
- context.letterSpacing = this.styles.letterSpacing;
519
- }
520
- }
521
-
522
- protected override collectAsyncResources(): void {
523
- super.collectAsyncResources();
524
- this.highlighter()?.initialize();
525
- }
526
- }
1
+ import type {
2
+ SerializedVector2,
3
+ Signal,
4
+ SignalValue,
5
+ SimpleSignal,
6
+ ThreadGenerator,
7
+ TimingFunction,
8
+ Vector2,
9
+ } from '@twick/core';
10
+ import {
11
+ BBox,
12
+ createSignal,
13
+ experimentalLog,
14
+ map,
15
+ unwrap,
16
+ useLogger,
17
+ useScene,
18
+ } from '@twick/core';
19
+ import type {
20
+ CodeFragmentDrawingInfo,
21
+ CodeHighlighter,
22
+ CodePoint,
23
+ CodeRange,
24
+ CodeSelection,
25
+ CodeSignal,
26
+ PossibleCodeScope,
27
+ PossibleCodeSelection,
28
+ } from '../code';
29
+ import {
30
+ CodeCursor,
31
+ codeSignal,
32
+ CodeSignalContext,
33
+ findAllCodeRanges,
34
+ isPointInCodeSelection,
35
+ lines,
36
+ parseCodeSelection,
37
+ resolveScope,
38
+ } from '../code';
39
+ import {computed, initial, nodeName, parser, signal} from '../decorators';
40
+ import type {DesiredLength} from '../partials';
41
+ import type {ShapeProps} from './Shape';
42
+ import {Shape} from './Shape';
43
+
44
+ export interface DrawTokenHook {
45
+ (
46
+ ctx: CanvasRenderingContext2D,
47
+ text: string,
48
+ position: Vector2,
49
+ color: string,
50
+ selection: number,
51
+ ): void;
52
+ }
53
+
54
+ /**
55
+ * Describes custom drawing logic used by the Code node.
56
+ */
57
+ export interface DrawHooks {
58
+ /**
59
+ * Custom drawing logic for individual code tokens.
60
+ *
61
+ * @example
62
+ * ```ts
63
+ * token(ctx, text, position, color, selection) {
64
+ * const blur = map(3, 0, selection);
65
+ * const alpha = map(0.5, 1, selection);
66
+ * ctx.globalAlpha *= alpha;
67
+ * ctx.filter = `blur(${blur}px)`;
68
+ * ctx.fillStyle = color;
69
+ * ctx.fillText(text, position.x, position.y);
70
+ * }
71
+ * ```
72
+ */
73
+ token: DrawTokenHook;
74
+ }
75
+
76
+ export interface CodeProps extends ShapeProps {
77
+ /**
78
+ * {@inheritDoc Code.highlighter}
79
+ */
80
+ highlighter?: SignalValue<CodeHighlighter | null>;
81
+ /**
82
+ * {@inheritDoc Code.code}
83
+ */
84
+ code?: SignalValue<PossibleCodeScope>;
85
+ /**
86
+ * {@inheritDoc Code.selection}
87
+ */
88
+ selection?: SignalValue<PossibleCodeSelection>;
89
+ /**
90
+ * {@inheritDoc Code.drawHooks}
91
+ */
92
+ drawHooks?: SignalValue<DrawHooks>;
93
+ }
94
+
95
+ /**
96
+ * A node for displaying and animating code.
97
+ *
98
+ * @experimental
99
+ *
100
+ * @preview
101
+ * ```tsx editor
102
+ * import {parser} from '@lezer/javascript';
103
+ * import {Code, LezerHighlighter, makeScene2D} from '@twick/2d';
104
+ * import {createRef} from '@twick/core';
105
+ *
106
+ * export default makeScene2D(function* (view) {
107
+ * LezerHighlighter.registerParser(parser);
108
+ * const code = createRef<Code>();
109
+ *
110
+ * view.add(
111
+ * <Code
112
+ * ref={code}
113
+ * offset={-1}
114
+ * position={view.size().scale(-0.5).add(60)}
115
+ * fontFamily={'JetBrains Mono, monospace'}
116
+ * fontSize={36}
117
+ * code={`\
118
+ * function hello() {
119
+ * console.log('Hello');
120
+ * }`}
121
+ * />,
122
+ * );
123
+ *
124
+ * yield* code()
125
+ * .code(
126
+ * `\
127
+ * function hello() {
128
+ * console.warn('Hello World');
129
+ * }`,
130
+ * 1,
131
+ * )
132
+ * .wait(0.5)
133
+ * .back(1)
134
+ * .wait(0.5);
135
+ * });
136
+ * ```
137
+ */
138
+ @nodeName('CodeBlock')
139
+ export class Code extends Shape {
140
+ /**
141
+ * Create a standalone code signal.
142
+ *
143
+ * @param initial - The initial code.
144
+ * @param highlighter - Custom highlighter to use.
145
+ */
146
+ public static createSignal(
147
+ initial: PossibleCodeScope,
148
+ highlighter?: SignalValue<CodeHighlighter>,
149
+ ): CodeSignal<void> {
150
+ return new CodeSignalContext<void>(
151
+ initial,
152
+ undefined,
153
+ highlighter,
154
+ ).toSignal();
155
+ }
156
+
157
+ public static defaultHighlighter: CodeHighlighter | null = null;
158
+ /**
159
+ * The code highlighter to use for this code node.
160
+ *
161
+ * @remarks
162
+ * Defaults to a shared {@link code.LezerHighlighter}.
163
+ */
164
+ @initial(() => Code.defaultHighlighter)
165
+ @signal()
166
+ public declare readonly highlighter: SimpleSignal<
167
+ CodeHighlighter | null,
168
+ this
169
+ >;
170
+
171
+ /**
172
+ * The code to display.
173
+ */
174
+ @codeSignal()
175
+ public declare readonly code: CodeSignal<this>;
176
+
177
+ /**
178
+ * Custom drawing logic for the code.
179
+ *
180
+ * @remarks
181
+ * Check out {@link DrawHooks} for available render hooks.
182
+ *
183
+ * @example
184
+ * Make the unselected code blurry and transparent:
185
+ * ```tsx
186
+ * <Code
187
+ * drawHooks={{
188
+ * token(ctx, text, position, color, selection) {
189
+ * const blur = map(3, 0, selection);
190
+ * const alpha = map(0.5, 1, selection);
191
+ * ctx.globalAlpha *= alpha;
192
+ * ctx.filter = `blur(${blur}px)`;
193
+ * ctx.fillStyle = color;
194
+ * ctx.fillText(text, position.x, position.y);
195
+ * },
196
+ * }}
197
+ * // ...
198
+ * />
199
+ * ```
200
+ */
201
+ @initial<DrawHooks>({
202
+ token(ctx, text, position, color, selection) {
203
+ ctx.fillStyle = color;
204
+ ctx.globalAlpha *= map(0.2, 1, selection);
205
+ ctx.fillText(text, position.x, position.y);
206
+ },
207
+ })
208
+ @signal()
209
+ public declare readonly drawHooks: SimpleSignal<DrawHooks, this>;
210
+
211
+ protected setDrawHooks(value: DrawHooks) {
212
+ if (
213
+ !useScene().experimentalFeatures &&
214
+ value !== this.drawHooks.context.getInitial()
215
+ ) {
216
+ useLogger().log({
217
+ ...experimentalLog(`Code uses experimental draw hooks.`),
218
+ inspect: this.key,
219
+ });
220
+ } else {
221
+ this.drawHooks.context.setter(value);
222
+ }
223
+ }
224
+
225
+ /**
226
+ * The currently selected code range.
227
+ *
228
+ * @remarks
229
+ * Either a single {@link code.CodeRange} or an array of them
230
+ * describing which parts of the code should be visually emphasized.
231
+ *
232
+ * You can use {@link code.word} and
233
+ * {@link code.lines} to quickly create ranges.
234
+ *
235
+ * @example
236
+ * The following will select the word "console" in the code.
237
+ * Both lines and columns are 0-based. So it will select a 7-character-long
238
+ * (`7`) word in the second line (`1`) starting at the third character (`2`).
239
+ * ```tsx
240
+ * <Code
241
+ * selection={word(1, 2, 7)}
242
+ * code={`\
243
+ * function hello() => {
244
+ * console.log('Hello');
245
+ * }`}
246
+ * // ...
247
+ * />
248
+ * ```
249
+ */
250
+ @initial(lines(0, Infinity))
251
+ @parser(parseCodeSelection)
252
+ @signal()
253
+ public declare readonly selection: Signal<
254
+ PossibleCodeSelection,
255
+ CodeSelection,
256
+ this
257
+ >;
258
+ public oldSelection: CodeSelection | null = null;
259
+ public selectionProgress = createSignal<number | null>(null);
260
+ protected *tweenSelection(
261
+ value: CodeRange[],
262
+ duration: number,
263
+ timingFunction: TimingFunction,
264
+ ): ThreadGenerator {
265
+ this.oldSelection = this.selection();
266
+ this.selection(value);
267
+ this.selectionProgress(0);
268
+ yield* this.selectionProgress(1, duration, timingFunction);
269
+ this.selectionProgress(null);
270
+ this.oldSelection = null;
271
+ }
272
+
273
+ /**
274
+ * Get the currently displayed code as a string.
275
+ */
276
+ @computed()
277
+ public parsed(): string {
278
+ return resolveScope(this.code(), scope => unwrap(scope.progress) > 0.5);
279
+ }
280
+
281
+ @computed()
282
+ public highlighterCache() {
283
+ const highlighter = this.highlighter();
284
+ if (!highlighter || !highlighter.initialize()) return null;
285
+ const code = this.code();
286
+ const before = resolveScope(code, false);
287
+ const after = resolveScope(code, true);
288
+
289
+ return {
290
+ before: highlighter.prepare(before),
291
+ after: highlighter.prepare(after),
292
+ };
293
+ }
294
+
295
+ private cursorCache: CodeCursor | undefined;
296
+ private get cursor() {
297
+ this.cursorCache ??= new CodeCursor(this);
298
+ return this.cursorCache;
299
+ }
300
+
301
+ public constructor(props: CodeProps) {
302
+ super({
303
+ fontFamily: 'monospace',
304
+ ...props,
305
+ });
306
+ }
307
+
308
+ /**
309
+ * Create a child code signal.
310
+ *
311
+ * @param initial - The initial code.
312
+ */
313
+ public createSignal(initial: PossibleCodeScope): CodeSignal<this> {
314
+ return new CodeSignalContext<this>(
315
+ initial,
316
+ this,
317
+ this.highlighter,
318
+ ).toSignal();
319
+ }
320
+
321
+ /**
322
+ * Find all code ranges that match the given pattern.
323
+ *
324
+ * @param pattern - Either a string or a regular expression to match.
325
+ */
326
+ public findAllRanges(pattern: string | RegExp): CodeRange[] {
327
+ return findAllCodeRanges(this.parsed(), pattern);
328
+ }
329
+
330
+ /**
331
+ * Find the first code range that matches the given pattern.
332
+ *
333
+ * @param pattern - Either a string or a regular expression to match.
334
+ */
335
+ public findFirstRange(pattern: string | RegExp): CodeRange {
336
+ return (
337
+ findAllCodeRanges(this.parsed(), pattern, 1)[0] ?? [
338
+ [0, 0],
339
+ [0, 0],
340
+ ]
341
+ );
342
+ }
343
+
344
+ /**
345
+ * Find the last code range that matches the given pattern.
346
+ *
347
+ * @param pattern - Either a string or a regular expression to match.
348
+ */
349
+ public findLastRange(pattern: string | RegExp): CodeRange {
350
+ return (
351
+ findAllCodeRanges(this.parsed(), pattern).at(-1) ?? [
352
+ [0, 0],
353
+ [0, 0],
354
+ ]
355
+ );
356
+ }
357
+
358
+ /**
359
+ * Return the bounding box of the given point (character) in the code.
360
+ *
361
+ * @remarks
362
+ * The returned bound box is in local space of the `Code` node.
363
+ *
364
+ * @param point - The point to get the bounding box for.
365
+ */
366
+ public getPointBbox(point: CodePoint): BBox {
367
+ const [line, column] = point;
368
+ const drawingInfo = this.drawingInfo();
369
+ let match: CodeFragmentDrawingInfo | undefined;
370
+ for (const info of drawingInfo.fragments) {
371
+ if (info.cursor.y < line) {
372
+ match = info;
373
+ continue;
374
+ }
375
+
376
+ if (info.cursor.y === line && info.cursor.x < column) {
377
+ match = info;
378
+ continue;
379
+ }
380
+
381
+ break;
382
+ }
383
+
384
+ if (!match) return new BBox();
385
+
386
+ const size = this.computedSize();
387
+ return new BBox(
388
+ match.position
389
+ .sub(size.scale(0.5))
390
+ .addX(match.characterSize.x * (column - match.cursor.x)),
391
+ match.characterSize,
392
+ );
393
+ }
394
+
395
+ /**
396
+ * Return bounding boxes of all characters in the selection.
397
+ *
398
+ * @remarks
399
+ * The returned bound boxes are in local space of the `Code` node.
400
+ * Each line of code has a separate bounding box.
401
+ *
402
+ * @param selection - The selection to get the bounding boxes for.
403
+ */
404
+ public getSelectionBbox(selection: PossibleCodeSelection): BBox[] {
405
+ const size = this.computedSize();
406
+ const range = parseCodeSelection(selection);
407
+ const drawingInfo = this.drawingInfo();
408
+ const bboxes: BBox[] = [];
409
+
410
+ let current: BBox | null = null;
411
+ let line = 0;
412
+ let column = 0;
413
+ for (const info of drawingInfo.fragments) {
414
+ if (info.cursor.y !== line) {
415
+ line = info.cursor.y;
416
+ if (current) {
417
+ bboxes.push(current);
418
+ current = null;
419
+ }
420
+ }
421
+
422
+ column = info.cursor.x;
423
+ for (let i = 0; i < info.text.length; i++) {
424
+ if (isPointInCodeSelection([line, column], range)) {
425
+ const bbox = new BBox(
426
+ info.position
427
+ .sub(size.scale(0.5))
428
+ .addX(info.characterSize.x * (column - info.cursor.x)),
429
+ info.characterSize,
430
+ );
431
+ if (!current) {
432
+ current = bbox;
433
+ } else {
434
+ current = current.union(bbox);
435
+ }
436
+ } else if (current) {
437
+ bboxes.push(current);
438
+ current = null;
439
+ }
440
+
441
+ column++;
442
+ }
443
+ }
444
+
445
+ if (current) {
446
+ bboxes.push(current);
447
+ }
448
+
449
+ return bboxes;
450
+ }
451
+
452
+ @computed()
453
+ protected drawingInfo() {
454
+ this.requestFontUpdate();
455
+ const context = this.cacheCanvas();
456
+ const code = this.code();
457
+
458
+ context.save();
459
+ this.applyStyle(context);
460
+ this.applyText(context);
461
+ this.cursor.setupDraw(context);
462
+ this.cursor.drawScope(code);
463
+ const info = this.cursor.getDrawingInfo();
464
+ context.restore();
465
+
466
+ return info;
467
+ }
468
+
469
+ protected override desiredSize(): SerializedVector2<DesiredLength> {
470
+ this.requestFontUpdate();
471
+ const context = this.cacheCanvas();
472
+ const code = this.code();
473
+
474
+ context.save();
475
+ this.applyStyle(context);
476
+ this.applyText(context);
477
+ this.cursor.setupMeasure(context);
478
+ this.cursor.measureSize(code);
479
+ const size = this.cursor.getSize();
480
+ context.restore();
481
+
482
+ return size;
483
+ }
484
+
485
+ protected override async draw(
486
+ context: CanvasRenderingContext2D,
487
+ ): Promise<void> {
488
+ this.requestFontUpdate();
489
+ this.applyStyle(context);
490
+ this.applyText(context);
491
+ const size = this.computedSize();
492
+ const drawingInfo = this.drawingInfo();
493
+
494
+ context.save();
495
+ context.translate(
496
+ -size.width / 2,
497
+ -size.height / 2 + drawingInfo.verticalOffset,
498
+ );
499
+
500
+ const drawHooks = this.drawHooks();
501
+ for (const info of drawingInfo.fragments) {
502
+ context.save();
503
+ context.globalAlpha *= info.alpha;
504
+ drawHooks.token(context, info.text, info.position, info.fill, info.time);
505
+ context.restore();
506
+ }
507
+
508
+ context.restore();
509
+
510
+ await this.drawChildren(context);
511
+ }
512
+
513
+ protected override applyText(context: CanvasRenderingContext2D) {
514
+ super.applyText(context);
515
+ context.font = this.styles.font;
516
+ context.textBaseline = 'top';
517
+ if ('letterSpacing' in context) {
518
+ context.letterSpacing = this.styles.letterSpacing;
519
+ }
520
+ }
521
+
522
+ protected override collectAsyncResources(): void {
523
+ super.collectAsyncResources();
524
+ this.highlighter()?.initialize();
525
+ }
526
+ }