Go token.Pos IsValid 怎样判断源码位置是否有效

在 AST、词法扫描器或类型分析工具里，源码位置经常以 token.Pos 出现。真正需要判断的通常不是“这个整数大不大”，而是“它是否代表一个可用位置”。最直接的答案是：调用 p.IsValid()；它只判断 p 是否为零值 token.NoPos，并不负责确认这个位置属于哪个文件。

官方资料：https://pkg.go.dev/go/token#Pos.IsValid

把 token.NoPos 当作“没有源码位置”，把 IsValid() 当作第一道保护；需要文件名、行号和列号时，再交给对应的 FileSet 或 File 转换。

先分清 Pos、NoPos 和 IsValid

token.Pos 是一个紧凑的位置编码，底层类型是 int。它的零值是 token.NoPos，表示没有关联的文件和行信息。IsValid 的判断边界很窄：只要位置不是 NoPos，就返回 true。

package main

import (
    "fmt"
    "go/token"
)

func main() {
    // NoPos 是 token.Pos 的零值，表示当前对象没有源码位置。
    positions := []token.Pos{token.NoPos, 1, 42}
    for _, p := range positions {
        fmt.Printf("pos=%d valid=%t\n", p, p.IsValid())
    }
}

这个判断不能理解成“位置一定能映射到某个文件”。例如，某个非零 Pos 可能来自另一个 FileSet，或者已经脱离了当前工具维护的文件集合。IsValid 解决的是“有没有位置值”，不是“位置值是否属于当前上下文”。

从 AST 节点取位置时，先判断再转换

AST 节点通常提供 Pos() 和 End()。对正常解析得到的节点，它们一般能提供有用位置；但代表缺省语法、合成节点或可选字段的对象，仍可能返回 NoPos。工具代码如果直接把它们转换成行号，日志里就容易出现误导性的零值。

package main

import (
    "fmt"
    "go/ast"
    "go/parser"
    "go/token"
)

func describeNode(fset *token.FileSet, node ast.Node) string {
    // nil 节点没有 Pos 方法；先保护 nil，再保护 NoPos。
    if node == nil || !node.Pos().IsValid() {
        return "没有可用源码位置"
    }

    // FileSet 负责把紧凑位置转换成文件名、行号和列号。
    position := fset.Position(node.Pos())
    return fmt.Sprintf("%s:%d:%d", position.Filename, position.Line, position.Column)
}

func main() {
    // 这个示例只展示位置判断链路，不把打印结果当作运行截图。
    const source = "package demo\n\nvar answer = 42\n"
    fset := token.NewFileSet()
    file, err := parser.ParseFile(fset, "demo.go", source, 0)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(describeNode(fset, file))
}

关键顺序是：先判断节点是否为 nil，再判断 Pos().IsValid()，最后才使用 FileSet.Position。如果需要处理结束位置，也要对 End() 单独判断，不能因为起点有效就假设终点一定有效。

IsValid 和 FileSet 位置转换不是一回事

实际排查中常把三个问题混在一起：

FileSet.Position 会把 Pos 转成更易读的 token.Position。这一步需要正确的文件集合上下文；如果你只拿着一个非零 Pos，不能跳过 FileSet 直接推算文件名和行号。

工具代码里最容易踩的四个坑

1. 把非零当成已定位。非零只说明 IsValid 为真，不能省略当前 FileSet 的归属判断。
2. 只判断起点。处理源码区间时，Pos() 和 End() 是两个独立返回值，合成节点可能只提供其中一端。
3. 把 NoPos 当成错误。可选语法或人为构造的 AST 节点没有位置并不一定是解析失败，是否报错要由业务语义决定。
4. 在没有文件集合时硬造行号。没有 FileSet 就保留 token.Pos 或输出“位置未知”，不要把整数格式化成假行号。

落地时可以把位置格式化集中到一个小函数里：函数内部负责 nil、IsValid 和 FileSet 三层判断，调用方只接收“可显示位置”或“未知位置”。这样比在每个诊断分支里重复拼字符串更不容易漏掉边界。

相关问题

token.NoPos 和 token.Position{} 是同一个东西吗？

不是。前者是 token.Pos 的无效零值；后者是转换后的结构体零值。它们表达的层次不同，但都可以作为“没有可用位置信息”的信号参与保护逻辑。

只调用 p.IsValid() 能避免所有位置错误吗？

不能。它只解决“是否为 NoPos”，仍要使用正确的 FileSet、处理 nil 节点，并根据业务决定是否接受跨文件或合成位置。