本文转载自微信公众号「鱼鹰谈单片机」,作者鱼鹰Osprey。转载本文请联系鱼鹰谈单片机公众号。
标题
有些工程,可能包含了一大堆文件(比如 rt-thread 工程),你可能并不需要它们,但是却一直保留在你的工程目录中,想删掉又怕删错,一个个整理又太麻烦。
还有就是,当你使用 SI(source insight) 看源代码时,因为你不知道哪些文件才是你当前文件需要的,所以只能一股脑把所有的源文件添加到工程里面了。
然后你会发现,一个 main 函数有多处定义了,你都不知道哪个文件的 main 函数才是正主(在看 linux 源代码时亦是如此,根本不知道哪些文件被编译进内核了)。并且 SI 同步时间也大大延长了,本来几秒钟就能完成同步的,可能就需要十几秒,几十秒。
有没有好的方法把 MDK 工程里面包含的文件提取出来呢?
当然有。
最近鱼鹰写了一个脚本,专门干这事,通过在 git bash 中执行这个脚本,就可以完成提取工作(包括汇编文件、C 文件、包含的头文件)。
汇编文件和C 文件我们可以通过打开 *.uvopt 文件找到对应的文件路径。
但是头文件咋办?
我们知道 MDK 工程可以编译可以通过,那么 MDK 肯定知道头文件在哪找,所以我们需要想办法找到这些信息。
然后我们可以在 Objects 文件夹里面的 *.d 文件中找到对应的头文件路径(每一个源文件都有一个对应的 *.d 文件存在,比如上面的 main.c 对应的文件就是 main.d)。
使用记事本打开 main.d 文件:
我们可以看到 main.d 文件的第一项就是 C 文件,后面的就是头文件路径了,因为目前这个文件只包含了一个头文件 S3C2440.h ,所以这个 main.d 文件里面只有一个头文件信息。
所以我们的脚本要做的事情很简单,就是把所有源文件的 *.d 文件信息收集起来,然后进行适当的处理就可以了。
脚本如下:
- #!/bin/bash
- # Author: Osprey
- # 本脚本用于生成 MDK 包含的源文件信息
- # 必须使用 MDK 编译后,在工程文件目录下执行本脚本
- dir_obj=./obj # *.d 文件所在目录
- out_file_name=absolute_files.txt # 输出文件名(绝对路径)
- relative_out_file_name=relative_files.txt # 输出文件名(相对路径)
- ###当前路径处理
- # 斜杠替换为反斜杠 \ 也是特殊字符,需要转义 操作 `` 有问题
- curr_dir=`pwd`/
- echo ${curr_dir} | sed 's/\//\\/g' > ${out_file_name} && curr_dir=`cat ${out_file_name}`
- curr_dir=${curr_dir#*\\} # 去除第一个斜杠
- # 第一个反斜杠替换 :\
- echo ${curr_dir} | sed 's/\\/:\\/' > ${out_file_name} && curr_dir=`cat ${out_file_name}`
- # 替换 \ 为 \\ 防止 sed 命令出错
- echo ${curr_dir} | sed 's/\\/\\\\/g' > ${out_file_name} && curr_dir=`cat ${out_file_name}`
- echo "curr dir: ${curr_dir}"
- # *.d 文件中包含了源文件信息所以不需要从 *.uvoptx 中提取,下面这些 if 里面的命令没有意义
- if false ; then
- dir_uvoptx=./
- file_uvoptx=`find ${dir_uvoptx} -name "*.uvoptx"`
- echo "file the name: ${file_uvoptx}"
- sed -i "s/ <PathWithFileName>/"${curr_dir}"/g" ${out_file_name}
- sed -i 's/<\/PathWithFileName>//g' ${out_file_name}
- fi
- # 首先进入目录
- cd ${dir_obj}
- temp_file_name=temp_files.txt
- find ./ -name "*.d" | xargs cat > head_temp.txt # 合并所有 d 文件
- if [[ ! -s head_temp.txt ]]
- then
- echo "file is null, please build the project" # 文件空白
- exit 0
- fi
- # 去除重复文件,并排序
- sort -u head_temp.txt > head_temp1.txt
- # 去除标准头文件 搜索关键 ':\' (包含了标准头文件),分隔符 ':' 去除 *.O 文件名 'o: ..' 'o: \.\.'
- cat head_temp1.txt | grep -v ':\\' | awk -F ": " '{print $2}' > head_temp.txt
- # 替换 / 为 \
- sed -i 's/\//\\/g' head_temp.txt
- # 添加绝对路径
- absolute_files=../${out_file_name}
- echo "add absolute dir: ${curr_dir}" # 双反斜杠是为了防止 sed 命令出错
- #行首(^ 代表行首)添加绝对路径字符串
- sed "s/^/"${curr_dir}"/g" head_temp.txt > ${absolute_files}
- # 添加相对路径(去除 ..\ )必须用单引号(根据 SI 工程的情况决定是否去除 ..\)
- relative_files=../${relative_out_file_name}
- sed 's:\.\.\\::g' head_temp.txt > ${relative_files}
- rm head_temp.txt head_temp1.txt # 删除文件
- cnt=`wc ${absolute_files} | awk '{print $2}'` # 计文件数
- echo "all files is saved in file: ${absolute_files##*/} && ${relative_files##*/}, files number is: ${cnt} "
这个脚本会在当前目录下生成两个文件,absolute_files.txt 和 relative_files.txt ,里面包含了两种路径信息,如果使用相对路径的话,可以使用 relative_files.txt 导入到 SI 工程中,比如通过下面的 “add from list”导入这个文件 relative_files.txt:
那么如何使用这个脚本呢?
特别注意,工程路径中不要有中文,否则执行失败(下面的截图路径是中文,所以会失败)
0、编译 MDK ,产生 *.d 文件
1、把脚本保存到一个文件中,比如 mdk_list.sh
2、将脚本复制到工程目录下
修改脚本的 *.d 文件夹路径,这里的路径为 obj,
3、打开 git bash
4、执行刚才的脚本(这里的后缀可以随便,没有关系),可以在脚本目录下生成两个文件
- ./mdk_lsit.sh.txt
生成的头文件路径中不存在标准头文件(可自行修改脚本支持),因为这个一般在 MDK 安装目录下,所以就去除了这些信息。
5、可以打开文件查看信息:
绝对路径:
相对路径:
特别注意:在使用 SI 导入该文件时,SI 工程路径必须和 MDK 工程保持一致。
即下面两个文件(夹)必须在同一目录下才能顺利添加进去。
如果 MDK 工程文件在子文件夹下,那么 SI 工程也必须在子文件夹下,否则 SI 导入时将失败,毕竟在使用相对路径时,不能找到对应文件当然会失败,但是使用绝对路径没有这个要求,但会影响 SI 工程的使用(不能随便移动工程或者重命名),可以自行修改脚本功能使其适用与不同情况。
总之,基本的脚本功能和思路已经提供给大家了,如何根据实际情况修改就是各位道友的问题了,建议大家简单学习一下这些脚本知识,可以帮助大家很方便的处理一些简单工作,比如替换、搜索、重命名、计数、数字比较等功能。
最后友情提醒,删除源文件时,需要有备份或者 git 管理,否则删错了可就后悔莫及了。