uv2compdb 0.3.0__tar.gz → 0.5.0__tar.gz

{uv2compdb-0.3.0 → uv2compdb-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uv2compdb
-Version: 0.3.0
+Version: 0.5.0
 Summary: Generate Compilation Database by parse Keil µVision project
 Keywords: keil,MDK,µVision,clangd,Compilation Database,compiled_commands.json
 Author: xbin
@@ -57,31 +57,33 @@ uv2compdb /path/to/project -t target -o /path/to/compile_commands.json
 ### Help
 
 ```sh
-usage: uv2compdb [-h] [-a ARGUMENTS] [-b] [-t TARGET] [-o OUTPUT] [-p] project
+usage: uv2compdb [-h] [-v] [-a ARGUMENTS] [-b] [-t TARGET] [-o OUTPUT] [-p] project
 
 Generate compile_commands.json by parse Keil µVision project
 
 positional arguments:
   project               path to .uvproj[x] file
 
-options:
+optional arguments:
   -h, --help            show this help message and exit
-  -a, --arguments ARGUMENTS
+  -v, --version         show version and exit
+  -a ARGUMENTS, --arguments ARGUMENTS
                         add extra arguments
   -b, --build           try to build while dep/build_log files don't not exist
-  -t, --target TARGET   target name
-  -o, --output OUTPUT   output dir/file path (default: compile_commands.json)
+  -t TARGET, --target TARGET
+                        target name
+  -o OUTPUT, --output OUTPUT
+                        output dir/file path (default: compile_commands.json)
   -p, --predefined      try to add predefined macros
 ```
 
 ## 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.3.0 → uv2compdb-0.5.0}/README.md

@@ -35,31 +35,33 @@ uv2compdb /path/to/project -t target -o /path/to/compile_commands.json
 ### Help
 
 ```sh
-usage: uv2compdb [-h] [-a ARGUMENTS] [-b] [-t TARGET] [-o OUTPUT] [-p] project
+usage: uv2compdb [-h] [-v] [-a ARGUMENTS] [-b] [-t TARGET] [-o OUTPUT] [-p] project
 
 Generate compile_commands.json by parse Keil µVision project
 
 positional arguments:
   project               path to .uvproj[x] file
 
-options:
+optional arguments:
   -h, --help            show this help message and exit
-  -a, --arguments ARGUMENTS
+  -v, --version         show version and exit
+  -a ARGUMENTS, --arguments ARGUMENTS
                         add extra arguments
   -b, --build           try to build while dep/build_log files don't not exist
-  -t, --target TARGET   target name
-  -o, --output OUTPUT   output dir/file path (default: compile_commands.json)
+  -t TARGET, --target TARGET
+                        target name
+  -o OUTPUT, --output OUTPUT
+                        output dir/file path (default: compile_commands.json)
   -p, --predefined      try to add predefined macros
 ```
 
 ## 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.3.0 → uv2compdb-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uv2compdb"
-version = "0.3.0"
+version = "0.5.0"
 description = "Generate Compilation Database by parse Keil µVision project"
 readme = "README.md"
 authors = [{ name = "xbin", email = "xbin.xu@qq.com" }]

{uv2compdb-0.3.0 → uv2compdb-0.5.0}/src/uv2compdb/__init__.py

@@ -1,5 +1,3 @@
-__version__ = "0.3.0"
-
 from uv2compdb.main import main
 
 __all__ = ["main"]

{uv2compdb-0.3.0 → uv2compdb-0.5.0}/src/uv2compdb/main.py

@@ -5,9 +5,11 @@ Generate Compilation Database by parse Keil µVision project.
 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, split_and_strip, generate_compile_commands
 
+__version__ = version("uv2compdb")
 logger = logging.getLogger(__name__)
 logging.basicConfig(
     level=logging.INFO,
@@ -20,6 +22,13 @@ def main() -> int:
     parser = argparse.ArgumentParser(
         description="Generate compile_commands.json by parse Keil µVision project"
     )
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=__version__,
+        help="show version and exit",
+    )
     parser.add_argument("-a", "--arguments", default=None, help="add extra arguments")
     parser.add_argument(
         "-b",
@@ -54,7 +63,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}")
@@ -71,7 +80,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 [],
+            split_and_strip(args.arguments, delimiter=" ") if args.arguments else [],
             args.predefined,
         )
         if not generate_compile_commands(command_objects, args.output):

{uv2compdb-0.3.0 → uv2compdb-0.5.0}/src/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)
 
@@ -242,11 +277,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 +307,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 +379,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 +401,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 +430,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,
@@ -433,6 +482,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:
@@ -487,7 +551,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 +564,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]
                     ),
                 )
             )