3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-21 23:46:21 +01:00

Split adfToPlainText's step, node and emit helpers out of its writer

This commit is contained in:
2026-11-14 21:31:26 +01:00
committed by Lillem4n
parent 0507a49579
commit d5935c6ac0
2 changed files with 74 additions and 74 deletions
+2 -2
View File
@@ -1,7 +1,7 @@
import assert from 'node:assert/strict' import assert from 'node:assert/strict'
import test from 'node:test' import test from 'node:test'
import type { AdfDocument, AdfMark, AdfNode } from '../adf/document.ts' import type { AdfAttributes, AdfDocument, AdfMark, AdfNode } from '../adf/document.ts'
import type { Result } from '../result.ts' import type { Result } from '../result.ts'
import { adfToHtml, adfToPlainText } from '../index.ts' import { adfToHtml, adfToPlainText } from '../index.ts'
import { largestNesting } from '../nesting.ts' import { largestNesting } from '../nesting.ts'
@@ -319,7 +319,7 @@ test('writes the images of a group and an inline image on the line they stand in
}) })
test('writes a card as its address, or as its name then its address', () => { test('writes a card as its address, or as its name then its address', () => {
const card = (attrs: Record<string, unknown>): AdfNode => ({ attrs, type: 'blockCard' }) const card = (attrs: AdfAttributes): AdfNode => ({ attrs, type: 'blockCard' })
assert.equal(shown(card({ url: 'https://example.com/spec' })), 'Before\n\nhttps://example.com/spec\n\nAfter') assert.equal(shown(card({ url: 'https://example.com/spec' })), 'Before\n\nhttps://example.com/spec\n\nAfter')
assert.equal(shown(card({ data: { name: 'Design spec' }, url: 'https://example.com/spec' })), 'Before\n\nhttps://example.com/spec\n\nAfter') assert.equal(shown(card({ data: { name: 'Design spec' }, url: 'https://example.com/spec' })), 'Before\n\nhttps://example.com/spec\n\nAfter')
assert.equal(shown(card({ data: { name: 'Design spec' } })), 'Before\n\nDesign spec\n\nAfter') assert.equal(shown(card({ data: { name: 'Design spec' } })), 'Before\n\nDesign spec\n\nAfter')
+56 -56
View File
@@ -17,6 +17,9 @@ type Step =
| { kind: 'separator' } | { kind: 'separator' }
| { depth: number; kind: 'node'; marker: string | undefined; node: AdfNode; place: Place | undefined; suffix: string | undefined } | { depth: number; kind: 'node'; marker: string | undefined; node: AdfNode; place: Place | undefined; suffix: string | undefined }
// The text written so far. `pieces`: its heads and bodies, `length` their total; `gap`: the line feeds the layout owes before the next text at least, and `literal` those the text before ended in, of which the larger is written; `lead`: the marker of the item the next text opens; `indent`: the margin of every line after that; `cell`: the table cell being written.
type Writing = { cell: Cell | undefined; gap: number; indent: string; lead: string | undefined; length: number; literal: number; pieces: string[] }
// A table cell being written: its text goes on the row's line, so `base`, the margin of the row, is not repeated; `start` is the `length` where the cell began. // A table cell being written: its text goes on the row's line, so `base`, the margin of the row, is not repeated; `start` is the `length` where the cell began.
type Cell = { base: string; start: number } type Cell = { base: string; start: number }
@@ -41,82 +44,79 @@ export function adfToPlainText(document: AdfDocument): Result<string> {
}) })
} }
// A stack rather than recursion (docs/decisions.md §Nothing recurses unbounded). Text is written the moment it is met: `gap` holds the line feeds the layout owes first and `literal` those the text before ended in, of which the larger is written, `lead` the marker of the item it opens, `indent` the margin of every line after that. // A stack rather than recursion (docs/decisions.md §Nothing recurses unbounded). Text is written the moment it is met.
function writeText(content: readonly AdfNode[]): Result<string> { function writeText(content: readonly AdfNode[]): Result<string> {
const pieces: string[] = [] const writing: Writing = { cell: undefined, gap: 0, indent: '', lead: undefined, length: 0, literal: 0, pieces: [] }
let length = 0
let gap = 0
let indent = ''
let lead: string | undefined
let literal = 0
let cell: Cell | undefined
// Past its first text, a cell goes on the row's line: a line feed owed becomes a space, and a marker keeps its place without the row's margin.
function emit(text: string): void {
const end = endBeforeLineFeeds(text)
if (end > 0) {
const owed = Math.max(gap, literal)
const open = cell
let head = ''
if (open !== undefined && length > open.start) head = owed > 0 ? ` ${lead === undefined ? '' : lead.slice(open.base.length)}` : ''
else if (length === 0 || owed > 0 || lead !== undefined) head = `${length === 0 ? '' : '\n'.repeat(owed)}${lead ?? indent}`
const kept = text.slice(0, end)
const body = open === undefined ? kept.replaceAll(/\n(?=[^\n])/g, `\n${indent}`) : kept.replaceAll(/\n+/g, ' ')
pieces.push(head, body)
length += head.length + body.length
gap = 0
lead = undefined
}
literal = (end > 0 ? 0 : literal) + (cell === undefined ? text.length - end : 0)
}
const pending: Step[] = childSteps(content, { level: 1, lines: 2 }, 0, undefined, () => undefined).reverse() const pending: Step[] = childSteps(content, { level: 1, lines: 2 }, 0, undefined, () => undefined).reverse()
for (let step = pending.pop(); step !== undefined; step = pending.pop()) { for (let step = pending.pop(); step !== undefined; step = pending.pop()) {
if (step.kind === 'gap') { if (step.kind === 'node') {
gap = Math.max(gap, step.lines) const refusal = openNode(writing, step, pending)
continue if (refusal !== undefined) return refusal
} else applyStep(writing, step)
if (writing.length > longestOutput) return tooLong()
} }
if (step.kind === 'leaveCell') { return success(writing.pieces.join(''))
const written = cell !== undefined && length > cell.start
gap = written ? 0 : step.gap
literal = written ? 0 : step.literal
cell = step.cell
continue
} }
if (step.kind === 'separator') {
emit(' | ') // What a step that is no node does to the state.
continue function applyStep(writing: Writing, step: Exclude<Step, { kind: 'node' }>): void {
if (step.kind === 'gap') writing.gap = Math.max(writing.gap, step.lines)
else if (step.kind === 'separator') emit(writing, ' | ')
else if (step.kind === 'leave') {
writing.indent = step.indent
writing.lead = step.length === writing.length ? step.lead : undefined
} else {
const written = writing.cell !== undefined && writing.length > writing.cell.start
writing.gap = written ? 0 : step.gap
writing.literal = written ? 0 : step.literal
writing.cell = step.cell
} }
if (step.kind === 'leave') {
indent = step.indent
lead = step.length === length ? step.lead : undefined
continue
} }
// Writes the text of a node, and pushes the steps for the nodes within it; refuses a node nested too deep.
function openNode(writing: Writing, step: Extract<Step, { kind: 'node' }>, pending: Step[]): Result<string> | undefined {
const { depth, marker, node, place, suffix } = step const { depth, marker, node, place, suffix } = step
if (depth > largestNesting) return failure('unsupported-nesting-depth', `the document nests deeper than the ${largestNesting} levels the writer carries`, pathTo(place)) if (depth > largestNesting) return failure('unsupported-nesting-depth', `the document nests deeper than the ${largestNesting} levels the writer carries`, pathTo(place))
if (cellTypes.includes(node.type)) { if (cellTypes.includes(node.type)) {
pending.push({ cell, gap, kind: 'leaveCell', literal }) pending.push({ cell: writing.cell, gap: writing.gap, kind: 'leaveCell', literal: writing.literal })
cell = { base: indent, start: length } writing.cell = { base: writing.indent, start: writing.length }
} }
if (marker !== undefined) { if (marker !== undefined) {
pending.push({ indent, kind: 'leave', lead, length }) pending.push({ indent: writing.indent, kind: 'leave', lead: writing.lead, length: writing.length })
lead = lead === undefined ? `${indent}${marker}` : `${lead}${marker}` writing.lead = writing.lead === undefined ? `${writing.indent}${marker}` : `${writing.lead}${marker}`
indent = `${indent}${' '.repeat(marker.length)}` writing.indent = `${writing.indent}${' '.repeat(marker.length)}`
} }
if (node.type === 'hardBreak') gap += 1 if (node.type === 'hardBreak') writing.gap += 1
else if (shownTextTypes.includes(node.type)) emit(shownText(node) ?? '') else if (shownTextTypes.includes(node.type)) emit(writing, shownText(node) ?? '')
else if (cardTypes.includes(node.type)) emit(cardText(node)) else if (cardTypes.includes(node.type)) emit(writing, cardText(node))
else if (imageTypes.includes(node.type)) emit(imageText(node)) else if (imageTypes.includes(node.type)) emit(writing, imageText(node))
else { else {
const title = expandTypes.includes(node.type) ? shownText(node) : undefined const title = expandTypes.includes(node.type) ? shownText(node) : undefined
emit(`${node.text ?? title ?? ''}${suffix ?? ''}`) emit(writing, `${node.text ?? title ?? ''}${suffix ?? ''}`)
const inner = stepsWithin(node, depth, place) const inner = stepsWithin(node, depth, place)
if (title !== undefined) inner.unshift({ kind: 'gap', lines: 2 }) if (title !== undefined) inner.unshift({ kind: 'gap', lines: 2 })
for (const child of inner.reverse()) pending.push(child) for (const child of inner.reverse()) pending.push(child)
} }
if (length > longestOutput) return tooLong() return undefined
} }
return success(pieces.join(''))
// Past its first text, a cell goes on the row's line: a line feed owed becomes a space, and a marker keeps its place without the row's margin.
function emit(writing: Writing, text: string): void {
const end = endBeforeLineFeeds(text)
if (end > 0) {
const owed = Math.max(writing.gap, writing.literal)
const { cell, indent, lead, length } = writing
let head = ''
if (cell !== undefined && length > cell.start) head = owed > 0 ? ` ${lead === undefined ? '' : lead.slice(cell.base.length)}` : ''
else if (length === 0 || owed > 0 || lead !== undefined) head = `${length === 0 ? '' : '\n'.repeat(owed)}${lead ?? indent}`
const kept = text.slice(0, end)
const body = cell === undefined ? kept.replaceAll(/\n(?=[^\n])/g, `\n${indent}`) : kept.replaceAll(/\n+/g, ' ')
writing.pieces.push(head, body)
writing.length += head.length + body.length
writing.gap = 0
writing.lead = undefined
}
writing.literal = (end > 0 ? 0 : writing.literal) + (writing.cell === undefined ? text.length - end : 0)
} }
function endBeforeLineFeeds(text: string): number { function endBeforeLineFeeds(text: string): number {