> For the complete documentation index, see [llms.txt](https://krjaeh0.gitbook.io/j-log/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://krjaeh0.gitbook.io/j-log/programming/languages/c-and-c++/build-and-tooling/cmake.md).
# cmake
{% hint style="warning" %}
* 이 글은 CMake에 대해 깊은 탐구를 위해 작성한 글이 아닙니다.
* VSCode로 C언어의 모듈화 프로그래밍에 대하여 학습 중 컴파일에 문제가 생겨 급히 CMake 로 프로젝트를 관리하게 되면서 필요했던 정보를 정리하였습니다.
* 겉핥기로 CMake의 정보가 필요할 경우 참고 할 가치가 있을 수 있지만 프로젝트의 크기가 큰 경우 참고할 가치가 없음을 알립니다.
{% endhint %}
{% stepper %}
{% step %}
### CMake?
* VSCode에는 프로젝트 내 소스 파일간의 연결(링크)를 관리하는 기능이 없다. -> 모듈화 할때에러
* windows 나 Mac 을 옮겨가며 프로젝트를 진행하다 보면 하나의 세팅으로 두 운영체제에 적용이 가능해야 한다.
* 프로젝트 빌드를 위해 빌드 프로그램을 사용해야 하는데 대표적으로 make 또는 Ninja 같은 프로그램을 사용해 빌드를 한다.
* 대부분 make를 사용하는데 make로 빌드 할 수 있도록 프로젝트를 관리해야 하는데 이를 도와주는 프로그램이 CMake를 사용한다.
* make와 같이 "러닝 커브"가 있고, 긴 역사 만큼 바른 사용법(Best practice)이 버전에 따라 많이 바뀐다.
{% endstep %}
{% step %}
### Install
#### Windows
* 설치 경로:
* 윈도우 버전 선택 후 다운로드
* "Add CMake to the system PATH for all users" 선택하고 다운로드(CMake를 어디서든 이용할 수 있도록 하기 위해서 시스템 경로(System Path)에 추가)
* Cmd에서 cmake 명령어 실행하여 Usage 내용 출력되면 설치 성공
#### Mac
* 터미널에 `brew install cmake`를 실행하면 CMake를 설치할 수 있다.
* 설치가 끝나면 `cmake --version`를 실행해서 설치 여부 확인할 수 있다.
{% endstep %}
{% step %}
### CMakeLists.txt 생성
* CMake를 사용하는 모든 프로젝트에는 반드시 프로젝트 최상위 디렉토리에 CMakeLists.txt 파일이 있어야 한다.
* CMakeLists.txt > CMake > Makefile > make > 실행파일 순으로 컴파일된다.
* 최상위 CMakeLists.txt 에는 반드시 아래 두 내용이 들어가야 된다.
```
# CMake 프로그램 최소 버전
cmake_minimum_required(VERSION 3.11)
# 프로젝트 정보
project(
ProjectName
VERSION 0.1
DESCRIPTION "예제 프로젝트"
LANGUAGES CXX
)
```
* 주석은 (#)을 사용하면 된다.
* CMake 버전별 지원 기능의 차이가 커 최소 버전을 3.0 이상으로 설정해 놓는다.
* project()에 프로젝트 정보를 간단히 명시 (프로젝트 이름은 필수)
* 실행 파일을 빌드하기 위해서 CMakeLists.txt 와 소스코드 파일은 같은 경로에 있어야 한다.
* CMake에서 권장하는 빌드 파일 생성 방법으로 빌드 파일과 작업하는 디렉토리는 서로 분리한다. build 라는 별도의 폴더를 만들어 사용
사용 예시:
```
# CMake 최소 버전 설정
cmake_minimum_required(VERSION 3.11)
# 프로젝트 설정
project(DEVBASICS VERSION 0.1 LANGUAGES C)
```
{% endstep %}
{% step %}
### C/C++ 표준 설정
* 프로젝트 빌드에 사용할 C/C++ 버전을 설정할 수 있다.
```
#c/c++ 표준 설정
set(CMAKE_C_STANDARD 99)
set(CMAKE_C_STANDARD_REQUIRED True)
```
{% endstep %}
{% step %}
### 소스파일 관계 설정
* 생성할 실행 파일의 이름과 소스코드 파일의 연결 지을 수 있다.
```
add_executable(linkedGraph ${SOURCE_DIR}/mainGraph.c ${SOURCE_DIR}/includeLinkedGraph.c ${SOURCE_DIR}/includeGenericStructure.c)
```
{% endstep %}
{% step %}
### 변수 생성
* 반복해서 사용하는 특정 값을 변수로 만들어 사용할 수 있다.
```
set(SOURCE_DIR source/DSNA/non-Linear)
add_executable(linkedGraph ${SOURCE_DIR}/mainGraph.c) #<- 변수 사용 예시
```
{% endstep %}
{% step %}
### 추가 라이브러리 설정
* .h파일 같이 라이브러리를 한 폴더에서 관리할 경우 아래와 같이 해당 폴더를 프로젝트에 추가할 수 있다.
```
# 추가 라이브러리 링크 혹은 옵션 지정
include_directories(include)
```
{% endstep %}
{% step %}
### 빌드 환경에 따라 프로젝트 설정 바꾸는 방법
```
if(WIN32)
# windows 설정
elseif(APPLE)
# mac 설정
endif()
```
{% endstep %}
{% step %}
### CMake를 활용한 빌드 방법
#### windows
```
cd build/build_win
cmake -G "MinGW Makefiles" ../../
cmake --build .
```
* 빌드를 위한 make 파일 생성이 우선
* make 파일을 생성할 폴더로 이동 후 make 명령어 실행
* 이후 빌드 진행
#### mac
```
cd build/build_mac
cmake ../../
make
```
* windows 명령어 사용과 같은 방식이지만 명령어가 조금 다르다.
#### 약간의 꼼수
* 빌드나 테스트를 위해 터미널에 명령어를 하나 하나 정성껏 입력하는 것은 매우 번거로운 일이다.
* 실행 파일로 만들어 빌드가 필요할 때 실행시키는 것이 좋을 것 같아 실행파일을 만들었다.
* windows 빌드 실행 파일 , mac 빌드 실행 파일
* make 파일 생성(또는 빌드 후 실행 파일 생성)위치를 바꾸려면 위 예제를 보면서 직접 수정해야 한다.
{% endstep %}
{% endstepper %}
## 참조
* [What\_CMake](https://growing-dev101.tistory.com/entry/%EA%B0%9C%EB%B0%9C%ED%99%98%EA%B2%BD-CMake)
* [sup\_CMake\_GIT](https://gist.github.com/luncliff/6e2d4eb7ca29a0afd5b592f72b80cb5c?permalink_comment_id=2831356)
* [CMake\_SET](https://growingdev.blog/entry/%EA%B0%9C%EB%B0%9C-%ED%99%98%EA%B2%BD-CMake-%EA%B8%B0%EB%B3%B8-%EC%84%A4%EC%A0%95-%EB%94%B0%EB%9D%BC%ED%95%98%EA%B8%B0-feat-VS-Code)
* [CMake 설치 for windows](https://ndb796.tistory.com/365)
* [모두의 코드](https://modoocode.com/332)
* [Mac os에서 CMake 사용하기](https://popcorn16.tistory.com/31)
*
*
*
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://krjaeh0.gitbook.io/j-log/programming/languages/c-and-c++/build-and-tooling/cmake.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.