Bài 38.126 phút đọc

CMakeLists cơ bản và target

Sau bài này bạn sẽ làm được

Viết CMakeLists tối thiểu build được
Phân biệt add_executable và add_library
Dùng target_link_libraries và target_include_directories
Giải thích PUBLIC, PRIVATE, INTERFACE

Make là công cụ Unix. CMake không dựng gì cả: nó sinh ra tệp dựng cho nền tảng của bạn, Makefile trên Linux, project Visual Studio trên Windows, Xcode trên macOS. Bài này viết một CMakeLists.txt chạy được và giải thích tư duy target đằng sau nó.

#Vì sao CMake

	Make	CMake
Học	Dễ hơn	Khó hơn
Đa nền tảng	Không, chủ yếu Unix	Có
Quản lý phụ thuộc	Thủ công	Tốt hơn
Tích hợp IDE	Kém	Tốt: VS, CLion, Xcode
Dự án nhỏ	Đủ dùng	Hơi thừa
Dự án lớn, thư viện	Khó	Tốt

Bộ sinh (generator)

Chương trình dựng thật mà CMake tạo tệp cho: Unix Makefiles, MinGW Makefiles, Ninja, Visual Studio, hoặc Xcode. Chọn bằng cờ -G. Cùng một CMakeLists.txt dựng được ở mọi nền tảng vì CMake sinh tệp phù hợp cho từng bộ.

#CMakeLists tối thiểu

CMakeLists.txt

cmake_minimum_required(VERSION 3.16)
project(MyApp VERSION 1.0.0 LANGUAGES C)

set(CMAKE_C_STANDARD 17)
set(CMAKE_C_STANDARD_REQUIRED ON)
set(CMAKE_C_EXTENSIONS OFF)          # dung -std=c17, khong phai -std=gnu17

add_executable(app src/main.c)
target_include_directories(app PRIVATE include)

Bốn dòng đầu là khuôn mẫu, đọc một lần rồi chép

cmake_minimum_required(VERSION 3.16)
/* Phien ban CMake toi thieu. 3.16 la moc hop ly nam 2024:
   cu du de co san khap noi, moi du de co cac lenh hien dai. */

project(MyApp VERSION 1.0.0 LANGUAGES C)
/* Ten du an, phien ban, va ngon ngu. LANGUAGES C bao CMake
   khong tim trinh bien dich C++ (mac dinh no tim ca hai). */

set(CMAKE_C_STANDARD 17)
set(CMAKE_C_STANDARD_REQUIRED ON)    /* loi neu trinh bien dich khong co C17 */
set(CMAKE_C_EXTENSIONS OFF)          /* c17 chu khong gnu17, xem Bai 36.3 */

CMAKE_C_EXTENSIONS OFF là dòng dễ quên nhất

set(CMAKE_C_EXTENSIONS OFF)

/* Neu ban KHONG dat dong nay, CMake dung -std=gnu17 (co mo rong
   GNU), khong phai -std=c17. Nghia la ma cua ban co the dung
   mot mo rong GNU ma khong bao loi, roi khong dich duoc tren
   MSVC hay tren mot trinh bien dich khac.

   Dat OFF de CMake dung chuan thuan, va ban phat hien phu thuoc
   khong di dong ngay tai may minh. Do la ly do quan trong nhat
   de dung CMake: no dua ma cua ban qua nhieu trinh bien dich,
   nen bat duoc thu Make mot he khong bat. */

#Cấu hình rồi dựng

terminal

# Buoc 1: cau hinh. -S nguon, -B thu muc dung (out-of-source)

cmake -S . -B build -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release

-- The C compiler identification is GNU 8.1.0
-- Detecting C compiler ABI info - done
-- Check for working C compiler: .../gcc.exe - skipped
-- Detecting C compile features - done
-- Configuring done (4.4s)
-- Generating done (0.1s)
-- Build files have been written to: .../build

# Buoc 2: dung. Goi bo sinh (o day la make) ho ban

cmake --build build

[ 50%] Building C object CMakeFiles/app.dir/src/main.c.obj
[100%] Linking C executable app.exe
[100%] Built target app

./build/app.exe

2+3=5 2*3=6

Luôn dựng ngoài nguồn (out-of-source)

cmake -S . -B build         # -B build: moi thu sinh ra vao build/

/* -S la thu muc NGUON (co CMakeLists.txt).
   -B la thu muc DUNG (moi file sinh ra).

   LUON tach hai thu muc. KHONG BAO GIO chay cmake ngay trong
   thu muc nguon (in-source build), vi no rai hang chuc file
   CMake lung tung khap noi, lam ban git status, va gan nhu
   khong the .gitignore het.

   Voi build/ rieng: xoa ca thu muc la sach, va .gitignore
   chi can mot dong "build/". */

cmake --build thay vì gọi make trực tiếp

cmake --build build              # goi bo sinh, dung o moi he
cmake --build build -j8          # song song
cmake --build build --target app # chi dung mot muc tieu
cmake --build build --clean-first

/* Vi sao khong go "make" thang: vi bo sinh co the KHONG phai make.
   Neu ban dung -G Ninja thi lenh dung la "ninja", neu -G "Visual
   Studio" thi la MSBuild. "cmake --build" goi dung cai nao co,
   nen mot lenh chay tren moi he.

   Do la triet ly CMake: ban KHONG goi bo sinh truc tiep,
   ban de CMake lam trung gian. */

#Thư viện và liên kết

Thêm một thư viện tĩnh

cmake_minimum_required(VERSION 3.16)
project(MyApp VERSION 1.0.0 LANGUAGES C)

set(CMAKE_C_STANDARD 17)
set(CMAKE_C_STANDARD_REQUIRED ON)
set(CMAKE_C_EXTENSIONS OFF)

# ===== Thu vien =====
add_library(toan STATIC src/toan.c)
target_include_directories(toan PUBLIC include)
target_compile_options(toan PRIVATE -Wall -Wextra)

# ===== Chuong trinh chinh =====
add_executable(app src/main.c)
target_link_libraries(app PRIVATE toan)

terminal

cmake --build build

[ 33%] Building C object CMakeFiles/toan.dir/src/toan.c.obj
[ 33%] Linking C static library libtoan.a
[ 33%] Built target toan
[ 66%] Building C object CMakeFiles/app.dir/src/main.c.obj
[ 66%] Linking C executable app.exe
[100%] Built target app

Ba lệnh tạo và dùng một target

Lệnh	Làm gì
add_library(toan STATIC ...)	Tạo thư viện tĩnh từ các tệp .c
add_library(toan SHARED ...)	Tạo thư viện động (.so, .dll)
add_executable(app ...)	Tạo chương trình thực thi
target_link_libraries(app PRIVATE toan)	Liên kết app với thư viện toan
target_include_directories(toan PUBLIC include)	Đường dẫn header của toan
target_compile_options(toan PRIVATE -Wall)	Cờ dịch cho toan

/* Chu y: KHONG viet duong dan header cua "toan" trong "app".

   Khi app LIEN KET voi toan, va toan khai bao
   target_include_directories(toan PUBLIC include), thi app
   TU DONG thua huong duong dan include do. Do la suc manh cua
   tu duy target: moi target mang theo cach dung no. */

#PUBLIC, PRIVATE, INTERFACE

Phạm vi lan truyền

Ba từ khoá quyết định một thuộc tính của thư viện có lan sang thứ liên kết với nó không. PRIVATE: chỉ thư viện dùng. INTERFACE: chỉ người dùng thư viện dùng. PUBLIC: cả hai.

Ba phạm vi, ba nghĩa

add_library(toan STATIC src/toan.c)

target_include_directories(toan
    PUBLIC  include        # header CONG KHAI: toan dung, VA app dung
    PRIVATE src            # header RIENG: chi toan dung, app khong thay
)

target_compile_options(toan
    PRIVATE -Wall -Wextra  # canh bao khi dich toan, KHONG lan sang app
)

target_link_libraries(toan
    PUBLIC  m              # neu toan.h dung <math.h>, app cung can -lm
    PRIVATE pthread        # neu chi toan.c dung pthread, app khong can
)

Cách chọn phạm vi: hỏi header hay chỉ .c

Thứ này có xuất hiện trong header công khai không? Có thì PUBLIC, vì người dùng thư viện cũng cần nó khi include header.
Thứ này chỉ dùng bên trong .c không? Có thì PRIVATE, vì người dùng thư viện không cần biết.
Thứ này là thư viện chỉ header, bản thân bạn không dịch? Thì INTERFACE.

/* Vi du cu the:
     toan.h co #include <math.h>  ->  toan can -lm KHI DICH,
       va app cung can -lm KHI LIEN KET voi toan
       ->  PUBLIC m

     toan.c dung mot ham noi bo, khong lo trong toan.h
       ->  PRIVATE

   Dat PRIVATE cai le ra PUBLIC: app khong lien ket duoc,
     bao "undefined reference" toi ham cua thu vien phu.
   Dat PUBLIC cai le ra PRIVATE: app keo theo phu thuoc thua,
     dich cham hon va rang buoc nhieu hon can thiet.

   Khi phan van, PRIVATE la mac dinh an toan hon: no lo it nhat,
   va ban noi rong ra PUBLIC khi trinh lien ket bao thieu. */

Tự làm thử

Viết một CMakeLists.txt tối thiểu và dựng một chương trình một tệp.
Cấu hình với -B build và chứng minh không có tệp CMake nào rơi vào thư mục nguồn.
Tách mã thành một thư viện và liên kết chương trình với nó.
Bỏ CMAKE_C_EXTENSIONS OFF và tìm cờ -std mà CMake dùng trong tệp dựng.
Đặt một đường dẫn include là PRIVATE mà lẽ ra PUBLIC, và đọc lỗi liên kết.
Thêm target_compile_options với PRIVATE -Wall và xác nhận cảnh báo không lan sang chương trình.

Trình chấm điểm tự động sẽ được bổ sung ở giai đoạn sau. Hiện tại bạn tự chạy thử trên máy.

Tóm tắt

CMake không dựng mà sinh tệp dựng cho nền tảng của bạn qua một bộ sinh; cùng CMakeLists.txt chạy mọi nơi.
Khuôn mẫu bốn dòng đầu, và CMAKE_C_EXTENSIONS OFF để dùng chuẩn thuần.
Luôn dựng ngoài nguồn với -B build, và dùng cmake --build thay vì gọi bộ sinh trực tiếp.
add_library, add_executable, target_link_libraries tạo và nối các target; target mang theo cách dùng nó.
PUBLIC lan cả hai chiều, PRIVATE chỉ thư viện, INTERFACE chỉ người dùng; khi phân vân chọn PRIVATE.