9bc59e6af8
## Description Ref #12556 To make things easier I've starting splitting up #12469 into smaller PRs. This first PR for codegen adds basic infrastructure for: * adding package imports * creating new var names (`*ast.Ident`) without conflicts Other PRs will add the actual codegen functionality. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
91 lines
2.1 KiB
Go
91 lines
2.1 KiB
Go
package codegen
|
|
|
|
import (
|
|
"fmt"
|
|
"go/ast"
|
|
"go/token"
|
|
"strconv"
|
|
)
|
|
|
|
// FileGen is a utility for generating/patching golang file ASTs.
|
|
type FileGen struct {
|
|
File *ast.File
|
|
idents map[string]bool
|
|
codegenPkgPath string
|
|
pkgImportMap map[string]*importInfo
|
|
}
|
|
|
|
// NewFileGen creates a new FileGen instance from a file AST with the provided package path.
|
|
func NewFileGen(file *ast.File, codegenPkgPath string) (*FileGen, error) {
|
|
g := &FileGen{
|
|
File: file,
|
|
idents: map[string]bool{},
|
|
codegenPkgPath: codegenPkgPath,
|
|
pkgImportMap: map[string]*importInfo{},
|
|
}
|
|
|
|
// add all go keywords to reserved idents
|
|
for i := token.Token(0); i <= token.TILDE; i++ {
|
|
name := i.String()
|
|
if token.IsKeyword(name) {
|
|
g.idents[name] = true
|
|
}
|
|
}
|
|
|
|
// add all top-level decl idents
|
|
for _, decl := range file.Decls {
|
|
switch decl := decl.(type) {
|
|
case *ast.FuncDecl:
|
|
g.idents[decl.Name.Name] = true
|
|
case *ast.GenDecl:
|
|
for _, spec := range decl.Specs {
|
|
switch spec := spec.(type) {
|
|
case *ast.TypeSpec:
|
|
g.idents[spec.Name.Name] = true
|
|
case *ast.ValueSpec:
|
|
for _, name := range spec.Names {
|
|
g.idents[name.Name] = true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
for _, spec := range file.Imports {
|
|
pkgPath, err := strconv.Unquote(spec.Path.Value)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var info *importInfo
|
|
if spec.Name != nil {
|
|
name := spec.Name.Name
|
|
if name == "." {
|
|
return nil, fmt.Errorf(". package imports are not allowed")
|
|
}
|
|
|
|
info = &importInfo{importPrefix: name, ImportSpec: spec}
|
|
} else {
|
|
prefix := defaultPkgPrefix(pkgPath)
|
|
info = &importInfo{importPrefix: prefix, ImportSpec: spec}
|
|
}
|
|
g.pkgImportMap[pkgPath] = info
|
|
g.idents[info.importPrefix] = true
|
|
}
|
|
|
|
return g, nil
|
|
}
|
|
|
|
// PatchFuncDecl returns a FuncGen instance for the function declaration with the given name or returns nil.
|
|
func (g *FileGen) PatchFuncDecl(name string) *FuncGen {
|
|
for _, decl := range g.File.Decls {
|
|
funcDecl, ok := decl.(*ast.FuncDecl)
|
|
if ok {
|
|
if funcDecl.Name.Name == name {
|
|
return newFuncGen(g, funcDecl)
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|