1 // Copyright (c) 2020 Cisco and/or its affiliates.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at:
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
24 // commonInitialisms is a set of common initialisms that need to stay in upper case.
25 var commonInitialisms = map[string]bool{
28 // NOTE: There are only two occurences of the word 'ascii' and
29 // these already have initialism before and after ASCII part,
30 // thus disabling initialism for this case.
73 // specialInitialisms is a set of special initialisms that need part to stay in upper case.
74 var specialInitialisms = map[string]string{
78 func usesInitialism(s string) string {
79 u := strings.ToUpper(s)
80 if commonInitialisms[u] {
82 } else if su, ok := specialInitialisms[u]; ok {
88 // camelCaseName returns correct name identifier (camelCase).
89 func camelCaseName(name string) (should string) {
90 name = strings.Title(name)
92 // Fast path for simple cases: "_" and all lowercase.
97 for _, r := range name {
98 if !unicode.IsLower(r) {
107 // Split camelCase at any lower->upper transition, and split on underscores.
108 // Check each word for common initialisms.
109 runes := []rune(name)
110 w, i := 0, 0 // index of start of word, scan
111 for i+1 <= len(runes) {
112 eow := false // whether we hit the end of a word
113 if i+1 == len(runes) {
115 } else if runes[i+1] == '_' {
116 // underscore; shift the remainder forward over any run of underscores
119 for i+n+1 < len(runes) && runes[i+n+1] == '_' {
123 // Leave at most one underscore if the underscore is between two digits
124 if i+n+1 < len(runes) && unicode.IsDigit(runes[i]) && unicode.IsDigit(runes[i+n+1]) {
128 copy(runes[i+1:], runes[i+n+1:])
129 runes = runes[:len(runes)-n]
130 } else if unicode.IsLower(runes[i]) && !unicode.IsLower(runes[i+1]) {
140 word := string(runes[w:i])
141 if u := usesInitialism(word); u != "" {
142 // Keep consistent case, which is lowercase only at the start.
143 if w == 0 && unicode.IsLower(runes[w]) {
144 u = strings.ToLower(u)
146 // All the common initialisms are ASCII,
147 // so we can replace the bytes exactly.
148 copy(runes[w:], []rune(u))
149 } else if w > 0 && strings.ToLower(word) == word {
150 // already all lowercase, and not the first word, so uppercase the first character.
151 runes[w] = unicode.ToUpper(runes[w])
158 // sanitizedName returns the string converted into a valid Go identifier.
159 func sanitizedName(s string) string {
160 r, _ := utf8.DecodeRuneInString(s)
161 if token.Lookup(s).IsKeyword() || !unicode.IsLetter(r) {