跳到正文

模板解析 ​

背景 ​

在模板内部,依赖模板参数的名称要等模板实例化后才有确定的含义:编译器不会解析它,语言服务器面对的便是一片盲区。

cpp
template <typename T>
void foo(std::vector<std::vector<T>> rows) {
    rows[0].  // what is rows[0]?
}

rows[0] 的类型是 std::vector<std::vector<T>>::reference——标准库通过多层别名、偏特化(partial specialization)和默认实参定义的依赖名:reference → allocator_traits<Alloc>::value_type → ……。clangd 用户长期遇到模板体内代码补全和悬停失效的问题,原因在于 clangd 解析这类名称时的三处局限:

  • 不处理偏特化。 它只在主模板中查找成员,而主模板甚至未必声明了这些成员:allocator_traits 就是在特化中定义它们的。
  • 没有实参映射。 在 allocator_traits<Alloc> 中查到的成员仍以 Alloc 表示,而不是调用方的 T。
  • 不展开默认实参。 std::vector<T> 实为 std::vector<T, std::allocator<T>>;依赖默认实参的名称会保持未解析状态。

设计 ​

伪实例化 ​

clice 无需具体实参即可解析依赖名。它不必知道 T 是 int 还是 string,而是追踪 T 如何在别名链中传递,并用 T 表示最终结果:std::vector<std::vector<T>>::reference 化简为 std::vector<T>&,既具体到足以补全成员,又保留了 T 的符号形式。

解析器是独立实现的类型重写器,既不使用 Sema,也不使用 Clang 的 TreeTransform——这两者都假定存在带具体实参的真实实例化,而这里恰恰没有。解析器按两种策略运行:解析(resolve)负责名称查找——查找依赖成员、依赖模板、形参的绑定值或默认值,以及变量或调用的 decltype;替换(substitute)只做形参替换和别名展开。解析策略将别名展开委托给替换策略,因此一次查找绝不会通过某个别名触发又指回自身的另一次查找。

形参与特化 ​

嵌套模板会在多个层级绑定形参,解析器将其维护为一组栈帧;形参在声明它的那个模板的栈帧中查找,因此形参深度相同的两个模板绝不会混用彼此的形参。没有绑定值的形参取其默认值。

在 A<T> 中查找成员时,解析器自己做模板实参推导:将实参与各个偏特化的模式逐一匹配,选出最匹配的特化(若无匹配则回退到主模板),在其中及其基类中查找该成员,再将查到的类型映射回调用方的实参。正因如此,即使主模板什么也没有声明,也能解析出 allocator_traits<allocator<T>>::value_type。

标准库类型特征(type traits)中的 type(涵盖 conditional、enable_if、type_identity、remove_* 与 add_* 系列以及 decay)和 value(涵盖 conjunction、disjunction 与 negation)直接按标准规定的规则给出结果:各家标准库都用各自的偏特化来实现它们,每次查询都去推导那些偏特化既耗费开销,算出的结果又完全一致。

类型全程保留源码中的写法:形参按代码写出的形式绑定实参(是 std::string,而不是 std::basic_string<char, …>),结果也按名称显示形参。

优雅降级 ​

任何一步失败——查找无果、遇到循环或预算耗尽——都会原样返回依赖名,绝不报错,因此解析最坏也不会比不解析更糟。循环在三处截断:解析一个正在解析中的名称、在已经在查找某名称的类模板中再次查找该名称(CRTP),以及推导其初始化器依赖自身类型的 auto。每次查询还对嵌套深度和总步数设有上限。

将实例化视为实现 ​

伪实例化根据写下的模板代码推断依赖名可能表示什么,而翻译单元中的实际实例化则给出了它在每组实参下确实表示什么。clice 将模板视为接口,将它的各个实例化视为实现,正如虚函数与重写它的函数之间的关系:

  • 语义 Token 也会读取实例化后的代码:实例化复用了模板的源码位置,因此其解析结果会落到模板中写下的那个 Token 上。若各实例化对该名称的种类达成一致,则保留该种类及它们共有的修饰符;若不一致,则标为 conflict。
  • 悬停与内联提示在当前翻译单元只实例化过一次的函数模板内会显示那次实例化的实参;只实例化过一次的类模板中的 auto 变量也会按该次实例化推导类型;若有多次实例化,形参则保持源码中的写法。
  • 代码导航会读取每一个实例化:索引记录了每个实例化在模板文本中解析出的结果,因此无论文件是否打开,在依赖名上执行跳转到定义、查找引用、调用层次结构和跳转到实现,都会列出各个实例化的解析结果。
  • 代码补全只解析到光标位置,尚未读到后面调用模板的代码;因此模板本身无法确定的成员访问或限定名会再编译一次整个缓冲区,提供所有实例化共有的名称。

每个位置只生成单个条目的功能——内联提示、折叠范围和大纲——会跳过实例化后的代码:实例化在那里只会重复模板已给出的结果,或者与之冲突。

设计决策 ​

  • 为什么不执行真实实例化? 真实实例化需要具体实参,而模板内部并没有具体实参;何况正在编辑的代码往往还不完整,根本无法实例化。
  • 为什么分两种策略? 如果展开别名可以触发名称查找,而查找结果又需要展开别名,两者就会相互递归。替换策略绝不执行查找。
  • 为什么按规则直接给出标准类型特征的结果? 它们是实际代码里最常见的依赖类型,各家标准库的写法各不相同,而语言标准已经固定了它们的答案。

已知限制 ​

解析器只推导源码本身足以确定的部分,其余部分保持未解析而不做猜测:

  • 含依赖操作数的表达式。 值表达式在操作数已知时会常量折叠(如计算 N + 1,其中 N 已知),也能与写法相同的模式匹配(如 trait<X, X + 1> 匹配 trait<N, N + 1>);无法证明相等的表达式保持依赖状态。含依赖操作数的算术表达式(如 value + 1)不推导其类型;下标、->、* 以及运算符调用则可以解析。
  • 代码尚未确定的分支。 依赖未知实参的约束、互不比对方更特化的两个偏特化、通过 decltype 指代自身的基类,以及实参依赖查找(ADL)需要依赖实参才能完成的调用的 decltype,都会让名称保持依赖状态——除非所有候选项给出相同的答案。
  • 由主模板给出初值的值特征。 只在显式特化(explicit specialization)中才为 true 的值会折叠为主模板的值:libstdc++ 中 is_integral<T>::value 的主模板值为 false,因此 conditional_t<is_integral_v<T>, A, B> 会像已经确定一样显示为 B。
  • 靠引用绑定区分的重载。 若一组重载仅在实参或对象的绑定方式上有别——例如 const U&& 对 const int&、以不带 const 的方式绑定对象的成员模板对 const 成员函数,或显式对象形参(explicit object parameter)——解析器可能选出与编译器不同的重载,或者不选任何重载。