CLion是一個 IDE，它提供了許多功能來幫助開發(fā)人員。它顯示文檔彈出窗口、動態(tài)檢測錯誤、建議修復(fù)等。內(nèi)部代碼分析器始終在后臺運行，在您鍵入時分析 C 和 C++ 代碼。C 和 C++ 對于自動分析器來說是具有挑戰(zhàn)性的語言，因為正確解析代碼需要特定于編譯器的數(shù)據(jù)。引擎需要知道標(biāo)題搜索路徑、預(yù)定義的宏定義和其他一些細(xì)節(jié)。

對于一組預(yù)定義的已知編譯器，CLion 使用特殊選項運行項目的編譯器，并在解析項目時收集所需的信息。當(dāng)然，這只適用于有限數(shù)量的編譯器，如 GCC、Clang、MSVC、IAR 及其衍生產(chǎn)品。如果項目使用特定的自定義編譯器、很少使用的編譯器或我們無法訪問的專有編譯器以正確集成它，那么 CLion 無法通過其標(biāo)準(zhǔn)過程使用它。在這種情況下，您可以選擇使用自定義編譯器功能。

要在 CLion 中使用自定義編譯器，您需要一個包含必要編譯器數(shù)據(jù)的 YAML 文件。這樣的文件應(yīng)該包含一個或多個部分，每個部分描述一個特定的編譯器或編譯器變體。每個部分都應(yīng)該有一個描述、一個或多個匹配記錄和幾個信息記錄。

當(dāng) CLion 解析項目并遇到項目文件的編譯器時，CLion 會逐節(jié)掃描并檢查編譯器是否與記錄匹配。匹配是使用一個或多個匹配記錄完成的。可用的匹配記錄包括：

• match-compiler-exe是一個正則表達(dá)式，并根據(jù)它檢查編譯器名稱。一個很好的獨立于平臺的例子是"(.*/)?sdcc(.exe)?".
• match-source也是一個正則表達(dá)式，它與要編譯的源文件的名稱相匹配。通常它".*\\.c"用于 C 和".*\\.cpp"C++。
• match-args是單個命令行開關(guān)、開關(guān)序列或無序開關(guān)數(shù)組。例如，"-a"匹配參數(shù)-a，"-b -c"匹配參數(shù) -b -c，并["-b", "-c"]匹配其中一個-b -c或-c -b。
• match-language 可能是C或CPP。對于 CMake 項目，它與 CMake 檢測到的語言相匹配；對于其他類型的項目，該聲明被簡單地忽略。

一旦成功解決了所有匹配項，就會選擇節(jié)信息記錄，并跳過 YAML 文件的其余部分。編譯器數(shù)據(jù)取自信息記錄，然后直接傳遞給 CLion 的代碼分析器；也就是說，在編譯器試運行期間不會收集數(shù)據(jù)。

如果沒有任何部分為 IDE 提供將記錄與特定編譯器正匹配的信息，它會嘗試以通常的方式收集編譯器數(shù)據(jù)——通過猜測編譯器的類型并運行編譯器。

如何編寫自定義編譯器 YAML 文件

要開始編寫自定義編譯器 YAML 文件，您需要確定有關(guān)編譯器的以下詳細(xì)信息：

• 您希望支持的語言。每種支持的語言或語言變體都需要至少一個配置部分。
• 編譯器二進(jìn)制名稱。可以有不止一個。一些工具鏈具有不同的 C 和 C++ 編譯器二進(jìn)制文件、不同的內(nèi)存模型、語言變體等。此信息可以在工具鏈文檔中找到，并且必須反映在您的自定義編譯器 YAML 文件中。
• 標(biāo)準(zhǔn)包含文件所在的目錄。要識別這些目錄，請閱讀編譯器的文檔或簡單地瀏覽已安裝的工具鏈文件夾樹。
• 預(yù)定義宏的列表。一些編譯器可以報告其預(yù)定義宏的列表，而另一些則不能。請參閱編譯器的文檔以了解如何為您的編譯器獲取它們。

實際例子

讓我們通過為SmallDevice C Compiler (SDCC)編寫自定義編譯器 YAML 文件來實踐這個過程。SDCC 支持多種 8 位 CPU 架構(gòu)，例如 STM8、Z80 等。該編譯器是開源的，它是多個 MCU 系列的唯一免費編譯器。在此示例中，我們將為其 Microchip PIC-16 變體（端口）編寫一個 YAML 文件。

以下是我們需要了解的有關(guān)此編譯器的詳細(xì)信息：

• 僅支持 C 語言。
• 編譯器二進(jìn)制名稱為sdcc或sdcc.exe（在 Windows 下）。
• 該-mpic16選項對于 PIC16 架構(gòu)支持是強(qiáng)制性的，也--use-non-free應(yīng)該使用。
• 要報告標(biāo)頭搜索路徑的列表，應(yīng)使用該--print-search-dirs選項運行編譯器。
• 要報告預(yù)定義的宏，編譯器應(yīng)該使用-Eand-dM選項和一個空的源文件運行。

我們將從創(chuàng)建一個測試項目開始。最小的項目包含一個 C 文件、YAML 文件本身和一個構(gòu)建系統(tǒng)文件。我們將使用Makefile。如果應(yīng)該使用 C++，那么還應(yīng)該添加另一個用 C++ 編寫的源文件。

首先，創(chuàng)建一個項目文件夾，在里面創(chuàng)建一個空的Makefile。

在 CLion 中打開該文件夾，然后在彈出的“加載項目”對話框中單擊“取消”。

在 CLion 編輯器中打開Makefile并將最少的內(nèi)容添加到該Makefile中：

clean:
    all: main.c
    sdcc -mpic16 --use-non-free -S main.c

該文件現(xiàn)在包含一個將 main.c 編譯成匯編的命令，無需進(jìn)一步的步驟。

創(chuàng)建一個main.c文件。讓我們制作一個經(jīng)典的“Hello, World”，添加 SDCC 特定的附加功能——__code關(guān)鍵字和預(yù)定義的宏__SDCC_pic16。

#include <stdio.h>
int main() {
    printf("Hello, World!\n");
    return 0;
}
int __code i = 0;
#ifndef __SDCC_pic16
#  error "__SDCC_pic16 macro is expected to be defined"
#endif

現(xiàn)在我們編寫一個自定義編譯器配置存根：

創(chuàng)建一個名為clion-custom-compiler-sdcc-pic16.yaml 的文件。

將 JSON 模式“自定義編譯器定義”分配給文件。

自定義編譯器方案已驗證這樣，CLion 可以幫助您進(jìn)行即時文件結(jié)構(gòu)驗證和輸入提示。架構(gòu)名稱顯示在 IDE 狀態(tài)欄中，可以通過單擊名稱來選擇。

存根是：

compilers:
 - description: SDCC for PIC-16
   match-compiler-exe: "(.*/)?sdcc(.exe)?"

目前，我們僅按名稱匹配。它是一個匹配 Linux 和 Windows 編譯器二進(jìn)制名稱的正則表達(dá)式，與包含的文件夾無關(guān)。

下一步是在 CLion 中使用我們的自定義編譯器配置。打開設(shè)置/首選項 | 構(gòu)建、執(zhí)行、部署 | 工具鏈 | 自定義編譯器。選中Use custom compiler config并選擇項目的 YAML 文件作為配置文件。

在工具菜單中選擇Makefile | 清理并重新加載 Makefile 項目。如果一切正常，構(gòu)建工具窗口將顯示項目已成功加載。

如果項目未正確加載，則應(yīng)仔細(xì)檢查 YAML 文件中的match-compiler-exe語句。記錄值是一個正則表達(dá)式，它是過程中最脆弱的部分。

現(xiàn)在讓我們檢查一下 CLion 是否確實已經(jīng)接受了 SDCC，并且我們的項目按預(yù)期工作。

檢查自定義編譯器是否工作

在編輯器中打開main.c。此時可以看到一些錯誤。轉(zhuǎn)到幫助 | 診斷工具并選擇Show Compiler Info。這將打開一個診斷頁面，其中包含正在編輯的文件的編譯器信息。在這里您可以看到編譯器類型（“自定義編譯器”）和檢測到的編譯器描述（“SDCC for PIC-16”）。這意味著 CLion 知道項目結(jié)構(gòu)，但代碼分析器還沒有所需的編譯器數(shù)據(jù)，因此在main.c中顯示各種錯誤。

收集缺失的編譯器信息

main.c文件目前看起來已損壞。未找到stdio.hprintf ，未定義，__code修飾符錯誤，并且未定義文檔中的預(yù)定義宏。

讓我們通過提供正確的編譯器信息來解決所有這些問題。

幸運的是，SDCC 可以打印標(biāo)題位置和預(yù)定義的宏。將以下行添加到Makefile將起到作用：

gather_info:
#   List directories
    sdcc -mpic16 --use-non-free --print-search-dirs
#   Create a void C file
    echo //void > void.c
#   List predefined macros
    sdcc -mpic16 --use-non-free -E -dM void.c

…
includedir:
C:\Program Files\SDCC\bin\..\include\pic16
C:\Program Files\SDCC\bin\..\include
C:\Program Files\SDCC\bin\..\non-free\include\pic16
C:\Program Files\SDCC\bin\..\non-free\include
…

唯一的問題是這些路徑是絕對路徑。出于可移植性的原因，讓我們將它們相對于編譯器位置，并將它們作為include-dirs數(shù)組添加到編譯器定義中。 接下來是預(yù)定義的宏。它們打印在輸出的最底部。它們可以通過定義文本添加到 YAML 文件中。

match-args: -mpic16最后但同樣重要的是，我們需要通過使用and語句使我們的編譯器匹配更具體一些 match-language: C，然后添加 SDCC 語言擴(kuò)展詞作為空定義。完成后，最終的 YAML 文件將如下所示：

compilers:
  - description: SDCC for PIC-16
    match-compiler-exe: "(.*/)?sdcc(.exe)?"
    match-args: -mpic16
    match-language: C
    include-dirs:
      - ${compiler-exe-dir}/../include/pic16
      - ${compiler-exe-dir}/../include
      - ${compiler-exe-dir}/../non-free/include/pic16
      - ${compiler-exe-dir}/../non-free/include
    defines-text: "
#define __SDCC_USE_NON_FREE 1
#define __SDCC_PIC18F452 1
#define __18f452 1
#define __STACK_MODEL_SMALL 1
#define __SDCC_pic16 1
#define __SDCC_ALL_CALLEE_SAVES 1
#define __STDC_VERSION__ 201112L
#define __STDC_HOSTED__ 0
#define __SDCCCALL 0
#define __STDC_UTF_16__ 1
#define __SDCC_VERSION_MINOR 2
#define __STDC_ISO_10646__ 201409L
#define __SDCC_VERSION_PATCH 0
#define __SDCC_VERSION_MAJOR 4
#define __STDC_NO_VLA__ 1
#define __SDCC 4_2_0
#define __STDC_UTF_32__ 1
#define __STDC_NO_THREADS__ 1
#define __SDCC_CHAR_UNSIGNED 1
#define __STDC_NO_ATOMICS__ 1
#define __STDC__ 1
#define __SDCC_REVISION 13081
#define __STDC_NO_COMPLEX__ 1
#define __interrupt
#define __code
#define __at
"

現(xiàn)在我們可以重新加載項目（Tools | Makefile | Reload Makefile Project）并再次檢查main.c文件。

錯誤消失了，可以導(dǎo)航到stdio.h。Show Compiler Info窗口顯示正確的信息——包括預(yù)定義的宏、語言特性和標(biāo)題搜索路徑。

這個最終的 YAML 文件可以在GitHub上找到。

以上就是關(guān)于在 CLion 中使用任意編譯器的快速指南，更多關(guān)于CLion使用教程的內(nèi)容可進(jìn)入官網(wǎng)查看。

CLion| 下載試用

CLion是一款專為開發(fā)C及C++所設(shè)計的跨平臺IDE。它是以IntelliJ為基礎(chǔ)設(shè)計的，包含了許多智能功能來提高開發(fā)人員的生產(chǎn)力。

CLion技術(shù)交流QQ群：786598704      歡迎進(jìn)群一起討論