# VSCode For STM32脚本

**Repository Path**: JeckXu666/vscode-for-stm32-script

## Basic Information

- **Project Name**: VSCode For STM32脚本
- **Description**: 辅助 VScode 开发 STM32 的脚本
- **Primary Language**: Python
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-03-20
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: makefile, stm32, VSCode

## README

# 一个辅助 VSCode 下开发 STM32 的脚本

上一节我在 VSCode 下配置了 STM32 的开发环境，其中 STM32 的配置代码由 STM32CubeMX 生成，生成的时候选择的是 Makefile 进行编译，在生成的目录顶层会有一个 Makefile 脚本，使用 GCC ARM 来对工程代码进行编译，这段 Makefile 内容不是很多，逻辑也挺清楚，后面我会写一篇文章来分析，我们在开发的时候除了 CubeMX 生成的代码外，还要有自己的代码文件，这些文件的路径信息我们要添加到 Makefile 中才能参加编译，这时候就有个很麻烦的事了，一些开源的项目如果要移植进去，路径相关依赖很多，自己添加会要人命，加上我自己学识浅薄，一些高深的手段不清楚，所以就写了个 python 脚本，扫描指定的文件夹，生成相关信息，方便我们添加到 Makefile 中进行编译，脚本代码如下：

```python
'''
Author: jeckxu666
Date: 2022-03-20 09:07:52
LastEditTime: 2022-03-20 17:46:55
LastEditors: jeckxu666
Description: 
FilePath: \Photon\file_generated.py
仅可用于技术交流，严禁商用，转载请注明出处！QQ交流群：773080352
'''
import os

# 所有包含.h文件的文件夹路径
C_includeList = []  
# 所有C文件路径
C_fileList = []
# 所有ASM文件路径
A_fileList = []
# 排除扫描的文件夹
exclude = ['build','Core','Drivers','FATFS','USB_DEVICE','ST','Third_Party'] 

def Scan_Path(path):  
    global allFileNum  
    global C_includeList
    global C_fileList
    global A_fileList
    mark = 1
    # 扫描脚本层所有目录和文件
    files = os.listdir(path)  
    # 遍历文件
    for f in files: 
        # 如果是目录
        if(os.path.isdir(path + '/' + f)):  
            if(f[0] == '.' or f in exclude): 
                # 排除隐藏目录和开头设定的不扫描目录 
                pass  
            else:
                # 否则进入目录进行递归扫描    
                Scan_Path(path + '/' + f)
        # 如果是文件
        if(os.path.isfile(path + '/' + f)): 
            # 获取文件后缀
            file_path,type = os.path.splitext(path + '/' + f)
            if(type == '.c'or type == '.C'):
                # C 文件则获取文件路径
                C_fileList.append(os.path.relpath(path,head_path).replace('\\','/') + '/' + f)  
            elif(type == '.s' or type == '.S'):
                # 汇编文件则获取文件路径
                A_fileList.append(os.path.relpath(path,head_path).replace('\\','/') + '/' + f)
            elif(type == '.h' or type == '.H' or type == '.ph'):
                # 头文件则获取路径，并且该目录只添加一次，因为是头文件目录
                if(mark == 1):
                    C_includeList.append(os.path.relpath(path,head_path).replace('\\','/'))
                    mark = 0
            else:
                pass
if __name__ == '__main__': 
    global head_path 
    # 获取脚本文件所在的目录，调用递归
    head_path = os.getcwd()
    Scan_Path(head_path)
    # 将扫描完的文件写入到 txt 文件，方便我们复制
    # 文件生成在脚本文件目录下
    with open("generate_file.txt","w") as f:
        f.truncate(0)
        f.write('*'*50+"\n")
        f.write("* 头文件路径")
        f.write("\n"+'*'*50+"\n")

        C_includeList = ['-I'+ i for i in C_includeList]
        f.write("\\\n".join(C_includeList))

        f.write("\n"+'*'*50+"\n")
        f.write("* C文件路径")
        f.write("\n"+'*'*50+"\n")

        f.write("\\\n".join(C_fileList))
        f.write("\n"+'*'*50+"\n")
        f.write("* 汇编文件路径")
        f.write("\n"+'*'*50+"\n")

        f.write("\\\n".join(A_fileList))
        f.write("\n"+'*'*50+"\n")

    print("执行完成，目录已写入")
```

 脚本的注释已经写在代码里面，大家可以参考，代码源文件我传到 Gitee，欢迎大家收藏哈

[Gitee 仓库链接](https://gitee.com/JeckXu666/vscode-for-stm32-script/tree/master)

使用的时候就是将该脚本放到和 Make file 同一个目录下，修改排除扫描的文件夹，然后运行脚本（前提要装一个python环境，不多说），运行完成后，脚本目录就会生成一个txt目录，目录里面就有相关信息了：

![生成结果](image.png)

然后我们直接复制到 Makefile 指定位置就行