走进 funide：IDE 源码导读

# 走进 funide：IDE 源码导读

前天把 [funide 开源](funide-open-source.htm)，五千来行交了出去；昨天写了它那个 400 行的调试器；今天该进屋看看房子本身了。语言那边早有一篇 [Fun 源码阅读指南](fun-source-reading-guide.htm)，这篇是它的姊妹篇：那篇走语言，这篇走承载语言的那个工具。

## 一、两张地图

funide 是 Fun 的桌面 IDE，一个 Delphi/VCL 程序，核心就是 SynEdit 编辑器加 Fun 解释器本体。它独立成库，构建时通过链接而不是复制来复用 fun 项目，所以读它的时候脑子里要同时装两张地图：IDE 自己的目录树，以及构建那一刻并进语言源码树里的那一层。

```text
funide/
├── src/
│   ├── ide/          # IDE 单元：ide.pas（全部所在）、三个高亮单元、资源
│   └── prj/ide/      # funide.dpr + make-2006/2009.bat + setenv/sync-ide.bat
└── syntaxes/
    └── fun.tmLanguage.yaml
```

这里没有语言源码。构建脚本先干一件事：把 `src/ide`、`src/prj/ide` 复制进 fun 检出（`<FUN_ROOT>\src\ide`、`<FUN_ROOT>\src\prj\ide`），好让 `funide.dpr` 里那些相对单元路径（`..\..\ide\...`、`..\..\regex\pcre\...`）解析得开，解释器单元（core、parse、lib、regex）则原样取自 fun。所以 funide 仓库只维护 IDE 层，Fun 实现只有一份。这一步只跟构建有关，读代码时不必记它。

## 二、只记一个念头

真正要记的就一件事：IDE 不在你的代码运行时才去调 `fun.exe`。它把 Fun 的解析器与解释器编进了程序里，当库来驱动。三个对象：

- `CdParser`（一个 `CParser`）把编辑器里的文本变成 AST；
- `CdRunner`（一个 `CEnv2`）执行它，并把输出缓存起来；
- 调试器，就是这两个类各自重写的那几个钩子。

其余的一切，标签页、行号槽的标记、标记大纲、查找替换、悬停求值，都只是包在这三个对象外面的 UI。弄懂 `CdParser` 和 `CdRunner` 怎么接线，就弄懂了整个 IDE。

外部启动器（`Fun.exe` / `Funu.exe`）是另一码事：几个菜单项在控制台里把它们拉起来，方便脱离 IDE 跑一次。可交互的 Run / Debug 路径是进程内的。

## 三、建议阅读顺序

先读类型，再读代码。`ide.pas` 的 `interface` 类型块就是演员表，按重要性排：

```text
TfIDE    (TForm)          # 整个程序：动作、面板、标签页
 ├── Files: TfFiles       # 打开着的缓冲区，以及断点记录
 ├── root : CRun          # 当前已装载的已解析程序
 └── vtNodes: TfTree      # 标记大纲
TfFiles → TfFile          # 一个文档：它的 TfEdit + 逐行的 CRune[]（fCodes）
TfEdit   (TCustomSynEdit) # 编辑器控件
CdParser (CParser) / CdRunner (CEnv2)   # 引擎
```

`TfFile.fCodes: array of CRune` 是调试器的钥匙：一张「行号到 AST 节点」的表，解析过程中顺手建起来。

然后看引擎怎么回报 UI。它们是解释器自身类的子类，重写了内核会调的那几个钩子：

- `CdParser.OnParse(n)` 在每条语句被建出来时调用，记下 `fCodes[n.row] := n`，也就是哪个 AST 节点住在哪一行；
- `CdParser.OnParse(fn; var s; m)` 拦截源码装载，于是可以把内存里的编辑器缓冲区（而不是磁盘文件）交给编译器；
- `CdParser.DoError` 抛异常，把解析错误交回窗体；
- `CdRunner.echo` 把输出缓存进 `ret`，而不是写控制台，`DoRun` 结束后再冲进输出面板；
- `CdRunner.trace` / `traced` 就是调试器。

所谓「与语言集成」就这么小：解析器三四个重写，执行器三四个重写。这里正是工具与语言的接缝。

接着读运行循环 `DoRun`，心脏只有几行：

```pascal
root := CdParser.Parse(ActiveEdit.Lines.Text, CdParser, ActiveEdit.FileName);
_ENV := CdRunner.create;
IsRunning := true;
root.run(_ENV);
Output(CdRunner(_ENV).ret);
```

解析当前缓冲区的文本，把 `CdRunner` 装成全局环境，运行模块，打印缓存。没有子进程，没有序列化：编辑器文本、解析器、正在跑的程序，都在同一个进程里。

## 四、几处值得记下的设计

读过管道之后，有几处设计值得记。它们多半出自同一个直觉：让语言内核去干活，自己只用最省事的机制顶上。

- **调试接缝是内核本就提供的。** `core.pas` 的 `CEnv.trace` 只做一件事（`lastNode := n`），`traced` 什么也不做。funide 重写这两个方法，就得到了单步、断点和步出。悬停求值也复用同一条缝：`Eval(id)` 就是 `_env.lastNode.uid(id)`。
- **断点是指针同一性，不是行号。** `OnParse` 填 `fCodes[row]`，`sameCode(n)` 判断 `fCodes[n.row] = n`。重解析会生成新节点，过时的断点自然失配；反过来，一行里有几条语句时只记得第一条，`if fCodes[n.row] = nil then` 那半句就是全部原因。
- **暂停靠泵消息循环。** `CdRunner.trace` 阻塞在一个 `while IsBreaked do DoEvents(true)` 里，`DoEvents` 是 `ProcessMessages` 加 `Sleep(1)`。解释器跑在 UI 线程，所以既没有工作线程，也不需要加锁。
- **停止是一个异常。** `aStopExecute` 只把 `IsRunning` 清掉；正在跑的 `trace` 随后 `raise Exception.create('[Stopped]')`，由 `DoRun` 的 `except` 捕获并打印。拿异常当控制流，廉价，但有效。
- **单实例 IPC 走 shell 拖放通道。** `FindIDE` 用 `GlobalAlloc` 手工造一个 `DRAGINFO` / `HDROP`，把 `WM_DropFiles` 投给已在运行的窗口，接收端走的是标准的 `DragQueryFile` / `DragFinish`。不用 socket、管道或锁文件。
- **SynEdit 的查找引擎架在 PCRE 上。** `TfSearch` 把 `ssoMatchCase` 映射到 PCRE 的 `preCaseLess`；普通查找被包成 `\Q...\E`，整词再加 `\b`，于是所有查找都走同一个正则引擎。微妙处在坐标：Fun 的 `CPcre` 报的是 UTF-8 字节偏移，SynEdit 要的是 UTF-16 字符下标，`FindAll` 得先数前导字节。
- **sidecar 配置。** `funide.exe.ini`、`funide.exe.log`、`funide.exe.presets` 都是 `ParamStr(0)` 加后缀，程序把设置带在自己身边。

那份 presets 文件不只是查找替换用的，它正是 IDE 不靠解析器就能列出函数/类的方式，拆解另有一篇。

## 追一次「点 Run」

1. `aRunExecute` 清掉 `IsBreaked`，调用 `DoRun`。
2. `DoRun` 用 `CdParser` 解析当前缓冲区（顺手把「行到节点」记进 `fCodes`），建一个 `CdRunner` 当 `_ENV`。
3. `root.run(_ENV)` 执行。每条语句都会调到 `CdRunner.trace`；没有断点时它只是泵一泵消息循环。
4. `CdRunner.echo` 把输出累加进 `ret`；`DoRun` 通过 `Output` 显示出来。

再追一次「点 Step Into」：`aStepIntoExecute` 到 `DoStep(dmInto)`；下一次 `trace` 看到 `DebugMode = dmInto`，置 `IsBreaked`，窗体就在自己的消息泵循环里停住，直到用户再步进一次。

## 零碎

- **高亮器是生成的。** `funsyntax.pas`（1079 行）与 `regexsyntax.pas`（622 行）是 SynGen 生成的 `TSynCustomHighlighter`，`fdsyntax.pas`（646 行）是手写的；`funsyntax.msg` 与 `regex-syntax.pcre` 是设计输入，不是参与编译的文件。
- **TfTree 是标记大纲。** 一个 VirtualTrees 的 `TVirtualStringTree`，当惰性标记大纲用，不是 AST 视图；子节点数来自 `TfEdit.CountMark`，读的是行号槽用的同一个逐行字节数组。
- **只有 Windows。** IDE 只支持 Windows/VCL（它 `uses Windows, Messages, ShellAPI, XPMan`），没有 Free Pascal 或 Linux 目标。Delphi 2006/2009 的构建见 `src/prj/ide`。
- **另一个产物。** `syntaxes/fun.tmLanguage.yaml` 与编译出来的 IDE 无关，那是 GitHub Linguist 收录的 TextMate 语法。

一个好上手的改法：在 `CdRunner.trace` 里加一行打印，跑个小脚本，看 AST 一行行走过。那就是 [Fun 源码阅读指南](fun-source-reading-guide.htm) 里的解释器，只不过这次是从工具内部看它。