[Linux] C++ 컴파일러에 대하여 (feat. clang/LLVM, clang-format, clang-tidy)

💡 본 문서는 '[Linux] C++ 컴파일러에 대하여 (feat. clang/LLVM, clang-format, clang-tidy)'에 대해 정리해놓은 글입니다.
C++ 파일을 컴파일하기 위해서 많이 사용하는 컴파일러는 gcc와 clang입니다. 본 문에서는 clang에 대한 설명 및 관련 도구들에 대해 정리하였으니 참고하시기 바랍니다.

About clang

C, C++, Obejctive-C, Obejctive-C++ 프로그래밍 언어를 위한 컴파일러 프론트엔드이며, LLVM을 백엔드로 사용하며 LLVM 2.6 이후로 릴리즈의 일부로 자리잡으며, GCC(GNU 컴파일러 모음)를 대체하는 것을 목표로 하고 있습니다.

현재 GCC가 GPLv3를 적용한 이후 소스 코드 공개를 꺼리는 기업들이 하나둘씩 LLVM/Clang (UIUC License: 소스코드 공개 의무 없음)을 지원하고 있습니다.

• LLVM
  • 컴파일러는 프론트엔드-미들엔드-백엔드의 단계로 구성되어 있으며, 
    LLVM은 아키텍처별로 분리된 모듈식 미들엔드-백엔드를 중점으로 하고 있습니다.
    
  • 따라서 LLVM은 프론트엔드가 여러가지 프로그래밍 언어들을 중간 표현 코드로 바꿔놓으면,
    이를 각각의 아키텍처에 맞게 최적화하여 실행이 가능한 형태로 바꾸는 방식입니다.
• LLVD
  • LLVM 프론트엔드에 대응하는 디버거.
  • GCC의 GDB와 동일한 포지션을 갖고 있으며, 애플 Xcode 5.0 이상의 버전에서 기본 디버거로 사용되고 있습니다.

About clang-format

C/C++/Objective-C 코드 자동 서식 맞춤 도구로 코드의 최상단에 다음과 같은 .clang-format을 둔다면 코딩 컨벤션(coding convention)을 강제할 수 있습니다. 여기서 코딩 컨벤션이란? 어떤 규칙으로 프로그램을 수행할지에 대한 규약입니다.

BasedOnStyle: LLVM
UseTab: Never
IndentWidth: 4
TabWidth: 4
BreakBeforeBraces: Allman
AllowShortIfStatementsOnASingleLine: false
IndentCaseLabels: false
ColumnLimit: 0
AccessModifierOffset: -4

코딩컨벤션 자동 적용: 저장, 타이핑, 탭을 할 경우 적용.

• 다음의 내용을 .vscode/settings.json 내 설정하여, 저장-타이핑-붙여넣기 등을 할 때에 코딩 컨벤션이 강제할 수 있습니다.

// Coding convention
"editor.formatOnPaste": true,
"editor.formatOnSave": true,
"editor.formatOnType": true,
"files.trimTrailingWhitespace": true

특정 파일에 clang-format 적용

1. 특정 style guide 적용 (predefined style)

clang-format -style=google -i path/to/file.cpp

2. 특정 style guide를 일부 변형한 .clang-format 파일 적용 (custom style)

특정 style guide를 dump 하여 .clang-format 파일을 생성합니다.

clang-format -style=google -dump-config > .clang-format

clang format sytle options에 따라 항목을 원하는대로 변경 후 다음의 명령어로 특정 파일에 적용 가능합니다.

clang-format -i path/to/file.cpp

• one can either use one of the predefined styles (LLVM, Google, Chromium, Mozilla, WebKit, Microsoft)
  • LLVM A style complying with the LLVM coding standards
  • Google A style complying with Google’s C++ style guide
  • Chromium A style complying with Chromium’s style guide
  • Mozilla A style complying with Mozilla’s style guide
  • WebKit A style complying with WebKit’s style guide
  • Microsoft A style complying with Microsoft’s style guide
  • GNU A style complying with the GNU coding standards

About clang-tidy

스타일 위반, 인터페이스 오용 또는 정적 분석을 통해 추론할 수 있는 버그와 같은 일반적인 프로그래밍 오류를 진단하고 수정하기 위한 확장 가능한 프레임워크입니다. 이는 보편적으로 다음과 같이 설명하며, 여기서 'linter'란? 소스 코드를 분석하여 프로그램 오류, 버그, 스타일 오류, 의심스러운 구조체에 표시(flag)를 달아놓기 위한 도구를 말합니다.

clang-based C++ “linter” tool

How do you install clang-format on macOS?

clang은 macOS에 설치되며 기본 컴파일러이지만 clang-format 또는 clang-tidy (또는 추가 도구)와 함께 설치되지는 않습니다. 원하는 경우 Brew를 사용하여 다음과 같이 설치할 수 있습니다.

$ brew install clang-format
$ brew install fmenezes/tap/clang-tidy

위와 같은 방식(fmenezes/tap/clang-tidy)으로 설치하면 Ubuntu에서와 동일한 CMake 파일을 빌드할 수 없습니다. 따라서 macOS에서 clang-tidy를 적용하는 방법은 llvm까지 설치한 다음, 사용하려는 도구에 대한 심볼릭 링크를 설정해주면 됩니다.

$ brew install llvm
$ ln -s "$(brew --prefix llvm)/bin/clang-format" "/usr/local/bin/clang-format"
$ ln -s "$(brew --prefix llvm)/bin/clang-tidy" "/usr/local/bin/clang-tidy"

+ 기본 clang 컴파일러와의 충돌로 인해 모든 llvm을 PATH에 추가하는 것은 좋지 않습니다.

 

# 참고

• [Official Docs] clang official guideline: https://clang.llvm.org/extra/clang-doc.html
• [Blog] macOS에 clang-tidy를 설치하는 방법은 무엇입니까?: 
  https://www.wake-up-neo.com/ko/macos/macos%EC%97%90-clangtidy%EB%A5%BC-%EC%84%A4%EC%B9%98%ED%95%98%EB%8A%94-%EB%B0%A9%EB%B2%95%EC%9D%80-%EB%AC%B4%EC%97%87%EC%9E%85%EB%8B%88%EA%B9%8C/808393026/
• [StackOverFlow] How to install clang-tidy on macOS?
  https://stackoverflow.com/questions/53111082/how-to-install-clang-tidy-on-macos