go/parser

• import "go/parser"

• 概述

• 索引

• 示例

概述

Package parser 为 Go 源文件实现解析器。输入可以以各种形式提供（参见各种 Parse *functions）; 输出是表示 Go 源的抽象语法树（AST）。解析器是通过一个 Parse *functions 调用的。

解析器接受比 Go 规范在语法上允许的语言更大的语言，以简化语法错误​​，并提高语法错误的健壮性。例如，在方法声明中，接收器被看作是一个普通的参数列表，因此可能包含多个条目，其中规范只允许一个。因此，AST(ast.FuncDecl.Recv) 字段中的对应字段不限于一个条目。

索引

• func ParseDir(fset *token.FileSet, path string, filter func(os.FileInfo) bool, mode Mode) (pkgs map[string]*ast.Package, first error)

• func ParseExpr(x string) (ast.Expr, error)

• func ParseExprFrom(fset *token.FileSet, filename string, src interface{}, mode Mode) (ast.Expr, error)

• func ParseFile(fset *token.FileSet, filename string, src interface{}, mode Mode) (f *ast.File, err error)

• type Mode

示例

ParseFile

包文件

interface.go parser.go

func ParseDir（显示源代码）

func ParseDir(fset *token.FileSet, path string, filter func(os.FileInfo) bool, mode Mode) (pkgs map[string]*ast.Package, first error)

ParseDir 针对 path 指定的目录中名称以“.go”结尾的所有文件调用ParseFile，并返回 package name -> package AST 与所有找到的包。

如果filter！= nil，则只考虑 os.FileInfo 条目通过过滤器（以“.go”结尾）的文件。模式位不变地传递给 ParseFile。位置信息记录在 fset 中，不能为零。

如果无法读取目录，则返回零映射和相应的错误。如果发生分析错误，则返回一个非零但不完整的映射和遇到的第一个错误。

func ParseExpr（显示源代码）

func ParseExpr(x string) (ast.Expr, error)

ParseExpr 是获取表达式 x 的 AST 的便捷函数。记录在 AST 中的位置信息是未定义的。错误消息中使用的文件名是空字符串。

func ParseExprFrom（显示源代码）

func ParseExprFrom(fset *token.FileSet, filename string, src interface{}, mode Mode) (ast.Expr, error)

ParseExprFrom 是一个用于解析表达式的便捷函数。参数的含义与 ParseFile 相同，但源必须是有效的 Go（类型或值）表达式。具体而言，fset 不能为零。

func ParseFile（显示源代码）

func ParseFile(fset *token.FileSet, filename string, src interface{}, mode Mode) (f *ast.File, err error)

ParseFile 解析单个 Go 源文件的源代码并返回相应的 ast.File 节点。源代码可以通过源文件的文件名或通过 src 参数提供。

如果src！= nil，ParseFile 解析来自 src 的源文件并且文件名仅在记录位置信息时使用。src 参数的参数类型必须是 string，[]byte 或 io.Reader。如果 src == nil，ParseFile 解析由 filename 指定的文件。

mode 参数控制解析的源文本的数量和其他可选的解析器功能。位置信息记录在文件集 fset 中，该文件集不能为零。

如果源无法读取，则返回的 AST 为零，并且错误指示特定故障。如果源被读取但发现语法错误，则结果是部分 AST（ast.Bad* nodes 代表错误源代码的​​片段）。多个错误通过一个 scanner.ErrorList 按文件位置排序返回。

示例

package main

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

func main() {
	fset := token.NewFileSet() // 相对于fset的position
	src := `package foo

import (
	"fmt"
	"time"
)

func bar() {
	fmt.Println(time.Now())
}`

	// 解析src但在处理导入后停止。
	f, err := parser.ParseFile(fset, "", src, parser.ImportsOnly)
	if err != nil {
		fmt.Println(err)
		return
	}

	// 从文件CAST打印导入。
	for _, s := range f.Imports {
		fmt.Println(s.Path.Value)
	}

}

type Mode（显示源代码）

Mode 值是一组标志（或0）。它们控制解析的源代码量和其他可选的解析器功能。

type Mode uint

const (
        PackageClauseOnly Mode             = 1 << iota // 在package子句之后停止解析
        ImportsOnly                                    // 导入声明后停止解析
        ParseComments                                  // 解析注释并将它们添加到AST
        Trace                                          // 打印一系列已解析的作品
        DeclarationErrors                              // 报告声明错误
        SpuriousErrors                                 // 与AllErrors相同，以实现向后兼容性
        AllErrors         = SpuriousErrors             // 报告所有错误（不仅仅是不同行上的前10个）