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.

940 lines
34 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', 'term', 'statement', '_NL'],
  92. 'rule': ['RULE template_params _COLON expansions _NL',
  93. 'RULE template_params _DOT NUMBER _COLON expansions _NL'],
  94. 'template_params': ['_LBRACE _template_params _RBRACE',
  95. ''],
  96. '_template_params': ['RULE',
  97. '_template_params _COMMA RULE'],
  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': ['value',
  124. '_template_args _COMMA value'],
  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. class _ReplaceSymbols(Transformer_InPlace):
  298. " Helper for ApplyTemplates "
  299. def __init__(self):
  300. self.names = {}
  301. def value(self, c):
  302. if len(c) == 1 and isinstance(c[0], Token) and c[0].value in self.names:
  303. return self.names[c[0].value]
  304. return self.__default__('value', c, None)
  305. def template_usage(self, c):
  306. if c[0] in self.names:
  307. return self.__default__('template_usage', [self.names[c[0]].name] + c[1:], None)
  308. return self.__default__('template_usage', c, None)
  309. class ApplyTemplates(Transformer_InPlace):
  310. " Apply the templates, creating new rules that represent the used templates "
  311. def __init__(self, rule_defs):
  312. self.rule_defs = rule_defs
  313. self.replacer = _ReplaceSymbols()
  314. self.created_templates = set()
  315. def template_usage(self, c):
  316. name = c[0]
  317. args = c[1:]
  318. result_name = "%s{%s}" % (name, ",".join(a.name for a in args))
  319. if result_name not in self.created_templates:
  320. self.created_templates.add(result_name)
  321. (_n, params, tree, options) ,= (t for t in self.rule_defs if t[0] == name)
  322. assert len(params) == len(args), args
  323. result_tree = deepcopy(tree)
  324. self.replacer.names = dict(zip(params, args))
  325. self.replacer.transform(result_tree)
  326. self.rule_defs.append((result_name, [], result_tree, deepcopy(options)))
  327. return NonTerminal(result_name)
  328. def _rfind(s, choices):
  329. return max(s.rfind(c) for c in choices)
  330. def _literal_to_pattern(literal):
  331. v = literal.value
  332. flag_start = _rfind(v, '/"')+1
  333. assert flag_start > 0
  334. flags = v[flag_start:]
  335. assert all(f in _RE_FLAGS for f in flags), flags
  336. v = v[:flag_start]
  337. assert v[0] == v[-1] and v[0] in '"/'
  338. x = v[1:-1]
  339. s = eval_escaping(x)
  340. if literal.type == 'STRING':
  341. s = s.replace('\\\\', '\\')
  342. return { 'STRING': PatternStr,
  343. 'REGEXP': PatternRE }[literal.type](s, flags)
  344. @inline_args
  345. class PrepareLiterals(Transformer_InPlace):
  346. def literal(self, literal):
  347. return ST('pattern', [_literal_to_pattern(literal)])
  348. def range(self, start, end):
  349. assert start.type == end.type == 'STRING'
  350. start = start.value[1:-1]
  351. end = end.value[1:-1]
  352. assert len(eval_escaping(start)) == len(eval_escaping(end)) == 1, (start, end, len(eval_escaping(start)), len(eval_escaping(end)))
  353. regexp = '[%s-%s]' % (start, end)
  354. return ST('pattern', [PatternRE(regexp)])
  355. class TerminalTreeToPattern(Transformer):
  356. def pattern(self, ps):
  357. p ,= ps
  358. return p
  359. def expansion(self, items):
  360. assert items
  361. if len(items) == 1:
  362. return items[0]
  363. if len({i.flags for i in items}) > 1:
  364. raise GrammarError("Lark doesn't support joining terminals with conflicting flags!")
  365. return PatternRE(''.join(i.to_regexp() for i in items), items[0].flags if items else ())
  366. def expansions(self, exps):
  367. if len(exps) == 1:
  368. return exps[0]
  369. if len({i.flags for i in exps}) > 1:
  370. raise GrammarError("Lark doesn't support joining terminals with conflicting flags!")
  371. return PatternRE('(?:%s)' % ('|'.join(i.to_regexp() for i in exps)), exps[0].flags)
  372. def expr(self, args):
  373. inner, op = args[:2]
  374. if op == '~':
  375. if len(args) == 3:
  376. op = "{%d}" % int(args[2])
  377. else:
  378. mn, mx = map(int, args[2:])
  379. if mx < mn:
  380. raise GrammarError("Bad Range for %s (%d..%d isn't allowed)" % (inner, mn, mx))
  381. op = "{%d,%d}" % (mn, mx)
  382. else:
  383. assert len(args) == 2
  384. return PatternRE('(?:%s)%s' % (inner.to_regexp(), op), inner.flags)
  385. def maybe(self, expr):
  386. return self.expr(expr + ['?'])
  387. def alias(self, t):
  388. raise GrammarError("Aliasing not allowed in terminals (You used -> in the wrong place)")
  389. def value(self, v):
  390. return v[0]
  391. class PrepareSymbols(Transformer_InPlace):
  392. def value(self, v):
  393. v ,= v
  394. if isinstance(v, Tree):
  395. return v
  396. elif v.type == 'RULE':
  397. return NonTerminal(Str(v.value))
  398. elif v.type == 'TERMINAL':
  399. return Terminal(Str(v.value), filter_out=v.startswith('_'))
  400. assert False
  401. def _choice_of_rules(rules):
  402. return ST('expansions', [ST('expansion', [Token('RULE', name)]) for name in rules])
  403. class Grammar:
  404. def __init__(self, rule_defs, term_defs, ignore):
  405. self.term_defs = term_defs
  406. self.rule_defs = rule_defs
  407. self.ignore = ignore
  408. def compile(self, start):
  409. # We change the trees in-place (to support huge grammars)
  410. # So deepcopy allows calling compile more than once.
  411. term_defs = deepcopy(list(self.term_defs))
  412. rule_defs = deepcopy(self.rule_defs)
  413. # ===================
  414. # Compile Terminals
  415. # ===================
  416. # Convert terminal-trees to strings/regexps
  417. for name, (term_tree, priority) in term_defs:
  418. if term_tree is None: # Terminal added through %declare
  419. continue
  420. expansions = list(term_tree.find_data('expansion'))
  421. if len(expansions) == 1 and not expansions[0].children:
  422. raise GrammarError("Terminals cannot be empty (%s)" % name)
  423. transformer = PrepareLiterals() * TerminalTreeToPattern()
  424. terminals = [TerminalDef(name, transformer.transform( term_tree ), priority)
  425. for name, (term_tree, priority) in term_defs if term_tree]
  426. # =================
  427. # Compile Rules
  428. # =================
  429. # 1. Pre-process terminals
  430. transformer = PrepareLiterals() * PrepareSymbols() * PrepareAnonTerminals(terminals) # Adds to terminals
  431. # 2. Inline Templates
  432. transformer *= ApplyTemplates(rule_defs)
  433. # 3. Convert EBNF to BNF (and apply step 1 & 2)
  434. ebnf_to_bnf = EBNF_to_BNF()
  435. rules = []
  436. i = 0
  437. while i < len(rule_defs): # We have to do it like this because rule_defs might grow due to templates
  438. name, params, rule_tree, options = rule_defs[i]
  439. i += 1
  440. if len(params) != 0: # Dont transform templates
  441. continue
  442. ebnf_to_bnf.rule_options = RuleOptions(keep_all_tokens=True) if options.keep_all_tokens else None
  443. ebnf_to_bnf.prefix = name
  444. tree = transformer.transform(rule_tree)
  445. res = ebnf_to_bnf.transform(tree)
  446. rules.append((name, res, options))
  447. rules += ebnf_to_bnf.new_rules
  448. assert len(rules) == len({name for name, _t, _o in rules}), "Whoops, name collision"
  449. # 4. Compile tree to Rule objects
  450. rule_tree_to_text = RuleTreeToText()
  451. simplify_rule = SimplifyRule_Visitor()
  452. compiled_rules = []
  453. for rule_content in rules:
  454. name, tree, options = rule_content
  455. simplify_rule.visit(tree)
  456. expansions = rule_tree_to_text.transform(tree)
  457. for i, (expansion, alias) in enumerate(expansions):
  458. if alias and name.startswith('_'):
  459. raise GrammarError("Rule %s is marked for expansion (it starts with an underscore) and isn't allowed to have aliases (alias=%s)" % (name, alias))
  460. empty_indices = [x==_EMPTY for x in expansion]
  461. if any(empty_indices):
  462. exp_options = copy(options) or RuleOptions()
  463. exp_options.empty_indices = empty_indices
  464. expansion = [x for x in expansion if x!=_EMPTY]
  465. else:
  466. exp_options = options
  467. assert all(isinstance(x, Symbol) for x in expansion), expansion
  468. rule = Rule(NonTerminal(name), expansion, i, alias, exp_options)
  469. compiled_rules.append(rule)
  470. # Remove duplicates of empty rules, throw error for non-empty duplicates
  471. if len(set(compiled_rules)) != len(compiled_rules):
  472. duplicates = classify(compiled_rules, lambda x: x)
  473. for dups in duplicates.values():
  474. if len(dups) > 1:
  475. if dups[0].expansion:
  476. raise GrammarError("Rules defined twice: %s\n\n(Might happen due to colliding expansion of optionals: [] or ?)"
  477. % ''.join('\n * %s' % i for i in dups))
  478. # Empty rule; assert all other attributes are equal
  479. assert len({(r.alias, r.order, r.options) for r in dups}) == len(dups)
  480. # Remove duplicates
  481. compiled_rules = list(set(compiled_rules))
  482. # Filter out unused rules
  483. while True:
  484. c = len(compiled_rules)
  485. used_rules = {s for r in compiled_rules
  486. for s in r.expansion
  487. if isinstance(s, NonTerminal)
  488. and s != r.origin}
  489. used_rules |= {NonTerminal(s) for s in start}
  490. compiled_rules = [r for r in compiled_rules if r.origin in used_rules]
  491. if len(compiled_rules) == c:
  492. break
  493. # Filter out unused terminals
  494. used_terms = {t.name for r in compiled_rules
  495. for t in r.expansion
  496. if isinstance(t, Terminal)}
  497. terminals = [t for t in terminals if t.name in used_terms or t.name in self.ignore]
  498. return terminals, compiled_rules, self.ignore
  499. _imported_grammars = {}
  500. def import_grammar(grammar_path, base_paths=[]):
  501. if grammar_path not in _imported_grammars:
  502. import_paths = base_paths + IMPORT_PATHS
  503. for import_path in import_paths:
  504. with suppress(IOError):
  505. joined_path = os.path.join(import_path, grammar_path)
  506. with open(joined_path, encoding='utf8') as f:
  507. text = f.read()
  508. grammar = load_grammar(text, joined_path)
  509. _imported_grammars[grammar_path] = grammar
  510. break
  511. else:
  512. open(grammar_path, encoding='utf8')
  513. assert False
  514. return _imported_grammars[grammar_path]
  515. def import_from_grammar_into_namespace(grammar, namespace, aliases):
  516. """Returns all rules and terminals of grammar, prepended
  517. with a 'namespace' prefix, except for those which are aliased.
  518. """
  519. imported_terms = dict(grammar.term_defs)
  520. imported_rules = {n:(n,p,deepcopy(t),o) for n,p,t,o in grammar.rule_defs}
  521. term_defs = []
  522. rule_defs = []
  523. def rule_dependencies(symbol):
  524. if symbol.type != 'RULE':
  525. return []
  526. try:
  527. _, params, tree,_ = imported_rules[symbol]
  528. except KeyError:
  529. raise GrammarError("Missing symbol '%s' in grammar %s" % (symbol, namespace))
  530. return _find_used_symbols(tree) - set(params)
  531. def get_namespace_name(name, params):
  532. if params is not None:
  533. try:
  534. return params[name]
  535. except KeyError:
  536. pass
  537. try:
  538. return aliases[name].value
  539. except KeyError:
  540. if name[0] == '_':
  541. return '_%s__%s' % (namespace, name[1:])
  542. return '%s__%s' % (namespace, name)
  543. to_import = list(bfs(aliases, rule_dependencies))
  544. for symbol in to_import:
  545. if symbol.type == 'TERMINAL':
  546. term_defs.append([get_namespace_name(symbol, None), imported_terms[symbol]])
  547. else:
  548. assert symbol.type == 'RULE'
  549. _, params, tree, options = imported_rules[symbol]
  550. params_map = {p: ('%s__%s' if p[0]!='_' else '_%s__%s' ) % (namespace, p) for p in params}
  551. for t in tree.iter_subtrees():
  552. for i, c in enumerate(t.children):
  553. if isinstance(c, Token) and c.type in ('RULE', 'TERMINAL'):
  554. t.children[i] = Token(c.type, get_namespace_name(c, params_map))
  555. params = [params_map[p] for p in params] # We can not rely on ordered dictionaries
  556. rule_defs.append((get_namespace_name(symbol, params_map), params, tree, options))
  557. return term_defs, rule_defs
  558. def resolve_term_references(term_defs):
  559. # TODO Solve with transitive closure (maybe)
  560. term_dict = {k:t for k, (t,_p) in term_defs}
  561. assert len(term_dict) == len(term_defs), "Same name defined twice?"
  562. while True:
  563. changed = False
  564. for name, (token_tree, _p) in term_defs:
  565. if token_tree is None: # Terminal added through %declare
  566. continue
  567. for exp in token_tree.find_data('value'):
  568. item ,= exp.children
  569. if isinstance(item, Token):
  570. if item.type == 'RULE':
  571. raise GrammarError("Rules aren't allowed inside terminals (%s in %s)" % (item, name))
  572. if item.type == 'TERMINAL':
  573. term_value = term_dict[item]
  574. assert term_value is not None
  575. exp.children[0] = term_value
  576. changed = True
  577. if not changed:
  578. break
  579. for name, term in term_dict.items():
  580. if term: # Not just declared
  581. for child in term.children:
  582. ids = [id(x) for x in child.iter_subtrees()]
  583. if id(term) in ids:
  584. raise GrammarError("Recursion in terminal '%s' (recursion is only allowed in rules, not terminals)" % name)
  585. def options_from_rule(name, params, *x):
  586. if len(x) > 1:
  587. priority, expansions = x
  588. priority = int(priority)
  589. else:
  590. expansions ,= x
  591. priority = None
  592. params = [t.value for t in params.children] if params is not None else [] # For the grammar parser
  593. keep_all_tokens = name.startswith('!')
  594. name = name.lstrip('!')
  595. expand1 = name.startswith('?')
  596. name = name.lstrip('?')
  597. return name, params, expansions, RuleOptions(keep_all_tokens, expand1, priority=priority,
  598. template_source=(name if params else None))
  599. def symbols_from_strcase(expansion):
  600. return [Terminal(x, filter_out=x.startswith('_')) if x.isupper() else NonTerminal(x) for x in expansion]
  601. @inline_args
  602. class PrepareGrammar(Transformer_InPlace):
  603. def terminal(self, name):
  604. return name
  605. def nonterminal(self, name):
  606. return name
  607. def _find_used_symbols(tree):
  608. assert tree.data == 'expansions'
  609. return {t for x in tree.find_data('expansion')
  610. for t in x.scan_values(lambda t: t.type in ('RULE', 'TERMINAL'))}
  611. class GrammarLoader:
  612. def __init__(self):
  613. terminals = [TerminalDef(name, PatternRE(value)) for name, value in TERMINALS.items()]
  614. rules = [options_from_rule(name, None, x) for name, x in RULES.items()]
  615. rules = [Rule(NonTerminal(r), symbols_from_strcase(x.split()), i, None, o) for r, _p, xs, o in rules for i, x in enumerate(xs)]
  616. callback = ParseTreeBuilder(rules, ST).create_callback()
  617. lexer_conf = LexerConf(terminals, ['WS', 'COMMENT'])
  618. parser_conf = ParserConf(rules, callback, ['start'])
  619. self.parser = LALR_TraditionalLexer(lexer_conf, parser_conf)
  620. self.canonize_tree = CanonizeTree()
  621. def load_grammar(self, grammar_text, grammar_name='<?>'):
  622. "Parse grammar_text, verify, and create Grammar object. Display nice messages on error."
  623. try:
  624. tree = self.canonize_tree.transform( self.parser.parse(grammar_text+'\n') )
  625. except UnexpectedCharacters as e:
  626. context = e.get_context(grammar_text)
  627. raise GrammarError("Unexpected input at line %d column %d in %s: \n\n%s" %
  628. (e.line, e.column, grammar_name, context))
  629. except UnexpectedToken as e:
  630. context = e.get_context(grammar_text)
  631. error = e.match_examples(self.parser.parse, {
  632. 'Unclosed parenthesis': ['a: (\n'],
  633. 'Umatched closing parenthesis': ['a: )\n', 'a: [)\n', 'a: (]\n'],
  634. 'Expecting rule or terminal definition (missing colon)': ['a\n', 'a->\n', 'A->\n', 'a A\n'],
  635. 'Alias expects lowercase name': ['a: -> "a"\n'],
  636. 'Unexpected colon': ['a::\n', 'a: b:\n', 'a: B:\n', 'a: "a":\n'],
  637. 'Misplaced operator': ['a: b??', 'a: b(?)', 'a:+\n', 'a:?\n', 'a:*\n', 'a:|*\n'],
  638. 'Expecting option ("|") or a new rule or terminal definition': ['a:a\n()\n'],
  639. '%import expects a name': ['%import "a"\n'],
  640. '%ignore expects a value': ['%ignore %import\n'],
  641. })
  642. if error:
  643. raise GrammarError("%s at line %s column %s\n\n%s" % (error, e.line, e.column, context))
  644. elif 'STRING' in e.expected:
  645. raise GrammarError("Expecting a value at line %s column %s\n\n%s" % (e.line, e.column, context))
  646. raise
  647. tree = PrepareGrammar().transform(tree)
  648. # Extract grammar items
  649. defs = classify(tree.children, lambda c: c.data, lambda c: c.children)
  650. term_defs = defs.pop('term', [])
  651. rule_defs = defs.pop('rule', [])
  652. statements = defs.pop('statement', [])
  653. assert not defs
  654. term_defs = [td if len(td)==3 else (td[0], 1, td[1]) for td in term_defs]
  655. term_defs = [(name.value, (t, int(p))) for name, p, t in term_defs]
  656. rule_defs = [options_from_rule(*x) for x in rule_defs]
  657. # Execute statements
  658. ignore, imports = [], {}
  659. for (stmt,) in statements:
  660. if stmt.data == 'ignore':
  661. t ,= stmt.children
  662. ignore.append(t)
  663. elif stmt.data == 'import':
  664. if len(stmt.children) > 1:
  665. path_node, arg1 = stmt.children
  666. else:
  667. path_node, = stmt.children
  668. arg1 = None
  669. if isinstance(arg1, Tree): # Multi import
  670. dotted_path = tuple(path_node.children)
  671. names = arg1.children
  672. aliases = dict(zip(names, names)) # Can't have aliased multi import, so all aliases will be the same as names
  673. else: # Single import
  674. dotted_path = tuple(path_node.children[:-1])
  675. name = path_node.children[-1] # Get name from dotted path
  676. aliases = {name: arg1 or name} # Aliases if exist
  677. if path_node.data == 'import_lib': # Import from library
  678. base_paths = []
  679. else: # Relative import
  680. if grammar_name == '<string>': # Import relative to script file path if grammar is coded in script
  681. try:
  682. base_file = os.path.abspath(sys.modules['__main__'].__file__)
  683. except AttributeError:
  684. base_file = None
  685. else:
  686. base_file = grammar_name # Import relative to grammar file path if external grammar file
  687. if base_file:
  688. base_paths = [os.path.split(base_file)[0]]
  689. else:
  690. base_paths = [os.path.abspath(os.path.curdir)]
  691. try:
  692. import_base_paths, import_aliases = imports[dotted_path]
  693. assert base_paths == import_base_paths, 'Inconsistent base_paths for %s.' % '.'.join(dotted_path)
  694. import_aliases.update(aliases)
  695. except KeyError:
  696. imports[dotted_path] = base_paths, aliases
  697. elif stmt.data == 'declare':
  698. for t in stmt.children:
  699. term_defs.append([t.value, (None, None)])
  700. else:
  701. assert False, stmt
  702. # import grammars
  703. for dotted_path, (base_paths, aliases) in imports.items():
  704. grammar_path = os.path.join(*dotted_path) + EXT
  705. g = import_grammar(grammar_path, base_paths=base_paths)
  706. new_td, new_rd = import_from_grammar_into_namespace(g, '__'.join(dotted_path), aliases)
  707. term_defs += new_td
  708. rule_defs += new_rd
  709. # Verify correctness 1
  710. for name, _ in term_defs:
  711. if name.startswith('__'):
  712. raise GrammarError('Names starting with double-underscore are reserved (Error at %s)' % name)
  713. # Handle ignore tokens
  714. # XXX A slightly hacky solution. Recognition of %ignore TERMINAL as separate comes from the lexer's
  715. # inability to handle duplicate terminals (two names, one value)
  716. ignore_names = []
  717. for t in ignore:
  718. if t.data=='expansions' and len(t.children) == 1:
  719. t2 ,= t.children
  720. if t2.data=='expansion' and len(t2.children) == 1:
  721. item ,= t2.children
  722. if item.data == 'value':
  723. item ,= item.children
  724. if isinstance(item, Token) and item.type == 'TERMINAL':
  725. ignore_names.append(item.value)
  726. continue
  727. name = '__IGNORE_%d'% len(ignore_names)
  728. ignore_names.append(name)
  729. term_defs.append((name, (t, 1)))
  730. # Verify correctness 2
  731. terminal_names = set()
  732. for name, _ in term_defs:
  733. if name in terminal_names:
  734. raise GrammarError("Terminal '%s' defined more than once" % name)
  735. terminal_names.add(name)
  736. if set(ignore_names) > terminal_names:
  737. raise GrammarError("Terminals %s were marked to ignore but were not defined!" % (set(ignore_names) - terminal_names))
  738. resolve_term_references(term_defs)
  739. rules = rule_defs
  740. rule_names = {}
  741. for name, params, _x, _o in rules:
  742. if name.startswith('__'):
  743. raise GrammarError('Names starting with double-underscore are reserved (Error at %s)' % name)
  744. if name in rule_names:
  745. raise GrammarError("Rule '%s' defined more than once" % name)
  746. rule_names[name] = len(params)
  747. for name, params , expansions, _o in rules:
  748. for i, p in enumerate(params):
  749. if p in rule_names:
  750. raise GrammarError("Template Parameter conflicts with rule %s (in template %s)" % (p, name))
  751. if p in params[:i]:
  752. raise GrammarError("Duplicate Template Parameter %s (in template %s)" % (p, name))
  753. for temp in expansions.find_data('template_usage'):
  754. sym = temp.children[0]
  755. args = temp.children[1:]
  756. if sym not in params:
  757. if sym not in rule_names:
  758. raise GrammarError("Template '%s' used but not defined (in rule %s)" % (sym, name))
  759. if len(args) != rule_names[sym]:
  760. raise GrammarError("Wrong number of template arguments used for %s "
  761. "(expected %s, got %s) (in rule %s)"%(sym, rule_names[sym], len(args), name))
  762. for sym in _find_used_symbols(expansions):
  763. if sym.type == 'TERMINAL':
  764. if sym not in terminal_names:
  765. raise GrammarError("Token '%s' used but not defined (in rule %s)" % (sym, name))
  766. else:
  767. if sym not in rule_names and sym not in params:
  768. raise GrammarError("Rule '%s' used but not defined (in rule %s)" % (sym, name))
  769. return Grammar(rules, term_defs, ignore_names)
  770. load_grammar = GrammarLoader().load_grammar