# keil-autopiler

**Repository Path**: zhang_bin_bin/keil-autopiler

## Basic Information

- **Project Name**: keil-autopiler
- **Description**: 一个基于 keil 的自动化编译代码的脚本
- **Primary Language**: C
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 54
- **Created**: 2024-11-09
- **Last Updated**: 2024-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Keil-Autopiler v1.2

## 1 需求来源
部分对开发流程有限制的公司是将开发与编译（提交后的代码版本）分开的，要求编译过程尽可能少的人为参与，需在程序上实现代码的自动化编译。基于此需求开发了本脚本。
![演示界面](images/powershell_execute.png)

## 2 介绍
这是一个 `keil` 的自动化编译脚本，可被其他脚本或程序调用，接收参数并按参数编译 `keil` 工程，而不必打开 `keil` 软件，实现程序上的自动化。主要实现了以下功能：

1.  自动搜索脚本所在的目录下所有的 `keil` 工程
    - 搜索到多个 keil 工程时， **若未指定工程，则默认选择最后找到的 keil uvproj(x) 工程** 
    - 指定 keil uvproj(x) 工程时支持 **相对路径** 和 **绝对路径** 

2.  可指定 `keil` 版本进行编译
    - 可直接输入以指定 `keil` 软件路径，如： `C:\Keil_v5\UV4\UV4.exe`
    - 当 `keil` 安装路径以 `X:\Keil_vY` （X: 盘符； Y: 4 或 5）开头时支持模糊输入（模糊输入如： `4` , `K4` , `Keil4` , `Keilv4` , `Keil_4` 等）
    - 当 `keil` 的安装路径和本案例中的 `D:\Keil_v5\UV4\UV4.exe` 路径不同时，除非修改代码中的 `keil` 软件路径后重新编译成新的 `.exe` 或在系统环境变量 `Path` 中设置好路径，否则必须指定 keil 软件的所在路径

3.  可选择 `project target`
    -  **未指定则默认选择 keil 工程中最后一个 `project target`** 
    - 支持非法字符识别并报错

4.  编译完成后自动将 `.bin` 和 `.hex` 文件拷贝至脚本的同级目录
    - 仅拷贝选定的 keil 工程编译出的 `.bin` 和 `.hex` 文件

5.  自动从系统环境变量 `Path` 中搜索 `keil` 的 `UV4.exe` 程序
    - v1.2 新增功能
    - 不需要此功能忽略以下说明
    - `keil` 安装后不会自动设置环境变量，需要手动设置，可参考本文 5.1.3
    - 本脚本仅在系统环境变量 `Path` 中搜索
    - 参考值： `C:\Program Files (x86)\Keil_v5\UV4` **（必须是目录）**


## 3 有哪些参数
| 序号 | 描述 | 典型值 | 是否必须 | 备注 |
| :---: | --- | --- | :---: | --- |
| 1 | keil 版本 或 keil `UV4.exe` 的绝对路径 | 1. keil 路径与本脚本一致：`4` 或 `5` <br> 2. keil 路径与本脚本不一致： `C:\Keil_v5\UV4\UV4.exe` （示例）  | 否 | 1. v1.2 支持自动从系统环境变量 `Path` 中搜索<br>2. 脚本优先使用指定的 keil 路径 |
| 2 | keil project target | release （示例） | 否 | |
| 3 | 指定 keil 工程的相对路径或绝对路径 | 以 `.\` 或 `..\` 或 `C:\` 开头 | 否 | |

> **说明：** 本脚本的所有参数可不按顺序输入，为空时表示选择默认值，但参数与参数之间需用**空格**隔开


## 4 我想直接用
0.  本脚本仅支持 `windows` 系统且要求已经安装了 keil 软件
1.  在发行版中下载可直接运行的 `.exe`
2.  将 `.exe` 脚本与需要编译的 keil 工程放在同一级目录（下称目录 A ）
3.  打开 `powershell` 或 `cmd` 并定位至目录 A 
    - 若使用 `powershell` ，可在目录 A 空白处按住 `shift` 键同时单击鼠标右键选择打开 `powershell` ，将自动定位到目录 A

4.  执行脚本
    - 案例一：
      - 只有一个 keil 工程 或 搜索到的最后一个工程就是要编译的工程
      - 只有一个 project target 或 keil 工程保存时已选中需编译的 project target
      - keil UV4.exe 的路径和本脚本一致 （`D:\Keil_v5\UV4\UV4.exe`）
    ```
    .\Keil-Autopiler.exe
    ```

    - 案例二：
      - 指定 keil 版本 
    ```
    .\Keil-Autopiler.exe 4 
    （注：keil UV4.exe 的路径和本脚本一致或系统环境变量已设置才可使用本条指令，否则使用下条指令）
    ```
    或
    ```
    .\Keil-Autopiler.exe C:\Keil_v4\UV4\UV4.exe
    ```

    - 案例三：
      - 指定 keil 工程
    ```
    .\Keil-Autopiler.exe .\Code\Project\MDK\template.uvprojx
    ```
    或
    ```
    .\Keil-Autopiler.exe C:\Users\Administrator\Desktop\test\Code\Project\MDK\template.uvprojx
    ```

    - 案例四：
      - 指定 project target
    ```
    .\Keil-Autopiler.exe release
    ```

    - 案例五：
      - 指定 keil 版本
      - 指定 keil 工程
      - 指定 project target
    ```
    .\Keil-Autopiler.exe 4 release .\Code\Project\MDK\template.uvprojx
    （注：keil UV4.exe 的路径和本脚本一致才可使用本条指令，否则使用下条指令）
    ```
    或
    ```
    .\Keil-Autopiler.exe C:\Keil_v4\UV4\UV4.exe release C:\Users\Administrator\Desktop\test\Code\Project\MDK\template.uvprojx
    ```
5.  编译时间与编译器版本、编译选项和代码量有关，需耐心等待。（可打开同级目录的 `keilx_compile_log.txt` 查看编译过程日志）
6.  `powershell` 或 `cmd` 打印内容出现 `Copy above file(s) SUCCESS` 的字样表示执行成功，并将对应 keil 工程生成的 `.bin` 和 `.hex` 文件拷贝至脚本的同级目录中
    ![编译成功](images/keil_build_success.png)


## 5 我想自己编译这个脚本
**本代码仅支持 windows 系统**
### 5.1 预备操作
0.  如果你已经安装了 gcc ，请忽略本步骤
1.  下载 gcc 编译器，为了考虑兼容性，这里提供一个 32 位的 mingw 下载链接： [i686-13.1.0-release-posix-dwarf-ucrt-rt_v11-rev1.7z](https://github.com/niXman/mingw-builds-binaries/releases/download/13.1.0-rt_v11-rev1/i686-13.1.0-release-posix-dwarf-ucrt-rt_v11-rev1.7z)
2.  解压后放在任意路径，此处以 `C:\mingw32` 为例
3.  配置好环境变量
    ![配置环境变量](images/path_config.png)

4.  打开 `powershell` 或 `cmd` 输入 `gcc -v` ，出现下图内容表示配置成功
    ![gcc](images/gcc.png)

### 5.2 编译
1.  打开 `powershell` 或 `cmd` 并定位至代码目录
    - 若使用 `powershell` ，可在代码目录空白处按住 `shift` 键同时单击鼠标右键选择打开 `powershell` ，将自动定位到代码目录

2.  执行以下 gcc 命令
    ```
    gcc .\Keil-Autopiler.c -o .\Keil-Autopiler.exe
    ```
3.  无任何提示信息，编译通过
    ![gcc编译通过](images/gcc_compile.png)


## 修改记录
| 版本 |     日期    |修改者        |修改内容                                |
|:----:|:----------:|--------------|---------------------------------------|
| v1.0 | 2023-08-22 | Dino         | 初版发布                               |
| v1.1 | 2023-09-14 | Dino         | 1. 修复保存 keil uv4.exe 路径数组过小的问题<br>2. 增加实时打印编译输出内容的功能 |
| v1.2 | 2023-10-20 | Dino         | 1. 增加从系统环境变量 Path 中自动查找 keil UV4.exe 的功能 |


## 重要说明
> **1. 本脚本依赖 keil 软件，定位为 keil 的自动化编译脚本。目的是替代手动编译，实现程序自动化，而非替代编译工具，并无附带任何编译器和链接器。由此，无论代码工程是基于 keil C51 亦或是 keil MDK 都可执行。**
> 
> **2. 无论是 keil 安装目录、 keil 工程所在目录和 keil 的 project target ，都不要使用中文和空格。否则，不保证使用效果。**


## 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request