標準庫 - unicode/utf8/utf8.go 解讀

// Copyright 2009 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.

// go/src/unicode/utf8/utf8.go
// version 1.7

// 關於 UTF-8 編碼方式請參考：http://www.cnblogs.com/golove/p/3222096.html

package utf8

// 編碼所需的基本數字
const (
	RuneError = '\uFFFD'     // 錯誤的 Rune 或 Unicode 代理字符
	RuneSelf  = 0x80         // ASCII 字符範圍
	MaxRune   = '\U0010FFFF' // Unicode 碼點的最大值
	UTFMax    = 4            // 一個字符編碼的最大長度
)

// Unicode 代理字符對 UTF-8 編碼而言是無效的。
const (
	surrogateMin = 0xD800
	surrogateMax = 0xDFFF
)

// 用詞說明：
// 單字節字符：該字符的 UTF-8 編碼須要一個字節存放
// 雙字節字符：該字符的 UTF-8 編碼須要兩個字節存放
// 三字節字符：該字符的 UTF-8 編碼須要三個字節存放
// 四字節字符：該字符的 UTF-8 編碼須要四個字節存放
// 字符首字節：某字符的 UTF-8 編碼中的第一個字節
// 字符次字節：某字符的 UTF-8 編碼中的第二個字節
// 字符後續字節：某字符的 UTF-8 編碼中首字節後面的其它字節

const (
	// 位標記（用於判斷字節有效性）
	t1 = 0x00 // 0000 0000 單字節字符的首字節標記（二進制以 0     開頭）
	tx = 0x80 // 1000 0000 全部字符的後續字節標記（二進制以 10    開頭）
	t2 = 0xC0 // 1100 0000 雙字節字符的首字節標記（二進制以 110   開頭）
	t3 = 0xE0 // 1110 0000 三字節字符的首字節標記（二進制以 1110  開頭）
	t4 = 0xF0 // 1111 0000 四字節字符的首字節標記（二進制以 11110 開頭）
	t5 = 0xF8 // 1111 1000 好像未使用

	// 位掩碼（用於獲取標記以外的二進制位）
	maskx = 0x3F // 0011 1111 全部字符的後續字節掩碼
	mask2 = 0x1F // 0001 1111 雙字節字符的首字節掩碼
	mask3 = 0x0F // 0000 1111 三字節字符的首字節掩碼
	mask4 = 0x07 // 0000 0111 四字節字符的首字節掩碼

	rune1Max = 1<<7 - 1  // 單字節字符的總數（127   個）
	rune2Max = 1<<11 - 1 // 雙字節字符的總數（2047  個）
	rune3Max = 1<<16 - 1 // 三字節字符的總數（65535 個）

	// UTF-8 字符的後續字節的通常取值範圍
	locb = 0x80 // 1000 0000
	hicb = 0xBF // 1011 1111

	// 字符首字節分類標記，用於將全部的字符首字節分紅下面九類，分別處理。
	// 如下十六進制常量的高位和低位分別表示不一樣的含義：
	// 高位：「次字節取值範圍列表」的索引，若是高位是 F 則表示字符是單字節字符
	// 低位：字符的編碼長度，若是高位是 F 則低位表示單字節字符的狀態：有效、無效
	xx = 0xF1 // 無索引，長度 1，對應無效 UTF-8 編碼
	as = 0xF0 // 無索引，長度 1，對應普通 ASCII 字符
	s1 = 0x02 // 索引 0, 長度 2，對應普通「雙字節字符」的首字節
	s2 = 0x13 // 索引 1, 長度 3，對應特殊「雙字節字符」的首字節 0xE0（用於編碼長度跨越）
	s3 = 0x03 // 索引 0, 長度 3，對應普通「三字節字符」的首字節
	s4 = 0x23 // 索引 2, 長度 3，對應特殊「三字節字符」的首字節 0xED（用於代理區檢測）
	s5 = 0x34 // 索引 3, 長度 4，對應特殊「四字節字符」的首字節 0xF0（用於編碼長度跨越）
	s6 = 0x04 // 索引 0, 長度 4，對應普通「四字節字符」的首字節
	s7 = 0x44 // 索引 4, 長度 4，對應特殊「四字節字符」的首字節 0xF4（用於範圍檢測）
)

// first 是關於 UTF-8 字符中首字節的編碼信息。
// 將全部的首字節進行分類，分爲：xx、as、s一、s二、s三、s四、s五、s六、s7 九類，
// 其中 xx 表明無效首字節，s1 表明雙字節字符的首字節
// s二、s三、s4 表明三字節字符的首字節
// s五、s六、a7 表明四字節字符的首字節
var first = [256]uint8{
	//   1   2   3   4   5   6   7   8   9   A   B   C   D   E   F
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x00-0x0F
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x10-0x1F
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x20-0x2F
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x30-0x3F
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x40-0x4F
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x50-0x5F
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x60-0x6F
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x70-0x7F
	//   1   2   3   4   5   6   7   8   9   A   B   C   D   E   F
	xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0x80-0x8F
	xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0x90-0x9F
	xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0xA0-0xAF
	xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0xB0-0xBF
	xx, xx, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, // 0xC0-0xCF
	s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, // 0xD0-0xDF
	s2, s3, s3, s3, s3, s3, s3, s3, s3, s3, s3, s3, s3, s4, s3, s3, // 0xE0-0xEF
	s5, s6, s6, s6, s7, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0xF0-0xFF
}

// acceptRange 給出次字節的取值範圍。
type acceptRange struct {
	lo uint8 // 次字節最小取值
	hi uint8 // 次字節最大取值
}

// 不一樣的首字節字符有不一樣的次字節取值範圍，
// UTF-8 編碼編不出這些範圍以外的次字節內容。
var acceptRanges = [...]acceptRange{
	// 普通字符的次字節，範圍以外爲無效編碼（即二進制位不是以 10 開頭）
	0: {locb, hicb},
	// 三字節特殊字符（首字節爲 0xE0）的次字節：
	// 若是次字節低於 0xA0 則該字符應該用兩個字節表示，而不是三個字節。
	// 若是次字節高於 hicb 則該字節爲無效編碼（即二進制位不是以 10 開頭）
	1: {0xA0, hicb},
	// 三字節特殊字符（首字節爲 0xED）的次字節：
	// 若是次字節低於 locb 則該字節爲無效編碼（即二進制位不是以 10 開頭）
	// 若是次字節高於 0x9F 則該字符爲代理區字符（[ED A0 80] - [ED BF BF]）
	2: {locb, 0x9F},
	// 四字節特殊字符（首字節爲 0xF0）的次字節：
	// 若是次字節低於 0x90 則該字符應該用三個字節表示，而不是四個字節。
	// 若是次字節高於 hicb 則該字節爲無效編碼（即二進制位不是以 10 開頭）
	3: {0x90, hicb},
	// 四字節特殊字符（首字節爲 0xF4）的次字節：
	// 若是次字節低於 locb 則該字節爲無效編碼（即二進制位不是以 10 開頭）
	// 若是次字節高於 0x8F 則該字符超出 Unicode 範圍（超出 MaxRune）
	4: {locb, 0x8F},

	// 相鄰字符的編碼長度跨越：

	// [11011111 10111111]          [DF BF]    // U+07FF 的後一個字符爲三字節
	// [11100000 10100000 10000000] [E0 A0 80] // U+0800 的前一個字符爲兩字節

	// [11101111 10111111 10111111]          [EF BF BF]    // U+FFFF  的後一個字符爲四字節
	// [11110000 10010000 10000000 10000000] [F0 90 80 80] // U+10000 的前一個字符爲三字節
}

// FullRune 判斷 p 是否以一個完整（但不必定有效）的 UTF-8 字符開頭。
// 一個無效的編碼也被認爲是完整字符，由於它將被轉換爲一個 RuneError 字符。
// 只有「編碼有效但長度不夠」的字符才被認爲是不完整字符。
// 也就是說，只有截去一個有效字符的一個或多個後續字節，該字符纔算是不完整字符。
// 舉例：
// "好"     是完整字符
// "好"[1:] 是完整字符（首字節無效，轉換爲 RuneError 字符）
// "好"[2:] 是完整字符（首字節無效，轉換爲 RuneError 字符）
// "好"[:2] 是不完整字符（編碼有效但長度不夠）
// "好"[:1] 是不完整字符（編碼有效但長度不夠）
func FullRune(p []byte) bool {
	n := len(p)
	if n == 0 {
		return false
	}
	// 查表並計算，獲取編碼長度，判斷 p 的長度是否知足編碼長度
	x := first[p[0]]
	if n >= int(x&7) { // x&7 獲取的就是編碼長度
		// p 的長度知足編碼長度，表示 p 是一個完整的字符開頭。
		return true
	}

	// 此時 p 的長度不夠，應該是不完整的字符了，可是若是 p 中是無效編碼，也算完整。
	// 此時 n 確定小於 4，不然長度不可能不夠。

	// 獲取首字節對應的次字節有效範圍
	accept := acceptRanges[x>>4]
	if n > 1 {
		if c := p[1]; c < accept.lo || accept.hi < c {
			// 有一個無效字節，算完整字符
			return true
		} else if n > 2 && (p[2] < locb || hicb < p[2]) {
			// 有一個無效字節，算完整字符
			return true
		}
	}
	// 全是有效字節，但長度不夠，算不完整
	return false
}

// 功能同 FullRune，只不過參數爲字符串。
func FullRuneInString(s string) bool {
	n := len(s)
	if n == 0 {
		return false
	}
	x := first[s[0]]
	if n >= int(x&7) {
		return true
	}
	accept := acceptRanges[x>>4]
	if n > 1 {
		if c := s[1]; c < accept.lo || accept.hi < c {
			return true
		} else if n > 2 && (s[2] < locb || hicb < s[2]) {
			return true
		}
	}
	return false
}

// 解碼 UTF-8 序列 p 中的第一個 Unicode 字符。
// r   ：解碼出的字符
// size：該字符的 UTF-8 編碼長度
// 若是 p 爲空，則返回 RuneError, 0
// 若是 p 爲無效的 UTF-8 編碼，則返回 RuneError, 1
// 無效 UTF-8 編碼：UTF-8 編碼不正確（好比長度不夠）、結果超出 Unicode 範圍、
// 編碼不是最短的。
// 能夠用四個字節編碼一個單字節字符，但它不是最短的，好比：
// [111100000 10000000 10000000 10111000] 不是最短的，應該使用 [00111000]
func DecodeRune(p []byte) (r rune, size int) {
	n := len(p)
	if n < 1 {
		return RuneError, 0
	}
	// 處理單字節字符
	p0 := p[0]
	x := first[p0]
	if x >= as { // x 爲 F0 或 F1
		// 生成 0x0000 或 0xFFFF
		mask := rune(x) << 31 >> 31
		// return 保留 ASCII 字符 | 保留 RuneError, 1
		return rune(p[0])&^mask | RuneError&mask, 1
	}

	// 處理多字節字符

	// 獲取編碼長度
	sz := x & 7
	// 獲取次字節有效範圍
	accept := acceptRanges[x>>4]
	// p 長度不夠
	if n < int(sz) {
		return RuneError, 1
	}

	// p 長度知足

	// 次字節編碼有效
	b1 := p[1]
	if b1 < accept.lo || accept.hi < b1 {
		return RuneError, 1
	}
	// 處理有效的雙字節字符
	if sz == 2 {
		return rune(p0&mask2)<<6 | rune(b1&maskx), 2
	}
	// 超過雙字節，第三字節編碼有效
	b2 := p[2]
	if b2 < locb || hicb < b2 {
		return RuneError, 1
	}
	// 處理有效的三字節字符
	if sz == 3 {
		return rune(p0&mask3)<<12 | rune(b1&maskx)<<6 | rune(b2&maskx), 3
	}
	// 超過三字節，第四字節編碼有效
	b3 := p[3]
	if b3 < locb || hicb < b3 {
		return RuneError, 1
	}
	// 處理有效的四字節字符
	return rune(p0&mask4)<<18 | rune(b1&maskx)<<12 | rune(b2&maskx)<<6 | rune(b3&maskx), 4
}

// 功能同 DecodeRune，只不過參數爲字符串
func DecodeRuneInString(s string) (r rune, size int) {
	n := len(s)
	if n < 1 {
		return RuneError, 0
	}
	s0 := s[0]
	x := first[s0]
	if x >= as {
		mask := rune(x) << 31 >> 31
		return rune(s[0])&^mask | RuneError&mask, 1
	}
	sz := x & 7
	accept := acceptRanges[x>>4]
	if n < int(sz) {
		return RuneError, 1
	}
	s1 := s[1]
	if s1 < accept.lo || accept.hi < s1 {
		return RuneError, 1
	}
	if sz == 2 {
		return rune(s0&mask2)<<6 | rune(s1&maskx), 2
	}
	s2 := s[2]
	if s2 < locb || hicb < s2 {
		return RuneError, 1
	}
	if sz == 3 {
		return rune(s0&mask3)<<12 | rune(s1&maskx)<<6 | rune(s2&maskx), 3
	}
	s3 := s[3]
	if s3 < locb || hicb < s3 {
		return RuneError, 1
	}
	return rune(s0&mask4)<<18 | rune(s1&maskx)<<12 | rune(s2&maskx)<<6 | rune(s3&maskx), 4
}

// 功能同 DecodeRune，只不過解碼的是最後一個字符。
func DecodeLastRune(p []byte) (r rune, size int) {
	end := len(p)
	if end == 0 {
		return RuneError, 0
	}
	// 處理 p 的最後一個字節
	start := end - 1
	r = rune(p[start])
	if r < RuneSelf { // 單字節字符直接返回
		return r, 1
	}
	// 一次最多遍歷 4 個字節，避免因無效 UTF8 編碼形成的過分循環
	lim := end - UTFMax
	if lim < 0 {
		lim = 0
	}
	// 按字節反向遍歷
	for start--; start >= lim; start-- {
		if RuneStart(p[start]) { // 遇到首字節編碼便可
			break
		}
	}
	// 遍歷完了也沒遇到首字節，則解碼整個 p
	if start < 0 {
		start = 0
	}
	r, size = DecodeRune(p[start:end])
	// 遇到無效編碼，則只將最後一個字節解碼爲 RuneError
	if start+size != end {
		return RuneError, 1
	}
	// 解碼成功
	return r, size
}

// 功能同 DecodeLastRune，只不過參數爲字符串
func DecodeLastRuneInString(s string) (r rune, size int) {
	end := len(s)
	if end == 0 {
		return RuneError, 0
	}
	start := end - 1
	r = rune(s[start])
	if r < RuneSelf {
		return r, 1
	}
	lim := end - UTFMax
	if lim < 0 {
		lim = 0
	}
	for start--; start >= lim; start-- {
		if RuneStart(s[start]) {
			break
		}
	}
	if start < 0 {
		start = 0
	}
	r, size = DecodeRuneInString(s[start:end])
	if start+size != end {
		return RuneError, 1
	}
	return r, size
}

// RuneLen 返回 r 的 UTF-8 編碼所佔用的字節數。
// 若是 r 不是一個有效的值（代理區或超出範圍），則返回 -1。
func RuneLen(r rune) int {
	switch {
	case r < 0: // 超出範圍
		return -1
	case r <= rune1Max: // 單字節字符範圍
		return 1
	case r <= rune2Max: // 雙字節字符範圍
		return 2
	case surrogateMin <= r && r <= surrogateMax: // 代理區範圍
		return -1
	case r <= rune3Max: // 三字節字符範圍
		return 3
	case r <= MaxRune: // 四字節字符範圍
		return 4
	}
	return -1 // 超出範圍
}

// EncodeRune 將 r 編碼爲 UTF-8 序列，結果寫入 p 中（p 必須足夠長，通常爲 4）
// 返回寫入的字節數
func EncodeRune(p []byte, r rune) int {
	// 負數是錯誤的，將其轉換爲無符號數，以使其超出範圍，進而處理掉這個錯誤。
	switch i := uint32(r); {
	case i <= rune1Max: // 單字節字符
		p[0] = byte(r)
		return 1
	case i <= rune2Max: // 雙字節字符
		p[0] = t2 | byte(r>>6)
		p[1] = tx | byte(r)&maskx
		return 2
	// 超出範圍或代理區字符
	case i > MaxRune, surrogateMin <= i && i <= surrogateMax:
		r = RuneError
		fallthrough
	case i <= rune3Max: // 三字節字符
		p[0] = t3 | byte(r>>12)
		p[1] = tx | byte(r>>6)&maskx
		p[2] = tx | byte(r)&maskx
		return 3
	default: // 四字節字符
		p[0] = t4 | byte(r>>18)
		p[1] = tx | byte(r>>12)&maskx
		p[2] = tx | byte(r>>6)&maskx
		p[3] = tx | byte(r)&maskx
		return 4
	}
}

// RuneCount 返回 p 中的字符數（不是字節數）
// 錯誤的和長度無效的編碼中的每個字節都會被當作一個字符處理。
// RuneError 被視爲一個字符
func RuneCount(p []byte) int {
	np := len(p)
	var n int
	for i := 0; i < np; {
		n++
		c := p[i]
		if c < RuneSelf {
			i++ // 單字節字符
			continue
		}
		// 查表判斷首字節的有效性
		x := first[c]
		if x == xx {
			i++ // 首字節無效，字節當作一個字符處理
			continue
		}
		// 首字節有效
		size := int(x & 7)
		if i+size > np {
			i++ // 但長度不足，字節當作一個字符處理
			continue
		}
		// 首字節有效，長度也夠，判斷後續字節的有效性
		accept := acceptRanges[x>>4]
		if c := p[i+1]; c < accept.lo || accept.hi < c { // 次字節無效
			size = 1
		} else if size == 2 { // 次字節有效，長度恰好爲 2
		} else if c := p[i+2]; c < locb || hicb < c { // 第三字節無效
			size = 1
		} else if size == 3 { // 第三字節也有效，長度恰好爲 3
		} else if c := p[i+3]; c < locb || hicb < c { // 第四字節無效
			size = 1
		} // 第四字節也有效，長度不是 一、二、3，確定爲 4（size == 4）
		i += size
	}
	return n
}

// 功能同 RuneCount，只不過參數爲字符串
func RuneCountInString(s string) (n int) {
	ns := len(s)
	for i := 0; i < ns; n++ {
		c := s[i]
		if c < RuneSelf {
			i++
			continue
		}
		x := first[c]
		if x == xx {
			i++
			continue
		}
		size := int(x & 7)
		if i+size > ns {
			i++
			continue
		}
		accept := acceptRanges[x>>4]
		if c := s[i+1]; c < accept.lo || accept.hi < c {
			size = 1
		} else if size == 2 {
		} else if c := s[i+2]; c < locb || hicb < c {
			size = 1
		} else if size == 3 {
		} else if c := s[i+3]; c < locb || hicb < c {
			size = 1
		}
		i += size
	}
	return n
}

// RuneStart 判斷 b 是否爲 UTF-8 字符編碼的首字節（有多是無效字節）。
// UTF-8 編碼的後續字節的二進制位都是以 10 開始的。
func RuneStart(b byte) bool { return b&0xC0 != 0x80 }

// Valid 判斷 p 是否徹底由有效的 UTF-8 編碼組成。
func Valid(p []byte) bool {
	// 代碼同 RuneCount 相似
	n := len(p)
	for i := 0; i < n; {
		pi := p[i]
		if pi < RuneSelf {
			i++
			continue
		}
		x := first[pi]
		if x == xx {
			return false
		}
		size := int(x & 7)
		if i+size > n {
			return false
		}
		accept := acceptRanges[x>>4]
		if c := p[i+1]; c < accept.lo || accept.hi < c {
			return false
		} else if size == 2 {
		} else if c := p[i+2]; c < locb || hicb < c {
			return false
		} else if size == 3 {
		} else if c := p[i+3]; c < locb || hicb < c {
			return false
		}
		i += size
	}
	return true
}

// 功能同 Valid，只不過參數爲字符串
func ValidString(s string) bool {
	n := len(s)
	for i := 0; i < n; {
		si := s[i]
		if si < RuneSelf {
			i++
			continue
		}
		x := first[si]
		if x == xx {
			return false
		}
		size := int(x & 7)
		if i+size > n {
			return false
		}
		accept := acceptRanges[x>>4]
		if c := s[i+1]; c < accept.lo || accept.hi < c {
			return false
		} else if size == 2 {
		} else if c := s[i+2]; c < locb || hicb < c {
			return false
		} else if size == 3 {
		} else if c := s[i+3]; c < locb || hicb < c {
			return false
		}
		i += size
	}
	return true
}

// ValidRune 判斷 r 是否能夠被編碼成 UTF-8 序列。
// 代理區字符或超出範圍則返回 false。
func ValidRune(r rune) bool {
	switch {
	case r < 0: // 超出範圍
		return false
	case surrogateMin <= r && r <= surrogateMax: // 代理區字符
		return false
	case r > MaxRune: // 超出範圍
		return false
	}
	return true
}