日前在學習制作LearnOpenGL教程的實戰專案Breakout游戲時,希望能將這個小游戲開發成跨平臺的,支持在多個平臺運行,工欲善其事必先利其器,首先需要做的自然是搭建一個舒服的跨平臺C/C++開發環境,所以這篇文章主要就是記錄環境搭建的整個程序,踩到的一些坑,以及對應的解決辦法,
正文開始之前,先來闡述幾個問題
- 為什么選擇使用VSCode
- 實在用不習慣Visual Studio(也可能是用的太少了T▽T)
- 代碼編輯方面更喜歡用輕量級的編輯器,比如Sublime或者VSCode
- VSCode確實比較強大好用,插件豐富
- 為什么使用CMake
- 通用的編譯構建工具,跨平臺的關鍵,一份代碼,CMake可以針對不同的系統編譯構建生成不同的專案工程
- 源代碼管理,編譯更加方便(如果僅僅使用VSCode搭建開發環境,則每添加一個源檔案,就要改動一下編譯指令)
- 最終實作的開發流程是怎樣的
- VSCode撰寫代碼
- 快捷鍵
Ctrl+Shift+B,呼叫CMake完成本地專案生成(Mac快捷鍵Command+Shift+B) - 快捷鍵
Ctrl+B,完成專案的編譯構建與運行(Mac快捷鍵Command+B) - 快捷鍵
F5,完成專案的除錯與運行(VSCode的F5除錯運行,為了能夠實作除錯功能額外做了許多作業,所以啟動會有些慢,因此在不需要除錯的時候,直接使用Ctrl+B編譯運行看效果會更快些)
開發工具
CMake與VSCode
- CMake的獲取,可以查看CMake官網
- VSCode的獲取,可以查看VSCode官網
- 關于CMake與VSCode如何安裝,比較簡單,網上也有很多教程,這里就不詳細介紹了
VSCode插件推薦安裝
- 在VSCode的
Extensions面板中搜索下面的插件名即可,記得看清作者名,不要下錯啦
| 插件名 | 作者 | 描述 |
|---|---|---|
| C/C++ | Microsoft | 提供C/C++的代碼提示,跳轉,除錯等諸多功能,官方出品,基本是C/C++開發必備了 |
| CMake | twxs | 提供CMake語法的高亮顯示以及代碼段提示 |
示例專案
這里給出例子工程的檔案目錄情況,并不完整,但具有一定的代表性,不僅涉及源代碼的編譯,同樣包含了靜態庫,動態庫的加載,以及資源檔案的讀取等問題
Breakout
├── 3rd // 第三方庫
│ ├── glfw // 一個靜態庫目錄
│ ├── irrKlang-1.6.0 // 一個動態庫目錄
│ └── FindIrrKlang.cmake // cmake檔案
├── resources // 資源目錄
│ ├── textures // 存放貼圖檔案
│ └── shaders // 存放shader檔案
├── src // 源代碼目錄
│ ├── game // 源代碼子目錄
│ │ ├── game.h
│ │ └── game.cc
│ └── main.cc
└── CMakeLists.txt // cmake檔案
使用CMake
本文僅著重介紹為了完成示例專案開發,解決特定問題而使用的一些cmake陳述句,詳細的cmake介紹可以查看這份還不錯的檔案或者這篇博文
cmake的所有陳述句都寫在CMakeLists.txt中,cmake會根據該檔案中的配置完成最終的編譯,構建,打包,測驗等一系列任務
一個簡單的CMakeLists.txt如下所示,完整的檔案可以查看這里
# cmake最低版本號要求
cmake_minimum_required (VERSION 2.8)
# 設定PROJECT_NAME變數
set(PROJECT_NAME Breakout)
# 設定工程名
project (${PROJECT_NAME})
# 查找當前目錄下的所有源檔案并存入DIR_SRCS變數
aux_source_directory(src DIR_SRCS)
# 添加一個可編譯的目標到工程
add_executable (${PROJECT_NAME} ${DIR_SRCS})
如何編譯一個檔案夾下的所有源代碼
在開發程序中,由于架構設計或是為了便于管理與查找,源檔案一般會根據不同的功能存放在不同的檔案夾中,檔案夾中又可能嵌入檔案夾,所以需要一條陳述句能夠獲取所有的源檔案進行編譯,而不用每新創建一個源檔案,就修改一次編譯指令
# 遞回列出所有源檔案
file (GLOB_RECURSE SOURCE_FILES *.cc)
# 添加一個可編譯的目標到工程
add_executable (${PROJECT_NAME} ${SOURCE_FILES})
上面這條file命令會遞回列出所有.cc檔案,并存入SOURCE_FILES變數,然后將SOURCE_FILES表示的所有.cc檔案添加到目標即可,從而解決多源檔案編譯問題
如何引入一個第三方靜態庫
為了不重復造輪子,開發中不可避免的要引入其他第三方庫,正常情況下,這個第三方庫也會是一個CMake工程(或是庫的開發者直接提供已經編譯好的庫)
以示例專案引入的glfw庫為例
- 添加submodule引入glfw(glfw正好是github上的一個開源專案),或是直接將第三方庫的原始碼放到自己的目錄中
git submodule add https://github.com/glfw/glfw.git
- 使用add_subdirectory命令,將glfw所在的檔案夾添加到編譯的任務串列中
# 保證glfw dir被編譯
add_subdirectory (${GLFW_DIR})
- 將glfw的頭檔案目錄添加到頭檔案搜索路徑中
# 添加頭檔案搜索路徑
include_directories (${GLFW_DIR}/include)
- 鏈接glfw庫,target_link_libraries命令用來鏈接目標與庫檔案,第一個引數就是我們的構建目標,后面可以跟多個引數,來表示鏈接多個庫
# 添加鏈接庫
target_link_libraries (${PROJECT_NAME} glfw)
動態庫的加載問題
以示例專案引入的irrKlang庫為例,它并不是一個開源專案,不過好在它提供了已經在多個平臺上編譯好的庫,所以我們需要根據不同的平臺來設定引入不同的庫檔案
- 利用find_package引入外部依賴包,它可以幫我們找到官方預定義的許多依賴包模塊,當未在官方預定義的依賴中找到時,會再查找FindXXX.cmake檔案,執行該檔案從而找到XXX庫,更詳細的介紹可以查看這篇文章
# IrrKlang
find_package (IrrKlang REQUIRED)
- 先新建FindIrrKlang.cmake檔案,由它來負責具體的irrKlang庫加載,部分陳述句如下所示,主要是根據當前平臺的不同,設定不同的頭檔案路徑,庫路徑,庫所在目錄等變數,用到的find_library陳述句可以實作直接根據庫的base name(即不需要lib,so等),找到對應的庫,并存入IRRKLANG_LIBRARY變數
find_path(IRRKLANG_INCLUDE_DIR NAMES irrKlang.h PATHS "${3RD_DIR}/irrKlang-1.6.0/include")
IF(WIN32) # win32平臺
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
message(STATUS "Using MSVC")
set (IRRKLANG_LIB_DIR "${3RD_DIR}/irrKlang-1.6.0/lib/Win32-visualStudio")
set (IRRKLANG_BIN_DIR "${3RD_DIR}/irrKlang-1.6.0/bin/Win32-visualStudio")
find_library(IRRKLANG_LIBRARY NAMES irrKlang PATHS ${IRRKLANG_LIB_DIR})
elseif("${CMAKE_CXX_COMPILED_ID}" STREQUAL "GNU")
message(STATUS "Using GCC")
set (IRRKLANG_LIB_DIR "${3RD_DIR}/irrKlang-1.6.0/lib/Win32-gcc")
set (IRRKLANG_BIN_DIR "${3RD_DIR}/irrKlang-1.6.0/bin/Win32-gcc")
find_library(IRRKLANG_LIBRARY NAMES libirrKlang.a PATHS ${IRRKLANG_LIB_DIR})
endif()
elseif(APPLE) # mac平臺
set (IRRKLANG_BIN_DIR "${3RD_DIR}/irrKlang-1.6.0/bin/macosx-gcc")
find_library(IRRKLANG_LIBRARY NAMES libirrklang.dylib PATHS "${3RD_DIR}/irrKlang-1.6.0/bin/macosx-gcc")
elseif(UNIX AND NOT APPLE) # 等同于linux平臺
set (IRRKLANG_BIN_DIR "${3RD_DIR}/irrKlang-1.6.0/bin/inux-gcc")
find_library(IRRKLANG_LIBRARY NAMES IrrKlang PATHS "${3RD_DIR}/irrKlang-1.6.0/bin/linux-gcc")
endif()
- 將找到的irrKlan頭檔案添加到頭檔案搜索路徑中
include_directories (${IRRKLANG_INCLUDE_DIR})
- 鏈接irrKlang庫
# 添加鏈接庫
target_link_libraries (${PROJECT_NAME} glfw ${IRRKLANG_LIBRARY})
utf-8編碼格式的代碼通過visual studio編譯報錯問題
跨平臺的代碼,一般使用utf-8編碼格式的代碼,更加通用,也可以保證在MacOS或者Linux平臺上的正常編譯,
但是visual studio默認編譯檔案的編碼是utf-8 with bom,在沒有中文的情況下,直接編譯是沒有問題的,然而當源檔案含有中文時(比如中文注釋),則可能會出現例外,報一些莫名其妙的語法錯誤,解決辦法是通過CMake陳述句通知MSVC編譯時采用utf-8編碼
# 設定MSVC編譯編碼
add_compile_options("$<$<CXX_COMPILER_ID:MSVC>:/source-charset:utf-8>")
可執行檔案的作業目錄問題
當編譯構建生成可執行檔案后,我們希望可以直接通過命令列命令啟動可執行檔案來查看效果,但是由于作業目錄的問題,可能會導致出現資源檔案找不到,或者庫加載失敗問題
對于visual studio工程,可以通過CMake陳述句設定其作業目錄,但是這個作業目錄僅在通過visual studio除錯啟動時才會生效,但對于直接啟動可執行檔案的情況仍然是沒用的
# 設定作業目錄
set_property(TARGET ${PROJECT_NAME} PROPERTY VS_DEBUGGER_WORKING_DIRECTORY
${CMAKE_SOURCE_DIR}/resources
)
所以只能將資源檔案目錄放置到可執行檔案所在目錄下,以保證一定能加載到需要的資源,這可以通過CMake的自定義命令實作
# 復制資源檔案到作業目錄
add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_SOURCE_DIR}/resources
$<TARGET_FILE_DIR:${PROJECT_NAME}>/resources
)
這條陳述句的功能是在編譯結束后,將指定的資源目錄復制到生成的可執行檔案所在的目錄,
同樣的,對于一些動態庫,比如dylib,dll等也需要復制,不過注意最好在編譯前就將它們復制到目標目錄,使用PRE_BUILD指明命令執行的時機
# 復制庫到作業目錄
add_custom_command(TARGET ${PROJECT_NAME} PRE_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${IRRKLANG_BIN_DIR}
$<TARGET_FILE_DIR:${PROJECT_NAME}>
)
關于add_custom_command詳細介紹可以查看這里
如何修改Mac上動態庫的加載路徑
在Mac上啟動可執行檔案時,一直遇到一個動態庫無法加載的報錯
dyld: Library not loaded: /usr/local/lib/libirrklang.dylib
Referenced from: ...
Reason: image not found
這是由于在編譯生成動態庫時,可以指定動態庫的加載路徑,比如我們引入的libirrklang庫默認會到/usr/local/lib目錄下查找dylib檔案
簡單的解決方式,自然是通過install命令,將libirrklang.dylib檔案安裝到/usr/local/lib目錄下,不過為了不“污染”其他目錄,更希望可執行檔案加載的是我們放置在其所在目錄下的libirrklang.dylib檔案,為了實作這個目標,我們添加下面的CMake陳述句
if(APPLE)
add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
COMMAND install_name_tool -change /usr/local/lib/libirrklang.dylib @executable_path/libirrklang.dylib ${PROJECT_NAME}
)
endif()
判斷如果是Mac平臺,則通過add_custom_command呼叫install_name_tool命令,來修改應該應用程式對動態庫的查找路徑,其中的@executable_path就表示可執行檔案所在目錄
關于動態庫加載路徑涉及到的rpath,executable_path,install_name_tool的詳細介紹可以查看這里
利用VSCode的task.json執行指定命令
CMake的組態檔已經基本準備完畢了,接下來就是怎樣結合VSCode更方便的呼叫CMake的問題了
通過Ctrl+Shift+B執行CMake編譯本地工程
Ctrl+Shift+B是VSCode呼叫task的默認快捷鍵,task定義在.vscode目錄下的task.json檔案中,一般使用task來完成編譯等任務,VSCode任務系統提供了豐富的引數配置,我們可以利用它完成很多自定義任務
- 定義一個task,執行
cmake ..命令,完成本地專案的編譯生成,Linux會生成Makefile,MacOS生成Makefile或Xcode工程,Windows下生成Visual Studio工程,注意這里的..表示的是上層目錄,因為我們會在專案根目錄下新建一個build檔案夾,然后在這個檔案夾內完成一系列的編譯作業,這樣cmake生成的中間檔案都在build目錄,不會“污染”開發目錄(將build目錄加入.gitignorej即可忽略CMake所產生的所有中間檔案),在編譯出問題的時候也可以直接洗掉buidl目錄重新編譯
{
"label": "cmake", // task的名字
"type": "shell",
"command": "cmake",
"args": [
// "-DCMAKE_BUILD_TYPE=${input:CMAKE_BUILD_TYPE}",
".."
],
"options": {
"cwd": "build" // 表示當前執行目錄build檔案夾
},
"group": "build",
"presentation": { // 一些控制臺顯示配置
"echo": true,
"reveal": "always",
"focus": false,
"panel": "shared",
"showReuseMessage": true,
"clear": true
},
// Use the standard MS compiler pattern to detect errors, warnings and infos
"problemMatcher": "$msCompile",
"dependsOn":["mkbuild"] // 依賴的任務,在本任務執行前先執行mkbuild任務
}
- 在
cmake ..命令執行前,先通過task執行mkdir新建build檔案夾,其中通過windows引數,區分不同平臺設定不同的引數
{
"label": "mkbuild",
"type": "shell",
"command": "mkdir", // 呼叫的命令
"args": [ // 命令引數
"-p",
"build"
],
"windows":{ // windows平臺使用mkdir -Force build新建檔案夾
"args": [
"-Force",
"build"
]
},
"group": "build",
"presentation": {
"echo": true,
"reveal": "always",
"focus": false,
"panel": "shared",
"showReuseMessage": true,
"clear": true
},
// Use the standard MS compiler pattern to detect errors, warnings and infos
"problemMatcher": "$msCompile",
}
- 當按下Ctrl+Shift+B時,VSCode將彈出所有可執行的task,選擇執行cmake task即可,由于定義了依賴(dependsOn),在cmak task執行前,將自動先執行mkbuild task

通過Ctrl+B構建與運行可執行檔案
- 在啟動可執行檔案前,先通過
cmake --build .構建生成可執行檔案
{
"label": "compile",
"type": "shell",
"command": "cmake --build .",
"options": {
"cwd": "build"
},
"group": "build",
"presentation": {
// Reveal the output only if unrecognized errors occur.
"reveal": "always",
"clear": true
},
// Use the standard MS compiler pattern to detect errors, warnings and infos
"problemMatcher": "$msCompile"
}
- 在可執行檔案生成后,通過task啟動可執行檔案,其中的${workspaceFolderBasename}是VSCode的內置變數,表示工程名,更多的內置變數介紹可以查看這里
{
"label": "run",
"type": "shell",
"command": "./${workspaceFolderBasename}",
"group": "build",
"presentation": {
"echo": true,
"reveal": "always",
"focus": false,
"panel": "shared",
"showReuseMessage": true,
"clear": true
},
"options": {
"cwd": "build"
},
"windows":{
"options": {
"cwd": "build/Debug" // windows visual studio專案會默認多生成Debug/Release目錄
},
},
// Use the standard MS compiler pattern to detect errors, warnings and infos
"problemMatcher": "$msCompile",
"dependsOn":["compile"] // 在run任務執行前先執行compile任務,確保修改的代碼生效
}
- 通過Ctrl+B直接呼叫run任務,由于編譯運行這個任務經常要用到,如果依然通過Ctrl+Shift+B彈出所有任務,再進一步選擇就會有些麻煩,所以定義一個快捷鍵(讀者可以用同樣的方法設定自己喜歡的快捷鍵)來直接運行run任務
- 打開VSCode快捷鍵設定

- 在彈出的界面中輸入“run build task”搜索,并修改其快捷鍵

- 點擊右上角的翻轉按鈕,進入快捷鍵檔案配置

- 在打開的檔案中,為剛配置的快捷鍵添加引數,告訴它直接啟動名字叫“run”的task
{
"key": "ctrl+b",
"command": "workbench.action.tasks.runTask",
"args" : "run"
}
利用VSCode的launch.json完成除錯
VSCode通過.vscode目錄下的launch.json實作對多個平臺多種語言的除錯支持
通過F5完成專案的除錯與運行
- 配置launch.json檔案以支持C/C++專案的除錯
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Launch Debug", //名稱
"type": "cppdbg", //除錯型別,除使用msvc進行除錯外,均為該型別
"request": "launch",
"program": "${workspaceFolder}/build/${workspaceFolderBasename}", //指定C/C++程式位置
"args": [], //指定運行引數
"stopAtEntry": false,
"cwd": "${workspaceFolder}/build", //指定作業目錄
"preLaunchTask": "compile", //在除錯前會先呼叫這個task編譯構建程式
"environment": [],
"externalConsole": false,
"osx": { //macOS的特定配置
// "miDebuggerPath": "/Applications/Xcode.app/Contents/Developer/usr/bin/lldb-mi", //修改使用的lldb-mi,一般不需要修改
"MIMode": "lldb" //指定使用lldb進行除錯
},
"linux": { //linux的特定配置
"MIMode": "gdb", //指定使用gdb除錯
"setupCommands": [
{
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": true
}
]
},
"windows": { //windows的特定配置
"type": "cppvsdbg", //指定使用msvc進行除錯
"program": "${workspaceFolder}/build/Debug/${workspaceFolderBasename}.exe", //指定C/C++程式位置
}
}
]
}
- F5是VSCode除錯運行的默認快捷鍵,不需要額外配置,啟動除錯后的界面如下所示

通過使用本地工具完成除錯
- 由于cmake在windows平臺會默認生成Visual Stduio工程,所以也可以直接打開生成的解決方案,通過Visual Studio進行除錯
- Mac平臺可以使用
cmake .. -GXcode命令指定生成XCode工程,然后通過XCode進行除錯
參考鏈接
- 文中使用的完整示例專案倉庫
- 文中提到的完整的task.json檔案與launch.json檔案
- 詳細的VSCode配置C/C++開發環境(不涉及CMake)
- 另一篇講解VSCode與CMake搭建C/C++開發環境的文章
- 一篇還不錯的cmake使用檔案
- VSCode官方使用檔案
- VSCode task.json支持的所有欄位介紹
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/99145.html
標籤:C++
上一篇:nginx在手機訪問電腦圖片
下一篇:學習第32天
