mirror of
https://github.com/larvit/adf-codec.git
synced 2026-11-18 22:25:44 +01:00
337 lines
19 KiB
TypeScript
337 lines
19 KiB
TypeScript
import type { AdfDocument, AdfNode } from '../../adf/document.ts'
|
|
import type { BlockNodeModel } from '../../adf/block-nodes.ts'
|
|
import type { WrittenFlavour } from '../flavour.ts'
|
|
import { adfDocumentFault, heldTextLength, holdsOnlyAttributes, isUnmarkedSpellableText, nodeAttrs, nodeContent } from '../../adf/document.ts'
|
|
import { blockDirectiveForm, documentSpelling } from '../directive/block.ts'
|
|
import { blockNodeModel, blockNodes } from '../../adf/block-nodes.ts'
|
|
import { carriedBlock } from '../opaque-carry.ts'
|
|
import { emitInlineLine } from './inline-line.ts'
|
|
import { failure, faulted, success, type ConvertErrorPath, type Result } from '../../result.ts'
|
|
import { fencedCodeBlock } from '../commonmark/backtick-runs.ts'
|
|
import { flavourClaims } from '../flavour.ts'
|
|
import { holdsNullCharacter, isBlankLine, isThematicBreak, markerInterruptsParagraph } from '../commonmark/grammar.ts'
|
|
import { languageSlot, type LanguageSlot } from '../code-language.ts'
|
|
import { largestNesting } from '../../nesting.ts'
|
|
import { longestMarkdown, tooLong, withinEngineLimits, withinLongest } from '../length-bound.ts'
|
|
import { spellBlockDirectiveOpener } from '../directive/block-spelling.ts'
|
|
import { spellDirectiveCloser, spellDirectiveOpener } from '../directive/syntax.ts'
|
|
import { tryImage } from './image.ts'
|
|
import { tryPipeTable } from './pipe-table.ts'
|
|
|
|
type BlockContainer = 'directive' | 'document' | 'list-item'
|
|
type Delimiters = readonly [string, string]
|
|
// headroom: the nesting levels the deepest node below may still spend before `largestNesting` refuses it.
|
|
export type EmittedBlock = SpelledBlock & { headroom: number }
|
|
// A flavour's own blocks, spelled before CommonMark's, and the openings its reader claims, which a list item or quote escapes.
|
|
export type FlavourBlockWriters = {
|
|
claimsItem: (text: string) => boolean
|
|
claimsQuote: (text: string) => boolean
|
|
spell: (node: AdfNode, path: ConvertErrorPath, depth: number, writing: Writing) => Result<EmittedBlock> | undefined
|
|
}
|
|
type KeptSpelling = { block: EmittedBlock | undefined; depth: number }
|
|
export type PlacedBlock = SpelledBlock & { node: AdfNode }
|
|
export type PlacedBlocks = { blocks: readonly PlacedBlock[]; headroom: number }
|
|
// CommonMark starts a new list where the marker changes, so every second list in a run of one kind takes `alternateText`.
|
|
type SpelledBlock = { spelling: 'commonmark' | 'directive'; text: string } | { alternateText: string; interruptsParagraph: boolean; ordered: boolean; spelling: 'list'; text: string }
|
|
// Keyed by reference: only a caller building one object per position (the parse, the portable reduction) passes one; a consumer's document may share a node.
|
|
export type SpellingMemo = Map<AdfNode, KeptSpelling>
|
|
type WalkedItem = { node: AdfNode; walk: PlacedBlocks }
|
|
export type WrittenAs = { flavour: 'lossless' } | { blocks: FlavourBlockWriters; flavour: 'portable' }
|
|
export type Writing = WrittenAs & { memo: SpellingMemo | undefined }
|
|
|
|
const bulletDelimiters: Delimiters = ['-', '*']
|
|
export const largestListMarker = 999999999
|
|
// Bare because tryList admits no item carrying attributes, marks or text.
|
|
const listItemOpener = spellDirectiveOpener('listItem', undefined, '')
|
|
const orderedDelimiters: Delimiters = ['.', ')']
|
|
|
|
export function adfToLosslessMarkdown(document: AdfDocument): Result<string> {
|
|
return withinEngineLimits(() => writeMarkdown(document, { flavour: 'lossless' }))
|
|
}
|
|
|
|
export function writeMarkdown(document: AdfDocument, writtenAs: WrittenAs): Result<string> {
|
|
const fault = adfDocumentFault(document)
|
|
if (fault !== undefined) return faulted(fault, [])
|
|
if (document.version !== 1) return failure('unsupported-document-version', `no markdown spelling carries ADF version ${document.version}`, [])
|
|
if (document.content === undefined) return success(`${documentSpelling}\n`)
|
|
// Every character of text is spelled at least once, so this much text cannot fit, and none of it is spelled.
|
|
if (heldTextLength(document.content) > longestMarkdown) return tooLong()
|
|
const walk = walkBlocks(document.content, [], 0, { ...writtenAs, memo: undefined })
|
|
if (!walk.ok) return walk
|
|
const text = joinBlocks(walk.value.blocks, 'document')
|
|
return withinLongest(text === '' ? '' : `${text}\n`)
|
|
}
|
|
|
|
export function walkBlocks(nodes: readonly AdfNode[], path: ConvertErrorPath, depth: number, writing: Writing): Result<PlacedBlocks> {
|
|
let headroom = largestNesting - depth
|
|
if (headroom < 0) return tooDeep(path)
|
|
const blocks: PlacedBlock[] = []
|
|
for (const [index, node] of nodes.entries()) {
|
|
const block = emitBlock(node, [...path, 'content', index], depth, writing)
|
|
if (!block.ok) return block
|
|
// Refused here, so an engine holding longer strings stops at the block where V8 throws.
|
|
const fits = withinLongest(block.value.text)
|
|
if (!fits.ok) return fits
|
|
headroom = Math.min(headroom, block.value.headroom)
|
|
blocks.push({ ...block.value, node })
|
|
}
|
|
return success({ blocks, headroom })
|
|
}
|
|
|
|
function tooDeep(path: ConvertErrorPath): Result<never> {
|
|
return failure('unsupported-nesting-depth', `the document nests deeper than the ${largestNesting} levels the emitter carries`, path)
|
|
}
|
|
|
|
export function joinBlocks(blocks: readonly PlacedBlock[], container: BlockContainer): string {
|
|
let text = ''
|
|
let alternated = false
|
|
for (const [index, block] of blocks.entries()) {
|
|
const previous = blocks[index - 1]
|
|
if (previous !== undefined) text += separationBetween(previous, block, container)
|
|
alternated = !alternated && previous !== undefined && sharesMarker(previous, block)
|
|
text += alternated && block.spelling === 'list' ? block.alternateText : block.text
|
|
}
|
|
return text
|
|
}
|
|
|
|
function sharesMarker(previous: PlacedBlock, next: PlacedBlock): boolean {
|
|
return previous.spelling === 'list' && next.spelling === 'list' && previous.ordered === next.ordered
|
|
}
|
|
|
|
function separationBetween(previous: PlacedBlock, next: PlacedBlock, container: BlockContainer): string {
|
|
const bothCommonMark = previous.spelling !== 'directive' && next.spelling !== 'directive'
|
|
if (bothCommonMark && next.spelling === 'list' && container === 'list-item') return next.interruptsParagraph ? '\n' : '\n\n'
|
|
return container === 'directive' && !bothCommonMark ? '\n' : '\n\n'
|
|
}
|
|
|
|
export function emitBlock(node: AdfNode, path: ConvertErrorPath, depth: number, writing: Writing): Result<EmittedBlock> {
|
|
const model = blockNodeModel(node.type)
|
|
if (model === undefined) return carriedFence(carriedBlock(node, path, depth))
|
|
const readable = readableBlock(node, path, depth, writing, 'walked')
|
|
if (readable !== undefined) return readable
|
|
return emitDirectiveBlock(node, model, path, depth, () => walkBlocks(nodeContent(node), path, depth + 1, writing))
|
|
}
|
|
|
|
// Whether the node takes a CommonMark spelling, rather than its directive.
|
|
export function commonMarkSpelling(node: AdfNode, path: ConvertErrorPath, depth: number, writing: Writing & { memo: SpellingMemo }): Result<boolean> {
|
|
const readable = readableBlock(node, path, depth, writing, 'asked')
|
|
if (readable === undefined) return success(false)
|
|
if (!readable.ok) return readable
|
|
const fits = withinLongest(readable.value.text)
|
|
if (!fits.ok) return fits
|
|
return success(readable.value.spelling !== 'directive')
|
|
}
|
|
|
|
// Only an `asked` call keeps a spelling, and any read drops it: the ancestor that reads it spells it into its own text, so no two levels hold that text.
|
|
function readableBlock(node: AdfNode, path: ConvertErrorPath, depth: number, writing: Writing, caller: 'asked' | 'walked'): Result<EmittedBlock> | undefined {
|
|
const { memo } = writing
|
|
const kept = memo?.get(node)
|
|
memo?.delete(node)
|
|
if (kept !== undefined) {
|
|
if (kept.block === undefined) return undefined
|
|
// An entry holds the spelling at its fill depth. A read at or above it rebases headroom; a read below re-spells, because a hit skips the walk's depth guards.
|
|
if (depth <= kept.depth) return success({ ...kept.block, headroom: kept.block.headroom + kept.depth - depth })
|
|
}
|
|
const spelled = spellReadableBlock(node, path, depth, writing)
|
|
if (caller === 'asked' && spelled === undefined) memo?.set(node, { block: undefined, depth })
|
|
if (caller === 'asked' && spelled?.ok === true) memo?.set(node, { block: spelled.value, depth })
|
|
return spelled
|
|
}
|
|
|
|
function spellReadableBlock(node: AdfNode, path: ConvertErrorPath, depth: number, writing: Writing): Result<EmittedBlock> | undefined {
|
|
const own = writing.flavour === 'portable' ? writing.blocks.spell(node, path, depth, writing) : undefined
|
|
if (own !== undefined) return own
|
|
if (node.type === 'blockquote') return holdsOnlyAttributes(node, []) ? quotedBlocks(node, path, depth, writing, (body) => alertEscaped(body, writing)) : undefined
|
|
if (node.type === 'bulletList' || node.type === 'orderedList') return tryList(node, path, depth, writing)
|
|
if (node.type === 'codeBlock') return readableText(tryCodeBlock(node, writing.flavour))
|
|
if (node.type === 'heading') return tryHeading(node, path, writing.flavour)
|
|
if (node.type === 'mediaSingle') return readableText(tryImage(node))
|
|
if (node.type === 'paragraph') return tryParagraph(node, path, writing.flavour)
|
|
if (node.type === 'rule') return readableText(tryRule(node))
|
|
if (node.type === 'table') return readableText(tryPipeTable(node, path, writing.flavour))
|
|
return undefined
|
|
}
|
|
|
|
function quoted(text: string): string {
|
|
return text
|
|
.split('\n')
|
|
.map((line) => (line === '' ? '>' : `> ${line}`))
|
|
.join('\n')
|
|
}
|
|
|
|
function readableText(text: string | undefined): Result<EmittedBlock> | undefined {
|
|
return text === undefined ? undefined : success(commonMarkText(text))
|
|
}
|
|
|
|
function carriedFence(carried: Result<{ headroom: number; text: string }>): Result<EmittedBlock> {
|
|
if (!carried.ok) return carried
|
|
return success({ ...carried.value, spelling: 'commonmark' })
|
|
}
|
|
|
|
function commonMarkText(text: string, headroom: number = Number.POSITIVE_INFINITY): EmittedBlock {
|
|
return { headroom, spelling: 'commonmark', text }
|
|
}
|
|
|
|
function directivePair(node: AdfNode, opener: string, body: string, headroom: number = Number.POSITIVE_INFINITY): EmittedBlock {
|
|
return { headroom, spelling: 'directive', text: `${opener}\n${body === '' ? '' : `${body}\n`}${spellDirectiveCloser(node.type)}` }
|
|
}
|
|
|
|
function emitDirectiveBlock(node: AdfNode, model: BlockNodeModel, path: ConvertErrorPath, depth: number, walkBody: () => Result<PlacedBlocks>): Result<EmittedBlock> {
|
|
if (node.text !== undefined) return failure('unsupported-node-shape', `a ${node.type} carries no text: this one holds text`, path)
|
|
if (blockDirectiveForm(node.type) === 'leaf' && nodeContent(node).length > 0) return failure('unsupported-node-shape', `a ${node.type} holds no content: this one holds some`, path)
|
|
if (model.contentModel === 'code') return emitCodeDirective(node, model, path, depth)
|
|
const opener = spellBlockDirectiveOpener(node, model, path)
|
|
if (opener === undefined) return carriedFence(carriedBlock(node, path, depth))
|
|
if (!opener.ok) return opener
|
|
return emitDirectiveBody(node, model, opener.value, path, walkBody)
|
|
}
|
|
|
|
function emitDirectiveBody(node: AdfNode, model: BlockNodeModel, opener: string, path: ConvertErrorPath, walkBody: () => Result<PlacedBlocks>): Result<EmittedBlock> {
|
|
if (blockDirectiveForm(node.type) === 'leaf') return success({ headroom: Number.POSITIVE_INFINITY, spelling: 'directive', text: opener })
|
|
if (model.contentModel === 'inline') {
|
|
const line = emitInlineLine(nodeContent(node), 'paragraph', path, 'lossless')
|
|
if (!line.ok) return line
|
|
return success(directivePair(node, opener, line.value))
|
|
}
|
|
const walk = walkBody()
|
|
if (!walk.ok) return walk
|
|
return success(directivePair(node, opener, joinBlocks(walk.value.blocks, 'directive'), walk.value.headroom))
|
|
}
|
|
|
|
function alertEscaped(body: string, writing: Writing): string {
|
|
return writing.flavour === 'portable' && writing.blocks.claimsQuote(body) ? `\\${body}` : body
|
|
}
|
|
|
|
// Each quote speller calls it directly, not through a wrapper, so a quote level spends one frame between walks (docs/decisions.md §Nothing recurses unbounded).
|
|
export function quotedBlocks(node: AdfNode, path: ConvertErrorPath, depth: number, writing: Writing, bodyText: (body: string) => string): Result<EmittedBlock> {
|
|
const inner = walkBlocks(nodeContent(node), path, depth + 1, writing)
|
|
if (!inner.ok) return inner
|
|
return success(commonMarkText(quoted(bodyText(joinBlocks(inner.value.blocks, 'document'))), inner.value.headroom))
|
|
}
|
|
|
|
function tryCodeBlock(node: AdfNode, flavour: WrittenFlavour): string | undefined {
|
|
if (!holdsOnlyAttributes(node, ['language'])) return undefined
|
|
const slot = languageSlot(nodeAttrs(node)['language'], flavourClaims[flavour])
|
|
if (slot.kind === 'attribute') return undefined
|
|
const [only, ...others] = fencedTexts(node) ?? []
|
|
if (only === undefined || others.length > 0) return undefined
|
|
return fencedCodeBlock(slot.kind === 'fence' ? slot.info : '', only)
|
|
}
|
|
|
|
// spec/flavour.md, The CommonMark blocks: one fence per text node, the language on each; with no fence to carry it, the attribute does.
|
|
function emitCodeDirective(node: AdfNode, model: BlockNodeModel, path: ConvertErrorPath, depth: number): Result<EmittedBlock> {
|
|
const texts = fencedTexts(node)
|
|
if (texts === undefined) return carriedFence(carriedBlock(node, path, depth))
|
|
const slot: LanguageSlot = texts.length === 0 ? { kind: 'attribute' } : languageSlot(nodeAttrs(node)['language'], flavourClaims.lossless)
|
|
const opener = spellBlockDirectiveOpener(node, model, path, slot.kind === 'attribute' ? [] : ['language'])
|
|
if (opener === undefined) return carriedFence(carriedBlock(node, path, depth))
|
|
if (!opener.ok) return opener
|
|
const info = slot.kind === 'fence' ? slot.info : ''
|
|
return success(directivePair(node, opener.value, texts.map((text) => fencedCodeBlock(info, text)).join('\n')))
|
|
}
|
|
|
|
// The text of each fence, or `undefined` where a child holds what no fence keeps, so the block carry takes the node.
|
|
function fencedTexts(node: AdfNode): string[] | undefined {
|
|
if (node.content === undefined) return ['']
|
|
const texts: string[] = []
|
|
for (const child of node.content) {
|
|
if (!isUnmarkedSpellableText(child) || typeof child.text !== 'string' || child.text === '' || /\r/.test(child.text) || holdsNullCharacter(child.text)) return undefined
|
|
texts.push(child.text)
|
|
}
|
|
return texts
|
|
}
|
|
|
|
function tryHeading(node: AdfNode, path: ConvertErrorPath, flavour: WrittenFlavour): Result<EmittedBlock> | undefined {
|
|
if (!holdsOnlyAttributes(node, ['level'])) return undefined
|
|
const level = nodeAttrs(node)['level']
|
|
if (typeof level !== 'number' || !Number.isInteger(level) || level < 1 || level > 6) return undefined
|
|
const hashes = '#'.repeat(level)
|
|
const content = nodeContent(node)
|
|
if (content.length === 0) return success(commonMarkText(hashes))
|
|
const line = emitInlineLine(content, 'heading', path, flavour)
|
|
if (!line.ok) return line
|
|
return success(commonMarkText(`${hashes} ${line.value}`))
|
|
}
|
|
|
|
function tryList(node: AdfNode, path: ConvertErrorPath, depth: number, writing: Writing): Result<EmittedBlock> | undefined {
|
|
const ordered = node.type === 'orderedList'
|
|
if (!holdsOnlyAttributes(node, ordered ? ['order'] : [])) return undefined
|
|
const items = nodeContent(node)
|
|
const start = listStart(node, items.length)
|
|
if (start === undefined || items.length === 0) return undefined
|
|
if (items.some((item) => item.type !== 'listItem' || !holdsOnlyAttributes(item, []))) return undefined
|
|
const walked: WalkedItem[] = []
|
|
let headroom = Number.POSITIVE_INFINITY
|
|
for (const [offset, item] of items.entries()) {
|
|
const walk = walkBlocks(nodeContent(item), [...path, 'content', offset], depth + 1, writing)
|
|
if (!walk.ok) return walk
|
|
headroom = Math.min(headroom, walk.value.headroom)
|
|
walked.push({ node: item, walk: walk.value })
|
|
}
|
|
const inners = walked.map((item) => {
|
|
const inner = joinBlocks(item.walk.blocks, 'list-item')
|
|
return writing.flavour === 'portable' && writing.blocks.claimsItem(inner) ? `\\${inner}` : inner
|
|
})
|
|
const list = spelledList(inners, ordered ? start : undefined, headroom)
|
|
if (list !== undefined) return success(list)
|
|
// The directive form spends a level the walk did not count.
|
|
if (headroom < 1) return tooDeep(path)
|
|
return emitDirectiveBlock(node, ordered ? blockNodes.orderedList : blockNodes.bulletList, path, depth, () => success({ blocks: directiveItems(walked), headroom: headroom - 1 }))
|
|
}
|
|
|
|
// start: an ordered list's first number, undefined for a bullet list.
|
|
export function spelledList(inners: readonly string[], start: number | undefined, headroom: number): EmittedBlock | undefined {
|
|
const [usual, alternate] = start === undefined ? bulletDelimiters : orderedDelimiters
|
|
const number = (offset: number): string => (start === undefined ? '' : `${start + offset}`)
|
|
const text = listLines(inners, number, usual)
|
|
const alternateText = listLines(inners, number, alternate)
|
|
if (text === undefined || alternateText === undefined) return undefined
|
|
return { alternateText, headroom, interruptsParagraph: markerInterruptsParagraph(start, inners[0] === ''), ordered: start !== undefined, spelling: 'list', text }
|
|
}
|
|
|
|
function listLines(inners: readonly string[], number: (offset: number) => string, delimiter: string): string | undefined {
|
|
const lines: string[] = []
|
|
for (const [offset, inner] of inners.entries()) {
|
|
const line = tryListItemLines(inner, `${number(offset)}${delimiter} `)
|
|
if (line === undefined) return undefined
|
|
lines.push(line)
|
|
}
|
|
return lines.join('\n')
|
|
}
|
|
|
|
function directiveItems(items: readonly WalkedItem[]): PlacedBlock[] {
|
|
return items.map((item) => ({ ...directivePair(item.node, listItemOpener, joinBlocks(item.walk.blocks, 'directive')), node: item.node }))
|
|
}
|
|
|
|
function listStart(node: AdfNode, items: number): number | undefined {
|
|
if (node.type !== 'orderedList') return 0
|
|
const start = nodeAttrs(node)['order']
|
|
if (typeof start !== 'number' || !Number.isInteger(start) || start < 0 || Object.is(start, -0) || start > largestListMarker) return undefined
|
|
return start + items - 1 > largestListMarker ? undefined : start
|
|
}
|
|
|
|
function tryListItemLines(inner: string, marker: string): string | undefined {
|
|
if (inner === '') return marker.trimEnd()
|
|
const body = inner.split('\n')
|
|
if (body.some((line) => line !== '' && isBlankLine(line))) return undefined
|
|
const indent = ' '.repeat(marker.length)
|
|
const lines = body.map((line, index) => (index === 0 ? `${marker}${line}` : line === '' ? '' : `${indent}${line}`))
|
|
const first = lines[0] ?? ''
|
|
if (!isThematicBreak(first)) return lines.join('\n')
|
|
// An item opens with `*` only as text, a list there taking `- ` and a rule `---`; a backslash keeps a first line reading as a rule text.
|
|
return inner.startsWith('*') ? [`${marker}\\${first.slice(marker.length)}`, ...lines.slice(1)].join('\n') : undefined
|
|
}
|
|
|
|
function tryParagraph(node: AdfNode, path: ConvertErrorPath, flavour: WrittenFlavour): Result<EmittedBlock> | undefined {
|
|
const content = nodeContent(node)
|
|
if (content.length === 0 || !holdsOnlyAttributes(node, [])) return undefined
|
|
const line = emitInlineLine(content, 'paragraph', path, flavour)
|
|
if (!line.ok) return line
|
|
return success(commonMarkText(line.value))
|
|
}
|
|
|
|
function tryRule(node: AdfNode): string | undefined {
|
|
if (!holdsOnlyAttributes(node, []) || nodeContent(node).length > 0) return undefined
|
|
return '---'
|
|
}
|