Keil一鍵新增.c檔案和標頭檔案路徑指令碼--可遍歷新增整個資料夾

在没有你的地方發表於2024-06-08
指令碼

最近想移植個LVGL玩玩，發現檔案實在是太多了，加的手疼都沒搞完，實在不想搞了就去找指令碼和工具，基本沒找到一個。。。。。。

主要是自己也懶得去研究寫指令碼，偶然搜到了一個博主寫的指令碼，原部落格地址:https://blog.csdn.net/riyue2044/article/details/139424599

但是有以下問題：

1.這個指令碼的.h檔案也加在了分組下面，這樣一般是不對的，應該加在Target的C/C++的Include path裡面

2.指令碼沒有重複新增檢測，導致如果多次新增，會損壞工程檔案

3.輸入是命令列式的，使用者可能會忘了引數具體設定

之前沒接觸過XML，python也不熟，所以研究了一下，做以下修改

1.把之前的命令列式的輸入改為先執行再輸入，會提示具體的引數設定，有預設引數，是以我的工程包來寫的

2.把.h檔案路徑直接加在了Target的C/C++的Include path裡面

3.加入檔案路徑檢測，重複新增不會導致檔案損壞

4.加入更多提示

5.加入三種模式 0：.c檔案和.h路徑會一起新增 1：只加.c檔案 2：只加.h路徑

使用方法：需要安裝python，或者用python打包成exe檔案也可，命令參考：pyinstaller -F -i .\icon.ico .\keil_add_file.py，放個百度雲的連結，裡面有我打包好的，不過注意防毒軟體估計會報毒，請新增信任

連結：https://pan.baidu.com/s/1zC7kVboAtQwHZ2Zy5RFmIw?pwd=arzd
提取碼：arzd

指令碼需放在keil工程目錄，需要新增的目錄則以相對路徑填充，比如"../../../external/lvgl"，需要注意的是分組需要提前在keil裡面建立好，這個懶得改了，有需要的朋友可以自行修改

指令碼內容如下：

  1 import os
  2 import glob
  3 import xml.etree.ElementTree as ET
  4 import argparse
  5 
  6 from multiprocessing import Event
  7 
  8 def indent(elem, level=0):
  9     """ Helper function to indent the XML for pretty printing. """
 10     i = "\n" + level * "    "
 11     if len(elem):
 12         if not elem.text or not elem.text.strip():
 13             elem.text = i + "    "
 14         if not elem.tail or not elem.tail.strip():
 15             elem.tail = i
 16         for elem in elem:
 17             indent(elem, level + 1)
 18         if not elem.tail or not elem.tail.strip():
 19             elem.tail = i
 20     else:
 21         if level and (not elem.tail or not elem.tail.strip()):
 22             elem.tail = i
 23         if not elem.tail:
 24             elem.tail = "\n"
 25 
 26 def add_files_to_group(uvprojx_file_path, mode,folder_path, group_name_target):
 27     # 改變副檔名從 .uvprojx 到 .xml
 28     base, ext = os.path.splitext(uvprojx_file_path)
 29     if ext != '.uvprojx':
 30         print("工程副檔名不正確")
 31         return
 32     
 33     xml_path = base + '.xml'
 34     os.rename(uvprojx_file_path, xml_path)
 35 
 36     try:
 37         #解析XML檔案
 38         tree = ET.parse(xml_path)
 39         #獲取根節點
 40         root = tree.getroot()
 41 
 42         if mode == 0 or mode == 1:
 43             # 找到指定GroupName的Group節點
 44             target_group = None
 45             for group in root.findall('.//Group'):
 46                 group_name = group.find('GroupName')
 47                 if group_name is not None and group_name.text == group_name_target:
 48                     target_group = group
 49                     break
 50 
 51             if target_group is None:
 52                 print(f"未發現 '{group_name_target}' 分組，請先建立分組後再嘗試")
 53                 # 將副檔名改回 .uvprojx
 54                 os.rename(xml_path, uvprojx_file_path)
 55                 return
 56 
 57             # 找到目標 Group 節點下的 Files 節點，如果不存在則建立一個
 58             files_node = target_group.find('Files')
 59             if files_node is None:
 60                 files_node = ET.SubElement(target_group, 'Files')
 61                                 
 62         #尋找標頭檔案分組
 63         if mode == 0 or mode == 2:
 64             print("尋找標頭檔案分組......")
 65             target_header = None
 66             heard_inc = None
 67             target_header = root.find('.//Cads')
 68             if target_header == None:
 69                 print("未發現標頭檔案分組Cads")
 70                 return
 71             else:
 72                 heard_inc = target_header.find('VariousControls')
 73                 if heard_inc == None:
 74                     print("未發現標頭檔案分組VariousControls")
 75                     return
 76                 else:
 77                     heard_inc = heard_inc.find('IncludePath')
 78                     if heard_inc == None:
 79                         print("未發現標頭檔案分組IncludePath")
 80                         return
 81                     else:
 82                         print("找到標頭檔案分組")
 83                        
 84         
 85         
 86         #下面沒有節點
 87         if mode == 0 or mode == 1:
 88             creat_dot = 0 #是否需要建立節點標誌,如果有重複則跳過 
 89             init_creat = 0
 90             file_init = files_node.find('File')
 91             if file_init == None:
 92                 creat_dot = 1
 93                 init_creat = 1
 94                 print("初始節點為空需要建立節點")
 95   
 96         # 遍歷指定資料夾，查詢所有 .c 檔案  
 97         if mode == 0 or mode == 2:
 98             #print(heard_inc.text)  
 99             heard_data = heard_inc.text + ";"   #末尾需要先加一個分號   
100             
101         for subdir, _, files in os.walk(folder_path):
102             #.h路徑
103             if mode == 0 or mode == 2:
104                 dir_path = os.path.relpath(subdir, start=os.path.dirname(xml_path))
105                 if dir_path in heard_inc.text:
106                     print("需要新增的標頭檔案路徑已存在本次跳過")
107                 else:
108                     heard_data = heard_data + dir_path + ";"
109                     
110             #.c新增到分組
111             if mode == 0 or mode == 1:
112                 for file in files:     
113                     if file.endswith('.c'):
114                         # 計算相對路徑
115                         file_path = os.path.relpath(os.path.join(subdir, file), start=os.path.dirname(xml_path))
116                         #print("路徑",file_path)
117                         file_check = files_node.findall('File')
118                         if init_creat == 0:
119                             #print("長度",len(file_check))
120                             #遍歷當前分組下的節點,檢測是否已經包含了該路徑,如果有直接跳過
121                             for i in range(len(file_check)):
122                                 if file_path in file_check[i].find("FilePath").text:
123                                     print("節點已存在本次跳過")
124                                     creat_dot = 0
125                                     break
126                                 else: 
127                                     if i == len(file_check) - 1:
128                                         creat_dot = 1
129                                         print("節點不存在,建立節點")
130                                     else:
131                                        creat_dot = 0
132                                     continue    
133                         if creat_dot == 1:
134                             # 建立 File 節點並新增到 Files 節點下
135                             file_node = ET.SubElement(files_node, 'File')
136                             file_name_node = ET.SubElement(file_node, 'FileName')
137                             file_name_node.text = file
138                             file_type_node = ET.SubElement(file_node, 'FileType')
139                             file_type_node.text = '1'  # .c 檔案型別都為 1
140 
141                             file_path_node = ET.SubElement(file_node, 'FilePath')
142                             file_path_node.text = file_path
143                             creat_dot = 0
144                             init_creat = 0
145                             
146         if mode == 0 or mode == 2:
147             heard_data = heard_data.rstrip(";") #移除最後一個多加的;
148             heard_inc.text = heard_data
149             #print(heard_inc.text)                    
150                   
151         # 格式化 XML
152         indent(root)
153 
154         # 儲存修改後的 XML 檔案
155         tree.write(xml_path, encoding='utf-8', xml_declaration=True)
156         print("已完成")
157 
158     except ET.ParseError as e:
159         print(f"ParseError: {e}")
160         with open(xml_path, 'r', encoding='utf-8') as file:
161             lines = file.readlines()
162             start = max(0, e.position[0] - 5)
163             end = min(len(lines), e.position[0] + 5)
164             print("Context around the error:")
165             for i in range(start, end):
166                 print(f"{i+1}: {lines[i].strip()}")
167 
168     finally:
169         # 將副檔名改回 .uvprojx
170         os.rename(xml_path, uvprojx_file_path)
171 
172 #尋找工程檔案
173 def find_uvprojx_file():
174     uvprojx_files = glob.glob("*.uvprojx")
175     if not uvprojx_files:
176         print("未找到工程檔案,請把此檔案放在keil工程目錄下")
177         return None
178     elif len(uvprojx_files) > 1:
179         print("在當前目錄中找到多個.uvprojx檔案：")
180         for i, file in enumerate(uvprojx_files, start=1):
181             print(f"{i}. {file}")
182         print("請確保目錄中只有一個.uvprojx檔案")
183         return None
184     else:
185         return uvprojx_files[0]
186 
187 if __name__ == "__main__":
188     print("keil一鍵新增檔案和標頭檔案路徑指令碼\n\
189     需放在keil工程同級目錄下\n\
190     引數格式,引數用空格隔開\n\
191     預設模式:0\n\
192     預設路徑:\"../../../external/lvgl\"\n\
193     預設分組:\"lvgl\"\n\
194     1.新增模式 0:全部新增(.c檔案全新增到分組.h資料夾加入include路徑裡) 1:只新增.c檔案到分組 2:只新增.h資料夾到include裡\n\
195     2.要新增的資料夾路徑,請使用相對路徑\n\
196     3.要新增的分組名稱,如果沒有分組需要先去keil手動新增分組\n")
197     
198     param = input("請輸入引數:")
199     
200     if param:
201         #print(param)
202         args = param.split()
203         args[0] = int(args[0])
204         print(args)
205     else:
206         args = [0,"../../../external/lvgl","lvgl"]
207         print("使用預設引數:",args)
208     uvprojx_file_path = find_uvprojx_file()
209     if uvprojx_file_path:
210         add_files_to_group(uvprojx_file_path, args[0],args[1],args[2])
211 
212     event = Event()
213     event.wait()

相關文章