blob: 563ceea0ccf9410322a592df6a0354d098752f2d [file] [log] [blame]
// 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.
package scanner
import (
"bytes"
"fmt"
"os"
"strings"
"testing"
)
// A StringReader delivers its data one string segment at a time via Read.
type StringReader struct {
data []string
step int
}
func (r *StringReader) Read(p []byte) (n int, err os.Error) {
if r.step < len(r.data) {
s := r.data[r.step]
for i := 0; i < len(s); i++ {
p[i] = s[i]
}
n = len(s)
r.step++
} else {
err = os.EOF
}
return
}
func readRuneSegments(t *testing.T, segments []string) {
got := ""
want := strings.Join(segments, "")
s := new(Scanner).Init(&StringReader{data: segments})
for {
ch := s.Next()
if ch == EOF {
break
}
got += string(ch)
}
if got != want {
t.Errorf("segments=%v got=%s want=%s", segments, got, want)
}
}
var segmentList = [][]string{
[]string{},
[]string{""},
[]string{"日", "本語"},
[]string{"\u65e5", "\u672c", "\u8a9e"},
[]string{"\U000065e5", " ", "\U0000672c", "\U00008a9e"},
[]string{"\xe6", "\x97\xa5\xe6", "\x9c\xac\xe8\xaa\x9e"},
[]string{"Hello", ", ", "World", "!"},
[]string{"Hello", ", ", "", "World", "!"},
}
func TestNext(t *testing.T) {
for _, s := range segmentList {
readRuneSegments(t, s)
}
}
type token struct {
tok int
text string
}
var f100 = "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
var tokenList = []token{
token{Comment, "// line comments\n"},
token{Comment, "//\n"},
token{Comment, "////\n"},
token{Comment, "// comment\n"},
token{Comment, "// /* comment */\n"},
token{Comment, "// // comment //\n"},
token{Comment, "//" + f100 + "\n"},
token{Comment, "// general comments\n"},
token{Comment, "/**/"},
token{Comment, "/***/"},
token{Comment, "/* comment */"},
token{Comment, "/* // comment */"},
token{Comment, "/* /* comment */"},
token{Comment, "/*\n comment\n*/"},
token{Comment, "/*" + f100 + "*/"},
token{Comment, "// identifiers\n"},
token{Ident, "a"},
token{Ident, "a0"},
token{Ident, "foobar"},
token{Ident, "abc123"},
token{Ident, "LGTM"},
token{Ident, "_"},
token{Ident, "_abc123"},
token{Ident, "abc123_"},
token{Ident, "_abc_123_"},
token{Ident, "_äöü"},
token{Ident, "_本"},
// TODO for unknown reasons these fail when checking the literals
/*
token{Ident, "äöü"},
token{Ident, "本"},
*/
token{Ident, "a۰۱۸"},
token{Ident, "foo६४"},
token{Ident, "bar9876"},
token{Ident, f100},
token{Comment, "// decimal ints\n"},
token{Int, "0"},
token{Int, "1"},
token{Int, "9"},
token{Int, "42"},
token{Int, "1234567890"},
token{Comment, "// octal ints\n"},
token{Int, "00"},
token{Int, "01"},
token{Int, "07"},
token{Int, "042"},
token{Int, "01234567"},
token{Comment, "// hexadecimal ints\n"},
token{Int, "0x0"},
token{Int, "0x1"},
token{Int, "0xf"},
token{Int, "0x42"},
token{Int, "0x123456789abcDEF"},
token{Int, "0x" + f100},
token{Int, "0X0"},
token{Int, "0X1"},
token{Int, "0XF"},
token{Int, "0X42"},
token{Int, "0X123456789abcDEF"},
token{Int, "0X" + f100},
token{Comment, "// floats\n"},
token{Float, "0."},
token{Float, "1."},
token{Float, "42."},
token{Float, "01234567890."},
token{Float, ".0"},
token{Float, ".1"},
token{Float, ".42"},
token{Float, ".0123456789"},
token{Float, "0.0"},
token{Float, "1.0"},
token{Float, "42.0"},
token{Float, "01234567890.0"},
token{Float, "0e0"},
token{Float, "1e0"},
token{Float, "42e0"},
token{Float, "01234567890e0"},
token{Float, "0E0"},
token{Float, "1E0"},
token{Float, "42E0"},
token{Float, "01234567890E0"},
token{Float, "0e+10"},
token{Float, "1e-10"},
token{Float, "42e+10"},
token{Float, "01234567890e-10"},
token{Float, "0E+10"},
token{Float, "1E-10"},
token{Float, "42E+10"},
token{Float, "01234567890E-10"},
token{Comment, "// chars\n"},
token{Char, `' '`},
token{Char, `'a'`},
token{Char, `'本'`},
token{Char, `'\a'`},
token{Char, `'\b'`},
token{Char, `'\f'`},
token{Char, `'\n'`},
token{Char, `'\r'`},
token{Char, `'\t'`},
token{Char, `'\v'`},
token{Char, `'\''`},
token{Char, `'\000'`},
token{Char, `'\777'`},
token{Char, `'\x00'`},
token{Char, `'\xff'`},
token{Char, `'\u0000'`},
token{Char, `'\ufA16'`},
token{Char, `'\U00000000'`},
token{Char, `'\U0000ffAB'`},
token{Comment, "// strings\n"},
token{String, `" "`},
token{String, `"a"`},
token{String, `"本"`},
token{String, `"\a"`},
token{String, `"\b"`},
token{String, `"\f"`},
token{String, `"\n"`},
token{String, `"\r"`},
token{String, `"\t"`},
token{String, `"\v"`},
token{String, `"\""`},
token{String, `"\000"`},
token{String, `"\777"`},
token{String, `"\x00"`},
token{String, `"\xff"`},
token{String, `"\u0000"`},
token{String, `"\ufA16"`},
token{String, `"\U00000000"`},
token{String, `"\U0000ffAB"`},
token{String, `"` + f100 + `"`},
token{Comment, "// raw strings\n"},
token{String, "``"},
token{String, "`\\`"},
token{String, "`" + "\n\n/* foobar */\n\n" + "`"},
token{String, "`" + f100 + "`"},
token{Comment, "// individual characters\n"},
// NUL character is not allowed
token{'\x01', "\x01"},
token{' ' - 1, string(' ' - 1)},
token{'+', "+"},
token{'/', "/"},
token{'.', "."},
token{'~', "~"},
token{'(', "("},
}
func makeSource(pattern string) *bytes.Buffer {
var buf bytes.Buffer
for _, k := range tokenList {
fmt.Fprintf(&buf, pattern, k.text)
}
return &buf
}
func checkTok(t *testing.T, s *Scanner, line, got, want int, text string) {
if got != want {
t.Fatalf("tok = %s, want %s for %q", TokenString(got), TokenString(want), text)
}
if s.Line != line {
t.Errorf("line = %d, want %d for %q", s.Line, line, text)
}
stext := s.TokenText()
if stext != text {
t.Errorf("text = %q, want %q", stext, text)
} else {
// check idempotency of TokenText() call
stext = s.TokenText()
if stext != text {
t.Errorf("text = %q, want %q (idempotency check)", stext, text)
}
}
}
func countNewlines(s string) int {
n := 0
for _, ch := range s {
if ch == '\n' {
n++
}
}
return n
}
func testScan(t *testing.T, mode uint) {
s := new(Scanner).Init(makeSource(" \t%s\t\n\r"))
s.Mode = mode
tok := s.Scan()
line := 1
for _, k := range tokenList {
if mode&SkipComments == 0 || k.tok != Comment {
checkTok(t, s, line, tok, k.tok, k.text)
tok = s.Scan()
}
line += countNewlines(k.text) + 1 // each token is on a new line
}
checkTok(t, s, line, tok, -1, "")
}
func TestScan(t *testing.T) {
testScan(t, GoTokens)
testScan(t, GoTokens&^SkipComments)
}
func TestPosition(t *testing.T) {
src := makeSource("\t\t\t\t%s\n")
s := new(Scanner).Init(src)
s.Mode = GoTokens &^ SkipComments
s.Scan()
pos := Position{"", 4, 1, 5}
for _, k := range tokenList {
if s.Offset != pos.Offset {
t.Errorf("offset = %d, want %d for %q", s.Offset, pos.Offset, k.text)
}
if s.Line != pos.Line {
t.Errorf("line = %d, want %d for %q", s.Line, pos.Line, k.text)
}
if s.Column != pos.Column {
t.Errorf("column = %d, want %d for %q", s.Column, pos.Column, k.text)
}
pos.Offset += 4 + len(k.text) + 1 // 4 tabs + token bytes + newline
pos.Line += countNewlines(k.text) + 1 // each token is on a new line
s.Scan()
}
}
func TestScanZeroMode(t *testing.T) {
src := makeSource("%s\n")
str := src.String()
s := new(Scanner).Init(src)
s.Mode = 0 // don't recognize any token classes
s.Whitespace = 0 // don't skip any whitespace
tok := s.Scan()
for i, ch := range str {
if tok != ch {
t.Fatalf("%d. tok = %s, want %s", i, TokenString(tok), TokenString(ch))
}
tok = s.Scan()
}
if tok != EOF {
t.Fatalf("tok = %s, want EOF", TokenString(tok))
}
}
func testScanSelectedMode(t *testing.T, mode uint, class int) {
src := makeSource("%s\n")
s := new(Scanner).Init(src)
s.Mode = mode
tok := s.Scan()
for tok != EOF {
if tok < 0 && tok != class {
t.Fatalf("tok = %s, want %s", TokenString(tok), TokenString(class))
}
tok = s.Scan()
}
}
func TestScanSelectedMask(t *testing.T) {
testScanSelectedMode(t, 0, 0)
testScanSelectedMode(t, ScanIdents, Ident)
// Don't test ScanInts and ScanNumbers since some parts of
// the floats in the source look like (illegal) octal ints
// and ScanNumbers may return either Int or Float.
testScanSelectedMode(t, ScanChars, Char)
testScanSelectedMode(t, ScanStrings, String)
testScanSelectedMode(t, SkipComments, 0)
testScanSelectedMode(t, ScanComments, Comment)
}
func TestScanNext(t *testing.T) {
s := new(Scanner).Init(bytes.NewBufferString("if a == bcd /* comment */ {\n\ta += c\n}"))
checkTok(t, s, 1, s.Scan(), Ident, "if")
checkTok(t, s, 1, s.Scan(), Ident, "a")
checkTok(t, s, 1, s.Scan(), '=', "=")
checkTok(t, s, 1, s.Next(), '=', "")
checkTok(t, s, 1, s.Next(), ' ', "")
checkTok(t, s, 1, s.Next(), 'b', "")
checkTok(t, s, 1, s.Scan(), Ident, "cd")
checkTok(t, s, 1, s.Scan(), '{', "{")
checkTok(t, s, 2, s.Scan(), Ident, "a")
checkTok(t, s, 2, s.Scan(), '+', "+")
checkTok(t, s, 2, s.Next(), '=', "")
checkTok(t, s, 2, s.Scan(), Ident, "c")
checkTok(t, s, 3, s.Scan(), '}', "}")
checkTok(t, s, 3, s.Scan(), -1, "")
}
func TestScanWhitespace(t *testing.T) {
var buf bytes.Buffer
var ws uint64
// start at 1, NUL character is not allowed
for ch := byte(1); ch < ' '; ch++ {
buf.WriteByte(ch)
ws |= 1 << ch
}
const orig = 'x'
buf.WriteByte(orig)
s := new(Scanner).Init(&buf)
s.Mode = 0
s.Whitespace = ws
tok := s.Scan()
if tok != orig {
t.Errorf("tok = %s, want %s", TokenString(tok), TokenString(orig))
}
}
func testError(t *testing.T, src, msg string, tok int) {
s := new(Scanner).Init(bytes.NewBufferString(src))
errorCalled := false
s.Error = func(s *Scanner, m string) {
if !errorCalled {
// only look at first error
if m != msg {
t.Errorf("msg = %q, want %q for %q", m, msg, src)
}
errorCalled = true
}
}
tk := s.Scan()
if tk != tok {
t.Errorf("tok = %s, want %s for %q", TokenString(tk), TokenString(tok), src)
}
if !errorCalled {
t.Errorf("error handler not called for %q", src)
}
if s.ErrorCount == 0 {
t.Errorf("count = %d, want > 0 for %q", s.ErrorCount, src)
}
}
func TestError(t *testing.T) {
testError(t, `01238`, "illegal octal number", Int)
testError(t, `'\"'`, "illegal char escape", Char)
testError(t, `'aa'`, "illegal char literal", Char)
testError(t, `'`, "literal not terminated", Char)
testError(t, `"\'"`, "illegal char escape", String)
testError(t, `"abc`, "literal not terminated", String)
testError(t, "`abc", "literal not terminated", String)
testError(t, `//`, "comment not terminated", EOF)
testError(t, `/*/`, "comment not terminated", EOF)
testError(t, `"abc`+"\x00"+`def"`, "illegal character NUL", String)
testError(t, `"abc`+"\xff"+`def"`, "illegal UTF-8 encoding", String)
}
func checkPos(t *testing.T, s *Scanner, offset, line, column, char int) {
pos := s.Pos()
if pos.Offset != offset {
t.Errorf("offset = %d, want %d", pos.Offset, offset)
}
if pos.Line != line {
t.Errorf("line = %d, want %d", pos.Line, line)
}
if pos.Column != column {
t.Errorf("column = %d, want %d", pos.Column, column)
}
ch := s.Scan()
if ch != char {
t.Errorf("ch = %s, want %s", TokenString(ch), TokenString(char))
}
}
func TestPos(t *testing.T) {
s := new(Scanner).Init(bytes.NewBufferString("abc\n012\n\nx"))
s.Mode = 0
s.Whitespace = 0
checkPos(t, s, 0, 1, 1, 'a')
checkPos(t, s, 1, 1, 2, 'b')
checkPos(t, s, 2, 1, 3, 'c')
checkPos(t, s, 3, 2, 0, '\n')
checkPos(t, s, 4, 2, 1, '0')
checkPos(t, s, 5, 2, 2, '1')
checkPos(t, s, 6, 2, 3, '2')
checkPos(t, s, 7, 3, 0, '\n')
checkPos(t, s, 8, 4, 0, '\n')
checkPos(t, s, 9, 4, 1, 'x')
checkPos(t, s, 9, 4, 1, EOF)
checkPos(t, s, 9, 4, 1, EOF) // after EOF, position doesn't change
}