| commit | edda81f8e90fb13ea6d6227bde3d4f8f0f65d90c | [log] [tgz] |
|---|---|---|
| author | Alan Donovan <adonovan@google.com> | Sun Jul 16 09:43:14 2023 -0400 |
| committer | Gopher Robot <gobot@golang.org> | Tue Aug 29 15:44:16 2023 +0000 |
| tree | 95c392ffd1189a5c9192013e6ad6582a9fa86f8e | |
| parent | 2926c1f403f31a0c8d554caa3ce81fa1130663ee [diff] |
internal/refactor/inline: an inliner for Go source
This change creates at new (internal) package that
implements an inlining algorithm for Go functions,
and an analyzer in the go/analysis framework that
uses it to perform automatic inlining of calls to
specially annotated ("inlineme") functions.
Run this command to invoke the analyzer and
apply any suggested fixes to the source tree:
$ go run ./internal/refactor/inline/analyzer/main.go -fix packages...
The package is intended for use both in interactive tools
such as gopls and batch tools such as the analyzer
just mentioned and the tool proposed in the attached issue.
As noted in the code comments, correct inlining is a
surprisingly tricky problem, so for now we primarily
address the most general case in which a call f(args...)
has the function name f replaced by a literal copy of the
called function (func (...) {...})(args...).
Only in the simplest of special cases is the call
itself eliminated by replacing it with the function body.
There is much further work to do by careful analysis of cases.
The processing of the callee function occurs first,
and results in a serializable summary of the callee
that can be used for a later call to Inline, possibly
from a different process, thus enabling "separate analysis"
pipelines using the analysis.Fact mechanism.
Recommended reviewing order:
- callee.go, inline.go
- inline_test.go, testdata/*txtar
- analyzer/...
Updates golang/go#32816
Change-Id: If28e43a6ba9ab92639276c5b50b5a89a3b0c54c4
Reviewed-on: https://go-review.googlesource.com/c/tools/+/519715
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Alan Donovan <adonovan@google.com>
Auto-Submit: Alan Donovan <adonovan@google.com>
Reviewed-by: Robert Findley <rfindley@google.com>
This repository provides the golang.org/x/tools module, comprising various tools and packages mostly for static analysis of Go programs, some of which are listed below. Use the “Go reference” link above for more information about any package.
It also contains the golang.org/x/tools/gopls module, whose root package is a language-server protocol (LSP) server for Go. An LSP server analyses the source code of a project and responds to requests from a wide range of editors such as VSCode and Vim, allowing them to support IDE-like functionality.
Selected commands:
cmd/goimports formats a Go program like go fmt and additionally inserts import statements for any packages required by the file after it is edited.cmd/callgraph prints the call graph of a Go program.cmd/digraph is a utility for manipulating directed graphs in textual notation.cmd/stringer generates declarations (including a String method) for “enum” types.cmd/toolstash is a utility to simplify working with multiple versions of the Go toolchain.These commands may be fetched with a command such as
go install golang.org/x/tools/cmd/goimports@latest
Selected packages:
go/ssa provides a static single-assignment form (SSA) intermediate representation (IR) for Go programs, similar to a typical compiler, for use by analysis tools.
go/packages provides a simple interface for loading, parsing, and type checking a complete Go program from source code.
go/analysis provides a framework for modular static analysis of Go programs.
go/callgraph provides call graphs of Go programs using a variety of algorithms with different trade-offs.
go/ast/inspector provides an optimized means of traversing a Go parse tree for use in analysis tools.
go/cfg provides a simple control-flow graph (CFG) for a Go function.
go/expect reads Go source files used as test inputs and interprets special comments within them as queries or assertions for testing.
go/gcexportdata and go/gccgoexportdata read and write the binary files containing type information used by the standard and gccgo compilers.
go/types/objectpath provides a stable naming scheme for named entities (“objects”) in the go/types API.
Numerous other packages provide more esoteric functionality.
This repository uses Gerrit for code changes. To learn how to submit changes, see https://golang.org/doc/contribute.html.
The main issue tracker for the tools repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/tools/(your subdir):” in the subject line, so it is easy to find.
This repository uses prettier to format JS and CSS files.
The version of prettier used is 1.18.2.
It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.