1 // Copyright 2013 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
5 // This file implements printing of types.
15 // A Qualifier controls how named package-level objects are printed in
16 // calls to TypeString, ObjectString, and SelectionString.
18 // These three formatting routines call the Qualifier for each
19 // package-level object O, and if the Qualifier returns a non-empty
20 // string p, the object is printed in the form p.O.
21 // If it returns an empty string, only the object name O is printed.
23 // Using a nil Qualifier is equivalent to using (*Package).Path: the
24 // object is qualified by the import path, e.g., "encoding/json.Marshal".
26 type Qualifier func(*Package) string
28 // RelativeTo returns a Qualifier that fully qualifies members of
29 // all packages other than pkg.
30 func RelativeTo(pkg *Package) Qualifier {
34 return func(other *Package) string {
36 return "" // same package; unqualified
42 // If gcCompatibilityMode is set, printing of types is modified
43 // to match the representation of some types in the gc compiler:
45 // - byte and rune lose their alias name and simply stand for
46 // uint8 and int32 respectively
47 // - embedded interfaces get flattened (the embedding info is lost,
48 // and certain recursive interface types cannot be printed anymore)
50 // This makes it easier to compare packages computed with the type-
51 // checker vs packages imported from gc export data.
53 // Caution: This flag affects all uses of WriteType, globally.
54 // It is only provided for testing in conjunction with
57 // This flag is exported in the x/tools/go/types package. We don't
58 // need it at the moment in the std repo and so we don't export it
59 // anymore. We should eventually try to remove it altogether.
60 // TODO(gri) remove this
61 var gcCompatibilityMode bool
63 // TypeString returns the string representation of typ.
64 // The Qualifier controls the printing of
65 // package-level objects, and may be nil.
66 func TypeString(typ Type, qf Qualifier) string {
68 WriteType(&buf, typ, qf)
72 // WriteType writes the string representation of typ to buf.
73 // The Qualifier controls the printing of
74 // package-level objects, and may be nil.
75 func WriteType(buf *bytes.Buffer, typ Type, qf Qualifier) {
76 writeType(buf, typ, qf, make([]Type, 0, 8))
79 // instanceMarker is the prefix for an instantiated type
80 // in "non-evaluated" instance form.
81 const instanceMarker = '#'
83 func writeType(buf *bytes.Buffer, typ Type, qf Qualifier, visited []Type) {
84 // Theoretically, this is a quadratic lookup algorithm, but in
85 // practice deeply nested composite types with unnamed component
86 // types are uncommon. This code is likely more efficient than
88 for _, t := range visited {
90 fmt.Fprintf(buf, "○%T", goTypeName(typ)) // cycle to typ
94 visited = append(visited, typ)
96 switch t := typ.(type) {
98 buf.WriteString("<nil>")
101 // exported basic types go into package unsafe
102 // (currently this is just unsafe.Pointer)
103 if isExported(t.name) {
104 if obj, _ := Unsafe.scope.Lookup(t.name).(*TypeName); obj != nil {
105 writeTypeName(buf, obj, qf)
110 if gcCompatibilityMode {
111 // forget the alias names
119 buf.WriteString(t.name)
122 fmt.Fprintf(buf, "[%d]", t.len)
123 writeType(buf, t.elem, qf, visited)
126 buf.WriteString("[]")
127 writeType(buf, t.elem, qf, visited)
130 buf.WriteString("struct{")
131 for i, f := range t.fields {
133 buf.WriteString("; ")
135 // This doesn't do the right thing for embedded type
136 // aliases where we should print the alias name, not
137 // the aliased type (see issue #44410).
139 buf.WriteString(f.name)
142 writeType(buf, f.typ, qf, visited)
143 if tag := t.Tag(i); tag != "" {
144 fmt.Fprintf(buf, " %q", tag)
151 writeType(buf, t.base, qf, visited)
154 writeTuple(buf, t, false, qf, visited)
157 buf.WriteString("func")
158 writeSignature(buf, t, qf, visited)
161 writeTypeList(buf, t.types, qf, visited)
164 for i, e := range t.terms {
171 writeType(buf, e, qf, visited)
175 // We write the source-level methods and embedded types rather
176 // than the actual method set since resolved method signatures
177 // may have non-printable cycles if parameters have embedded
178 // interface types that (directly or indirectly) embed the
179 // current interface. For instance, consider the result type
183 // m() interface{ T }
186 buf.WriteString("interface{")
188 if gcCompatibilityMode {
189 // print flattened interface
190 // (useful to compare against gc-generated interfaces)
191 for i, m := range t.allMethods {
193 buf.WriteString("; ")
195 buf.WriteString(m.name)
196 writeSignature(buf, m.typ.(*Signature), qf, visited)
199 if !empty && t.allTypes != nil {
200 buf.WriteString("; ")
202 if t.allTypes != nil {
203 buf.WriteString("type ")
204 writeType(buf, t.allTypes, qf, visited)
207 // print explicit interface methods and embedded types
208 for i, m := range t.methods {
210 buf.WriteString("; ")
212 buf.WriteString(m.name)
213 writeSignature(buf, m.typ.(*Signature), qf, visited)
216 if !empty && len(t.embeddeds) > 0 {
217 buf.WriteString("; ")
219 for i, typ := range t.embeddeds {
221 buf.WriteString("; ")
223 writeType(buf, typ, qf, visited)
227 if debug && (t.allMethods == nil || len(t.methods) > len(t.allMethods)) {
231 buf.WriteString("/* incomplete */")
236 buf.WriteString("map[")
237 writeType(buf, t.key, qf, visited)
239 writeType(buf, t.elem, qf, visited)
247 // chan (<-chan T) requires parentheses
248 if c, _ := t.elem.(*Chan); c != nil && c.dir == RecvOnly {
262 writeType(buf, t.elem, qf, visited)
268 writeTypeName(buf, t.obj, qf)
272 writeTypeList(buf, t.targs, qf, visited)
274 } else if t.tparams != nil {
275 // parameterized type
276 writeTParamList(buf, t.tparams, qf, visited)
282 // Optionally write out package for typeparams (like Named).
283 // TODO(danscales): this is required for import/export, so
284 // we maybe need a separate function that won't be changed
285 // for debugging purposes.
286 if t.obj.pkg != nil {
287 writePackage(buf, t.obj.pkg, qf)
291 buf.WriteString(s + subscript(t.id))
294 buf.WriteByte(instanceMarker) // indicate "non-evaluated" syntactic instance
295 writeTypeName(buf, t.base.obj, qf)
297 writeTypeList(buf, t.targs, qf, visited)
307 // For externally defined implementations of Type.
308 // Note: In this case cycles won't be caught.
309 buf.WriteString(t.String())
313 func writeTypeList(buf *bytes.Buffer, list []Type, qf Qualifier, visited []Type) {
314 for i, typ := range list {
316 buf.WriteString(", ")
318 writeType(buf, typ, qf, visited)
322 func writeTParamList(buf *bytes.Buffer, list []*TypeName, qf Qualifier, visited []Type) {
325 for i, p := range list {
326 // TODO(gri) support 'any' sugar here.
327 var b Type = &emptyInterface
328 if t, _ := p.typ.(*TypeParam); t != nil && t.bound != nil {
333 // type bound changed - write previous one before advancing
335 writeType(buf, prev, qf, visited)
337 buf.WriteString(", ")
341 if t, _ := p.typ.(*TypeParam); t != nil {
342 writeType(buf, t, qf, visited)
344 buf.WriteString(p.name)
349 writeType(buf, prev, qf, visited)
354 func writeTypeName(buf *bytes.Buffer, obj *TypeName, qf Qualifier) {
355 s := "<Named w/o object>"
358 writePackage(buf, obj.pkg, qf)
360 // TODO(gri): function-local named types should be displayed
361 // differently from named types at package level to avoid
368 func writeTuple(buf *bytes.Buffer, tup *Tuple, variadic bool, qf Qualifier, visited []Type) {
371 for i, v := range tup.vars {
373 buf.WriteString(", ")
376 buf.WriteString(v.name)
380 if variadic && i == len(tup.vars)-1 {
381 if s, ok := typ.(*Slice); ok {
382 buf.WriteString("...")
386 // append(s, "foo"...) leads to signature func([]byte, string...)
387 if t := asBasic(typ); t == nil || t.kind != String {
388 panic("internal error: string type expected")
390 writeType(buf, typ, qf, visited)
391 buf.WriteString("...")
395 writeType(buf, typ, qf, visited)
401 // WriteSignature writes the representation of the signature sig to buf,
402 // without a leading "func" keyword.
403 // The Qualifier controls the printing of
404 // package-level objects, and may be nil.
405 func WriteSignature(buf *bytes.Buffer, sig *Signature, qf Qualifier) {
406 writeSignature(buf, sig, qf, make([]Type, 0, 8))
409 func writeSignature(buf *bytes.Buffer, sig *Signature, qf Qualifier, visited []Type) {
410 if sig.tparams != nil {
411 writeTParamList(buf, sig.tparams, qf, visited)
414 writeTuple(buf, sig.params, sig.variadic, qf, visited)
416 n := sig.results.Len()
423 if n == 1 && sig.results.vars[0].name == "" {
424 // single unnamed result
425 writeType(buf, sig.results.vars[0].typ, qf, visited)
429 // multiple or named result(s)
430 writeTuple(buf, sig.results, false, qf, visited)
433 // subscript returns the decimal (utf8) representation of x using subscript digits.
434 func subscript(x uint64) string {
435 const w = len("₀") // all digits 0...9 have the same utf8 width
440 utf8.EncodeRune(buf[i:], '₀'+rune(x%10)) // '₀' == U+2080
446 return string(buf[i:])