登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go问答

Go token.File.PositionFor 的 adjusted 参数会改变什么

来源:17golang原创

时间:2026-11-10 17:16:31 293浏览 收藏

token.File.PositionFor(pos, true) 会采用已登记的替代位置信息,例如解析器处理 line 指令后得到的映射;传入 false 则忽略这些调整,按原文件行表解释。它可能改变返回的文件名、行号和列号,不会改变传入的 Pos,也不会把原文件字节偏移变成另一个文件的偏移。

官方文档:https://pkg.go.dev/go/token#File.PositionFor;line 指令:https://go.dev/cmd/compile/#hdr-Line_directives。

诊断跳到另一个文件时先看映射

若源码分析服务把生成文件里的错误显示为模板文件的第80行,先不要断定 FileSet 混乱。生成内容中可能有 line 指令,用来把后续代码的位置展示为原始来源的位置。检查记录中是否采用调整位置,往往比先改文件名更直接。

快速判断需要同时保留两种解释:同一个 Pos 在 false 与 true 下返回什么,以及两者是否使用相同原始偏移。没有映射时两种结果通常一致;有映射时,差异本身可能是预期行为,不需要删除指令来“修复”。

对同一位置读取两种解释

下面的原创独立示例在内存源码中放入 line 指令,然后对 Value 的同一位置分别查询。代码只做解析与位置解释,未在本文执行,也不读取 origin.tpl 文件。

package main

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

func main() {
 // line 指令为后续源码提供另一个文件名、行号和列号。
 const source = "package sample\n//line origin.tpl:80:7\nvar Value = 1\n"
 fset := token.NewFileSet()
 tree, err := parser.ParseFile(fset, "generated.go", source, parser.SkipObjectResolution)
 if err != nil {
  fmt.Println("解析失败:", err)
  return
 }
 for _, decl := range tree.Decls {
  group, ok := decl.(*ast.GenDecl)
  if !ok || group.Tok != token.VAR { continue }
  spec, ok := group.Specs[0].(*ast.ValueSpec)
  if !ok || len(spec.Names) == 0 { continue }
  pos := spec.Names[0].Pos()
  file := fset.File(pos)
  if file == nil {
   fmt.Println("位置不属于当前文件集合")
   return
  }
  // 两次查询使用同一个 Pos,只有解释策略不同。
  physical := file.PositionFor(pos, false)
  adjusted := file.PositionFor(pos, true)
  fmt.Printf("物理位置:文件=%s 行=%d 列=%d 偏移=%d\n",
   physical.Filename, physical.Line, physical.Column, physical.Offset)
  fmt.Printf("调整位置:文件=%s 行=%d 列=%d 偏移=%d\n",
   adjusted.Filename, adjusted.Line, adjusted.Column, adjusted.Offset)
 }
}
同一位置值与两种位置解释的关系
图1:静态关系说明图,同一个 Pos 可以按物理行表或替代位置信息解释,原始偏移不因此变化。

按示例规则推导,false 对应 generated.go 中 Value 的物理行列,true 则采用 origin.tpl 的替代位置。指令在下一行生效,且列号由具体指令形式参与计算,不应把指令声明的起始列直接当成该行每个标识符的列。

PositionFor 不是每次查询时扫描源码;替代位置信息需要事先由扫描器、解析器或调用方通过 AddLineColumnInfo 等方式登记。仅把普通注释文本存放在别处,不会自动建立映射。

按用途选择显示位置和编辑位置

如果目标是给用户展示生成代码的来源,true 更适合保留映射含义。如果目标是修改当前解析的原始文件,false 的文件位置配合原始字节偏移更贴近编辑对象。不能拿调整后的文件名与原始 Offset 直接拼成“去模板文件修改这个偏移”的操作。

诊断显示与原始文件编辑定位的职责
图2:静态职责说明图,用户诊断可以展示调整位置,编辑原始内容需要对应文件与字节偏移。
任务位置信息选择处理重点
展示逻辑来源诊断adjusted=true文件名可能来自映射
定位原始生成文件adjusted=false对应当前行表
编辑解析输入内容原文件与字节偏移不能跨文件套用偏移
排查位置差异两种视图并存记录映射与输入来源

token.File.Position 默认采用调整后的解释。若旧代码只调用 Position,后来改用 PositionFor(false),诊断显示变化不一定是回归,可能只是明确选择了另一种视图。回退时应恢复显示策略,不要随意重写 AST 位置或删除源码映射。

记录原始偏移避免错误回退

诊断记录可以分别保存物理位置、调整位置、字节偏移与分析输入标识。这样报告显示与源码编辑可以各取所需,也便于排查“文件不存在”或“行号超过文件长度”的来源。调整文件名只是映射提供的文字,不证明目标文件在当前机器存在。

PositionFor 的位置必须属于该 File 或为 NoPos。示例先通过 FileSet.File 找到相应文件,避免拿其他文件的 Pos 调用。NoPos 或无效位置也不应展示成正常源码行。列号为字节单位,编辑器协议使用其他字符单位时需要额外转换;某些没有列信息的映射还可能返回未知列。

常见问题:false 会改变源码吗?不会,只改变查询解释。true 是否总会改变结果?没有适用映射时通常不会。Offset 能直接用于调整后的文件吗?不能,它仍对应当前 token.File 的原始内容。开启 ParseComments 是否是处理 line 指令的前提?不应将注释保留与位置指令处理混为一个功能。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>