uv2compdb 0.4.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

uv2compdb/main.py

@@ -2,12 +2,13 @@
 Generate Compilation Database by parse Keil µVision project.
 """
 
+import shlex
 import logging
 import argparse
 from pathlib import Path
 from importlib.metadata import version
 
-from uv2compdb.parser import UV2CompDB, _split_and_strip, generate_compile_commands
+from uv2compdb.parser import UV2CompDB, generate_compile_commands
 
 __version__ = version("uv2compdb")
 logger = logging.getLogger(__name__)
@@ -63,7 +64,7 @@ def main() -> int:
         if not args.target:
             args.target = targets[0]
             logger.warning(
-                f"Project has multi targets: {targets}, use the first {args.target}"
+                f"Project has target(s): {targets}, use the first {args.target}"
             )
         elif args.target not in targets:
             logger.error(f"Not found target: {args.target}")
@@ -80,7 +81,7 @@ def main() -> int:
         target_setting = uv2compdb.parse(args.target, args.build)
         command_objects = uv2compdb.generate_command_objects(
             target_setting,
-            _split_and_strip(args.arguments, delimiter=" ") if args.arguments else [],
+            shlex.split(args.arguments) if args.arguments else [],
             args.predefined,
         )
         if not generate_compile_commands(command_objects, args.output):

uv2compdb/parser.py

@@ -43,12 +43,12 @@ PREDEFINED_FILTER_ARGUMENT_REGEX = [
 ]
 
 
-def _to_posix_path(path: str) -> str:
+def to_posix_path(path: str) -> str:
     """Convert Windows path separators to POSIX format."""
     return path.replace("\\", "/")
 
 
-def _split_and_strip(text: str, delimiter: str) -> list[str]:
+def split_and_strip(text: str, delimiter: str) -> list[str]:
     """Split text by delimiter and strip whitespace from each part."""
     return [striped for item in text.split(delimiter) if (striped := item.strip())]
 
@@ -58,6 +58,7 @@ class Toolchain:
     path: str
     compiler: str
     assembler: str
+    xml_tag: tuple[str, str]
 
 
 @dataclass
@@ -108,10 +109,10 @@ class VariousControls:
         # 'MBEDTLS_CONFIG_FILE=/\"config-aes-cbc.h/\"'
         #    => '-DMBEDTLS_CONFIG_FILE="config-aes-cbc.h"'
         return (
-            [f"-I{_to_posix_path(x)}" for x in self.include_path]
-            + [f"{_to_posix_path(x)}" for x in self.misc_controls]
-            + [f"-U{_to_posix_path(x)}" for x in self.undefine]
-            + ["-D" + _to_posix_path(x.replace(r'\\"', '"')) for x in self.define]
+            [f"-I{to_posix_path(x)}" for x in self.include_path]
+            + [f"{to_posix_path(x)}" for x in self.misc_controls]
+            + [f"-U{to_posix_path(x)}" for x in self.undefine]
+            + ["-D" + to_posix_path(x.replace(r'\\"', '"')) for x in self.define]
         )
 
     @classmethod
@@ -129,16 +130,48 @@ class UV2CompDB:
 
     # TODO: how to deal with delimiters inside text (e.g., -DFOO="(1, 2)")
     UV_VARIOUS_CONTROLS_MAP: dict[str, tuple[str, Callable[[str], list[str]]]] = {
-        "MiscControls": ("misc_controls", partial(_split_and_strip, delimiter=" ")),
-        "Define": ("define", partial(_split_and_strip, delimiter=",")),
-        "Undefine": ("undefine", partial(_split_and_strip, delimiter=",")),
-        "IncludePath": ("include_path", partial(_split_and_strip, delimiter=";")),
+        "MiscControls": ("misc_controls", partial(split_and_strip, delimiter=" ")),
+        "Define": ("define", partial(split_and_strip, delimiter=",")),
+        "Undefine": ("undefine", partial(split_and_strip, delimiter=",")),
+        "IncludePath": ("include_path", partial(split_and_strip, delimiter=";")),
+    }
+
+    UV_C51_XML_TAG: tuple[str, str] = ("C51", "Ax51")
+    UV_ARM_XML_TAG: tuple[str, str] = ("Cads", "Aads")
+
+    # Language-Extensions: https://developer.arm.com/documentation/101655/0961/Cx51-User-s-Guide/Language-Extensions?lang=en
+    UV_C51_EXTENSION_KEYWORDS: dict[str, str] = {
+        # Data Type
+        "bit": "unsigned char",
+        "sbit": "volatile unsigned char",
+        "sfr": "volatile unsigned char",
+        "sfr16": "volatile unsigned short",
+        # Memory Models
+        "small": "",
+        "compact": "",
+        "large": "",
+        # Memory Type
+        "bdata": "",
+        "data": "",
+        "idata": "",
+        "pdata": "",
+        "xdata": "",
+        "far": "",
+        "code": "",
+        # Other
+        "_at_": "",
+        "alien": "",
+        "interrupt": "",
+        "_priority_": "",
+        "reentrant": "",
+        "_task_": "",
+        "using": "",
     }
 
     UV_TOOLCHAIN_MAP: dict[str, Toolchain] = {
-        "0x00": Toolchain("", "c51", ""),
-        "0x40": Toolchain("", "armcc", "armasm"),
-        "0x41": Toolchain("", "armclang", "armasm"),
+        "0x00": Toolchain("", "c51", "a51", UV_C51_XML_TAG),
+        "0x40": Toolchain("", "armcc", "armasm", UV_ARM_XML_TAG),
+        "0x41": Toolchain("", "armclang", "armasm", UV_ARM_XML_TAG),
     }
 
     UV_CLI_ERRORLEVEL_MAP: dict[int, str] = {
@@ -174,8 +207,10 @@ class UV2CompDB:
             return None
         return elem.text
 
-    def get_various_controls(self, elem: ET.Element | None) -> VariousControls | None:
-        if elem is None:
+    def get_various_controls(
+        self, elem: ET.Element | None, xml_tag: str | None
+    ) -> VariousControls | None:
+        if elem is None or not xml_tag:
             return None
 
         # None: True, "0": False, "1": True, "2": inherit
@@ -184,7 +219,7 @@ class UV2CompDB:
 
         result = {}
         for name, (var_name, pred) in self.UV_VARIOUS_CONTROLS_MAP.items():
-            text = self._get_text(elem.find(f".//Cads/VariousControls/{name}"))
+            text = self._get_text(elem.find(f".//{xml_tag}/VariousControls/{name}"))
             result[var_name] = pred(text) if text else []
         return VariousControls(**result)
 
@@ -199,8 +234,15 @@ class UV2CompDB:
         if not (uv4_path := shutil.which("uv4")):
             return False
 
-        cmd = f"{uv4_path} -b -t {target_name} {self.project_path.resolve().as_posix()} -j0"
-        logger.info(f"Run: `{cmd}`")
+        cmd = [
+            uv4_path,
+            "-b",
+            "-t",
+            target_name,
+            self.project_path.resolve().as_posix(),
+            "-j0",
+        ]
+        logger.info(f"Run: `{subprocess.list2cmdline(cmd)}`")
         try:
             result = subprocess.run(cmd, capture_output=True, text=True)
             logger.info(
@@ -242,11 +284,14 @@ class UV2CompDB:
         if not (m := TOOLCHAIN_REGEX.search(text)):
             return None
 
-        toolchain_path = _to_posix_path(m.group(1))
+        toolchain_path = to_posix_path(m.group(1))
         return Toolchain(
             path=toolchain_path,
             compiler=f"{toolchain_path}/{m.group(2)}",
             assembler=f"{toolchain_path}/{m.group(3)}",
+            xml_tag=self.UV_C51_XML_TAG
+            if "c51" in m.group(2).lower()
+            else self.UV_ARM_XML_TAG,
         )
 
     def get_toolchain_from_xml(self, target: ET.Element | None) -> Toolchain | None:
@@ -269,13 +314,14 @@ class UV2CompDB:
                 else toolchain.path
             ),
             compiler=(
-                _to_posix_path(compiler_path) if compiler_path else toolchain.compiler
+                to_posix_path(compiler_path) if compiler_path else toolchain.compiler
             ),
             assembler=(
                 (Path(compiler_path).parent / toolchain.assembler).resolve().as_posix()
                 if compiler_path
                 else toolchain.assembler
             ),
+            xml_tag=toolchain.xml_tag,
         )
 
     def get_toolchain(
@@ -340,17 +386,21 @@ class UV2CompDB:
             file_objects.append(FileObject(file=file, arguments=args))
         return file_objects
 
-    def parse_xml(self, target: ET.Element | None) -> list[FileObject]:
-        if target is None:
+    def parse_xml(
+        self, target: ET.Element | None, toolchain: Toolchain | None
+    ) -> list[FileObject]:
+        if target is None or toolchain is None:
             return []
 
-        if (target_vc := self.get_various_controls(target)) is None:
+        xml_tag = toolchain.xml_tag[0]
+
+        if (target_vc := self.get_various_controls(target, xml_tag)) is None:
             logger.warning("Not found target_controls in target")
             return []
 
         file_objects = []
         for group in target.findall(".//Group"):
-            if (group_vc := self.get_various_controls(group)) is None:
+            if (group_vc := self.get_various_controls(group, xml_tag)) is None:
                 continue
 
             current_vc = VariousControls.merge(target_vc, group_vc)
@@ -358,17 +408,17 @@ class UV2CompDB:
                 file_path = self._get_text(file.find("FilePath"))
                 # file_type = self._get_text(file.find("FileType"))
 
-                if not file_path or not file_path.endswith(
-                    (".s", ".c", ".cpp", ".cc", ".cx", ".cxx")
+                if not file_path or not file_path.lower().endswith(
+                    (".a51", ".s", ".c", ".cpp", ".cc", ".cx", ".cxx")
                 ):
                     continue
 
-                if (file_controls := self.get_various_controls(file)) is None:
+                if (file_controls := self.get_various_controls(file, xml_tag)) is None:
                     continue
 
                 file_objects.append(
                     FileObject(
-                        file=_to_posix_path(file_path),
+                        file=to_posix_path(file_path),
                         arguments=VariousControls.merge(
                             current_vc, file_controls
                         ).get_options(),
@@ -387,9 +437,15 @@ class UV2CompDB:
             return None
         logger.info(f"Toolchain: {toolchain}")
 
-        if not (file_objects := self.parse_dep(target, try_build)):
-            logger.warning("Not found dep file, fallback to parse xml")
-            file_objects = self.parse_xml(target)
+        if toolchain.xml_tag == self.UV_C51_XML_TAG:
+            file_objects = self.parse_xml(target, toolchain)
+        elif toolchain.xml_tag == self.UV_ARM_XML_TAG:
+            if not (file_objects := self.parse_dep(target, try_build)):
+                logger.warning("Not found dep file, fallback to parse xml")
+                file_objects = self.parse_xml(target, toolchain)
+        else:
+            logger.error(f"Unknown {toolchain.xml_tag=}")
+            return None
 
         return TargetSetting(
             name=target_name,
@@ -399,16 +455,18 @@ class UV2CompDB:
 
     @staticmethod
     @lru_cache(maxsize=32)
-    def _get_predefined_macros_cached(compiler: str, args_str: str) -> tuple[str, ...]:
+    def _get_predefined_macros_cached(
+        compiler: str, args: tuple[str, ...]
+    ) -> tuple[str, ...]:
         """Get predefined macros from compiler with caching."""
         if "armcc" in compiler.lower():
-            cmd = f"{compiler} {args_str} --list_macros"
+            cmd = [compiler, *args, "--list_macros"]
         elif "armclang" in compiler.lower():
-            cmd = f"{compiler} {args_str} --target=arm-arm-none-eabi -dM -E -"
+            cmd = [compiler, *args, "--target=arm-arm-none-eabi", "-dM", "-E", "-"]
         else:
             return ()
 
-        logger.info(f"Get predefined macro by: `{cmd}`")
+        logger.info(f"Get predefined macro by: `{subprocess.list2cmdline(cmd)}`")
         try:
             result = subprocess.run(cmd, capture_output=True, text=True, input="")
             if result.returncode != 0:
@@ -433,6 +491,21 @@ class UV2CompDB:
         if toolchain is None or not args:
             return []
 
+        if toolchain.xml_tag == self.UV_C51_XML_TAG:
+            # Predefined-Macros: https://developer.arm.com/documentation/101655/0961/Cx51-User-s-Guide/Preprocessor/Macros/Predefined-Macros?lang=en
+            c51_defs = ["-D__C51__"]
+            c51_defs.extend(
+                f"-D{key}={val}" for key, val in self.UV_C51_EXTENSION_KEYWORDS.items()
+            )
+
+            # /path/to/keil/c51/bin -> /path/to/keil/c51/inc
+            if (idx := toolchain.path.lower().rfind("bin")) != -1:
+                c51_inc = toolchain.path[:idx] + toolchain.path[idx:].lower().replace(
+                    "bin", "inc"
+                )
+                c51_defs.append(f"-I{c51_inc}")
+            return c51_defs
+
         filtered_args = []
         args_iter = iter(args)
         for arg in args_iter:
@@ -445,9 +518,7 @@ class UV2CompDB:
                 next(args_iter, None)
 
         return list(
-            self._get_predefined_macros_cached(
-                toolchain.compiler, " ".join(filtered_args)
-            )
+            self._get_predefined_macros_cached(toolchain.compiler, tuple(filtered_args))
         )
 
     def filter_unknown_argument(
@@ -487,7 +558,8 @@ class UV2CompDB:
                 self.get_predefined_macros(
                     target_setting.toolchain, file_object.arguments
                 )
-                if predefined_macros and not file_object.file.endswith(".s")
+                if predefined_macros
+                and not file_object.file.lower().endswith((".a51", ".s"))
                 else []
             )
             arguments = self.filter_unknown_argument(
@@ -499,13 +571,16 @@ class UV2CompDB:
                     file=file_object.file,
                     arguments=(
                         [
-                            target_setting.toolchain.compiler
-                            if not file_object.file.endswith(".s")
-                            else target_setting.toolchain.assembler
+                            (
+                                target_setting.toolchain.compiler
+                                if not file_object.file.lower().endswith((".a51", ".s"))
+                                else target_setting.toolchain.assembler
+                            )
                         ]
                         + toolchain_args
                         + arguments
                         + extra_args
+                        + [file_object.file]
                     ),
                 )
             )

{uv2compdb-0.4.0.dist-info → uv2compdb-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uv2compdb
-Version: 0.4.0
+Version: 0.5.1
 Summary: Generate Compilation Database by parse Keil µVision project
 Keywords: keil,MDK,µVision,clangd,Compilation Database,compiled_commands.json
 Author: xbin
@@ -79,12 +79,11 @@ optional arguments:
 
 ## Limit
 
-+ [ ] Not support C51
 + [x] Not parsed `"Options" -> "C/C++" -> "Language / Code Generation"`
 + [x] Not parsed `"Options" -> "ASM"`, so Asm file use same options with C file
 + [x] Can't parse **RTE** components
 + [x] Can't add toolchain predefined macros and include path
-+ [ ] The support for ARMCC (AC5) not well
++ [ ] The support for C51 / ARMCC (AC5) not well
   + need config `.clangd` manually
 
 ## [Clangd]

uv2compdb-0.5.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+uv2compdb/__init__.py,sha256=eL3VL6_9X_0E-oz3h4d1ovhCLrATHvviKkyZQOguqqQ,55
+uv2compdb/__main__.py,sha256=6nm32QqZwc9URAzRAwrgJTyoLM-nGu0r9wH5iZfOKuE,70
+uv2compdb/main.py,sha256=SvgdSzYk7jVywnlm0y67Vb15j8LOaPxFr2bvAjal96M,2970
+uv2compdb/parser.py,sha256=v4GTmzwradOIFsgbhrDj_cO8iaJXWhfmDH2NcRHo-5o,21630
+uv2compdb-0.5.1.dist-info/licenses/LICENSE,sha256=jBXhW_dm3ZqVqD8CitzmaDMGPonkPOmqWSDaIEUO30M,1085
+uv2compdb-0.5.1.dist-info/WHEEL,sha256=XjEbIc5-wIORjWaafhI6vBtlxDBp7S9KiujWF1EM7Ak,79
+uv2compdb-0.5.1.dist-info/entry_points.txt,sha256=O6qqKx-ZWjCetvl-PiycCpx92c9Xwm-EN9_UZEMHo04,46
+uv2compdb-0.5.1.dist-info/METADATA,sha256=cS-Bz5kZesMNJMEiV7bGpMmJdbC7L7WBhh5sce9rbpE,3549
+uv2compdb-0.5.1.dist-info/RECORD,,

uv2compdb-0.4.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-uv2compdb/__init__.py,sha256=eL3VL6_9X_0E-oz3h4d1ovhCLrATHvviKkyZQOguqqQ,55
-uv2compdb/__main__.py,sha256=6nm32QqZwc9URAzRAwrgJTyoLM-nGu0r9wH5iZfOKuE,70
-uv2compdb/main.py,sha256=0druk2CVT-FfUoHjYayC3J27zAEXBFPA1tYz0DhSeOg,2998
-uv2compdb/parser.py,sha256=BN-MHujtrSiL9wibFpPGIu8le9WEWZhLtAnXdUXFeig,18927
-uv2compdb-0.4.0.dist-info/licenses/LICENSE,sha256=jBXhW_dm3ZqVqD8CitzmaDMGPonkPOmqWSDaIEUO30M,1085
-uv2compdb-0.4.0.dist-info/WHEEL,sha256=XjEbIc5-wIORjWaafhI6vBtlxDBp7S9KiujWF1EM7Ak,79
-uv2compdb-0.4.0.dist-info/entry_points.txt,sha256=O6qqKx-ZWjCetvl-PiycCpx92c9Xwm-EN9_UZEMHo04,46
-uv2compdb-0.4.0.dist-info/METADATA,sha256=k7L8K53W4BihcOLFgu4MBBRlXsoleqakCkf1ZfsTQF8,3566
-uv2compdb-0.4.0.dist-info/RECORD,,