fixed syntax highlighting bug

Author: michaelkamprath

CHANGELOG.md

@@ -23,6 +23,7 @@ Changes that are planned but not implemented yet:
 * Upgrade python version requirements to 3.11
 * Fixed a bug where embedded stringsd weren't properly parsed if they contained a newline character or there were multiple embedded strings per line
 * Fixed a bug where parsing properly discriminate between labels starting with `BYTE` string and the `BYTEx()` operator.
+* Fixed a bug in generating the syntax highlighting configuration that caused mnemonics with special characters to not be highlighted properly.
 
 ## [0.4.2]
 *  Added support for The Minimal 64x4 Home Computer with an example and updated assembler functionality to support it.

src/bespokeasm/configgen/__init__.py

@@ -1,3 +1,4 @@
+import re
 from bespokeasm.assembler.model import AssemblerModel
 
 
@@ -50,7 +51,10 @@ def _replace_token_with_regex_list(
         self,
         template_str: str,
         token: str,
-        regex_list: list[str]
+        item_list: list[str]
     ) -> str:
+        # first, convert the item list into individual regex strings, which is
+        # mostly escaping any periods or other special characters
+        regex_list = [re.escape(item) for item in item_list]
         regex_str = '\\b' + '\\b|\\b'.join(regex_list) + '\\b'
         return template_str.replace(token, regex_str)

test/test_configgen.py

@@ -348,3 +348,44 @@ def test_sublime_configgen_with_registers(self):
         self.assertIsFile(package_fp)
 
         shutil.rmtree(test_destination_dir)
+
+    def test_sublime_escaping_of_names(self):
+        # goal of this test is to ensure that entity names sourced from the ISA config are properly escaped
+        # in the generated language configuration files, notablye the syntax highlighting configuration file.
+        # for example, if an instruction mnemonic is 'ad.r', the generated regex should be '\\bad\\.r\\b'
+        # where the '.' is escaped to '\.' and the whole string is wrapped in '\\b' to ensure it is a word boundary.
+        test_destination_dir = tempfile.mkdtemp()
+        test_tmp_dir = tempfile.mkdtemp()
+        config_file = pkg_resources.files(config_files).joinpath('test_instructions_with_periods.yaml')
+        configgen = SublimeConfigGenerator(
+            str(config_file),
+            0,
+            str(test_destination_dir),
+            None,
+            None,
+            'asmtest',
+        )
+        self.assertEqual(configgen.model.isa_name, 'test_instructions_with_periods', 'name should be in ISA config')
+        # generate the files to inspect their content
+        configgen._generate_files_in_dir(test_tmp_dir)
+
+        syntax_fp = os.path.join(test_tmp_dir, 'test_instructions_with_periods.sublime-syntax')
+        self.assertIsFile(syntax_fp)
+        with open(syntax_fp) as yaml_file:
+            syntax_dict = yaml.safe_load(yaml_file)
+
+        for instr_dict in syntax_dict['contexts']['instructions']:
+            if instr_dict['scope'] == 'variable.function.instruction':
+                self._assert_grouped_item_list(
+                    instr_dict['match'],
+                    [
+                        '\\bnop\\b',
+                        '\\bma\\.hl\\b',    # note the escaped '.'
+                    ],
+                    'instructions'
+                )
+            elif instr_dict['scope'] == 'variable.function.macro':
+                self.fail('There should be no macros defined in this list')
+
+        # clean up
+        shutil.rmtree(test_tmp_dir)