Add support for grammars that are split into separate lexer/parser fi…

…les (#5)
amykyta3 · Dec 18, 2020 · 8bc36f2 · 8bc36f2
1 parent 89c44b9
commit 8bc36f2
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 18 deletions.
diff --git a/docs/example.rst b/docs/example.rst
@@ -49,6 +49,10 @@ You'll notice this last step generates the following files:
 * cpp_src/sa_mygrammar_translator.cpp/.h
 * cpp_src/speedy_antlr.cpp/.h
 
+.. note::
+    If your language grammar is split into separate Lexer and Parser files, see
+    the alternate `src/spam/parser/generate_parsers_split.sh <https://github.com/amykyta3/speedy-antlr-example/blob/master/src/spam/parser/generate_parsers_split.sh>`_
+    example script.
 
 sa_mygrammar.py
 ---------------
@@ -118,10 +122,10 @@ Since you'll be bundling the Antlr C++ runtime in your package's distribution
 (source and binary), be a good steward of open-source software and include a
 copy of Antlr's BSD license.
 
-.travis.yml
------------
+.github/workflows/build.yml
+---------------------------
 
-`.travis.yml <https://github.com/amykyta3/speedy-antlr-example/blob/master/.travis.yml>`_
+`.github/workflows/build.yml <https://github.com/amykyta3/speedy-antlr-example/blob/master/.github/workflows/build.yml>`_
 
 If you've attempted to install this example by now, you've probably noticed that
 it takes a *looong* time. This is because all the C++ files (antlr has many)
@@ -132,8 +136,8 @@ binary distributions. This eliminates the need for the end-user to install a
 compiler and build everything from source.
 
 Since you probably dont have access to every variant of Windows/Linux/macOS,
-this is typically done using a continuous integration service like
-`Travis-CI <https://travis-ci.org>`_. This YAML file tells Travis-CI how to
-run your project's tests, and how to deploy to PyPi. I'm also using
+this is typically done using a continuous integration service like Github
+Actions. This YAML file tells Github Actions how to run your project's tests,
+and how to deploy to PyPi. I'm also using
 `cibuildwheel <https://github.com/joerick/cibuildwheel>`_ to automate building
 all the different distribution variants.
diff --git a/docs/speedy-antlr-example b/docs/speedy-antlr-example
diff --git a/speedy_antlr_tool/__about__.py b/speedy_antlr_tool/__about__.py
@@ -1 +1 @@
-__version__ = "1.0.0"
+__version__ = "1.1.0"
diff --git a/speedy_antlr_tool/extractor.py b/speedy_antlr_tool/extractor.py
@@ -1,4 +1,5 @@
 import re
+import os
 import importlib.util
 from typing import List
 
@@ -32,7 +33,7 @@ def iter_rule_context_classes(parser_cls:antlr4.Parser):
         # Detect ParserRuleContext classes
         if not (isinstance(obj, type) and issubclass(obj, antlr4.ParserRuleContext)):
             continue
-            
+
         yield obj
 
 
@@ -83,8 +84,10 @@ def get_context_data(context_cls:antlr4.ParserRuleContext) -> ContextData:
 def extract(parser_path:str) -> List[ContextData]:
     parser_cls = get_parser_class(parser_path)
 
+    parser_basename = os.path.splitext(os.path.basename(parser_cls.grammarFileName))[0]
+
     cds = []
     for context_cls in iter_rule_context_classes(parser_cls):
         cds.append(get_context_data(context_cls))
-    
-    return cds
+
+    return cds, parser_basename
diff --git a/speedy_antlr_tool/main.py b/speedy_antlr_tool/main.py
@@ -5,7 +5,7 @@
 from .extractor import extract
 from .__about__ import __version__
 
-def write_cpp_files(grammar_name:str, context_data:str, output_dir:str):
+def write_cpp_files(grammar_name:str, parser_basename:str, context_data:str, output_dir:str):
     loader = jj.FileSystemLoader(os.path.join(os.path.dirname(__file__), "templates"))
 
     jj_env = jj.Environment(
@@ -15,6 +15,7 @@ def write_cpp_files(grammar_name:str, context_data:str, output_dir:str):
 
     context = {
         "grammar_name": grammar_name,
+        "parser_basename": parser_basename,
         "context_data": context_data,
         "__version__": __version__,
     }
@@ -50,7 +51,7 @@ def write_cpp_files(grammar_name:str, context_data:str, output_dir:str):
     stream.dump(output_path)
 
 
-def write_py_files(grammar_name:str, context_data:str, output_dir:str):
+def write_py_files(grammar_name:str, parser_basename:str, context_data:str, output_dir:str):
     loader = jj.FileSystemLoader(os.path.join(os.path.dirname(__file__), "templates"))
 
     jj_env = jj.Environment(
@@ -60,6 +61,7 @@ def write_py_files(grammar_name:str, context_data:str, output_dir:str):
 
     context = {
         "grammar_name": grammar_name,
+        "parser_basename": parser_basename,
         "context_data": context_data,
         "__version__": __version__,
     }
@@ -83,8 +85,8 @@ def generate(py_parser_path:str, cpp_output_dir:str):
     py_output_dir = os.path.dirname(py_parser_path)
 
     # Parse the Parser.py file and extract context data
-    context_data = extract(py_parser_path)
+    context_data, parser_basename = extract(py_parser_path)
 
     # Write out files
-    write_py_files(grammar_name, context_data, py_output_dir)
-    write_cpp_files(grammar_name, context_data, cpp_output_dir)
+    write_py_files(grammar_name, parser_basename, context_data, py_output_dir)
+    write_cpp_files(grammar_name, parser_basename, context_data, cpp_output_dir)
diff --git a/speedy_antlr_tool/templates/sa_X_translator.h b/speedy_antlr_tool/templates/sa_X_translator.h
@@ -5,10 +5,10 @@
 
 #pragma once
 
-#include "{{grammar_name}}BaseVisitor.h"
+#include "{{parser_basename}}BaseVisitor.h"
 #include "speedy_antlr.h"
 
-class SA_{{grammar_name}}Translator : public {{grammar_name}}BaseVisitor {
+class SA_{{grammar_name}}Translator : public {{parser_basename}}BaseVisitor {
     speedy_antlr::Translator *translator;
 
     // Cached context classes