cosmos-sdk/depinject/internal/codegen/import.go
Aaron Craelius 9bc59e6af8
feat(depinject): codegen part 1 (imports & idents) (#12557)
## 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)
2022-07-15 11:16:35 +00:00

49 lines
1.0 KiB
Go

package codegen
import (
"fmt"
"go/ast"
"go/token"
"strings"
)
type importInfo struct {
*ast.ImportSpec
importPrefix string
}
// AddOrGetImport adds a new import for the provided pkgPath (if needed) and
// returns the unique import prefix for that path.
func (g *FileGen) AddOrGetImport(pkgPath string) (importPrefix string) {
if pkgPath == "" || pkgPath == g.codegenPkgPath {
return ""
}
if i, ok := g.pkgImportMap[pkgPath]; ok {
return i.importPrefix
}
imp := &ast.ImportSpec{
Path: &ast.BasicLit{Kind: token.STRING, Value: fmt.Sprintf("%q", pkgPath)},
}
defaultPrefix := defaultPkgPrefix(pkgPath)
importPrefix = g.doCreateIdent(defaultPrefix)
if importPrefix != defaultPrefix {
imp.Name = ast.NewIdent(importPrefix)
}
g.File.Imports = append(g.File.Imports, imp)
g.pkgImportMap[pkgPath] = &importInfo{
ImportSpec: imp,
importPrefix: importPrefix,
}
g.idents[importPrefix] = true
return importPrefix
}
func defaultPkgPrefix(pkgPath string) string {
pkgParts := strings.Split(pkgPath, "/")
return pkgParts[len(pkgParts)-1]
}