parse.go

package mutesting

import (
	"fmt"
	"go/ast"
	"go/build"
	"go/parser"
	"go/token"
	"go/types"
	"os"
	"path/filepath"

	"golang.org/x/tools/go/loader" //nolint:staticcheck
)

// ParseFile parses the content of the given file and returns the corresponding ast.File node and its file set for positional information.
// If a fatal error is encountered the error return argument is not nil.
func ParseFile(file string) (*ast.File, *token.FileSet, error) {
	data, err := os.ReadFile(file)
	if err != nil {
		return nil, nil, err
	}

	return ParseSource(data)
}

// ParseSource parses the given source and returns the corresponding ast.File node and its file set for positional information.
// If a fatal error is encountered the error return argument is not nil.
func ParseSource(data interface{}) (*ast.File, *token.FileSet, error) {
	fset := token.NewFileSet()

	src, err := parser.ParseFile(fset, "", data, parser.ParseComments|parser.AllErrors)
	if err != nil {
		return nil, nil, err
	}

	return src, fset, err
}

// ParseAndTypeCheckFile parses and type-checks the given file, and returns everything interesting about the file.
// If a fatal error is encountered the error return argument is not nil.
func ParseAndTypeCheckFile(file string) (*ast.File, *token.FileSet, *types.Package, *types.Info, error) {
	fileAbs, err := filepath.Abs(file)
	if err != nil {
		return nil, nil, nil, nil, fmt.Errorf("Could not absolute the file path of %q: %v", file, err)
	}
	dir := filepath.Dir(fileAbs)

	buildPkg, err := build.ImportDir(dir, build.FindOnly)
	if err != nil {
		return nil, nil, nil, nil, fmt.Errorf("Could not create build package of %q: %v", file, err)
	}

	var conf = loader.Config{
		ParserMode: parser.AllErrors | parser.ParseComments,
	}

	if buildPkg.ImportPath != "." {
		conf.Import(buildPkg.ImportPath)
	} else {
		// This is most definitely the case for files inside a "testdata" package
		conf.CreateFromFilenames(dir, fileAbs)
	}

	conf.AllowErrors = true
	prog, err := conf.Load()
	if err != nil {
		return nil, nil, nil, nil, fmt.Errorf("Could not load package of file %q: %v", file, err)
	}

	pkgInfo := prog.InitialPackages()[0]

	var src *ast.File
	for _, f := range pkgInfo.Files {
		if prog.Fset.Position(f.Pos()).Filename == fileAbs {
			src = f

			break
		}
	}

	return src, prog.Fset, pkgInfo.Pkg, &pkgInfo.Info, nil
}