regexp.go 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  1. package parser
  2. import (
  3. "bytes"
  4. "fmt"
  5. "strconv"
  6. )
  7. type _RegExp_parser struct {
  8. str string
  9. length int
  10. chr rune // The current character
  11. chrOffset int // The offset of current character
  12. offset int // The offset after current character (may be greater than 1)
  13. errors []error
  14. invalid bool // The input is an invalid JavaScript RegExp
  15. goRegexp *bytes.Buffer
  16. }
  17. // TransformRegExp transforms a JavaScript pattern into a Go "regexp" pattern.
  18. //
  19. // re2 (Go) cannot do backtracking, so the presence of a lookahead (?=) (?!) or
  20. // backreference (\1, \2, ...) will cause an error.
  21. //
  22. // re2 (Go) has a different definition for \s: [\t\n\f\r ].
  23. // The JavaScript definition, on the other hand, also includes \v, Unicode "Separator, Space", etc.
  24. //
  25. // If the pattern is invalid (not valid even in JavaScript), then this function
  26. // returns the empty string and an error.
  27. //
  28. // If the pattern is valid, but incompatible (contains a lookahead or backreference),
  29. // then this function returns the transformation (a non-empty string) AND an error.
  30. func TransformRegExp(pattern string) (string, error) {
  31. if pattern == "" {
  32. return "", nil
  33. }
  34. // TODO If without \, if without (?=, (?!, then another shortcut
  35. parser := _RegExp_parser{
  36. str: pattern,
  37. length: len(pattern),
  38. goRegexp: bytes.NewBuffer(make([]byte, 0, 3*len(pattern)/2)),
  39. }
  40. parser.read() // Pull in the first character
  41. parser.scan()
  42. var err error
  43. if len(parser.errors) > 0 {
  44. err = parser.errors[0]
  45. }
  46. if parser.invalid {
  47. return "", err
  48. }
  49. // Might not be re2 compatible, but is still a valid JavaScript RegExp
  50. return parser.goRegexp.String(), err
  51. }
  52. func (self *_RegExp_parser) scan() {
  53. for self.chr != -1 {
  54. switch self.chr {
  55. case '\\':
  56. self.read()
  57. self.scanEscape(false)
  58. case '(':
  59. self.pass()
  60. self.scanGroup()
  61. case '[':
  62. self.pass()
  63. self.scanBracket()
  64. case ')':
  65. self.error(-1, "Unmatched ')'")
  66. self.invalid = true
  67. self.pass()
  68. default:
  69. self.pass()
  70. }
  71. }
  72. }
  73. // (...)
  74. func (self *_RegExp_parser) scanGroup() {
  75. str := self.str[self.chrOffset:]
  76. if len(str) > 1 { // A possibility of (?= or (?!
  77. if str[0] == '?' {
  78. if str[1] == '=' || str[1] == '!' {
  79. self.error(-1, "re2: Invalid (%s) <lookahead>", self.str[self.chrOffset:self.chrOffset+2])
  80. }
  81. }
  82. }
  83. for self.chr != -1 && self.chr != ')' {
  84. switch self.chr {
  85. case '\\':
  86. self.read()
  87. self.scanEscape(false)
  88. case '(':
  89. self.pass()
  90. self.scanGroup()
  91. case '[':
  92. self.pass()
  93. self.scanBracket()
  94. default:
  95. self.pass()
  96. continue
  97. }
  98. }
  99. if self.chr != ')' {
  100. self.error(-1, "Unterminated group")
  101. self.invalid = true
  102. return
  103. }
  104. self.pass()
  105. }
  106. // [...]
  107. func (self *_RegExp_parser) scanBracket() {
  108. for self.chr != -1 {
  109. if self.chr == ']' {
  110. break
  111. } else if self.chr == '\\' {
  112. self.read()
  113. self.scanEscape(true)
  114. continue
  115. }
  116. self.pass()
  117. }
  118. if self.chr != ']' {
  119. self.error(-1, "Unterminated character class")
  120. self.invalid = true
  121. return
  122. }
  123. self.pass()
  124. }
  125. // \...
  126. func (self *_RegExp_parser) scanEscape(inClass bool) {
  127. offset := self.chrOffset
  128. var length, base uint32
  129. switch self.chr {
  130. case '0', '1', '2', '3', '4', '5', '6', '7':
  131. var value int64
  132. size := 0
  133. for {
  134. digit := int64(digitValue(self.chr))
  135. if digit >= 8 {
  136. // Not a valid digit
  137. break
  138. }
  139. value = value*8 + digit
  140. self.read()
  141. size += 1
  142. }
  143. if size == 1 { // The number of characters read
  144. _, err := self.goRegexp.Write([]byte{'\\', byte(value) + '0'})
  145. if err != nil {
  146. self.errors = append(self.errors, err)
  147. }
  148. if value != 0 {
  149. // An invalid backreference
  150. self.error(-1, "re2: Invalid \\%d <backreference>", value)
  151. }
  152. return
  153. }
  154. tmp := []byte{'\\', 'x', '0', 0}
  155. if value >= 16 {
  156. tmp = tmp[0:2]
  157. } else {
  158. tmp = tmp[0:3]
  159. }
  160. tmp = strconv.AppendInt(tmp, value, 16)
  161. _, err := self.goRegexp.Write(tmp)
  162. if err != nil {
  163. self.errors = append(self.errors, err)
  164. }
  165. return
  166. case '8', '9':
  167. size := 0
  168. for {
  169. digit := digitValue(self.chr)
  170. if digit >= 10 {
  171. // Not a valid digit
  172. break
  173. }
  174. self.read()
  175. size += 1
  176. }
  177. err := self.goRegexp.WriteByte('\\')
  178. if err != nil {
  179. self.errors = append(self.errors, err)
  180. }
  181. _, err = self.goRegexp.WriteString(self.str[offset:self.chrOffset])
  182. if err != nil {
  183. self.errors = append(self.errors, err)
  184. }
  185. self.error(-1, "re2: Invalid \\%s <backreference>", self.str[offset:self.chrOffset])
  186. return
  187. case 'x':
  188. self.read()
  189. length, base = 2, 16
  190. case 'u':
  191. self.read()
  192. length, base = 4, 16
  193. case 'b':
  194. if inClass {
  195. _, err := self.goRegexp.Write([]byte{'\\', 'x', '0', '8'})
  196. if err != nil {
  197. self.errors = append(self.errors, err)
  198. }
  199. self.read()
  200. return
  201. }
  202. fallthrough
  203. case 'B':
  204. fallthrough
  205. case 'd', 'D', 's', 'S', 'w', 'W':
  206. // This is slightly broken, because ECMAScript
  207. // includes \v in \s, \S, while re2 does not
  208. fallthrough
  209. case '\\':
  210. fallthrough
  211. case 'f', 'n', 'r', 't', 'v':
  212. err := self.goRegexp.WriteByte('\\')
  213. if err != nil {
  214. self.errors = append(self.errors, err)
  215. }
  216. self.pass()
  217. return
  218. case 'c':
  219. self.read()
  220. var value int64
  221. if 'a' <= self.chr && self.chr <= 'z' {
  222. value = int64(self.chr) - 'a' + 1
  223. } else if 'A' <= self.chr && self.chr <= 'Z' {
  224. value = int64(self.chr) - 'A' + 1
  225. } else {
  226. err := self.goRegexp.WriteByte('c')
  227. if err != nil {
  228. self.errors = append(self.errors, err)
  229. }
  230. return
  231. }
  232. tmp := []byte{'\\', 'x', '0', 0}
  233. if value >= 16 {
  234. tmp = tmp[0:2]
  235. } else {
  236. tmp = tmp[0:3]
  237. }
  238. tmp = strconv.AppendInt(tmp, value, 16)
  239. _, err := self.goRegexp.Write(tmp)
  240. if err != nil {
  241. self.errors = append(self.errors, err)
  242. }
  243. self.read()
  244. return
  245. default:
  246. // $ is an identifier character, so we have to have
  247. // a special case for it here
  248. if self.chr == '$' || !isIdentifierPart(self.chr) {
  249. // A non-identifier character needs escaping
  250. err := self.goRegexp.WriteByte('\\')
  251. if err != nil {
  252. self.errors = append(self.errors, err)
  253. }
  254. } else {
  255. // Unescape the character for re2
  256. }
  257. self.pass()
  258. return
  259. }
  260. // Otherwise, we're a \u.... or \x...
  261. valueOffset := self.chrOffset
  262. var value uint32
  263. {
  264. length := length
  265. for ; length > 0; length-- {
  266. digit := uint32(digitValue(self.chr))
  267. if digit >= base {
  268. // Not a valid digit
  269. goto skip
  270. }
  271. value = value*base + digit
  272. self.read()
  273. }
  274. }
  275. if length == 4 {
  276. _, err := self.goRegexp.Write([]byte{
  277. '\\',
  278. 'x',
  279. '{',
  280. self.str[valueOffset+0],
  281. self.str[valueOffset+1],
  282. self.str[valueOffset+2],
  283. self.str[valueOffset+3],
  284. '}',
  285. })
  286. if err != nil {
  287. self.errors = append(self.errors, err)
  288. }
  289. } else if length == 2 {
  290. _, err := self.goRegexp.Write([]byte{
  291. '\\',
  292. 'x',
  293. self.str[valueOffset+0],
  294. self.str[valueOffset+1],
  295. })
  296. if err != nil {
  297. self.errors = append(self.errors, err)
  298. }
  299. } else {
  300. // Should never, ever get here...
  301. self.error(-1, "re2: Illegal branch in scanEscape")
  302. goto skip
  303. }
  304. return
  305. skip:
  306. _, err := self.goRegexp.WriteString(self.str[offset:self.chrOffset])
  307. if err != nil {
  308. self.errors = append(self.errors, err)
  309. }
  310. }
  311. func (self *_RegExp_parser) pass() {
  312. if self.chr != -1 {
  313. _, err := self.goRegexp.WriteRune(self.chr)
  314. if err != nil {
  315. self.errors = append(self.errors, err)
  316. }
  317. }
  318. self.read()
  319. }
  320. // TODO Better error reporting, use the offset, etc.
  321. func (self *_RegExp_parser) error(offset int, msg string, msgValues ...interface{}) error {
  322. err := fmt.Errorf(msg, msgValues...)
  323. self.errors = append(self.errors, err)
  324. return err
  325. }