問題表現
通過cmake編譯的代碼,在代碼中輸出__FILE__就代碼文件的絕對路徑。在大多數使用__FILE__這宏的,一般都是用於日誌輸出,首先使用絕對路徑會使日誌量膨脹,其次我們最終的程序執行的環境,可能與編譯的環境不一樣,輸出絕對路徑並沒有多大的參考意義
//tests/test.cc
#include <iostream>
int main(int argc, char** argv) {
std::cout << "hello __FILE__=" << __FILE__ << std::endl;
return0;
}
//輸出:hello __FILE__=/home/sylar/test/cmake_test/tests/test.cc
#一個最簡單的CMakeLists.txt
cmake_minimum_required (VERSION 2.8) #要求最低cmake版本
project(sylar) #定義項目名稱
add_executable(test tests/test.cc) #添加一個可執行文件的生成
解決思路
既然__FILE__宏是gcc定義的,默認等於gcc命令中的文件路徑,我們可以通過重新定義該宏來達到我們的目的,如下方式:
g++ tests/test.cc -D__FILE__="\"sylar/test.cc\"" -o test
//輸出:hello __FILE__=sylar/test.cc
爲了讓輸出更有區分度,我在這裏強行改成sylar/test.cc, 在程序執行的時候,輸出了我們預期的結果,說明這種做法是可行的
在cmake中優雅的解決
如果需要在每個源文件的編譯上面都帶上對應的定義(-D__FILE__="“sylar/test.cc”"),那麼CMakeLists.txt裏面就比較混亂了。我們可以把這種定義,封裝到一個cmake函數裏面,當需要使用這個功能的時候,就執行一下這個函數,這樣就可以優雅的解決__FILE__絕對路徑的問題,將絕對路徑變成相對路徑
# utils.cmake
#重新定義當前目標的源文件的__FILE__宏
function(redefine_file_macro targetname)
#獲取當前目標的所有源文件
get_target_property(source_files "${targetname}" SOURCES)
#遍歷源文件
foreach(sourcefile ${source_files})
#獲取當前源文件的編譯參數
get_property(defs SOURCE "${sourcefile}"
PROPERTY COMPILE_DEFINITIONS)
#獲取當前文件的絕對路徑
get_filename_component(filepath "${sourcefile}" ABSOLUTE)
#將絕對路徑中的項目路徑替換成空,得到源文件相對於項目路徑的相對路徑
string(REPLACE ${PROJECT_SOURCE_DIR}/ "" relpath ${filepath})
#將我們要加的編譯參數(__FILE__定義)添加到原來的編譯參數裏面
list(APPEND defs "__FILE__=\"${relpath}\"")
#重新設置源文件的編譯參數
set_property(
SOURCE "${sourcefile}"
PROPERTY COMPILE_DEFINITIONS ${defs}
)
endforeach()
endfunction()
我們將上面的代碼,寫入到utils.cmake文件裏面,然後去修改我們的CMakeLists.txt,讓我們的代碼支持__FILE__輸出相對路徑
cmake_minimum_required (VERSION 2.8)
project(sylar)
include (utils.cmake)
add_definitions(-Wno-builtin-macro-redefined)
add_executable(test tests/test.cc)
redefine_file_macro(test)
redefine_file_macro(test), 爲我們的輸出目標添加__FILE__宏重定義功能
當我們衝定義了__FILE__宏,編譯器會告警 “:0:0: warning: “FILE” redefined [-Wbuiltin-macro-redefined]”, 爲了解決這個告警,我們需要在CMakeLists.txt裏面加上add_definitions(-Wno-builtin-macro-redefined)
重新編譯
最終輸出:hello FILE=tests/test.cc
總結
cmake編譯的__FILE__雖然是絕對路徑,我們可以通過沖定義__FILE__的方式來解決。cmake支持自定義函數,自定義宏的方式,我們利用自定義函數,將我們經常使用的特性封裝到函數裏面,寫到一個單獨的cmake文件裏面,當我們需要使用的時候,只需要include xxx.cmake文件就可以了。