This repo contains code to mirror other repos. It also contains the code that is getting mirrored.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

872 lines
31 KiB

  1. "Parses and creates Grammar objects"
  2. import os.path
  3. import sys
  4. from copy import copy, deepcopy
  5. from io import open
  6. from .utils import bfs, eval_escaping
  7. from .lexer import Token, TerminalDef, PatternStr, PatternRE
  8. from .parse_tree_builder import ParseTreeBuilder
  9. from .parser_frontends import LALR_TraditionalLexer
  10. from .common import LexerConf, ParserConf
  11. from .grammar import RuleOptions, Rule, Terminal, NonTerminal, Symbol
  12. from .utils import classify, suppress, dedup_list, Str
  13. from .exceptions import GrammarError, UnexpectedCharacters, UnexpectedToken
  14. from .tree import Tree, SlottedTree as ST
  15. from .visitors import Transformer, Visitor, v_args, Transformer_InPlace
  16. inline_args = v_args(inline=True)
  17. __path__ = os.path.dirname(__file__)
  18. IMPORT_PATHS = [os.path.join(__path__, 'grammars')]
  19. EXT = '.lark'
  20. _RE_FLAGS = 'imslux'
  21. _EMPTY = Symbol('__empty__')
  22. _TERMINAL_NAMES = {
  23. '.' : 'DOT',
  24. ',' : 'COMMA',
  25. ':' : 'COLON',
  26. ';' : 'SEMICOLON',
  27. '+' : 'PLUS',
  28. '-' : 'MINUS',
  29. '*' : 'STAR',
  30. '/' : 'SLASH',
  31. '\\' : 'BACKSLASH',
  32. '|' : 'VBAR',
  33. '?' : 'QMARK',
  34. '!' : 'BANG',
  35. '@' : 'AT',
  36. '#' : 'HASH',
  37. '$' : 'DOLLAR',
  38. '%' : 'PERCENT',
  39. '^' : 'CIRCUMFLEX',
  40. '&' : 'AMPERSAND',
  41. '_' : 'UNDERSCORE',
  42. '<' : 'LESSTHAN',
  43. '>' : 'MORETHAN',
  44. '=' : 'EQUAL',
  45. '"' : 'DBLQUOTE',
  46. '\'' : 'QUOTE',
  47. '`' : 'BACKQUOTE',
  48. '~' : 'TILDE',
  49. '(' : 'LPAR',
  50. ')' : 'RPAR',
  51. '{' : 'LBRACE',
  52. '}' : 'RBRACE',
  53. '[' : 'LSQB',
  54. ']' : 'RSQB',
  55. '\n' : 'NEWLINE',
  56. '\r\n' : 'CRLF',
  57. '\t' : 'TAB',
  58. ' ' : 'SPACE',
  59. }
  60. # Grammar Parser
  61. TERMINALS = {
  62. '_LPAR': r'\(',
  63. '_RPAR': r'\)',
  64. '_LBRA': r'\[',
  65. '_RBRA': r'\]',
  66. '_LBRACE': r'\{',
  67. '_RBRACE': r'\}',
  68. 'OP': '[+*]|[?](?![a-z])',
  69. '_COLON': ':',
  70. '_COMMA': ',',
  71. '_OR': r'\|',
  72. '_DOT': r'\.(?!\.)',
  73. '_DOTDOT': r'\.\.',
  74. 'TILDE': '~',
  75. 'RULE': '!?[_?]?[a-z][_a-z0-9]*',
  76. 'TERMINAL': '_?[A-Z][_A-Z0-9]*',
  77. 'STRING': r'"(\\"|\\\\|[^"\n])*?"i?',
  78. 'REGEXP': r'/(?!/)(\\/|\\\\|[^/\n])*?/[%s]*' % _RE_FLAGS,
  79. '_NL': r'(\r?\n)+\s*',
  80. 'WS': r'[ \t]+',
  81. 'COMMENT': r'\s*//[^\n]*',
  82. '_TO': '->',
  83. '_IGNORE': r'%ignore',
  84. '_DECLARE': r'%declare',
  85. '_IMPORT': r'%import',
  86. 'NUMBER': r'[+-]?\d+',
  87. }
  88. RULES = {
  89. 'start': ['_list'],
  90. '_list': ['_item', '_list _item'],
  91. '_item': ['rule', 'rule_template', 'term', 'statement', '_NL'],
  92. 'template': ['RULE _LBRACE template_params _RBRACE _COLON expansions _NL',
  93. 'RULE _LBRACE template_params _RBRACE _DOT NUMBER _COLON expansions _NL'],
  94. 'template_params': ['RULE',
  95. 'template_params _COMMA RULE'],
  96. 'rule': ['RULE _COLON expansions _NL',
  97. 'RULE _DOT NUMBER _COLON expansions _NL'],
  98. 'expansions': ['alias',
  99. 'expansions _OR alias',
  100. 'expansions _NL _OR alias'],
  101. '?alias': ['expansion _TO RULE', 'expansion'],
  102. 'expansion': ['_expansion'],
  103. '_expansion': ['', '_expansion expr'],
  104. '?expr': ['atom',
  105. 'atom OP',
  106. 'atom TILDE NUMBER',
  107. 'atom TILDE NUMBER _DOTDOT NUMBER',
  108. ],
  109. '?atom': ['_LPAR expansions _RPAR',
  110. 'maybe',
  111. 'value'],
  112. 'value': ['terminal',
  113. 'nonterminal',
  114. 'literal',
  115. 'range',
  116. 'template_usage'],
  117. 'terminal': ['TERMINAL'],
  118. 'nonterminal': ['RULE'],
  119. '?name': ['RULE', 'TERMINAL'],
  120. 'maybe': ['_LBRA expansions _RBRA'],
  121. 'range': ['STRING _DOTDOT STRING'],
  122. 'template_usage': ['RULE _LBRACE template_args _RBRACE'],
  123. 'template_args': ['atom',
  124. 'template_args _COMMA atom'],
  125. 'term': ['TERMINAL _COLON expansions _NL',
  126. 'TERMINAL _DOT NUMBER _COLON expansions _NL'],
  127. 'statement': ['ignore', 'import', 'declare'],
  128. 'ignore': ['_IGNORE expansions _NL'],
  129. 'declare': ['_DECLARE _declare_args _NL'],
  130. 'import': ['_IMPORT _import_path _NL',
  131. '_IMPORT _import_path _LPAR name_list _RPAR _NL',
  132. '_IMPORT _import_path _TO name _NL'],
  133. '_import_path': ['import_lib', 'import_rel'],
  134. 'import_lib': ['_import_args'],
  135. 'import_rel': ['_DOT _import_args'],
  136. '_import_args': ['name', '_import_args _DOT name'],
  137. 'name_list': ['_name_list'],
  138. '_name_list': ['name', '_name_list _COMMA name'],
  139. '_declare_args': ['name', '_declare_args name'],
  140. 'literal': ['REGEXP', 'STRING'],
  141. }
  142. @inline_args
  143. class EBNF_to_BNF(Transformer_InPlace):
  144. def __init__(self):
  145. self.new_rules = []
  146. self.rules_by_expr = {}
  147. self.prefix = 'anon'
  148. self.i = 0
  149. self.rule_options = None
  150. def _add_recurse_rule(self, type_, expr):
  151. if expr in self.rules_by_expr:
  152. return self.rules_by_expr[expr]
  153. new_name = '__%s_%s_%d' % (self.prefix, type_, self.i)
  154. self.i += 1
  155. t = NonTerminal(new_name)
  156. tree = ST('expansions', [ST('expansion', [expr]), ST('expansion', [t, expr])])
  157. self.new_rules.append((new_name, tree, self.rule_options))
  158. self.rules_by_expr[expr] = t
  159. return t
  160. def expr(self, rule, op, *args):
  161. if op.value == '?':
  162. empty = ST('expansion', [])
  163. return ST('expansions', [rule, empty])
  164. elif op.value == '+':
  165. # a : b c+ d
  166. # -->
  167. # a : b _c d
  168. # _c : _c c | c;
  169. return self._add_recurse_rule('plus', rule)
  170. elif op.value == '*':
  171. # a : b c* d
  172. # -->
  173. # a : b _c? d
  174. # _c : _c c | c;
  175. new_name = self._add_recurse_rule('star', rule)
  176. return ST('expansions', [new_name, ST('expansion', [])])
  177. elif op.value == '~':
  178. if len(args) == 1:
  179. mn = mx = int(args[0])
  180. else:
  181. mn, mx = map(int, args)
  182. if mx < mn or mn < 0:
  183. raise GrammarError("Bad Range for %s (%d..%d isn't allowed)" % (rule, mn, mx))
  184. return ST('expansions', [ST('expansion', [rule] * n) for n in range(mn, mx+1)])
  185. assert False, op
  186. def maybe(self, rule):
  187. keep_all_tokens = self.rule_options and self.rule_options.keep_all_tokens
  188. def will_not_get_removed(sym):
  189. if isinstance(sym, NonTerminal):
  190. return not sym.name.startswith('_')
  191. if isinstance(sym, Terminal):
  192. return keep_all_tokens or not sym.filter_out
  193. assert False
  194. if any(rule.scan_values(will_not_get_removed)):
  195. empty = _EMPTY
  196. else:
  197. empty = ST('expansion', [])
  198. return ST('expansions', [rule, empty])
  199. class SimplifyRule_Visitor(Visitor):
  200. @staticmethod
  201. def _flatten(tree):
  202. while True:
  203. to_expand = [i for i, child in enumerate(tree.children)
  204. if isinstance(child, Tree) and child.data == tree.data]
  205. if not to_expand:
  206. break
  207. tree.expand_kids_by_index(*to_expand)
  208. def expansion(self, tree):
  209. # rules_list unpacking
  210. # a : b (c|d) e
  211. # -->
  212. # a : b c e | b d e
  213. #
  214. # In AST terms:
  215. # expansion(b, expansions(c, d), e)
  216. # -->
  217. # expansions( expansion(b, c, e), expansion(b, d, e) )
  218. self._flatten(tree)
  219. for i, child in enumerate(tree.children):
  220. if isinstance(child, Tree) and child.data == 'expansions':
  221. tree.data = 'expansions'
  222. tree.children = [self.visit(ST('expansion', [option if i==j else other
  223. for j, other in enumerate(tree.children)]))
  224. for option in dedup_list(child.children)]
  225. self._flatten(tree)
  226. break
  227. def alias(self, tree):
  228. rule, alias_name = tree.children
  229. if rule.data == 'expansions':
  230. aliases = []
  231. for child in tree.children[0].children:
  232. aliases.append(ST('alias', [child, alias_name]))
  233. tree.data = 'expansions'
  234. tree.children = aliases
  235. def expansions(self, tree):
  236. self._flatten(tree)
  237. tree.children = dedup_list(tree.children)
  238. class RuleTreeToText(Transformer):
  239. def expansions(self, x):
  240. return x
  241. def expansion(self, symbols):
  242. return symbols, None
  243. def alias(self, x):
  244. (expansion, _alias), alias = x
  245. assert _alias is None, (alias, expansion, '-', _alias) # Double alias not allowed
  246. return expansion, alias.value
  247. @inline_args
  248. class CanonizeTree(Transformer_InPlace):
  249. def tokenmods(self, *args):
  250. if len(args) == 1:
  251. return list(args)
  252. tokenmods, value = args
  253. return tokenmods + [value]
  254. class PrepareAnonTerminals(Transformer_InPlace):
  255. "Create a unique list of anonymous terminals. Attempt to give meaningful names to them when we add them"
  256. def __init__(self, terminals):
  257. self.terminals = terminals
  258. self.term_set = {td.name for td in self.terminals}
  259. self.term_reverse = {td.pattern: td for td in terminals}
  260. self.i = 0
  261. @inline_args
  262. def pattern(self, p):
  263. value = p.value
  264. if p in self.term_reverse and p.flags != self.term_reverse[p].pattern.flags:
  265. raise GrammarError(u'Conflicting flags for the same terminal: %s' % p)
  266. term_name = None
  267. if isinstance(p, PatternStr):
  268. try:
  269. # If already defined, use the user-defined terminal name
  270. term_name = self.term_reverse[p].name
  271. except KeyError:
  272. # Try to assign an indicative anon-terminal name
  273. try:
  274. term_name = _TERMINAL_NAMES[value]
  275. except KeyError:
  276. if value.isalnum() and value[0].isalpha() and value.upper() not in self.term_set:
  277. with suppress(UnicodeEncodeError):
  278. value.upper().encode('ascii') # Make sure we don't have unicode in our terminal names
  279. term_name = value.upper()
  280. if term_name in self.term_set:
  281. term_name = None
  282. elif isinstance(p, PatternRE):
  283. if p in self.term_reverse: # Kind of a wierd placement.name
  284. term_name = self.term_reverse[p].name
  285. else:
  286. assert False, p
  287. if term_name is None:
  288. term_name = '__ANON_%d' % self.i
  289. self.i += 1
  290. if term_name not in self.term_set:
  291. assert p not in self.term_reverse
  292. self.term_set.add(term_name)
  293. termdef = TerminalDef(term_name, p)
  294. self.term_reverse[p] = termdef
  295. self.terminals.append(termdef)
  296. return Terminal(term_name, filter_out=isinstance(p, PatternStr))
  297. def _rfind(s, choices):
  298. return max(s.rfind(c) for c in choices)
  299. def _literal_to_pattern(literal):
  300. v = literal.value
  301. flag_start = _rfind(v, '/"')+1
  302. assert flag_start > 0
  303. flags = v[flag_start:]
  304. assert all(f in _RE_FLAGS for f in flags), flags
  305. v = v[:flag_start]
  306. assert v[0] == v[-1] and v[0] in '"/'
  307. x = v[1:-1]
  308. s = eval_escaping(x)
  309. if literal.type == 'STRING':
  310. s = s.replace('\\\\', '\\')
  311. return { 'STRING': PatternStr,
  312. 'REGEXP': PatternRE }[literal.type](s, flags)
  313. @inline_args
  314. class PrepareLiterals(Transformer_InPlace):
  315. def literal(self, literal):
  316. return ST('pattern', [_literal_to_pattern(literal)])
  317. def range(self, start, end):
  318. assert start.type == end.type == 'STRING'
  319. start = start.value[1:-1]
  320. end = end.value[1:-1]
  321. assert len(eval_escaping(start)) == len(eval_escaping(end)) == 1, (start, end, len(eval_escaping(start)), len(eval_escaping(end)))
  322. regexp = '[%s-%s]' % (start, end)
  323. return ST('pattern', [PatternRE(regexp)])
  324. class TerminalTreeToPattern(Transformer):
  325. def pattern(self, ps):
  326. p ,= ps
  327. return p
  328. def expansion(self, items):
  329. assert items
  330. if len(items) == 1:
  331. return items[0]
  332. if len({i.flags for i in items}) > 1:
  333. raise GrammarError("Lark doesn't support joining terminals with conflicting flags!")
  334. return PatternRE(''.join(i.to_regexp() for i in items), items[0].flags if items else ())
  335. def expansions(self, exps):
  336. if len(exps) == 1:
  337. return exps[0]
  338. if len({i.flags for i in exps}) > 1:
  339. raise GrammarError("Lark doesn't support joining terminals with conflicting flags!")
  340. return PatternRE('(?:%s)' % ('|'.join(i.to_regexp() for i in exps)), exps[0].flags)
  341. def expr(self, args):
  342. inner, op = args[:2]
  343. if op == '~':
  344. if len(args) == 3:
  345. op = "{%d}" % int(args[2])
  346. else:
  347. mn, mx = map(int, args[2:])
  348. if mx < mn:
  349. raise GrammarError("Bad Range for %s (%d..%d isn't allowed)" % (inner, mn, mx))
  350. op = "{%d,%d}" % (mn, mx)
  351. else:
  352. assert len(args) == 2
  353. return PatternRE('(?:%s)%s' % (inner.to_regexp(), op), inner.flags)
  354. def maybe(self, expr):
  355. return self.expr(expr + ['?'])
  356. def alias(self, t):
  357. raise GrammarError("Aliasing not allowed in terminals (You used -> in the wrong place)")
  358. def value(self, v):
  359. return v[0]
  360. class PrepareSymbols(Transformer_InPlace):
  361. def value(self, v):
  362. v ,= v
  363. if isinstance(v, Tree):
  364. return v
  365. elif v.type == 'RULE':
  366. return NonTerminal(Str(v.value))
  367. elif v.type == 'TERMINAL':
  368. return Terminal(Str(v.value), filter_out=v.startswith('_'))
  369. assert False
  370. def _choice_of_rules(rules):
  371. return ST('expansions', [ST('expansion', [Token('RULE', name)]) for name in rules])
  372. class Grammar:
  373. def __init__(self, rule_defs, term_defs, ignore):
  374. self.term_defs = term_defs
  375. self.rule_defs = rule_defs
  376. self.ignore = ignore
  377. def compile(self, start):
  378. # We change the trees in-place (to support huge grammars)
  379. # So deepcopy allows calling compile more than once.
  380. term_defs = deepcopy(list(self.term_defs))
  381. rule_defs = deepcopy(self.rule_defs)
  382. # ===================
  383. # Compile Terminals
  384. # ===================
  385. # Convert terminal-trees to strings/regexps
  386. for name, (term_tree, priority) in term_defs:
  387. if term_tree is None: # Terminal added through %declare
  388. continue
  389. expansions = list(term_tree.find_data('expansion'))
  390. if len(expansions) == 1 and not expansions[0].children:
  391. raise GrammarError("Terminals cannot be empty (%s)" % name)
  392. transformer = PrepareLiterals() * TerminalTreeToPattern()
  393. terminals = [TerminalDef(name, transformer.transform( term_tree ), priority)
  394. for name, (term_tree, priority) in term_defs if term_tree]
  395. # =================
  396. # Compile Rules
  397. # =================
  398. # 1. Pre-process terminals
  399. transformer = PrepareLiterals() * PrepareSymbols() * PrepareAnonTerminals(terminals) # Adds to terminals
  400. # 2. Convert EBNF to BNF (and apply step 1)
  401. ebnf_to_bnf = EBNF_to_BNF()
  402. rules = []
  403. for name, rule_tree, options in rule_defs:
  404. ebnf_to_bnf.rule_options = RuleOptions(keep_all_tokens=True) if options.keep_all_tokens else None
  405. ebnf_to_bnf.prefix = name
  406. tree = transformer.transform(rule_tree)
  407. res = ebnf_to_bnf.transform(tree)
  408. rules.append((name, res, options))
  409. rules += ebnf_to_bnf.new_rules
  410. assert len(rules) == len({name for name, _t, _o in rules}), "Whoops, name collision"
  411. # 3. Compile tree to Rule objects
  412. rule_tree_to_text = RuleTreeToText()
  413. simplify_rule = SimplifyRule_Visitor()
  414. compiled_rules = []
  415. for rule_content in rules:
  416. name, tree, options = rule_content
  417. simplify_rule.visit(tree)
  418. expansions = rule_tree_to_text.transform(tree)
  419. for i, (expansion, alias) in enumerate(expansions):
  420. if alias and name.startswith('_'):
  421. raise GrammarError("Rule %s is marked for expansion (it starts with an underscore) and isn't allowed to have aliases (alias=%s)" % (name, alias))
  422. empty_indices = [x==_EMPTY for x in expansion]
  423. if any(empty_indices):
  424. exp_options = copy(options) or RuleOptions()
  425. exp_options.empty_indices = empty_indices
  426. expansion = [x for x in expansion if x!=_EMPTY]
  427. else:
  428. exp_options = options
  429. assert all(isinstance(x, Symbol) for x in expansion), expansion
  430. rule = Rule(NonTerminal(name), expansion, i, alias, exp_options)
  431. compiled_rules.append(rule)
  432. # Remove duplicates of empty rules, throw error for non-empty duplicates
  433. if len(set(compiled_rules)) != len(compiled_rules):
  434. duplicates = classify(compiled_rules, lambda x: x)
  435. for dups in duplicates.values():
  436. if len(dups) > 1:
  437. if dups[0].expansion:
  438. raise GrammarError("Rules defined twice: %s\n\n(Might happen due to colliding expansion of optionals: [] or ?)"
  439. % ''.join('\n * %s' % i for i in dups))
  440. # Empty rule; assert all other attributes are equal
  441. assert len({(r.alias, r.order, r.options) for r in dups}) == len(dups)
  442. # Remove duplicates
  443. compiled_rules = list(set(compiled_rules))
  444. # Filter out unused rules
  445. while True:
  446. c = len(compiled_rules)
  447. used_rules = {s for r in compiled_rules
  448. for s in r.expansion
  449. if isinstance(s, NonTerminal)
  450. and s != r.origin}
  451. used_rules |= {NonTerminal(s) for s in start}
  452. compiled_rules = [r for r in compiled_rules if r.origin in used_rules]
  453. if len(compiled_rules) == c:
  454. break
  455. # Filter out unused terminals
  456. used_terms = {t.name for r in compiled_rules
  457. for t in r.expansion
  458. if isinstance(t, Terminal)}
  459. terminals = [t for t in terminals if t.name in used_terms or t.name in self.ignore]
  460. return terminals, compiled_rules, self.ignore
  461. _imported_grammars = {}
  462. def import_grammar(grammar_path, base_paths=[]):
  463. if grammar_path not in _imported_grammars:
  464. import_paths = base_paths + IMPORT_PATHS
  465. for import_path in import_paths:
  466. with suppress(IOError):
  467. joined_path = os.path.join(import_path, grammar_path)
  468. with open(joined_path, encoding='utf8') as f:
  469. text = f.read()
  470. grammar = load_grammar(text, joined_path)
  471. _imported_grammars[grammar_path] = grammar
  472. break
  473. else:
  474. open(grammar_path, encoding='utf8')
  475. assert False
  476. return _imported_grammars[grammar_path]
  477. def import_from_grammar_into_namespace(grammar, namespace, aliases):
  478. """Returns all rules and terminals of grammar, prepended
  479. with a 'namespace' prefix, except for those which are aliased.
  480. """
  481. imported_terms = dict(grammar.term_defs)
  482. imported_rules = {n:(n,deepcopy(t),o) for n,t,o in grammar.rule_defs}
  483. term_defs = []
  484. rule_defs = []
  485. def rule_dependencies(symbol):
  486. if symbol.type != 'RULE':
  487. return []
  488. try:
  489. _, tree, _ = imported_rules[symbol]
  490. except KeyError:
  491. raise GrammarError("Missing symbol '%s' in grammar %s" % (symbol, namespace))
  492. return _find_used_symbols(tree)
  493. def get_namespace_name(name):
  494. try:
  495. return aliases[name].value
  496. except KeyError:
  497. if name[0] == '_':
  498. return '_%s__%s' % (namespace, name[1:])
  499. return '%s__%s' % (namespace, name)
  500. to_import = list(bfs(aliases, rule_dependencies))
  501. for symbol in to_import:
  502. if symbol.type == 'TERMINAL':
  503. term_defs.append([get_namespace_name(symbol), imported_terms[symbol]])
  504. else:
  505. assert symbol.type == 'RULE'
  506. rule = imported_rules[symbol]
  507. for t in rule[1].iter_subtrees():
  508. for i, c in enumerate(t.children):
  509. if isinstance(c, Token) and c.type in ('RULE', 'TERMINAL'):
  510. t.children[i] = Token(c.type, get_namespace_name(c))
  511. rule_defs.append((get_namespace_name(symbol), rule[1], rule[2]))
  512. return term_defs, rule_defs
  513. def resolve_term_references(term_defs):
  514. # TODO Solve with transitive closure (maybe)
  515. term_dict = {k:t for k, (t,_p) in term_defs}
  516. assert len(term_dict) == len(term_defs), "Same name defined twice?"
  517. while True:
  518. changed = False
  519. for name, (token_tree, _p) in term_defs:
  520. if token_tree is None: # Terminal added through %declare
  521. continue
  522. for exp in token_tree.find_data('value'):
  523. item ,= exp.children
  524. if isinstance(item, Token):
  525. if item.type == 'RULE':
  526. raise GrammarError("Rules aren't allowed inside terminals (%s in %s)" % (item, name))
  527. if item.type == 'TERMINAL':
  528. term_value = term_dict[item]
  529. assert term_value is not None
  530. exp.children[0] = term_value
  531. changed = True
  532. if not changed:
  533. break
  534. for name, term in term_dict.items():
  535. if term: # Not just declared
  536. for child in term.children:
  537. ids = [id(x) for x in child.iter_subtrees()]
  538. if id(term) in ids:
  539. raise GrammarError("Recursion in terminal '%s' (recursion is only allowed in rules, not terminals)" % name)
  540. def options_from_rule(name, *x,is_template=False):
  541. if len(x) > (1+is_template):
  542. priority, expansions = x
  543. priority = int(priority)
  544. else:
  545. expansions ,= x
  546. priority = None
  547. keep_all_tokens = name.startswith('!')
  548. name = name.lstrip('!')
  549. expand1 = name.startswith('?')
  550. name = name.lstrip('?')
  551. return name, expansions, RuleOptions(keep_all_tokens, expand1, priority=priority)
  552. def symbols_from_strcase(expansion):
  553. return [Terminal(x, filter_out=x.startswith('_')) if x.isupper() else NonTerminal(x) for x in expansion]
  554. @inline_args
  555. class PrepareGrammar(Transformer_InPlace):
  556. def terminal(self, name):
  557. return name
  558. def nonterminal(self, name):
  559. return name
  560. def _find_used_symbols(tree):
  561. assert tree.data == 'expansions'
  562. return {t for x in tree.find_data('expansion')
  563. for t in x.scan_values(lambda t: t.type in ('RULE', 'TERMINAL'))}
  564. class GrammarLoader:
  565. def __init__(self):
  566. terminals = [TerminalDef(name, PatternRE(value)) for name, value in TERMINALS.items()]
  567. rules = [options_from_rule(name, x) for name, x in RULES.items()]
  568. rules = [Rule(NonTerminal(r), symbols_from_strcase(x.split()), i, None, o) for r, xs, o in rules for i, x in enumerate(xs)]
  569. callback = ParseTreeBuilder(rules, ST).create_callback()
  570. lexer_conf = LexerConf(terminals, ['WS', 'COMMENT'])
  571. parser_conf = ParserConf(rules, callback, ['start'])
  572. self.parser = LALR_TraditionalLexer(lexer_conf, parser_conf)
  573. self.canonize_tree = CanonizeTree()
  574. def load_grammar(self, grammar_text, grammar_name='<?>'):
  575. "Parse grammar_text, verify, and create Grammar object. Display nice messages on error."
  576. try:
  577. tree = self.canonize_tree.transform( self.parser.parse(grammar_text+'\n') )
  578. except UnexpectedCharacters as e:
  579. context = e.get_context(grammar_text)
  580. raise GrammarError("Unexpected input at line %d column %d in %s: \n\n%s" %
  581. (e.line, e.column, grammar_name, context))
  582. except UnexpectedToken as e:
  583. context = e.get_context(grammar_text)
  584. error = e.match_examples(self.parser.parse, {
  585. 'Unclosed parenthesis': ['a: (\n'],
  586. 'Umatched closing parenthesis': ['a: )\n', 'a: [)\n', 'a: (]\n'],
  587. 'Expecting rule or terminal definition (missing colon)': ['a\n', 'a->\n', 'A->\n', 'a A\n'],
  588. 'Alias expects lowercase name': ['a: -> "a"\n'],
  589. 'Unexpected colon': ['a::\n', 'a: b:\n', 'a: B:\n', 'a: "a":\n'],
  590. 'Misplaced operator': ['a: b??', 'a: b(?)', 'a:+\n', 'a:?\n', 'a:*\n', 'a:|*\n'],
  591. 'Expecting option ("|") or a new rule or terminal definition': ['a:a\n()\n'],
  592. '%import expects a name': ['%import "a"\n'],
  593. '%ignore expects a value': ['%ignore %import\n'],
  594. })
  595. if error:
  596. raise GrammarError("%s at line %s column %s\n\n%s" % (error, e.line, e.column, context))
  597. elif 'STRING' in e.expected:
  598. raise GrammarError("Expecting a value at line %s column %s\n\n%s" % (e.line, e.column, context))
  599. raise
  600. tree = PrepareGrammar().transform(tree)
  601. # Extract grammar items
  602. defs = classify(tree.children, lambda c: c.data, lambda c: c.children)
  603. term_defs = defs.pop('term', [])
  604. rule_defs = defs.pop('rule', [])
  605. template_defs = defs.pop('template', [])
  606. statements = defs.pop('statement', [])
  607. assert not defs
  608. term_defs = [td if len(td)==3 else (td[0], 1, td[1]) for td in term_defs]
  609. term_defs = [(name.value, (t, int(p))) for name, p, t in term_defs]
  610. rule_defs = [options_from_rule(*x) for x in rule_defs]
  611. template_defs = [options_from_rule(*x, is_template=True) for x in rule_defs]
  612. # Execute statements
  613. ignore, imports = [], {}
  614. for (stmt,) in statements:
  615. if stmt.data == 'ignore':
  616. t ,= stmt.children
  617. ignore.append(t)
  618. elif stmt.data == 'import':
  619. if len(stmt.children) > 1:
  620. path_node, arg1 = stmt.children
  621. else:
  622. path_node, = stmt.children
  623. arg1 = None
  624. if isinstance(arg1, Tree): # Multi import
  625. dotted_path = tuple(path_node.children)
  626. names = arg1.children
  627. aliases = dict(zip(names, names)) # Can't have aliased multi import, so all aliases will be the same as names
  628. else: # Single import
  629. dotted_path = tuple(path_node.children[:-1])
  630. name = path_node.children[-1] # Get name from dotted path
  631. aliases = {name: arg1 or name} # Aliases if exist
  632. if path_node.data == 'import_lib': # Import from library
  633. base_paths = []
  634. else: # Relative import
  635. if grammar_name == '<string>': # Import relative to script file path if grammar is coded in script
  636. try:
  637. base_file = os.path.abspath(sys.modules['__main__'].__file__)
  638. except AttributeError:
  639. base_file = None
  640. else:
  641. base_file = grammar_name # Import relative to grammar file path if external grammar file
  642. if base_file:
  643. base_paths = [os.path.split(base_file)[0]]
  644. else:
  645. base_paths = [os.path.abspath(os.path.curdir)]
  646. try:
  647. import_base_paths, import_aliases = imports[dotted_path]
  648. assert base_paths == import_base_paths, 'Inconsistent base_paths for %s.' % '.'.join(dotted_path)
  649. import_aliases.update(aliases)
  650. except KeyError:
  651. imports[dotted_path] = base_paths, aliases
  652. elif stmt.data == 'declare':
  653. for t in stmt.children:
  654. term_defs.append([t.value, (None, None)])
  655. else:
  656. assert False, stmt
  657. # import grammars
  658. for dotted_path, (base_paths, aliases) in imports.items():
  659. grammar_path = os.path.join(*dotted_path) + EXT
  660. g = import_grammar(grammar_path, base_paths=base_paths)
  661. new_td, new_rd = import_from_grammar_into_namespace(g, '__'.join(dotted_path), aliases)
  662. term_defs += new_td
  663. rule_defs += new_rd
  664. # Verify correctness 1
  665. for name, _ in term_defs:
  666. if name.startswith('__'):
  667. raise GrammarError('Names starting with double-underscore are reserved (Error at %s)' % name)
  668. # Handle ignore tokens
  669. # XXX A slightly hacky solution. Recognition of %ignore TERMINAL as separate comes from the lexer's
  670. # inability to handle duplicate terminals (two names, one value)
  671. ignore_names = []
  672. for t in ignore:
  673. if t.data=='expansions' and len(t.children) == 1:
  674. t2 ,= t.children
  675. if t2.data=='expansion' and len(t2.children) == 1:
  676. item ,= t2.children
  677. if item.data == 'value':
  678. item ,= item.children
  679. if isinstance(item, Token) and item.type == 'TERMINAL':
  680. ignore_names.append(item.value)
  681. continue
  682. name = '__IGNORE_%d'% len(ignore_names)
  683. ignore_names.append(name)
  684. term_defs.append((name, (t, 1)))
  685. # Verify correctness 2
  686. terminal_names = set()
  687. for name, _ in term_defs:
  688. if name in terminal_names:
  689. raise GrammarError("Terminal '%s' defined more than once" % name)
  690. terminal_names.add(name)
  691. if set(ignore_names) > terminal_names:
  692. raise GrammarError("Terminals %s were marked to ignore but were not defined!" % (set(ignore_names) - terminal_names))
  693. resolve_term_references(term_defs)
  694. rules = rule_defs
  695. rule_names = set()
  696. for name, _x, _o in rules:
  697. if name.startswith('__'):
  698. raise GrammarError('Names starting with double-underscore are reserved (Error at %s)' % name)
  699. if name in rule_names:
  700. raise GrammarError("Rule '%s' defined more than once" % name)
  701. rule_names.add(name)
  702. for name, expansions, _o in rules:
  703. for sym in _find_used_symbols(expansions):
  704. if sym.type == 'TERMINAL':
  705. if sym not in terminal_names:
  706. raise GrammarError("Token '%s' used but not defined (in rule %s)" % (sym, name))
  707. else:
  708. if sym not in rule_names:
  709. raise GrammarError("Rule '%s' used but not defined (in rule %s)" % (sym, name))
  710. return Grammar(rules, term_defs, ignore_names)
  711. load_grammar = GrammarLoader().load_grammar