[parser] parser: change the location of RestoreCtx (pingcap#157)

parser/ast/ast.go

@@ -18,6 +18,7 @@ package ast
 import (
 	"io"
 
+	. "github.com/pingcap/parser/format"
 	"github.com/pingcap/parser/model"
 	"github.com/pingcap/parser/types"
 )

parser/ast/ddl.go

@@ -16,6 +16,7 @@ package ast
 import (
 	"github.com/pingcap/errors"
 	"github.com/pingcap/parser/auth"
+	. "github.com/pingcap/parser/format"
 	"github.com/pingcap/parser/model"
 	"github.com/pingcap/parser/types"
 )

parser/ast/dml.go

@@ -18,6 +18,7 @@ import (
 
 	"github.com/pingcap/errors"
 	"github.com/pingcap/parser/auth"
+	. "github.com/pingcap/parser/format"
 	"github.com/pingcap/parser/model"
 	"github.com/pingcap/parser/mysql"
 )

parser/ast/expressions.go

@@ -20,6 +20,7 @@ import (
 	"strings"
 
 	"github.com/pingcap/errors"
+	. "github.com/pingcap/parser/format"
 	"github.com/pingcap/parser/model"
 	"github.com/pingcap/parser/opcode"
 )

parser/ast/functions.go

@@ -18,6 +18,7 @@ import (
 	"io"
 
 	"github.com/pingcap/errors"
+	. "github.com/pingcap/parser/format"
 	"github.com/pingcap/parser/model"
 	"github.com/pingcap/parser/types"
 )

parser/ast/misc.go

@@ -20,6 +20,7 @@ import (
 
 	"github.com/pingcap/errors"
 	"github.com/pingcap/parser/auth"
+	. "github.com/pingcap/parser/format"
 	"github.com/pingcap/parser/model"
 	"github.com/pingcap/parser/mysql"
 )

parser/ast/stats.go

@@ -15,6 +15,7 @@ package ast
 
 import (
 	"github.com/pingcap/errors"
+	. "github.com/pingcap/parser/format"
 	"github.com/pingcap/parser/model"
 )
 

parser/ast/util.go

@@ -13,12 +13,6 @@
 
 package ast
 
-import (
-	"fmt"
-	"io"
-	"strings"
-)
-
 // IsReadOnly checks whether the input ast is readOnly.
 func IsReadOnly(node Node) bool {
 	switch st := node.(type) {
@@ -65,152 +59,3 @@ func (checker *readOnlyChecker) Enter(in Node) (out Node, skipChildren bool) {
 func (checker *readOnlyChecker) Leave(in Node) (out Node, ok bool) {
 	return in, checker.readOnly
 }
-
-//RestoreFlag mark the Restore format
-type RestoreFlags uint64
-
-// Mutually exclusive group of `RestoreFlags`:
-// [RestoreStringSingleQuotes, RestoreStringDoubleQuotes]
-// [RestoreKeyWordUppercase, RestoreKeyWordLowercase]
-// [RestoreNameUppercase, RestoreNameLowercase]
-// [RestoreNameDoubleQuotes, RestoreNameBackQuotes]
-// The flag with the left position in each group has a higher priority.
-const (
-	RestoreStringSingleQuotes RestoreFlags = 1 << iota
-	RestoreStringDoubleQuotes
-	RestoreStringEscapeBackslash
-
-	RestoreKeyWordUppercase
-	RestoreKeyWordLowercase
-
-	RestoreNameUppercase
-	RestoreNameLowercase
-	RestoreNameDoubleQuotes
-	RestoreNameBackQuotes
-)
-
-const (
-	DefaultRestoreFlags = RestoreStringSingleQuotes | RestoreKeyWordUppercase | RestoreNameBackQuotes
-)
-
-func (rf RestoreFlags) has(flag RestoreFlags) bool {
-	return rf&flag != 0
-}
-
-// HasStringSingleQuotesFlag returns a boolean indicating when `rf` has `RestoreStringSingleQuotes` flag.
-func (rf RestoreFlags) HasStringSingleQuotesFlag() bool {
-	return rf.has(RestoreStringSingleQuotes)
-}
-
-// HasStringDoubleQuotesFlag returns a boolean indicating whether `rf` has `RestoreStringDoubleQuotes` flag.
-func (rf RestoreFlags) HasStringDoubleQuotesFlag() bool {
-	return rf.has(RestoreStringDoubleQuotes)
-}
-
-// HasStringEscapeBackslashFlag returns a boolean indicating whether `rf` has `RestoreStringEscapeBackslash` flag.
-func (rf RestoreFlags) HasStringEscapeBackslashFlag() bool {
-	return rf.has(RestoreStringEscapeBackslash)
-}
-
-// HasKeyWordUppercaseFlag returns a boolean indicating whether `rf` has `RestoreKeyWordUppercase` flag.
-func (rf RestoreFlags) HasKeyWordUppercaseFlag() bool {
-	return rf.has(RestoreKeyWordUppercase)
-}
-
-// HasKeyWordLowercaseFlag returns a boolean indicating whether `rf` has `RestoreKeyWordLowercase` flag.
-func (rf RestoreFlags) HasKeyWordLowercaseFlag() bool {
-	return rf.has(RestoreKeyWordLowercase)
-}
-
-// HasNameUppercaseFlag returns a boolean indicating whether `rf` has `RestoreNameUppercase` flag.
-func (rf RestoreFlags) HasNameUppercaseFlag() bool {
-	return rf.has(RestoreNameUppercase)
-}
-
-// HasNameLowercaseFlag returns a boolean indicating whether `rf` has `RestoreNameLowercase` flag.
-func (rf RestoreFlags) HasNameLowercaseFlag() bool {
-	return rf.has(RestoreNameLowercase)
-}
-
-// HasNameDoubleQuotesFlag returns a boolean indicating whether `rf` has `RestoreNameDoubleQuotes` flag.
-func (rf RestoreFlags) HasNameDoubleQuotesFlag() bool {
-	return rf.has(RestoreNameDoubleQuotes)
-}
-
-// HasNameBackQuotesFlag returns a boolean indicating whether `rf` has `RestoreNameBackQuotes` flag.
-func (rf RestoreFlags) HasNameBackQuotesFlag() bool {
-	return rf.has(RestoreNameBackQuotes)
-}
-
-// RestoreCtx is `Restore` context to hold flags and writer.
-type RestoreCtx struct {
-	Flags     RestoreFlags
-	In        io.Writer
-	JoinLevel int
-}
-
-// NewRestoreCtx returns a new `RestoreCtx`.
-func NewRestoreCtx(flags RestoreFlags, in io.Writer) *RestoreCtx {
-	return &RestoreCtx{flags, in, 0}
-}
-
-// WriteKeyWord writes the `keyWord` into writer.
-// `keyWord` will be converted format(uppercase and lowercase for now) according to `RestoreFlags`.
-func (ctx *RestoreCtx) WriteKeyWord(keyWord string) {
-	switch {
-	case ctx.Flags.HasKeyWordUppercaseFlag():
-		keyWord = strings.ToUpper(keyWord)
-	case ctx.Flags.HasKeyWordLowercaseFlag():
-		keyWord = strings.ToLower(keyWord)
-	}
-	fmt.Fprint(ctx.In, keyWord)
-}
-
-// WriteString writes the string into writer
-// `str` may be wrapped in quotes and escaped according to RestoreFlags.
-func (ctx *RestoreCtx) WriteString(str string) {
-	if ctx.Flags.HasStringEscapeBackslashFlag() {
-		str = strings.Replace(str, `\`, `\\`, -1)
-	}
-	quotes := ""
-	switch {
-	case ctx.Flags.HasStringSingleQuotesFlag():
-		str = strings.Replace(str, `'`, `''`, -1)
-		quotes = `'`
-	case ctx.Flags.HasStringDoubleQuotesFlag():
-		str = strings.Replace(str, `"`, `""`, -1)
-		quotes = `"`
-	}
-	fmt.Fprint(ctx.In, quotes, str, quotes)
-}
-
-// WriteName writes the name into writer
-// `name` maybe wrapped in quotes and escaped according to RestoreFlags.
-func (ctx *RestoreCtx) WriteName(name string) {
-	switch {
-	case ctx.Flags.HasNameUppercaseFlag():
-		name = strings.ToUpper(name)
-	case ctx.Flags.HasNameLowercaseFlag():
-		name = strings.ToLower(name)
-	}
-	quotes := ""
-	switch {
-	case ctx.Flags.HasNameDoubleQuotesFlag():
-		name = strings.Replace(name, `"`, `""`, -1)
-		quotes = `"`
-	case ctx.Flags.HasNameBackQuotesFlag():
-		name = strings.Replace(name, "`", "``", -1)
-		quotes = "`"
-	}
-	fmt.Fprint(ctx.In, quotes, name, quotes)
-}
-
-// WritePlain writes the plain text into writer without any handling.
-func (ctx *RestoreCtx) WritePlain(plainText string) {
-	fmt.Fprint(ctx.In, plainText)
-}
-
-// WritePlainf write the plain text into writer without any handling.
-func (ctx *RestoreCtx) WritePlainf(format string, a ...interface{}) {
-	fmt.Fprintf(ctx.In, format, a...)
-}

parser/ast/util_test.go

@@ -20,11 +20,11 @@ import (
 	. "github.com/pingcap/check"
 	"github.com/pingcap/parser"
 	. "github.com/pingcap/parser/ast"
+	. "github.com/pingcap/parser/format"
 	driver "github.com/pingcap/tidb/types/parser_driver"
 )
 
 var _ = Suite(&testCacheableSuite{})
-var _ = Suite(&testRestoreCtxSuite{})
 
 type testCacheableSuite struct {
 }
@@ -83,43 +83,6 @@ func (checker *nodeTextCleaner) Leave(in Node) (out Node, ok bool) {
 	return in, true
 }
 
-type testRestoreCtxSuite struct {
-}
-
-func (s *testRestoreCtxSuite) TestRestoreCtx(c *C) {
-	testCases := []struct {
-		flag   RestoreFlags
-		expect string
-	}{
-		{0, "key`.'\"Word\\ str`.'\"ing\\ na`.'\"Me\\"},
-		{RestoreStringSingleQuotes, "key`.'\"Word\\ 'str`.''\"ing\\' na`.'\"Me\\"},
-		{RestoreStringDoubleQuotes, "key`.'\"Word\\ \"str`.'\"\"ing\\\" na`.'\"Me\\"},
-		{RestoreStringEscapeBackslash, "key`.'\"Word\\ str`.'\"ing\\\\ na`.'\"Me\\"},
-		{RestoreKeyWordUppercase, "KEY`.'\"WORD\\ str`.'\"ing\\ na`.'\"Me\\"},
-		{RestoreKeyWordLowercase, "key`.'\"word\\ str`.'\"ing\\ na`.'\"Me\\"},
-		{RestoreNameUppercase, "key`.'\"Word\\ str`.'\"ing\\ NA`.'\"ME\\"},
-		{RestoreNameLowercase, "key`.'\"Word\\ str`.'\"ing\\ na`.'\"me\\"},
-		{RestoreNameDoubleQuotes, "key`.'\"Word\\ str`.'\"ing\\ \"na`.'\"\"Me\\\""},
-		{RestoreNameBackQuotes, "key`.'\"Word\\ str`.'\"ing\\ `na``.'\"Me\\`"},
-		{DefaultRestoreFlags, "KEY`.'\"WORD\\ 'str`.''\"ing\\' `na``.'\"Me\\`"},
-		{RestoreStringSingleQuotes | RestoreStringDoubleQuotes, "key`.'\"Word\\ 'str`.''\"ing\\' na`.'\"Me\\"},
-		{RestoreKeyWordUppercase | RestoreKeyWordLowercase, "KEY`.'\"WORD\\ str`.'\"ing\\ na`.'\"Me\\"},
-		{RestoreNameUppercase | RestoreNameLowercase, "key`.'\"Word\\ str`.'\"ing\\ NA`.'\"ME\\"},
-		{RestoreNameDoubleQuotes | RestoreNameBackQuotes, "key`.'\"Word\\ str`.'\"ing\\ \"na`.'\"\"Me\\\""},
-	}
-	var sb strings.Builder
-	for _, testCase := range testCases {
-		sb.Reset()
-		ctx := NewRestoreCtx(testCase.flag, &sb)
-		ctx.WriteKeyWord("key`.'\"Word\\")
-		ctx.WritePlain(" ")
-		ctx.WriteString("str`.'\"ing\\")
-		ctx.WritePlain(" ")
-		ctx.WriteName("na`.'\"Me\\")
-		c.Assert(sb.String(), Equals, testCase.expect, Commentf("case: %#v", testCase))
-	}
-}
-
 type NodeRestoreTestCase struct {
 	sourceSQL string
 	expectSQL string