技术文章

HotXLS 公式闭包:Delphi 中的 LAMBDA 与 LET

单元格里写着 =NetOf(B2, C2),B2 是 1250,C2 是 0.19,Excel 显示 1012.5,而工作簿里既没有 VBA 模块也没有加载项。NetOf 住在名称管理器里:它是一个定义名称,内容是 LAMBDA(amount, rate, amount*(1-rate))。把每个定义名称都当成区域或常量的服务端求值器在这里找不到任何可调用的东西,单元格返回 #NAME?

要把这个单元格算对,光有一个认识 LAMBDA 这个词的解析器不够。经典的电子表格求值器认识五种值:数字、文本、布尔、错误、以及指向装着这些值的单元格的引用。LAMBDA 增加了第六种:函数值,它带着参数名、函数体、以及书写处可见的那些名字。LET 是故事的另一半,因为用户正是在 LET 里把这些函数绑到简短的局部名字上,几个 token 之后便调用,还常常套三层

函数名字能在三个地方解析

HotXLS 公式引擎遇到对一个名字的调用而该名字不是内置函数时,会按固定顺序尝试三个来源。第一个是当前 LET 或 LAMBDA 作用域:如果 f 是持有闭包的局部绑定,f(21) 就应用它。第二个是其文本以 LAMBDA 开头的工作簿定义名称,于是 NetOf(1250, 0.19) 会编译该名称的函数体并应用到两个参数上。第三个是你可能已经在用的自定义 Delphi 函数的用户函数处理器,见 HotXLS 公式引擎中的自定义函数。三处都落空,单元格才是 #NAME?

这个顺序在一种具体情况里很关键。局部名字永远压过同拼写的工作簿名字,哪怕局部绑定装的是一个普通数字。此时定义名称查找整个跳过,调用直接落到用户函数处理器,同名的工作簿 LAMBDA 在这次调用中不会被征询

HotXLS 在 Delphi 中对未知函数名(如 f(21))依次尝试的三条调用解析路径示意:持有闭包的局部 LET 或 LAMBDA 作用域绑定、RefersTo 文本以 LAMBDA 开头的工作簿定义名称、经典用户函数处理器;装着数字的局部绑定不会被当函数应用,没有用户函数处理器认领该名字时调用以 #NAME? 收场
HotXLS 先试局部作用域,再试 LAMBDA 定义名称,最后是经典用户函数处理器;不持有闭包的绑定拒绝被调用

Delphi 这边很短。具名函数只是一个用 TXLSXDefinedNames.Add 加进去的定义名称,而一条公式内部的闭包根本不需要注册:

var
  Book: TXLSXWorkbook;
  Sheet: TXLSXWorksheet;
begin
  Book := TXLSXWorkbook.Create;
  try
    Sheet := Book.Sheets.Add('Model');

    // 两参数 Add = 工作簿级作用域,按名调用查找的正是这里
    Book.DefinedNames.Add('NetOf', 'LAMBDA(amount, rate, amount*(1-rate))');

    // 1250 * (1 - 0.19) = 1012.5
    Sheet.Cells[2, 2].Formula := 'NetOf(1250, 0.19)';

    // 在一条公式内绑定并应用闭包:42
    Sheet.Cells[3, 2].Formula := 'LET(double, LAMBDA(x, x*2), double(21))';

    // bump 捕获 base = 100;bump(5) = 105,step*2 = 210
    Sheet.Cells[4, 2].Formula :=
      'LET(base, 100, bump, LAMBDA(v, v+base), LET(step, bump(5), step*2))';

    // 后缀应用,连名字都没有:42
    Sheet.Cells[5, 2].Formula := 'LAMBDA(x, x*2)(21)';

    Book.Recalculate;
    Book.SaveAs('lambda-model.xlsx');
  finally
    Book.Free;
  end;
end;

最后一个单元格展示了一种容易被遗忘的写法。Excel 允许在 LAMBDA 表达式后面直接跟实参列表来应用它,HotXLS 也以同样的方式解析 LAMBDA(x, x*2)(21)。只有当前面是一个可能产生函数的东西——名字、LET 或 IF 表达式、或另一次应用——解析器才接受这个尾随实参列表。写 (1+2)(3) 会在编译期失败,而不是求值期

闭包记住什么,参数为什么赢

在 HotXLS 里求值一个 LAMBDA 表达式产出一个闭包值:参数名、函数体副本、书写时所在的工作表、以及当时可见的每一条 LET 或 LAMBDA 绑定的快照。在上面第四个单元格里,bump 创建时 base 已绑定为 100,所以闭包随身带着 base = 100。bump(5) 在内层 LET 里运行时,函数体仍然看得到那个 100,尽管内层 LET 对名为 base 的东西一无所知

一次调用分三步。先在调用者的作用域里求值实参表达式;然后压入捕获的环境,再在其上压入参数,求值函数体。查找自顶向下,所以名为 rate 的参数遮住捕获的名为 rate 的绑定,捕获绑定又遮住调用者恰好绑定的同名东西。函数体返回或失败后,作用域裁剪回调用开始的位置

HotXLS 在 Delphi 中一次 LAMBDA 闭包调用示意:闭包值带着参数、函数体和从外围 LET 捕获的 base 绑定,调用先压入捕获的环境再压入实参 v = 5,函数体求值得到 105,作用域栈在 finally 保护中裁剪回入口标记
调用闭包先压入捕获的环境、再压入实参绑定,正是这个顺序让参数遮住外围名字

“装上任何绑定之前先求值实参”听起来像细节,直到你写下 LET(x, 10, f, LAMBDA(x, x+1), f(x*2))。实参 x*2 必须指外层 x,得 20,结果是 21。如果参数先装上,实参就会读到它即将定义的那个参数。由此得出的规则正是 Excel 用户期待的:具名函数算出什么,取决于它的实参和它书写时捕获的东西,调用者的其他局部名字从不漏进去

f 拿着数字时 f(21) 为什么失败?

装着闭包以外东西的局部绑定永远不会被当函数应用。LET(f, 3, f(21)) 不会把 3 乘以 21,也不会回退到名为 f 的工作簿名称。调用继续走向用户函数处理器,没有处理器认领这个名字,单元格就以 #NAME? 收场。对电子表格来说这是正确结果:一个悄悄把函数调用变成乘法的笔误会产出一个没人怀疑的像样数字

后缀应用更严格。实参列表前面的东西先求值,结果不是闭包就给单元格 #VALUE!,所以 LET(g, 3, (g)(21)) 和 LET(g, 3, g(21)) 以不同的错误失败。其他失败你可以在草稿工作簿里复现:

  • 实参个数不对:LET(add, LAMBDA(a, b, a+b), add(1)) 在实参表达式求值之前就返回 #VALUE!
  • 实参里的错误作为值传递:在 LET(safe, LAMBDA(x, IFERROR(x, 0)), safe(1/0)) 里,#DIV/0! 被绑到 x,函数体内的 IFERROR 把它变成 0
  • 引用保持为引用:A1 这样的实参以单元格引用的身份进入函数体,所以关心引用身份的函数(ISREF 是其中之一)看到的是引用而不是单元格的值
  • LAMBDA 定义最多接受 253 个参数,与 Excel 为 LAMBDA 文档记载的上限相同
  • 失控递归会被拦下:调用自身的具名 lambda 与普通公式嵌套共享 256 层嵌套的默认上限,越界后调用以资源超限错误结束,而不是耗尽 Delphi 栈
// Log 是你自己的日志例程,不属于 HotXLS
procedure ProbeLambdaErrors(Sheet: TXLSXWorksheet; Book: TXLSXWorkbook);
begin
  Sheet.Cells[2, 4].Formula := 'LET(f, 3, f(21))';                       // 无处理器时为 #NAME?
  Sheet.Cells[3, 4].Formula := 'LET(g, 3, (g)(21))';                     // #VALUE!,后缀应用
  Sheet.Cells[4, 4].Formula := 'LET(add, LAMBDA(a, b, a+b), add(1))';     // #VALUE!,参数个数
  Sheet.Cells[5, 4].Formula := 'LET(safe, LAMBDA(x, IFERROR(x, 0)), safe(1/0))'; // 0
  Book.Recalculate;
  Log(Sheet.Cells[2, 4].FormattedText);
  Log(Sheet.Cells[3, 4].FormattedText);
  Log(Sheet.Cells[4, 4].FormattedText);
  Log(Sheet.Cells[5, 4].FormattedText);
end;

HotXLS 中的 LET 绑定:嵌套与形态规则

HotXLS 从左到右求值 LET:每条绑定都在此前所有绑定可见的情况下求值、压入,最后一个实参在完整绑定集下求值。所以 LET(a, 1, b, a+1, LET(c, b*2, c)) 返回 4,内层 LET 同时看得到 a 和 b。外层 LET 结束时它的绑定就没了,这意味着隔壁单元格的兄弟公式从空作用域起步

任何求值开始前先执行两条形态规则。LET 需要奇数个实参、至少三个,所以 LET(a, 1) 是 #VALUE!。而且每个名字槽位必须是纯名字:LET(A1, 5, A1*2) 被拒绝,因为 A1 是单元格引用;而 x 或 ab 这类同时也是列标拼写的短名字,在 LET 和 LAMBDA 内部按局部名字读取。绑定到区域的绑定保留区域,所以 LET(r, A1:A10, ROWS(r)) 返回 10,SUM(r) 把单元格加总

同样的闭包值也喂给为它们而建的辅助函数:MAP、REDUCE、SCAN、MAKEARRAY、BYROW 和 BYCOL。MAP(A2:A6, LAMBDA(v, v*2)) 溢出五个翻倍的值,REDUCE(0, A2:A6, LAMBDA(acc, v, acc+v)) 把它们折叠成一个和。捕获的环境跟着进入这些调用,与直接调用完全一致,所以 LET 绑定的 rate 在 MAP 函数体里依然可见

逗号、分号与 SaveAs 写出的东西

HotXLS 公式解析器把逗号和分号当作可互换的实参分隔符。公式文本来自你控制不了的地方:德语 locale 机器上写的支持工单、用 Excel 规范逗号写的文档、生成公式字符串的脚本、通篇用分号的旧 HotXLS 代码。SUM(A1,A2) 和 SUM(A1;A2) 编译成同一个东西,两种写法的 LAMBDA 也一样

内联数组常量是例外。花括号内分号保留它的 Excel 含义——行分隔符,所以 {1,2;3,4} 是二乘二数组,不是四实参列表。用分号当实参分隔符生成公式时,让数组常量保持 Excel 语法,两者就永远不会撞车

Cell.Formula 返回你赋进去的文本。SaveAs 写 XLSX 文件时,花括号外当实参分隔符用的分号会写成逗号,因为 OOXML 文件格式按 Excel 的逗号语法存储公式;Excel 存储时带 _xlfn. 前缀的函数在写出处也会带上前缀。从文件加载且未被改动的公式按其原始 XML 文本写回

从客户工作簿读取具名 lambda

Excel 制作的工作簿按 Excel 的写法存储 LAMBDA 名称:函数名带 _xlfn. 前缀,参数常带 _xlpm. 前缀。HotXLS 求值该名称时会剥掉这些前缀,但 TXLSXDefinedName.Formula 返回的是文件提供的原始定义文本。写成 Copy(Name.Formula, 1, 6) = 'LAMBDA' 的检查对你代码里创建的名称放行,却漏掉所有出自 Excel 的名称。这种不一致很容易被放过,因为两种情况下计算值都对,不统一的只有你自己的审计代码

// IsLambdaDefinition 是你自己加的辅助函数,不是 HotXLS API
function IsLambdaDefinition(const Text: WideString): Boolean;
var
  S: WideString;
begin
  S := UpperCase(Trim(Text));
  if (S <> '') and (S[1] = '=') then
    Delete(S, 1, 1);
  if Copy(S, 1, 6) = '_XLFN.' then
    Delete(S, 1, 6);
  Result := Copy(S, 1, 7) = 'LAMBDA(';
end;

procedure AuditLambdas(const FileName: string);
var
  Book: TXLSXWorkbook;
  Name: TXLSXDefinedName;
  I: Integer;
begin
  // Log 是你自己的日志例程
  Book := TXLSXWorkbook.Create;
  try
    if Book.Open(FileName) = 1 then
    begin
      for I := 0 to Book.DefinedNames.Count - 1 do
      begin
        Name := Book.DefinedNames[I];
        if IsLambdaDefinition(Name.Formula) and (Name.SheetIndex >= 0) then
          Log('Sheet-scoped lambda, not callable by name: ' + Name.Name);
      end;
      Book.Recalculate;
      Log(VarToStr(Book.Sheets[1].Cells[2, 2].Value));
    end;
  finally
    Book.Free;
  end;
end;

循环里那个作用域检查是有原因的:HotXLS 的按名调用只在工作簿级名称里找被调者。具名函数请留在工作簿级作用域。表级作用域的 LAMBDA 名称仍可通过 FindByName(AName, ASheetIndex) 读取,但一个要被多张表调用的函数属于工作簿;背后的作用域规则在 定义名称与跨表公式中有完整说明

日后编辑 lambda 很便宜。给 TXLSXDefinedName.Formula 赋新文本会使依赖图失效,下一次 Recalculate 重建它并重算调用该函数的单元格;机制见 增量重算与依赖图。公式求值结果是裸闭包的单元格(比如没有调用的 =LAMBDA(x, x*2))完全不设缓存值,因为没有数字或文本可存;Excel 对同样的单元格显示 #CALC!。对必须在无 LAMBDA 支持的工具里打开的报表,在最后一次 Recalculate 之后用 Sheet.Cells.ConvertFormulasToValues 冻结结果,保留每个缓存值、丢弃公式文本

LAMBDA、LET、辅助函数和定义名称 API 全部随同一个原生 Delphi 与 C++Builder 库交付,无需安装 Excel 即可读写 XLS、XLSX 和 ODS。完整的公式函数列表见 HotXLS 电子表格组件页面