k2c 1.5.1__tar.gz

k2c-1.5.1/.github/workflows/release.yml

@@ -0,0 +1,68 @@
+name: Build Windows Executable
+on:
+  push:
+    tags:
+      - "v*.*.*"
+permissions:
+  contents: read
+jobs:
+  build-exe:
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: windows-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          architecture: 'x64'
+      - name: Install requirements and installer
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install json5 pyinstaller
+      - name: Run pyinstaller
+        env:
+          K2C_VERSION: ${{ github.ref_name }}
+        run: |
+          python -m PyInstaller k2c.spec
+      - run: ls dist
+      - run: mv dist/k2c.exe .
+      - run: ls .
+      - name: Build Changelog
+        id: github_release
+        uses: mikepenz/release-changelog-builder-action@v5
+        env:
+            GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          token: ${{ secrets.RELEASE_TOKEN }}
+          body: ${{steps.github_release.outputs.changelog}}
+          files: |
+            ./k2c.exe
+  publish-pypi:
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Build Python package
+        run: |
+          python -m pip install build
+          python -m build
+      - name: Publish Python package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}
+          attestations: false

k2c-1.5.1/.gitignore

@@ -0,0 +1,15 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+data/
+compile_commands.json
+output/
+*.uvprojx
+uv.lock

k2c-1.5.1/.python-version

@@ -0,0 +1 @@
+3.13

k2c-1.5.1/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: k2c
+Version: 1.5.1
+Summary: Keil .uvprojx to compile_commands.json Converter
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: json5>=0.12.0
+
+# Keil to Compile Commands Converter
+
+这是一个 Python/uv 工具，用于解析 Keil MDK 项目文件 (.uvprojx、.uvproj) 并生成 `compile_commands.json` 文件。这个文件可以被 Clangd 等语言服务器使用，以提供更准确的代码补全、导航和诊断功能。
+
+## 功能
+
+*   解析 Keil `.uvprojx` XML 文件。
+*   提取项目中包含的 C/C++ 源文件 (`.c`) 和汇编文件 (`.s`)。
+*   提取在 Keil 项目设置中定义的宏 (`-D` 标志)。
+*   提取在 Keil 项目设置中指定的包含路径 (`-I` 标志)。
+*   支持 Target 选择和 Target 列表查看。
+*   合并 Target、Group、File 级别的宏、包含路径和部分编译选项。
+*   支持 C、C++、汇编源文件 (`.c`, `.cc`, `.cpp`, `.cxx`, `.s`, `.S`)。
+*   从 Keil CPU/FPU 配置推导常用 clang 参数，如 `-mcpu`、`-mthumb`、`-mfpu`。
+*   自动处理包含路径的相对路径转换
+*   统一路径分隔符为 `/` 格式
+*   支持从 VSCode Clangd 设置中自动获取编译器路径
+*   支持检查缺失的源文件和包含目录。
+*   根据提取的信息生成 `compile_commands.json` 文件。
+
+## 依赖
+
+*   uv
+*   Python 3.13+
+*   标准库: `xml.etree.ElementTree`, `json`, `os`, `sys` (无需额外安装)
+*   `json5` (由 uv 按 `pyproject.toml` 自动安装，用于读取带注释的VSCode设置文件)
+
+## 使用方法
+
+### 安装
+
+通过 pip 安装 Python 包:
+
+```bash
+pip install k2c
+```
+
+安装后可以直接运行:
+
+```bash
+k2c --version
+```
+
+也可以从 GitHub Release 下载 `k2c.exe` 后直接运行。
+
+### 本地开发运行
+
+首次使用先同步运行环境：
+
+```bash
+uv sync
+```
+
+日常使用建议加 `--no-sync`，避免每次运行前重复检查和同步环境：
+
+```bash
+uv run --no-sync k2c <path_to_your_keil_project.uvprojx> [options]
+```
+
+**参数说明:**
+- `--version`: 输出当前版本号
+- `-d`: 可选参数，创建clangd缓存目录
+  - 不带参数值: 默认创建`.cache`目录
+  - 带参数值: 创建指定名称的目录
+- `-o, --output`: 指定输出文件路径，默认 `compile_commands.json`
+- `--target`: 指定要解析的 Keil Target 名称
+- `--list-targets`: 列出工程中的 Target 名称后退出
+- `--compiler`: 显式指定编译器路径，优先级高于 VSCode 设置
+- `--dry-run`: 只解析并打印摘要，不写入文件
+- `--verbose`: 打印解析摘要
+- `--check-missing-files`: 检查缺失的源文件和 include 路径
+
+**示例:**
+
+基本用法:
+```bash
+uv run --no-sync k2c C:/Path/To/Your/Project/YourProject.uvprojx
+```
+
+查看 Target:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --list-targets
+```
+
+查看版本:
+```bash
+uv run --no-sync k2c --version
+```
+
+指定 Target 和编译器:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --target Debug --compiler C:/Keil_v5/ARM/ARMCLANG/bin/armclang.exe
+```
+
+指定输出路径:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -o build/compile_commands.json
+```
+
+检查解析结果:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --dry-run --verbose --check-missing-files
+```
+
+创建默认缓存目录:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -d
+```
+
+创建自定义缓存目录:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -d my_cache
+```
+
+当然你也可以使用打包好的exe可执行文件 [Release](https://github.com/liuyu80/keil2CompileCommands/releases/latest)
+
+```bash
+k2c ../../MyKeilProject/MyProject.uvprojx -d
+```
+
+工具默认将在当前工作目录下生成一个名为 `compile_commands.json` 的文件。
+
+## 编译器路径设置
+
+为了获取正确的编译器路径，脚本会按以下顺序查找：
+1. 当前项目目录下的 `.vscode/settings.json`
+2. 全局 VSCode 用户设置 (`AppData/Code/User/settings.json`)
+
+如果找不到编译器路径，脚本会提醒您添加以下配置到 VSCode 设置中：
+```json
+"clangd.arguments": ["--query-driver=<absolute_path_to_compiler>"]
+```
+
+## `compile_commands.json`
+
+生成的 `compile_commands.json` 文件包含一个 JSON 数组，其中每个对象代表项目中的一个源文件及其编译参数。结构如下：
+
+```json
+[
+  {
+    "directory": "/path/to/source/file/directory",
+    "arguments": [
+      "<absolute_path_to_compiler>",
+      "-Iinclude/path1",
+      "-Iinclude/path2",
+      "-DMACRO1",
+      "-DMACRO2"
+    ],
+    "file": "/path/to/source/file/filename.c"
+  },
+  ...
+]
+```
+
+这个文件可以被许多开发工具（如 VS Code 配合 Clangd 插件）使用，以增强代码编辑体验。
+
+Clangd LSP 安装包: https://github.com/clangd/clangd/releases/latest
+
+VS Code 的 Clangd 插件: https://github.com/clangd/vscode-clangd/releases/latest
+

k2c-1.5.1/README.md

@@ -0,0 +1,160 @@
+# Keil to Compile Commands Converter
+
+这是一个 Python/uv 工具，用于解析 Keil MDK 项目文件 (.uvprojx、.uvproj) 并生成 `compile_commands.json` 文件。这个文件可以被 Clangd 等语言服务器使用，以提供更准确的代码补全、导航和诊断功能。
+
+## 功能
+
+*   解析 Keil `.uvprojx` XML 文件。
+*   提取项目中包含的 C/C++ 源文件 (`.c`) 和汇编文件 (`.s`)。
+*   提取在 Keil 项目设置中定义的宏 (`-D` 标志)。
+*   提取在 Keil 项目设置中指定的包含路径 (`-I` 标志)。
+*   支持 Target 选择和 Target 列表查看。
+*   合并 Target、Group、File 级别的宏、包含路径和部分编译选项。
+*   支持 C、C++、汇编源文件 (`.c`, `.cc`, `.cpp`, `.cxx`, `.s`, `.S`)。
+*   从 Keil CPU/FPU 配置推导常用 clang 参数，如 `-mcpu`、`-mthumb`、`-mfpu`。
+*   自动处理包含路径的相对路径转换
+*   统一路径分隔符为 `/` 格式
+*   支持从 VSCode Clangd 设置中自动获取编译器路径
+*   支持检查缺失的源文件和包含目录。
+*   根据提取的信息生成 `compile_commands.json` 文件。
+
+## 依赖
+
+*   uv
+*   Python 3.13+
+*   标准库: `xml.etree.ElementTree`, `json`, `os`, `sys` (无需额外安装)
+*   `json5` (由 uv 按 `pyproject.toml` 自动安装，用于读取带注释的VSCode设置文件)
+
+## 使用方法
+
+### 安装
+
+通过 pip 安装 Python 包:
+
+```bash
+pip install k2c
+```
+
+安装后可以直接运行:
+
+```bash
+k2c --version
+```
+
+也可以从 GitHub Release 下载 `k2c.exe` 后直接运行。
+
+### 本地开发运行
+
+首次使用先同步运行环境：
+
+```bash
+uv sync
+```
+
+日常使用建议加 `--no-sync`，避免每次运行前重复检查和同步环境：
+
+```bash
+uv run --no-sync k2c <path_to_your_keil_project.uvprojx> [options]
+```
+
+**参数说明:**
+- `--version`: 输出当前版本号
+- `-d`: 可选参数，创建clangd缓存目录
+  - 不带参数值: 默认创建`.cache`目录
+  - 带参数值: 创建指定名称的目录
+- `-o, --output`: 指定输出文件路径，默认 `compile_commands.json`
+- `--target`: 指定要解析的 Keil Target 名称
+- `--list-targets`: 列出工程中的 Target 名称后退出
+- `--compiler`: 显式指定编译器路径，优先级高于 VSCode 设置
+- `--dry-run`: 只解析并打印摘要，不写入文件
+- `--verbose`: 打印解析摘要
+- `--check-missing-files`: 检查缺失的源文件和 include 路径
+
+**示例:**
+
+基本用法:
+```bash
+uv run --no-sync k2c C:/Path/To/Your/Project/YourProject.uvprojx
+```
+
+查看 Target:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --list-targets
+```
+
+查看版本:
+```bash
+uv run --no-sync k2c --version
+```
+
+指定 Target 和编译器:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --target Debug --compiler C:/Keil_v5/ARM/ARMCLANG/bin/armclang.exe
+```
+
+指定输出路径:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -o build/compile_commands.json
+```
+
+检查解析结果:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --dry-run --verbose --check-missing-files
+```
+
+创建默认缓存目录:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -d
+```
+
+创建自定义缓存目录:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -d my_cache
+```
+
+当然你也可以使用打包好的exe可执行文件 [Release](https://github.com/liuyu80/keil2CompileCommands/releases/latest)
+
+```bash
+k2c ../../MyKeilProject/MyProject.uvprojx -d
+```
+
+工具默认将在当前工作目录下生成一个名为 `compile_commands.json` 的文件。
+
+## 编译器路径设置
+
+为了获取正确的编译器路径，脚本会按以下顺序查找：
+1. 当前项目目录下的 `.vscode/settings.json`
+2. 全局 VSCode 用户设置 (`AppData/Code/User/settings.json`)
+
+如果找不到编译器路径，脚本会提醒您添加以下配置到 VSCode 设置中：
+```json
+"clangd.arguments": ["--query-driver=<absolute_path_to_compiler>"]
+```
+
+## `compile_commands.json`
+
+生成的 `compile_commands.json` 文件包含一个 JSON 数组，其中每个对象代表项目中的一个源文件及其编译参数。结构如下：
+
+```json
+[
+  {
+    "directory": "/path/to/source/file/directory",
+    "arguments": [
+      "<absolute_path_to_compiler>",
+      "-Iinclude/path1",
+      "-Iinclude/path2",
+      "-DMACRO1",
+      "-DMACRO2"
+    ],
+    "file": "/path/to/source/file/filename.c"
+  },
+  ...
+]
+```
+
+这个文件可以被许多开发工具（如 VS Code 配合 Clangd 插件）使用，以增强代码编辑体验。
+
+Clangd LSP 安装包: https://github.com/clangd/clangd/releases/latest
+
+VS Code 的 Clangd 插件: https://github.com/clangd/vscode-clangd/releases/latest
+

k2c-1.5.1/k2c.spec

@@ -0,0 +1,51 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+import os
+from pathlib import Path
+
+
+version = os.getenv('K2C_VERSION', '0.1.0')
+version_hook = Path('build') / 'k2c_version_hook.py'
+version_hook.parent.mkdir(parents=True, exist_ok=True)
+version_hook.write_text(
+    "import os\n\n"
+    f"os.environ.setdefault('K2C_VERSION', {version!r})\n",
+    encoding='utf-8',
+)
+
+
+a = Analysis(
+    ['main.py'],
+    pathex=['src'],
+    binaries=[],
+    datas=[],
+    hiddenimports=[],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[str(version_hook)],
+    excludes=[],
+    noarchive=False,
+    optimize=0,
+)
+pyz = PYZ(a.pure)
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    a.binaries,
+    a.datas,
+    [],
+    name='k2c',
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    runtime_tmpdir=None,
+    console=True,
+    disable_windowed_traceback=False,
+    argv_emulation=False,
+    target_arch=None,
+    codesign_identity=None,
+    entitlements_file=None,
+)

k2c-1.5.1/main.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+import sys
+
+
+sys.path.insert(0, str(Path(__file__).resolve().parent / "src"))
+
+from keil2compilecommands.cli import main
+from keil2compilecommands.k2c_utils import (
+    build_compile_commands,
+    create_clangd_directory,
+    get_clangd_query_driver,
+    write_compile_commands,
+)
+
+
+def parse_keil_project(keil_project_file_path: str):
+    return build_compile_commands(
+        keil_project_file_path,
+        compiler=get_clangd_query_driver(),
+    )
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

k2c-1.5.1/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=69", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "k2c"
+description = "Keil .uvprojx to compile_commands.json Converter"
+readme = "README.md"
+requires-python = ">=3.13"
+dynamic = ["version"]
+dependencies = [
+    "json5>=0.12.0",
+]
+
+[project.scripts]
+k2c = "keil2compilecommands.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools_scm]
+fallback_version = "0.1.0"
+
+[dependency-groups]
+dev = [
+    "auto-py-to-exe>=2.46.0",
+    "build>=1.2.2",
+    "twine>=6.1.0",
+]
+
+[[tool.uv.index]]
+url = "https://pypi.tuna.tsinghua.edu.cn/simple"
+default = true

k2c-1.5.1/requirements.txt

@@ -0,0 +1 @@
+json5==0.12.0

k2c-1.5.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

k2c-1.5.1/src/k2c.egg-info/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: k2c
+Version: 1.5.1
+Summary: Keil .uvprojx to compile_commands.json Converter
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: json5>=0.12.0
+
+# Keil to Compile Commands Converter
+
+这是一个 Python/uv 工具，用于解析 Keil MDK 项目文件 (.uvprojx、.uvproj) 并生成 `compile_commands.json` 文件。这个文件可以被 Clangd 等语言服务器使用，以提供更准确的代码补全、导航和诊断功能。
+
+## 功能
+
+*   解析 Keil `.uvprojx` XML 文件。
+*   提取项目中包含的 C/C++ 源文件 (`.c`) 和汇编文件 (`.s`)。
+*   提取在 Keil 项目设置中定义的宏 (`-D` 标志)。
+*   提取在 Keil 项目设置中指定的包含路径 (`-I` 标志)。
+*   支持 Target 选择和 Target 列表查看。
+*   合并 Target、Group、File 级别的宏、包含路径和部分编译选项。
+*   支持 C、C++、汇编源文件 (`.c`, `.cc`, `.cpp`, `.cxx`, `.s`, `.S`)。
+*   从 Keil CPU/FPU 配置推导常用 clang 参数，如 `-mcpu`、`-mthumb`、`-mfpu`。
+*   自动处理包含路径的相对路径转换
+*   统一路径分隔符为 `/` 格式
+*   支持从 VSCode Clangd 设置中自动获取编译器路径
+*   支持检查缺失的源文件和包含目录。
+*   根据提取的信息生成 `compile_commands.json` 文件。
+
+## 依赖
+
+*   uv
+*   Python 3.13+
+*   标准库: `xml.etree.ElementTree`, `json`, `os`, `sys` (无需额外安装)
+*   `json5` (由 uv 按 `pyproject.toml` 自动安装，用于读取带注释的VSCode设置文件)
+
+## 使用方法
+
+### 安装
+
+通过 pip 安装 Python 包:
+
+```bash
+pip install k2c
+```
+
+安装后可以直接运行:
+
+```bash
+k2c --version
+```
+
+也可以从 GitHub Release 下载 `k2c.exe` 后直接运行。
+
+### 本地开发运行
+
+首次使用先同步运行环境：
+
+```bash
+uv sync
+```
+
+日常使用建议加 `--no-sync`，避免每次运行前重复检查和同步环境：
+
+```bash
+uv run --no-sync k2c <path_to_your_keil_project.uvprojx> [options]
+```
+
+**参数说明:**
+- `--version`: 输出当前版本号
+- `-d`: 可选参数，创建clangd缓存目录
+  - 不带参数值: 默认创建`.cache`目录
+  - 带参数值: 创建指定名称的目录
+- `-o, --output`: 指定输出文件路径，默认 `compile_commands.json`
+- `--target`: 指定要解析的 Keil Target 名称
+- `--list-targets`: 列出工程中的 Target 名称后退出
+- `--compiler`: 显式指定编译器路径，优先级高于 VSCode 设置
+- `--dry-run`: 只解析并打印摘要，不写入文件
+- `--verbose`: 打印解析摘要
+- `--check-missing-files`: 检查缺失的源文件和 include 路径
+
+**示例:**
+
+基本用法:
+```bash
+uv run --no-sync k2c C:/Path/To/Your/Project/YourProject.uvprojx
+```
+
+查看 Target:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --list-targets
+```
+
+查看版本:
+```bash
+uv run --no-sync k2c --version
+```
+
+指定 Target 和编译器:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --target Debug --compiler C:/Keil_v5/ARM/ARMCLANG/bin/armclang.exe
+```
+
+指定输出路径:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -o build/compile_commands.json
+```
+
+检查解析结果:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx --dry-run --verbose --check-missing-files
+```
+
+创建默认缓存目录:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -d
+```
+
+创建自定义缓存目录:
+```bash
+uv run --no-sync k2c ../../MyKeilProject/MyProject.uvprojx -d my_cache
+```
+
+当然你也可以使用打包好的exe可执行文件 [Release](https://github.com/liuyu80/keil2CompileCommands/releases/latest)
+
+```bash
+k2c ../../MyKeilProject/MyProject.uvprojx -d
+```
+
+工具默认将在当前工作目录下生成一个名为 `compile_commands.json` 的文件。
+
+## 编译器路径设置
+
+为了获取正确的编译器路径，脚本会按以下顺序查找：
+1. 当前项目目录下的 `.vscode/settings.json`
+2. 全局 VSCode 用户设置 (`AppData/Code/User/settings.json`)
+
+如果找不到编译器路径，脚本会提醒您添加以下配置到 VSCode 设置中：
+```json
+"clangd.arguments": ["--query-driver=<absolute_path_to_compiler>"]
+```
+
+## `compile_commands.json`
+
+生成的 `compile_commands.json` 文件包含一个 JSON 数组，其中每个对象代表项目中的一个源文件及其编译参数。结构如下：
+
+```json
+[
+  {
+    "directory": "/path/to/source/file/directory",
+    "arguments": [
+      "<absolute_path_to_compiler>",
+      "-Iinclude/path1",
+      "-Iinclude/path2",
+      "-DMACRO1",
+      "-DMACRO2"
+    ],
+    "file": "/path/to/source/file/filename.c"
+  },
+  ...
+]
+```
+
+这个文件可以被许多开发工具（如 VS Code 配合 Clangd 插件）使用，以增强代码编辑体验。
+
+Clangd LSP 安装包: https://github.com/clangd/clangd/releases/latest
+
+VS Code 的 Clangd 插件: https://github.com/clangd/vscode-clangd/releases/latest
+