1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
|
package jen
import (
"bytes"
"fmt"
"regexp"
"strings"
"unicode"
"unicode/utf8"
)
// NewFile Creates a new file, with the specified package name.
func NewFile(packageName string) *File {
return &File{
Group: &Group{
multi: true,
},
name: packageName,
imports: map[string]importdef{},
hints: map[string]importdef{},
}
}
// NewFilePath creates a new file while specifying the package path - the
// package name is inferred from the path.
func NewFilePath(packagePath string) *File {
return &File{
Group: &Group{
multi: true,
},
name: guessAlias(packagePath),
path: packagePath,
imports: map[string]importdef{},
hints: map[string]importdef{},
}
}
// NewFilePathName creates a new file with the specified package path and name.
func NewFilePathName(packagePath, packageName string) *File {
return &File{
Group: &Group{
multi: true,
},
name: packageName,
path: packagePath,
imports: map[string]importdef{},
hints: map[string]importdef{},
}
}
// File represents a single source file. Package imports are managed
// automaticaly by File.
type File struct {
*Group
name string
path string
imports map[string]importdef
hints map[string]importdef
comments []string
headers []string
cgoPreamble []string
// If you're worried about generated package aliases conflicting with local variable names, you
// can set a prefix here. Package foo becomes {prefix}_foo.
PackagePrefix string
// CanonicalPath adds a canonical import path annotation to the package clause.
CanonicalPath string
}
// importdef is used to differentiate packages where we know the package name from packages where the
// import is aliased. If alias == false, then name is the actual package name, and the import will be
// rendered without an alias. If used == false, the import has not been used in code yet and should be
// excluded from the import block.
type importdef struct {
name string
alias bool
}
// HeaderComment adds a comment to the top of the file, above any package
// comments. A blank line is rendered below the header comments, ensuring
// header comments are not included in the package doc.
func (f *File) HeaderComment(comment string) {
f.headers = append(f.headers, comment)
}
// PackageComment adds a comment to the top of the file, above the package
// keyword.
func (f *File) PackageComment(comment string) {
f.comments = append(f.comments, comment)
}
// CgoPreamble adds a cgo preamble comment that is rendered directly before the "C" pseudo-package
// import.
func (f *File) CgoPreamble(comment string) {
f.cgoPreamble = append(f.cgoPreamble, comment)
}
// Anon adds an anonymous import.
func (f *File) Anon(paths ...string) {
for _, p := range paths {
f.imports[p] = importdef{name: "_", alias: true}
}
}
// ImportName provides the package name for a path. If specified, the alias will be omitted from the
// import block. This is optional. If not specified, a sensible package name is used based on the path
// and this is added as an alias in the import block.
func (f *File) ImportName(path, name string) {
f.hints[path] = importdef{name: name, alias: false}
}
// ImportNames allows multiple names to be imported as a map. Use the [gennames](gennames) command to
// automatically generate a go file containing a map of a selection of package names.
func (f *File) ImportNames(names map[string]string) {
for path, name := range names {
f.hints[path] = importdef{name: name, alias: false}
}
}
// ImportAlias provides the alias for a package path that should be used in the import block. A
// period can be used to force a dot-import.
func (f *File) ImportAlias(path, alias string) {
f.hints[path] = importdef{name: alias, alias: true}
}
func (f *File) isLocal(path string) bool {
return f.path == path
}
func (f *File) isValidAlias(alias string) bool {
// multiple dot-imports are ok
if alias == "." {
return true
}
// the import alias is invalid if it's a reserved word
if IsReservedWord(alias) {
return false
}
// the import alias is invalid if it's already been registered
for _, v := range f.imports {
if alias == v.name {
return false
}
}
return true
}
func (f *File) isDotImport(path string) bool {
if id, ok := f.hints[path]; ok {
return id.name == "." && id.alias
}
return false
}
func (f *File) register(path string) string {
if f.isLocal(path) {
// notest
// should never get here becasue in Qual the packageToken will be null,
// so render will never be called.
return ""
}
// if the path has been registered previously, simply return the name
def := f.imports[path]
if def.name != "" && def.name != "_" {
return def.name
}
// special case for "C" pseudo-package
if path == "C" {
f.imports["C"] = importdef{name: "C", alias: false}
return "C"
}
var name string
var alias bool
if hint := f.hints[path]; hint.name != "" {
// look up the path in the list of provided package names and aliases by ImportName / ImportAlias
name = hint.name
alias = hint.alias
} else if standardLibraryHints[path] != "" {
// look up the path in the list of standard library packages
name = standardLibraryHints[path]
alias = false
} else {
// if a hint is not found for the package, guess the alias from the package path
name = guessAlias(path)
alias = true
}
// If the name is invalid or has been registered already, make it unique by appending a number
unique := name
i := 0
for !f.isValidAlias(unique) {
i++
unique = fmt.Sprintf("%s%d", name, i)
}
// If we've changed the name to make it unique, it should definitely be an alias
if unique != name {
alias = true
}
// Only add a prefix if the name is an alias
if f.PackagePrefix != "" && alias {
unique = f.PackagePrefix + "_" + unique
}
// Register the eventual name
f.imports[path] = importdef{name: unique, alias: alias}
return unique
}
// GoString renders the File for testing. Any error will cause a panic.
func (f *File) GoString() string {
buf := &bytes.Buffer{}
if err := f.Render(buf); err != nil {
panic(err)
}
return buf.String()
}
func guessAlias(path string) string {
alias := path
if strings.HasSuffix(alias, "/") {
// training slashes are usually tolerated, so we can get rid of one if
// it exists
alias = alias[:len(alias)-1]
}
if strings.Contains(alias, "/") {
// if the path contains a "/", use the last part
alias = alias[strings.LastIndex(alias, "/")+1:]
}
// alias should be lower case
alias = strings.ToLower(alias)
// alias should now only contain alphanumerics
importsRegex := regexp.MustCompile(`[^a-z0-9]`)
alias = importsRegex.ReplaceAllString(alias, "")
// can't have a first digit, per Go identifier rules, so just skip them
for firstRune, runeLen := utf8.DecodeRuneInString(alias); unicode.IsDigit(firstRune); firstRune, runeLen = utf8.DecodeRuneInString(alias) {
alias = alias[runeLen:]
}
// If path part was all digits, we may be left with an empty string. In this case use "pkg" as the alias.
if alias == "" {
alias = "pkg"
}
return alias
}
|