【Golang源码阅读】strings/builder.go

// Copyright 2017 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package strings

import (
	"unicode/utf8"
	"unsafe"
)

// Builder用于使用Write方法有效地构建字符串。它最大限度地减小了内存的复制。零值可以使用。不要复制非零的Builer。
type Builder struct {
	addr *Builder // of receiver, to detect copies by value
	buf  []byte
}

// noescape 在逃逸分析中隐藏了一个指针。 noescape 是恒等函数，但转义分析并不认为输出取决于输入。 noescape 是内联的，目前编译为零指令。
func noescape(p unsafe.Pointer) unsafe.Pointer {
	x := uintptr(p)
	return unsafe.Pointer(x ^ 0)
}

func (b *Builder) copyCheck() {
	if b.addr == nil {
		// 这个 hack 解决了 Go 的逃逸分析失败，致使 b 逃逸并被堆分配。
		b.addr = (*Builder)(noescape(unsafe.Pointer(b)))
	} else if b.addr != b {
		panic("strings: illegal use of non-zero Builder copied by value")
	}
}

// String 返回累积的字符串。
func (b *Builder) String() string {
	return *(*string)(unsafe.Pointer(&b.buf))
}

// Len 返回累积的字节数； b.Len() == len(b.String())。
func (b *Builder) Len() int { return len(b.buf) }

// Cap 返回构建器底层字节切片的容量。 它是为正在构建的字符串分配的总空间，包括已写入的任何字节。
func (b *Builder) Cap() int { return cap(b.buf) }

// Reset 将Builder重置为空。
func (b *Builder) Reset() {
	b.addr = nil
	b.buf = nil
}

// grow 将缓冲区复制到一个新的更大的缓冲区，以便至少有 n 个字节的容量超出 len(b.buf)。
func (b *Builder) grow(n int) {
	buf := make([]byte, len(b.buf), 2*cap(b.buf)+n)
	copy(buf, b.buf)
	b.buf = buf
}

// 若有必要，Grow会增长b的容量，以保证另外n个字节的空间。 在Grow(n)以后，至少能够将n个字节写入 b 而无需其余分配。 若是n为负，则panic。
func (b *Builder) Grow(n int) {
	b.copyCheck()
	if n < 0 {
		panic("strings.Builder.Grow: negative count")
	}
	if cap(b.buf)-len(b.buf) < n {
		b.grow(n)
	}
}

// Write 将 p 的内容附加到 b 的缓冲区。 Write 老是返回 len(p), nil。
func (b *Builder) Write(p []byte) (int, error) {
	b.copyCheck()
	b.buf = append(b.buf, p...)
	return len(p), nil
}

// WriteByte 将字节 c 附加到 b 的缓冲区。 返回的错误始终为nil。
func (b *Builder) WriteByte(c byte) error {
	b.copyCheck()
	b.buf = append(b.buf, c)
	return nil
}


// WriteRune 将 Unicode 代码点 r 的 UTF-8 编码附加到 b 的缓冲区。它返回 r 的长度和一个nil错误。
func (b *Builder) WriteRune(r rune) (int, error) {
	b.copyCheck()
	if r < utf8.RuneSelf {
		b.buf = append(b.buf, byte(r))
		return 1, nil
	}
	l := len(b.buf)
	if cap(b.buf)-l < utf8.UTFMax {
		b.grow(utf8.UTFMax)
	}
	n := utf8.EncodeRune(b.buf[l:l+utf8.UTFMax], r)
	b.buf = b.buf[:l+n]
	return n, nil
}

// WriteString 将 s 的内容附加到 b 的缓冲区。它返回 s 的长度和一个nil错误。
func (b *Builder) WriteString(s string) (int, error) {
	b.copyCheck()
	b.buf = append(b.buf, s...)
	return len(s), nil
}