ekp/readme_zh.md

Emacs-KP: Knuth-Plass 排版算法 Emacs 实现

English Documentation | 开发者指南 | 仓库审计

Emacs-kp 在 Emacs 内部完整实现了 Knuth-Plass 最优断行算法,支持中日韩 (CJK)与拉丁文混合排版。

特性

• 全局最优断行 — Knuth-Plass 动态规划求段落全局最优断点,而非贪心 首次适应。
• CJK 支持 — 每个 CJK 字符都是可断行的盒子;避头尾规则保证标点正确 附着(，。 不出现在行首,「《 不出现在行尾);汉字间距、中西文间距 独立可调。
• 连字符断词 — Frank Liang 算法(TeX 同款),内置 49 份带固定来源 与 SHA-256 的 Hunspell pattern 词典。
• 像素级两端对齐 — 每一行渲染宽度精确等于目标像素宽度(通过 display (space :width ...) 属性实现),支持变宽字体。
• 文本属性保留 — face、颜色等属性完整保留;断词插入的连字符继承所 在单词的样式。
• 困难输入不丢内容 — 超长不可断 token(URL、窄栏长词)退化为紧急 断行而不是吞掉文本;任何输入都有输出。
• 可选 C 模块 — 动态模块用 C 执行 DP,线程池并行处理多个段落(见 性能数据)。

环境要求

• Emacs 29.1+(依赖 string-pixel-width 与 object-intervals)
• 可选(C 模块):C11 编译器和 pthreads

安装

克隆仓库并加入 load-path(dictionaries/ 目录须与 .el 文件同级):

(add-to-list 'load-path "/path/to/emacs-kp")
(require 'ekp)
(require 'ekp-region)   ; buffer/region 命令

强烈建议字节编译——编译后 Elisp 引擎约快 10 倍。

快速开始

(require 'ekp)

;; 按 600 像素宽度两端对齐
(insert (ekp-pixel-justify "这是一段测试文本..." 600))

;; 在范围内寻找最优宽度,返回 (对齐文本 . 最优宽度)
(ekp-pixel-range-justify "测试文本" 400 800)

多行字符串按行分段处理,空行保留。

C 模块(长文本推荐)

cd ekp_c && make PROFILE=portable # 默认;产出 ekp.dylib/.so/.dll

(ekp-c-module-load)     ; 显示 "ekp-c module loaded (version 1.6, N threads)"
(ekp-c-module-build)    ; 选择 portable/native/debug/sanitize

加载后(ekp-use-c-module 默认为 t)所有排版调用自动走 C 引擎。 Elisp 与 C 两个引擎的输出完全一致;未启用模块或 C 返回 nil 时走 Elisp。已启用模块若 signal,则作为后端契约错误直接呈现。若磁盘上的 模块版本旧于 Elisp 代码的要求,加载会拒绝并提示重新编译。

交互使用(buffer 与 region)

ekp-region.el 把字符串 API 变成 buffer 级命令:

(require 'ekp-region)

• M-x ekp-justify-region — 把选区排版到窗口文本宽度(数字前缀参数 可指定像素宽)。没有激活选区时,排版光标所在段落。
• M-x ekp-justify-buffer — 排版整个 buffer。
• M-x ekp-unjustify-region / ekp-unjustify-buffer — 精确还原 原文,包括被折叠的连续空格。排版是无损的:每个合成空隙、软换行、 软连字符都携带它所替换的原文,还原是纯结构变换,即使排版后又编辑 过也能正确还原。
• M-x ekp-auto-justify-mode — 让整个 buffer 保持按窗口宽度排版。 窗口宽度变化时自动重排(防抖延迟 ekp-auto-justify-resize-delay); 编辑后只重排被改动的段落(空闲延迟 ekp-auto-justify-edit-delay), 未变段落直接命中段落缓存。关闭 mode 时 buffer 精确恢复原状。 mode 激活时,标准 EKP 菜单提供排版、保护与窗口适配诊断命令; C-h m 也会说明同一套流程。

buffer 被当作活的文档,而不只是画布:

• 保存时写入的是逻辑文本——软换行、glue 空格、断词连字符属于 排版而非内容,不会落盘;即使写盘失败或中断,屏幕 buffer 也保持排版态。 该保证适用于整 buffer 保存;显式只写局部的 write-region 会写入所选 区域当前的物理 buffer 表示。
• 搜索(isearch)看到的是逻辑文本,中文短语与被断词的英文单词 都能跨排版找到。
• 复制放进 kill ring 的是逻辑文本,粘贴出去的是文字而非像素间距; 已有 mode/user substring filter 会继续生效,最后一个排版区间移除后 精确恢复。
• 仅仅开启 mode 不会把 buffer 标记为已修改(不产生锁文件或 auto-save), 重排定时器也不再与 undo 打架。

ekp-region-margin-pixel(默认 2)是从窗口宽度中扣除的取整安全边距。

大 buffer(超过 ekp-auto-justify-lazy-threshold 字符,默认 2 万) 自动改为可视优先重排:屏幕内的部分同步完成,其余在空闲时后台分块 补齐,每个时间片有时间预算(ekp-auto-justify-tick-budget),并优先 处理你滚动到的区域。

各 mode 的 verbatim 保护预设——各一行:

(add-hook 'org-mode-hook      #'ekp-org-setup)
(add-hook 'markdown-mode-hook #'ekp-markdown-setup)

在 Org 与 Markdown buffer 里,若你没有自定义配置, ekp-auto-justify-mode 会自动套用对应预设。

保护代码块与 verbatim 文本

• 段落级:携带 ekp-verbatim 文本属性(M-x ekp-verbatim-region)、 face 在 ekp-region-skip-faces 列表中(如 org-block、 markdown-code-face)、或被 buffer-local 的 ekp-region-skip-predicate 判定的段落原样跳过,一个字节都不动。
• 行内级:带 ekp-no-break 属性的区间(M-x ekp-no-break-region) 成为刚性原子——不断行、不断词、空格保持字面宽度——适合行内代码、 产品名、数字加单位。

手动属性明确只在当前 buffer 会话有效:普通文本保存与重新打开不会 恢复它们。使用 M-x ekp-allow-break-region / ekp-clear-verbatim-region 清除。需要从持久文档语法派生保护时,使用 mode face 或 buffer-local 的 ekp-region-skip-predicate(Org/Markdown 预设会自动这样做)。

排版特性

• 对齐模式 — ekp-alignment:justify(默认)/ragged-right/ ragged-left/center。非两端对齐模式下词间距保持自然,K-P 仍在 每行 ekp-ragged-stretch-pixel(≈2 em)的余量内全局最小化参差。
• 标点悬挂 — 置 ekp-protrusion 为 t,行尾标点(。、」以及 西文句读、断词连字符)按 ekp-protrusion-ratios 悬出齐边。全角 闭合标点默认 0.5,视觉上等价于 CLREQ 的行尾标点半角化。 ekp-auto-justify-mode 自动预留悬挂宽度。
• 段落形状 — ekp-first-line-indent(t = 2 em)实现中文段首 缩进惯例;或用 TeX 式 ekp-parshape 逐行指定 (缩进 . 宽度)。 首行缩进走高速的 1D 路径与 C 引擎;只有完整的 ekp-parshape 和 ekp-looseness 才回落到 Elisp 专属的 2D 动态规划。
• 不可断字符 — NBSP、窄 NBSP、数字空格、WORD JOINER 天然把两侧 锁在同一行。
• 禁则覆盖全角与半角标点:行首不会出现 。、」!? 或独立的 .,;:!?,行尾不会出现 「( 等。日文行首禁则还覆盖小假名、长音 符和叠字符(っ ょ ー 々),可通过 ekp-cjk-no-line-start-extra 配置。

已知限制:行中的 CLREQ 标点压缩(如「字。下」行内挤压)无法渲 染——Emacs 不能缩减字形 advance——因此行边压缩以悬挂方式呈现;左缘 悬挂同理不可渲染(文本无法起笔于行原点之前)。

配置

断词语言

(setq ekp-latin-lang "de_DE")   ; 默认 "en_US"

"de" 这类短代码会解析到第一个匹配的词典。受支持词典自身的 LEFTHYPHENMIN / RIGHTHYPHENMIN 都会被遵守(英文在断点前保留 ≥2 字母、之后 ≥3); 给 ekp-hyphen-create 传显式边距可覆盖。

EKP 支持普通 Liang pattern。eo、ca、hu_HU 与 sq_AL 含有 斜杠/替换规则,会在选中断点时改写字形;把它们当成普通位置既会产生 错误拼写,也会让 DP 使用错误宽度。因此这些语言会明确 signal ekp-hyphen-unsupported-pattern,而不是静默降级。完整文件清单、 SHA-256、固定来源路径和许可证据见 dictionaries/MANIFEST.tsv 与 dictionaries/LICENSES.md。

间距参数

三类 glue 控制间距(单位均为像素):

参数组	位置
lws-*	拉丁词之间
mws-*	拉丁词与 CJK 字符之间
cws-*	CJK 字符之间

每类包含理想宽度、最大拉伸、最大收缩:

(ekp-param-set lws-ideal lws-stretch lws-shrink
               mws-ideal mws-stretch mws-shrink
               cws-ideal cws-stretch cws-shrink)
;; 例如 (ekp-param-set 7 3 2  5 2 1  0 2 0)

• 从不调用 ekp-param-set 时,参数按每个字符串的字体自动计算。
• 显式设置的参数持久生效,直到调用 ekp-param-reset 恢复自动模式。

算法参数

变量	默认值	含义
ekp-line-penalty	10	每行基础代价;越大越倾向少行
ekp-hyphen-penalty	50	连字符断词代价(以 penalty² 计入)
ekp-adjacent-fitness-penalty	100	相邻行松紧等级相差 >1 的代价
ekp-consecutive-hyphen-penalty	100	连续断词行的代价系数(× 次数²)
ekp-last-line-min-ratio	0.5	末行最小填充比例
ekp-last-line-short-penalty	50	末行过短的代价系数
ekp-looseness	0	目标行数偏移:+1 比最优多一行,−1 少一行

两个引擎都实现了这些参数:实际进入 C 计算前,Elisp 会同步当前值。 DP 缓存签名包含表中的全部参数,因此修改后下一次调用即生效,无需 手动清缓存。ekp-looseness 由专门的 Elisp 路径处理(非零时自动 绕过 C 模块)。

缓存

分词、测宽和 DP 结果按段落缓存;盒宽还额外做会话级缓存,跨段落共享 的字形整个会话只测量一次。 显式间距值和自动模式的 ekp-default-cws-stretch-pixel 都属于段落 缓存签名。同字符串快路径也使用同一个完整结构 key,因此在已缓存的 字符串对象上增删 ekp-no-break 等排版属性会立即生效。

• ekp-para-cache-limit(默认 256):缓存段落数上限,超过后整体清空。
• M-x ekp-clear-caches 清空所有缓存(更换字体或影响字宽的主题后使用)。

性能

基于内置示例文本(tests/ekp-bench.el)、batch Emacs 30.2、Apple Silicon 测得;方法见 DEVELOPER_ZH.md:

场景(text-zh.txt ≈ 3.6KB)	Elisp(字节编译)	C 模块
两端对齐,宽 200px	150 ms	41 ms
最优宽度搜索 340–380	529 ms	106 ms
仅 DP,宽 400px	30 ms	2.5 ms

请字节编译本包——编译后 Elisp 引擎快约 10 倍。两引擎输出完全一 致;C 模块在最优宽度搜索和长多段文本上收益最大。(绝对数值随机器与 功耗状态波动,重点看比例。)

已知限制

• 测量会跟随当前 buffer 的 face 重映射(text-scale-mode、主题等), 并在无 fringe 的窗口里为截断指示符预留一列,排版行贴合真实显示。 若在特殊配置下仍出现截断或偏短,在该 buffer 里执行 M-x ekp-diagnose——它会报告测量与渲染是否一致。完整贴合矩阵是 tests/ekp-gui-verify.el 中的开发工具;执行 M-x ekp-gui-verify 前须先加载该文件。
• 计算默认间距时假定每段落的拉丁/CJK 各使用一种字体;混合字体段落可以 工作,但默认间距取自找到的第一个字体。
• ekp-pixel-range-justify 用三分搜索加局部扫描最小化平均 demerits; 代价关于宽度并非严格单峰,结果是很好的局部最优,不保证全局最优。
• batch/tty 模式下像素宽度退化为字符列数(整条管线仍可工作,便于测试)。

交互式演示

emacs -Q -L /path/to/emacs-kp -l tests/ekp-showcase.el -f ekp-showcase

单 buffer 按键交互:-/+ 增减像素宽度(头行实时显示本次重排毫秒 数),d 宽度扫掠动画并报告 fps,a 循环四种对齐,p 标点悬挂, i 首行缩进,s 楔形 parshape,c 切换 C/Elisp 引擎对比性能, w 进入跟随窗口宽度模式(真实 ekp-auto-justify-mode)。样例文本 内置受保护代码块、行内不可断原子与 NBSP 锁定的数字。

测试

tests/run-tests.sh /path/to/emacs     # 全部支持 batch 的 ERT 测试集

# 完整的交互式 GUI 贴合矩阵
emacs -Q -L /path/to/emacs-kp -L /path/to/emacs-kp/tests \
  -l /path/to/emacs-kp/tests/ekp-gui-verify.el \
  -f ekp-gui-verify-matrix

矩阵会打印全部行；任一贴合检查失败时以状态码 1 退出，因此同一命令可 作为本地发布门禁。验证器是 tests/ 下的开发工具， (require 'ekp-region) 不会加载它。

致谢

• 核心算法: "Breaking Paragraphs into Lines" by Donald E. Knuth and Michael F. Plass (1981)
• 断词算法: Frank Liang 算法,改编自 Pyphen
• 词典: 断词模式来自 LibreOffice dictionaries;准确来源、校验值和许可证据见 dictionaries/MANIFEST.tsv、dictionaries/LICENSES.md 与随附的各词典说明。