Remove most String methods and change String to SourceRepresentation …

…where appropriate

comment.go

@@ -24,7 +24,6 @@
 package proto
 
 import (
-	"fmt"
 	"strings"
 	"text/scanner"
 )
@@ -161,5 +160,3 @@ func mergeOrReturnComment(elements []Visitee, lit string, pos scanner.Position)
 	}
 	return com
 }
-
-func (c *Comment) String() string { return fmt.Sprintf("<comment %s>", c.Message()) }

extensions.go

@@ -24,7 +24,6 @@
 package proto
 
 import (
-	"fmt"
 	"text/scanner"
 )
 
@@ -56,5 +55,3 @@ func (e *Extensions) parse(p *Parser) error {
 	e.Ranges = list
 	return nil
 }
-
-func (e *Extensions) String() string { return fmt.Sprintf("<extensions %v>", e.Ranges) }

extensions_test.go

@@ -47,7 +47,7 @@ func TestExtensions(t *testing.T) {
 	if got, want := f.Position.Line, 3; got != want {
 		t.Fatalf("got [%d] want [%d]", got, want)
 	}
-	if got, want := f.Ranges[1].String(), "20 to max"; got != want {
+	if got, want := f.Ranges[1].SourceRepresentation(), "20 to max"; got != want {
 		t.Errorf("got [%s] want [%s]", got, want)
 	}
 	if f.Comment == nil {

field.go

@@ -24,7 +24,6 @@
 package proto
 
 import (
-	"fmt"
 	"strconv"
 	"text/scanner"
 )
@@ -164,8 +163,6 @@ func parseFieldAfterType(f *Field, p *Parser) error {
 	return nil
 }
 
-func (n *NormalField) String() string { return fmt.Sprintf("<field %s=%d>", n.Name, n.Sequence) }
-
 // MapField represents a map entry in a message.
 type MapField struct {
 	*Field

formatter.go

@@ -107,13 +107,13 @@ func (f *Formatter) VisitOption(o *Option) {
 		f.level(1)
 		for _, each := range o.AggregatedConstants {
 			f.indent(0)
-			fmt.Fprintf(f.w, "%s: %s\n", each.Name, each.Literal.String())
+			fmt.Fprintf(f.w, "%s: %s\n", each.Name, each.Literal.SourceRepresentation())
 		}
 		f.indent(-1)
 		fmt.Fprintf(f.w, "}")
 	} else {
 		// TODO printAs groups with fixed length
-		fmt.Fprintf(f.w, o.Constant.String())
+		fmt.Fprintf(f.w, o.Constant.SourceRepresentation())
 	}
 	fmt.Fprintf(f.w, ";")
 	if o.InlineComment != nil {
@@ -177,7 +177,7 @@ func (f *Formatter) VisitReserved(r *Reserved) {
 			if i > 0 {
 				io.WriteString(f.w, ", ")
 			}
-			fmt.Fprintf(f.w, "%s", each.String())
+			fmt.Fprintf(f.w, "%s", each.SourceRepresentation())
 		}
 	} else {
 		for i, each := range r.FieldNames {
@@ -230,7 +230,7 @@ func (f *Formatter) VisitExtensions(e *Extensions) {
 		if i > 0 {
 			io.WriteString(f.w, ", ")
 		}
-		fmt.Fprintf(f.w, "%s", each.String())
+		fmt.Fprintf(f.w, "%s", each.SourceRepresentation())
 	}
 	f.endWithComment(e.InlineComment)
 }

group.go

@@ -24,7 +24,6 @@
 package proto
 
 import (
-	"fmt"
 	"text/scanner"
 )
 
@@ -91,5 +90,3 @@ func (g *Group) parse(p *Parser) error {
 	}
 	return parseMessageBody(p, g)
 }
-
-func (g *Group) String() string { return fmt.Sprintf("<group %s>", g.Name) }

message.go

@@ -24,7 +24,6 @@
 package proto
 
 import (
-	"fmt"
 	"text/scanner"
 )
 
@@ -225,5 +224,3 @@ func (m *Message) takeLastComment() (last *Comment) {
 func (m *Message) Doc() *Comment {
 	return m.Comment
 }
-
-func (m *Message) String() string { return fmt.Sprintf("<message %s>", m.Name) }

option.go

@@ -65,9 +65,9 @@ func (o *Option) keyValuePair(embedded bool) (cols []aligned) {
 	equals := alignedEquals
 	name := o.Name
 	if embedded {
-		return append(cols, leftAligned(name), equals, leftAligned(o.Constant.String())) // numbers right, strings left? TODO
+		return append(cols, leftAligned(name), equals, leftAligned(o.Constant.SourceRepresentation())) // numbers right, strings left? TODO
 	}
-	return append(cols, rightAligned(name), equals, rightAligned(o.Constant.String()))
+	return append(cols, rightAligned(name), equals, rightAligned(o.Constant.SourceRepresentation()))
 }
 
 // parse reads an Option body
@@ -145,8 +145,8 @@ type Literal struct {
 	IsString bool
 }
 
-// String returns the source (if quoted then use double quote).
-func (l Literal) String() string {
+// SourceRepresentation returns the source (if quoted then use double quote).
+func (l Literal) SourceRepresentation() string {
 	var buf bytes.Buffer
 	if l.IsString {
 		buf.WriteRune('"')

range.go

@@ -34,8 +34,8 @@ type Range struct {
 	Max      bool
 }
 
-// String return a single number if from = to. Returns <from> to <to> otherwise unless Max then return <from> to max.
-func (r Range) String() string {
+// SourceRepresentation return a single number if from = to. Returns <from> to <to> otherwise unless Max then return <from> to max.
+func (r Range) SourceRepresentation() string {
 	if r.Max {
 		return fmt.Sprintf("%d to max", r.From)
 	}

range_test.go

@@ -33,7 +33,7 @@ func TestParseRanges(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if got, want := ranges[2].String(), "9 to 11"; got != want {
+	if got, want := ranges[2].SourceRepresentation(), "9 to 11"; got != want {
 		t.Errorf("got [%v] want [%v]", got, want)
 	}
 }
@@ -46,7 +46,7 @@ func TestParseRangesMax(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if got, want := ranges[0].String(), "3 to max"; got != want {
+	if got, want := ranges[0].SourceRepresentation(), "3 to max"; got != want {
 		t.Errorf("got [%v] want [%v]", got, want)
 	}
 }
@@ -62,7 +62,7 @@ func TestParseRangesMultiToMax(t *testing.T) {
 	if got, want := len(ranges), 4; got != want {
 		t.Fatalf("got [%v] want [%v]", got, want)
 	}
-	if got, want := ranges[3].String(), "10 to max"; got != want {
+	if got, want := ranges[3].SourceRepresentation(), "10 to max"; got != want {
 		t.Errorf("got [%v] want [%v]", got, want)
 	}
 }

reserved_test.go

@@ -36,10 +36,10 @@ func TestReservedRanges(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if got, want := r.Ranges[0].String(), "2"; got != want {
+	if got, want := r.Ranges[0].SourceRepresentation(), "2"; got != want {
 		t.Fatalf("got [%v] want [%v]", got, want)
 	}
-	if got, want := r.Ranges[2].String(), "9 to 11"; got != want {
+	if got, want := r.Ranges[2].SourceRepresentation(), "9 to 11"; got != want {
 		t.Errorf("got [%v] want [%v]", got, want)
 	}
 }