用VSCode和CMake編寫調(diào)試C/C++

這篇文章的首要目的是,通過配置VSCode,達(dá)到全平臺(tái)的一致C/C++開發(fā)體驗(yàn)

對(duì)于編寫C/C++的環(huán)境,我們至少需要有文本編輯器、C/C++編譯器,最好還能有C/C++調(diào)試器。

VSCode本質(zhì)上是一個(gè)文本編輯器,但是它有豐富的插件生態(tài),通過插件我們可以對(duì)C/C++程序進(jìn)行調(diào)試。而且,它擁有可自定義的任務(wù)系統(tǒng),通過任務(wù),可以封裝一些操作,化繁為簡。

如果談編譯器調(diào)試器的話,一般來講,這兩個(gè)東西是成雙成對(duì)的,由gccg++編譯的程序,使用gdb進(jìn)行調(diào)試,由clang編譯的程序使用lldb進(jìn)行調(diào)試,由msvc編譯的程序用msvc進(jìn)行調(diào)試。除了msvc之外,其他的編譯器調(diào)試器都是可以跨平臺(tái)(Windows上通過Mingw實(shí)現(xiàn))。 這幾種編譯器調(diào)試器占據(jù)了大部分市場,所以實(shí)際上也沒得選,根據(jù)平臺(tái),LinuxGNUgcc、g++gdb是主流,macOS下,clang+lldb是主流,使用GNU的也不能算少。Windows平臺(tái)下比較復(fù)雜,主要有兩種,一種是通過Mingw使用gcc的,另一種則是使用微軟出品的宇宙最強(qiáng)IDEVisual Studio

上面提到全平臺(tái)的一致C/C++開發(fā)體驗(yàn),但是不同編譯器、調(diào)試器的使用方式并不相同。調(diào)試器的問題,VSCode通過C/C++插件已經(jīng)解決了。而編譯器的問題,需要一個(gè)通用的編譯構(gòu)建工具,通過CMake生成Makefile并編譯。

CMake is an open-source, cross-platform family of tools designed to build, test and package software. CMake is used to control the software compilation process using simple platform and compiler independent configuration files, and generate native makefiles and workspaces that can be used in the compiler environment of your choice.

到這里,梳理一下需要用到的東西。

  1. 文本編輯器:Visual Studio Code。
  2. C/C++編譯器:gcc/g++(Linux)、clang(macOS)、msvc(Windows)。
  3. C/C++調(diào)試器:gdb(Linux)、lldb(macOS)、msvc(Windows)。
  4. 構(gòu)建工具:CMake、Make。

下面說明環(huán)境的安裝和配置步驟。

  1. 根據(jù)平臺(tái)下載安裝Visual Studio Code。

  2. 打開VSCode,搜索安裝擴(kuò)展C/C++CMake。

    1. C/C++。這個(gè)擴(kuò)展的作用是C/C++代碼提示和高亮、調(diào)試和代碼文件關(guān)聯(lián)跳轉(zhuǎn)。
      vsccc.png
    2. CMake。這個(gè)擴(kuò)展的作用是CMake語法提示和高亮。
      vsccmake.png
  3. 安裝編譯器和調(diào)試器。

    1. Windows
      下載并安裝Visual Studio Community 。
      安裝使用C++的桌面開發(fā)。

      vscc.png

    2. Linux

      1. Debian系列(Debian/Ubuntu)

        sudo apt install gcc
        sudo apt install g++
        sudo apt install gdb
        sudo apt install make
        
      2. Redhat系列(RHEL/CentOS/Fedora)

        sudo yum install gcc
        sudo yum install g++
        sudo yum install gdb
        sudo yum install make
        
      3. 其它源碼安裝(自行搜索安裝方式)

    3. macOS

      xcode-select --install
      
  4. 安裝CMake

    1. Windows
      如果安裝的Visual Studio Community版本大于2017,并選擇了用于Windows的CMake工具,則不需要單獨(dú)安裝CMake

    2. Linux

      1. Debian系列(Debian/Ubuntu)

        sudo apt install cmake
        
      2. Redhat系列(RHEL/CentOS/Fedora)

        sudo yum install cmake
        
    3. macOS

      安裝CMake需要用到brew,首先安裝brew。

      /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
      
      brew install cmake
      
    4. 也可以選擇官網(wǎng)安裝

      cmake.png

      根據(jù)平臺(tái)下載并安裝相應(yīng)的安裝包安裝。

  5. 此時(shí),所需要的工具都已經(jīng)安裝完畢。
    創(chuàng)建我們的C/C++項(xiàng)目文件夾,這里命名為CStart,并用VSCode打開該文件夾。
    新建下列文件結(jié)構(gòu)

    CStart
    │—— CMakeLists.txt
    │—— main.c
    |—— .vscode
    │—— │—— launch.json
    │—— │—— tasks.json
    
  6. 使用CMake構(gòu)建C/C++項(xiàng)目
    CMakeLists.txt 項(xiàng)目cmake配置文件。關(guān)于CMakeLists.txt的編寫,展開來講有點(diǎn)長,可以到網(wǎng)上搜索相關(guān)教程。這是一個(gè)最簡單的版本。通過這個(gè)文件,統(tǒng)一全平臺(tái)下的項(xiàng)目管理與構(gòu)建配置

    cmake_minimum_required (VERSION 2.8) #最低要求的CMake版本
    project(CStart) # 項(xiàng)目名稱
    file(GLOB SRC_FILE *.c) # 建立變量SRC_FILE為目錄下.c文件列表
    add_executable (${PROJECT_NAME} ${SRC_FILE}) # 要求編譯可執(zhí)行文件
    

    main.c 簡單的HelloWorld代碼

    #include <stdio.h>
    
    int main(void) {
        printf("Hello world\n");
        return 0;
    }
    

    CMake簡易教程

  7. VSCode配置編譯任務(wù)與調(diào)試對(duì)象
    在配置的時(shí)候會(huì)用到一些vscode的變量,用${}包裹起來的那些。
    ${workspaceFolder}是當(dāng)前工作空間(或vscode所打開根文件夾)在操作系統(tǒng)中絕對(duì)路徑
    ${workspaceFolderBasename}是當(dāng)前工作空間(或vscode所打開根文件夾)的名稱

    tasks.json 這是VSCode任務(wù)的配置文件,通過配置它可以快速執(zhí)行各種命令。這里我們利用它來配置編譯構(gòu)建流程。我們要執(zhí)行的任務(wù)為建立build文件夾,在build文件夾中使用CMake生成并編譯。通過這個(gè)任務(wù)配置,統(tǒng)一全平臺(tái)下的程序編譯命令。

    {
        // See https://go.microsoft.com/fwlink/?LinkId=733558
        // for the documentation about the tasks.json format
        "version": "2.0.0",
        "tasks": [
            { // 在根文件夾中執(zhí)行創(chuàng)建文件夾build的命令
                // 除windows系統(tǒng)外執(zhí)行的命令為`mkdir -p build`
                // windows系統(tǒng)是在powershell中執(zhí)行命令`mkdir -Force build`
                "label": "build_dir",
                "command": "mkdir",
                "type": "shell",
                "args": [
                    "-p",
                    "build"
                ],
                "windows": {
                    "options": {
                        "shell": {
                            "executable": "powershell.exe"
                        }
                    },
                    "args": [
                        "-Force",
                        "build"
                    ],
                }
            },
            { // 在build文件夾中調(diào)用cmake進(jìn)行項(xiàng)目配置
                // 除windows系統(tǒng)外執(zhí)行的命令為`cmake -DCMAKE_BUILD_TYPE=<Debug|Release|RelWithDebInfo|MinSizeRel> ../`
                // windows系統(tǒng)是在visual stuido的環(huán)境中執(zhí)行命令`cmake -DCMAKE_BUILD_TYPE=<Debug|Release|RelWithDebInfo|MinSizeRel>  ../ -G "CodeBlocks - NMake Makefiles"`
                "label": "cmake",
                "type": "shell",
                "command": "cmake",
                "args": [
                    "-DCMAKE_BUILD_TYPE=${input:CMAKE_BUILD_TYPE}",
                    "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON", // 生成compile_commands.json 供c/c++擴(kuò)展提示使用
                    "../"
                ],
                "options": {
                    "cwd": "${workspaceFolder}/build",
                },
                "windows": {
                    "args": [
                        "-DCMAKE_BUILD_TYPE=${input:CMAKE_BUILD_TYPE}",
                        "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON",
                        "../",
                        "-G",
                        "\"CodeBlocks - NMake Makefiles\""
                    ],
                    "options": {
                        "shell": {
                            // "executable": "C:\\Program Files (x86)\\Microsoft Visual Studio 12.0\\VC\\vcvarsall.bat",
                            // 需要根據(jù)安裝的vs版本調(diào)用vs工具命令提示符
                            "executable": "C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community\\VC\\Auxiliary\\Build\\vcvarsall.bat",
                            "args": [
                                "${input:PLATFORM}", //指定平臺(tái)
                                "-vcvars_ver=${input:vcvars_ver}", //指定vc環(huán)境版本
                                "&&"
                            ]
                        }
                    },
                },
                "dependsOn": [
                    "build_dir" // 在task `build_dir` 后執(zhí)行該task
                ]
            },
            { // 在build文件夾中調(diào)用cmake編譯構(gòu)建debug程序
                // 執(zhí)行的命令為`cmake --build ./ --target all --`
                //  windows系統(tǒng)如上需要在visual stuido的環(huán)境中執(zhí)行命令
                "label": "build",
                "group": "build",
                "type": "shell",
                "command": "cmake",
                "args": [
                    "--build",
                    "./",
                    "--target",
                    "all",
                    "--"
                ],
                "options": {
                    "cwd": "${workspaceFolder}/build",
                },
                "problemMatcher": "$gcc",
                "windows": {
                    "options": {
                        "shell": {
                            // "executable": "C:\\Program Files (x86)\\Microsoft Visual Studio 12.0\\VC\\vcvarsall.bat",
                            "executable": "C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community\\VC\\Auxiliary\\Build\\vcvarsall.bat",
                            "args": [
                                "${input:PLATFORM}",
                                "-vcvars_ver=${input:vcvars_ver}",
                                "&&"
                            ]
                        }
                    },
                    "problemMatcher": "$msCompile"
                },
                "dependsOn": [
                    "cmake" // 在task `cmake` 后執(zhí)行該task
                ]
            }
        ],
        "inputs": [
            {
                "id": "CMAKE_BUILD_TYPE",
                "type": "pickString",
                "description": "What CMAKE_BUILD_TYPE do you want to create?",
                "options": [
                    "Debug",
                    "Release",
                    "RelWithDebInfo",
                    "MinSizeRel",
                ],
                "default": "Debug"
            },
            {
                "id": "PLATFORM",
                "type": "pickString",
                "description": "What PLATFORM do you want to create?",
                "options": [
                    "x86",
                    "amd64",
                    "arm",
                    "x86_arm",
                    "x86_amd64",
                    "amd64_x86",
                    "amd64_arm",
                ],
                "default": "amd64"
            },
            {
                "id": "vcvars_ver",
                "type": "pickString",
                "description": "What vcvars_ver do you want to create?",
                "options": [
                    "14.2", // 2019
                    "14.1", // 2017
                    "14.0", // 2015
                ],
                "default": "14.2"
            }
        ]
    }
    

    launch.json 這是VSCode運(yùn)行調(diào)試的配置文件。全平臺(tái)統(tǒng)一的調(diào)試體驗(yàn)就靠它了。依賴于VSCode的C/C++擴(kuò)展。這里需要告訴VSCode你的C/C++程序在哪,以及運(yùn)行參數(shù),工作目錄等,用哪個(gè)調(diào)試器調(diào)試

    {
        // 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", //調(diào)試類型,除使用msvc進(jìn)行調(diào)試外,均為該類型
                "request": "launch",
                "program": "${workspaceFolder}/build/${workspaceFolderBasename}", //指定C/C++程序位置
                "args": [], //指定運(yùn)行參數(shù)
                "stopAtEntry": false,
                "cwd": "${workspaceFolder}", //指定工作目錄
                "preLaunchTask": "build", //在調(diào)試前會(huì)先調(diào)用build_debug這個(gè)task編譯構(gòu)建程序
                "environment": [],
                "externalConsole": false,
                "osx": { //macOS的特定配置
                    // "miDebuggerPath": "/Applications/Xcode.app/Contents/ Developer/usr/bin/lldb-mi", //修改使用的lldb-mi,一般不需要修改
                    "MIMode": "lldb" //指定使用lldb進(jìn)行調(diào)試
                },
                "linux": { //linux的特定配置
                    "MIMode": "gdb", //指定使用gdb調(diào)試
                    "setupCommands": [
                        {
                            "description": "Enable pretty-printing for gdb",
                            "text": "-enable-pretty-printing",
                            "ignoreFailures": true
                        }
                    ]
                },
                "windows": { //windows的特定配置
                    "type": "cppvsdbg", //指定使用msvc進(jìn)行調(diào)試
                    "program": "${workspaceFolder}/build/${workspaceFolderBasename}.exe", //指定C/C++程序位置
                }
            }
        ]
    }
    
  8. 加入斷點(diǎn),左鍵單擊即可,右鍵可以設(shè)置條件斷點(diǎn)等。

    breakmain.png

  9. 按下F5,VSCode開始執(zhí)行launch.json的命令,在執(zhí)行前會(huì)先運(yùn)行preLaunchTask,編譯C代碼。
    終端界面可以看到編譯的過程。

    build.png

    編譯完成后,文件目錄變成了這個(gè)樣子,生成了Makefile文件和可執(zhí)行文件還有調(diào)試信息,以及CMake緩存信息。
    files.png

    程序運(yùn)行到斷點(diǎn)處,如下圖。
    break.png

    左側(cè)為當(dāng)前的變量信息,還有上邊有調(diào)試的控制條,
    |繼續(xù)|單步跳過|單步調(diào)試|單步跳出|重啟|停止。
    切換到調(diào)試控制臺(tái)界面,看到輸出了庫文件和調(diào)試信息加載過程。
    debug.png

    單擊調(diào)試控制條的繼續(xù)。輸出Hello World,程序退出返回0。
    hello .png

  10. 有時(shí)候我們只想編譯,不想運(yùn)行程序,可以單獨(dú)運(yùn)行task: build_debug

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評(píng)論 6 544
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,687評(píng)論 3 429
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 178,640評(píng)論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評(píng)論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,682評(píng)論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 56,011評(píng)論 1 329
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評(píng)論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,183評(píng)論 0 290
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,714評(píng)論 1 336
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,435評(píng)論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,665評(píng)論 1 374
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評(píng)論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,838評(píng)論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評(píng)論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評(píng)論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,379評(píng)論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,627評(píng)論 2 380

推薦閱讀更多精彩內(nèi)容