如何在不重置排版状态下刷新OCaml Format格式化器？

在OCaml的Format模块中，pp_print_flush会强制输出格式化器的缓冲区内容，但同时会重置所有排版状态（关闭所有打开的排版框、取消制表位等）。如果用Format.make_formatter自定义了格式化器，想要触发其out函数写入内容，又不想破坏当前的排版状态（比如保留打开的缩进框），可以通过以下方式解决：

背景说明 #

我开发了一个支持并发测试的单元测试框架，要求输出严格按照测试启动顺序排列且不交错，同时完成的测试要尽快输出。为验证这个行为，我实现了一个追加到string ref的格式化器，但只有调用pp_print_flush才会触发out函数执行。测试时，不刷新就无法验证中间输出，但刷新会关闭排版框导致后续输出缩进错误，目前只能修改预期结果，希望找到正确的解决方式。

自定义格式化器实现：

let make_string_ref_formatter s =
  let out b p l =
    let current = !s in
    let appended = String.sub b p l in
    s := current ^ appended
  in
  Format.make_formatter out (fun _ -> ())

可行解决方案 #

OCaml的Format模块本身没有提供“只刷新输出不重置排版状态”的直接函数，但可以通过以下几种方式解决：

方案1：刷新后恢复排版状态 #

核心思路是：在调用pp_print_flush前记录当前的排版框深度，刷新后重新打开对应深度的排版框，恢复之前的排版环境。

修改后的测试代码示例

let s = ref "" in
let fmt = make_string_ref_formatter s in
let p1, r1 = Lwt.wait () in
let p2, r2 = Lwt.wait () in
let p3, r3 = Lwt.wait () in
(* Setup test functions for these delayed promises, and run the test runner ... *)
Lwt.wakeup r3 ();
!s |> should (equal_string "");
Lwt.wakeup r1 ();
(* 记录当前排版框的深度 *)
let box_depth = Format.get_box_depth fmt in
(* 刷新输出 *)
Format.pp_print_flush fmt ();
!s |> should (equal_string "• ctx\n  ✔ 1\n  ");
(* 重新打开对应深度的vbox（假设之前用的是缩进2的vbox） *)
for _ = 1 to box_depth do
  Format.pp_open_vbox fmt 2
done;
Lwt.wakeup r2 ();
(* 最终刷新获取完整输出 *)
Format.pp_print_flush fmt ();
!s |> should (equal_string "• ctx\n  ✔ 1\n  ✔ 2\n  ✔ 3");

注意：这个方案依赖你知道之前使用的排版框类型（比如示例中的vbox），如果你的框架使用其他类型（如hbox），需要替换对应的pp_open_*函数。

方案2：调整格式化器为实时输出（不推荐） #

如果你的测试场景不需要复杂的排版功能，可以修改自定义格式化器，强制Format模块立即输出内容，避免缓冲。通过设置极小的margin值，让缓冲区一有内容就触发out函数：

修改后的格式化器实现

let make_immediate_string_ref_formatter s =
  let out b p l =
    let appended = String.sub b p l in
    s := !s ^ appended
  in
  let fmt = Format.make_formatter out (fun _ -> ()) in
  (* 设置margin为1，强制立即输出 *)
  Format.set_margin fmt 1;
  fmt

这种方式会破坏Format的排版逻辑，仅适合不需要缩进、换行控制的简单场景。

方案3：调整测试策略，验证最终输出 #

如果测试场景允许，可以放弃验证中间状态的输出，只测试所有测试完成后的最终输出。这样不需要调用pp_print_flush，排版状态不会被破坏，也能验证输出顺序是否符合预期。

内容的提问来源于stack exchange，提问作者Pete