Bài 54.226 phút đọc

Macro biến đối số, nối và chuỗi hóa

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

Viết macro nhận số đối số thay đổi
Xử lý trường hợp không có đối số nào
Dùng # để biến biểu thức thành chuỗi
Dùng ## và biết vì sao cần hai tầng macro

Bốn công cụ: __VA_ARGS__ để nhận số đối số thay đổi, __VA_OPT__ để xử lý trường hợp không có đối số nào, # để biến biểu thức thành chuỗi, và ## để nối tên. Ba cái sau đều có cạm bẫy riêng.

#__VA_ARGS__

Cú pháp

#define GHI_LOG(dinh_dang, ...) \
    printf("[%s:%d] " dinh_dang "\n", __FILE__, __LINE__, __VA_ARGS__)

GHI_LOG("gia tri = %d", x);
GHI_LOG("hai gia tri: %d %d", x, y);

/* Bung ra:
     printf("[%s:%d] " "gia tri = %d" "\n", "a.c", 12, x);

   Ba chuoi lien nhau duoc noi lai luc dich, nen ket qua la:
     printf("[%s:%d] gia tri = %d\n", "a.c", 12, x);

   Ky thuat noi chuoi hang nay la co so cua moi macro ghi nhat ky. */

Cạm bẫy: dấu phẩy trong danh sách khởi tạo

#define KHOI_TAO(ten, ...) Diem ten = { __VA_ARGS__ }

KHOI_TAO(p, 1, 2);           /* Diem p = { 1, 2 };  dung */

#define CHAY(f, ...) f(__VA_ARGS__)

CHAY(g, (Diem){1, 2});       /* mot doi so, dung */
CHAY(g, (Diem){1, 2}, 3);    /* hai doi so, dung */

/* Nhung: */
#define MOT(x) f(x)
MOT((Diem){1, 2});           /* error: macro "MOT" passed 2 arguments,
                                but takes just 1

   Vi dau phay trong { } KHONG duoc bao ve, chi dau phay trong ( ) moi duoc.

   Cach chua: them ngoac tron, hoac dung __VA_ARGS__: */

MOT(((Diem){1, 2}));         /* hai lop ngoac */
#define MOT(...) f(__VA_ARGS__)   /* hoac nhan so doi so thay doi */

#Vấn đề không có đối số nào

Cạm bẫy kinh điển

#define GHI_LOG(dinh_dang, ...) \
    printf(dinh_dang "\n", __VA_ARGS__)

GHI_LOG("bat dau");

/* Bung ra:
     printf("bat dau" "\n", );
                            ^ dau phay THUA

   error: expected expression before ')' token */

Cách chữa	Chuẩn	Nhược điểm
##__VA_ARGS__	Mở rộng GNU	Không chuẩn, MSVC cũ không hỗ trợ
__VA_OPT__(,)	C23, và GCC 8 trở lên đã có	Cần trình biên dịch mới
Bắt đối số đầu vào ...	Chuẩn C99	Cần một thủ thuật, xem dưới
Luôn có ít nhất một đối số	Chuẩn C99	Người dùng phải nhớ

Bốn cách, viết đủ

/* 1. ##__VA_ARGS__ cua GNU: dau ## XOA dau phay truoc no
      neu __VA_ARGS__ rong */

#define GHI_LOG(dd, ...) printf(dd "\n", ##__VA_ARGS__)

GHI_LOG("bat dau");              /* printf("bat dau" "\n"); dung */
GHI_LOG("x = %d", x);            /* printf("x = %d" "\n", x); dung */

/* 2. __VA_OPT__ cua C23: chi chen noi dung neu __VA_ARGS__ KHONG rong */

#define GHI_LOG(dd, ...) printf(dd "\n" __VA_OPT__(,) __VA_ARGS__)

GHI_LOG("bat dau");              /* khong chen dau phay */
GHI_LOG("x = %d", x);            /* chen dau phay */

/* 3. Chuan C99: bat dinh dang vao trong ... roi tach ra */

#define GHI_LOG(...) ghi_log_that(__FILE__, __LINE__, __VA_ARGS__)

static void ghi_log_that(const char *tep, int dong, const char *dd, ...) {
    va_list ap;
    printf("[%s:%d] ", tep, dong);
    va_start(ap, dd);
    vprintf(dd, ap);
    va_end(ap);
    putchar('\n');
}

GHI_LOG("bat dau");              /* dung: dinh dang la doi so dau cua ...  */
GHI_LOG("x = %d", x);            /* dung */

/* Cach 3 la cach CHUAN va thuong la tot nhat:
     - khong dung mo rong nao
     - chuyen viec noi chuoi sang cho ham xu ly
     - va ban co the them muc do log, mau sac, ghi ra tep, tat bat */

/* 4. Bat nguoi dung luon truyen it nhat mot doi so */
#define GHI_LOG(dd, ...) printf(dd "\n", __VA_ARGS__)
GHI_LOG("%s", "bat dau");        /* nguoi dung tu them */

terminal

# GCC 8.1 hỗ trợ __VA_OPT__ với -std=c2x, và ##__VA_ARGS__ luôn có

gcc -std=c11 -Wall -Wpedantic -c log.c

log.c:4:41: warning: ISO C++11 requires at least one argument for the "..." in a variadic macro [-Wpedantic]

#Toán tử #

#define CHUOI(x) #x

CHUOI(hello)          /* "hello" */
CHUOI(1 + 2)          /* "1 + 2" */
CHUOI(a, b)           /* error: macro "CHUOI" passed 2 arguments */

/* Toan tu # bien MOT tham so thanh mot chuoi hang.
   No giu nguyen van ban ban viet, ke ca khoang trang o giua,
   nhung gop nhieu khoang trang lien tiep thanh mot. */

CHUOI(  a   +   b  )  /* "a + b" */

Ứng dụng chính: thông báo lỗi nói đúng dòng bạn viết

#define KIEM(dk) do {                                          \
    if (!(dk)) printf("HONG %s:%d: %s\n",                      \
                      __FILE__, __LINE__, #dk);                \
} while (0)

KIEM(bu_dem_bit(0xF0F0u) == 8);

/* Neu that bai:
     HONG bitutils.c:42: bu_dem_bit(0xF0F0u) == 8

   Nguoi doc thay dung bieu thuc ban viet, khong phai mot ma loi.
   Bai 32.4 da dung ky thuat nay cho ca mot khung kiem thu. */

/* Va ba ung dung khac: */

#define TEN_BIEN(x) #x
printf("%s = %d\n", TEN_BIEN(dem), dem);     /* "dem = 5" */

#define KHONG_LAM_GI(x) ((void)0)              /* bo qua, khong canh bao */

#define BAO_LOI(dk, tin)                                       \
    do { if (!(dk)) { fprintf(stderr, "%s: %s\n", #dk, tin);   \
                      exit(1); } } while (0)

# KHÔNG mở rộng macro trong đối số

#define TOI_DA 100
#define CHUOI(x) #x

CHUOI(TOI_DA)         /* "TOI_DA", KHONG phai "100" */

/* Vi toan tu # lay TOKEN NGUYEN VAN, khong bung macro truoc.

   Muon bung truoc thi phai qua HAI TANG: */

#define CHUOI_TRONG(x) #x
#define CHUOI(x) CHUOI_TRONG(x)

CHUOI(TOI_DA)         /* "100" */

/* Vi sao hai tang lam duoc:
     1. CHUOI(TOI_DA) -> tham so x duoc BUNG thanh 100,
        vi x khong di kem # hay ## trong than CHUOI
     2. roi CHUOI_TRONG(100) -> # ap dung, cho ra "100"

   Day la mot trong nhung mau quan trong nhat cua bo tien xu ly,
   va no dung cho ca ## nhu muc duoi. */

terminal

# Chuỗi hóa giữ nguyên dấu ngoặc kép và dấu chéo ngược trong chuỗi con

gcc -E -P chuoi.c

int main(void) {
    puts("printf(\"C:\\tmp\")");
    return 0;
}

Quy tắc thoát ký tự của #

#define S(x) #x

S(abc)                /* "abc" */
S("abc")              /* "\"abc\"", tuc dau nhay duoc thoat */
S(printf("C:\tmp"))   /* "printf(\"C:\\tmp\")" */

/* Chuan noi: dau nhay kep va dau cheo nguoc BEN TRONG mot chuoi hang
   hoac mot hang ky tu cua doi so thi duoc them mot dau cheo nguoc.
   Moi ky tu khac giu nguyen.

   Nen mot dau cheo nguoc DON LE ben ngoai chuoi thi khong bi thoat: */

S(a\b)                /* "a\b", mot dau cheo nguoc, khong phai hai */

/* Bai 32.4 da gap dung quy tac nay khi viet macro KIEM_CHUOI. */

#Toán tử ##

#define NOI(a, b) a##b

NOI(x, 1)             /* x1 */
NOI(ham_, doc)        /* ham_doc */
NOI(1, 2)             /* 12, mot hang so */

/* Toan tu ## noi hai token thanh MOT token.
   Ket qua phai la mot token hop le, neu khong thi UB. */

NOI(1, x)             /* error: invalid suffix "x" on integer constant
                         vi "1x" khong phai token hop le */

Ứng dụng chính: sinh tên hàm và tên kiểu

#define KHAI_BAO_VEC(T, ten)                              \
    typedef struct { T *d; size_t n, sc; } ten;           \
    int  ten##_them(ten *v, T x);                         \
    void ten##_huy(ten *v);                               \
    T    ten##_tai(const ten *v, size_t i);

KHAI_BAO_VEC(int, VecInt)

/* Sinh ra:
     typedef struct { int *d; size_t n, sc; } VecInt;
     int  VecInt_them(VecInt *v, int x);
     void VecInt_huy(VecInt *v);
     int  VecInt_tai(const VecInt *v, size_t i);

   Bai 30.2 da dung ky thuat nay cho ca mot vector tong quat. */

/* Va cac ung dung khac: */

#define TEN_TRUONG(nhom, ten) nhom##_##ten
TEN_TRUONG(sv, ma)               /* sv_ma */

#define BANG_CHO(T) BANG_##T
BANG_CHO(int)                    /* BANG_int */

#define HANG_SO(n) HS_##n = n
enum { HANG_SO(10), HANG_SO(20) };   /* HS_10 = 10, HS_20 = 20 */

## cũng KHÔNG mở rộng macro, và cùng cách chữa

#define TIEN_TO ml
#define NOI(a, b) a##b

NOI(TIEN_TO, _doc)    /* "TIEN_TO_doc", KHONG phai "ml_doc" */

/* Chua bang hai tang, giong het toan tu #: */

#define NOI_TRONG(a, b) a##b
#define NOI(a, b) NOI_TRONG(a, b)

NOI(TIEN_TO, _doc)    /* "ml_doc" */

/* Va day la ly do ban thay mau nay trong moi thu vien header lon:

     #define GHEP2(a, b) a##b
     #define GHEP(a, b)  GHEP2(a, b)

   Hai dong, va tang ngoai chi de bung tham so. */

Cạm bẫy: ## với đối số rỗng

#define F(a, b) a##b

F(x, )                /* "x" */
F(, y)                /* "y" */
F(, )                 /* rong, hop le */

/* Chuan noi: neu mot toan hang cua ## la mot chuoi token rong
   thi ket qua la toan hang kia.

   Do la co so cho thu thuat ##__VA_ARGS__ o muc tren:
   khi __VA_ARGS__ rong, "," ## rong -> dau phay bi xoa.

   Nhung chu y do la MO RONG cua GNU: theo chuan, ## voi mot ben la
   dau phay va ben kia la __VA_ARGS__ rong KHONG duoc dinh nghia.
   C23 giai quyet bang __VA_OPT__ mot cach chinh thuc. */

#Vì sao cần hai tầng macro

Quy tắc bung macro, rút gọn

/* Bo tien xu ly xu ly mot loi goi macro theo ba buoc:

   Buoc 1: bung cac THAM SO, TRU nhung tham so di kem # hoac ##

   Buoc 2: thay tham so vao than macro,
           ap dung # va ##

   Buoc 3: bung lai KET QUA mot lan nua

   Nen: */

#define A 100
#define S1(x) #x           /* x di kem #, KHONG bung o buoc 1 */
#define S2(x) S1(x)        /* x KHONG di kem gi, bung o buoc 1 */

S1(A)    /* buoc 1: khong bung A     -> buoc 2: #A  -> "A"   */
S2(A)    /* buoc 1: A bung thanh 100 -> buoc 2: S1(100)
            -> buoc 3: bung S1(100) -> "100" */

Ba trường hợp cần hai tầng

/* 1. Chuoi hoa mot macro */
#define CHUOI_TRONG(x) #x
#define CHUOI(x) CHUOI_TRONG(x)

#define PHIEN_BAN 3
CHUOI(PHIEN_BAN)          /* "3" */

/* Rat huu ich de tao chuoi phien ban: */
#define CHINH 1
#define PHU   2
#define VA    3
#define PB_CHUOI CHUOI(CHINH) "." CHUOI(PHU) "." CHUOI(VA)
/* "1.2.3" */

/* 2. Noi voi mot macro */
#define NOI_TRONG(a, b) a##b
#define NOI(a, b) NOI_TRONG(a, b)

#define TIEN_TO ml
NOI(TIEN_TO, _doc)        /* ml_doc */

/* 3. Ten duy nhat bang __LINE__ */
#define DUY_NHAT(x) NOI(x, __LINE__)

int DUY_NHAT(tam);        /* tam42 neu o dong 42 */
/* Neu chi co mot tang thi ket qua la "tam__LINE__". */

terminal

# Xem sự khác biệt bằng gcc -E

gcc -E -P hai_tang.c

const char *a = "PHIEN_BAN";
const char *b = "3";

#Đếm số đối số

Thủ thuật đếm, dùng trong nhiều thư viện

/* Y tuong: day danh sach doi so vao mot danh sach co dinh,
   roi doc phan tu o vi tri co dinh. */

#define DEM_DOI_SO(...) \
    DEM_TRONG(__VA_ARGS__, 8, 7, 6, 5, 4, 3, 2, 1, 0)

#define DEM_TRONG(_1, _2, _3, _4, _5, _6, _7, _8, N, ...) N

DEM_DOI_SO(a)              /* 1 */
DEM_DOI_SO(a, b)           /* 2 */
DEM_DOI_SO(a, b, c)        /* 3 */

/* Cach hoat dong voi DEM_DOI_SO(a, b, c):

     DEM_TRONG(a, b, c, 8, 7, 6, 5, 4, 3, 2, 1, 0)
                _1 _2 _3 _4 _5 _6 _7 _8  N  ...

     _1 = a, _2 = b, _3 = c, _4 = 8, _5 = 7, _6 = 6,
     _7 = 5, _8 = 4, N = 3

     -> tra ve 3

   Cac so 8 xuong 0 dong vai tro "day len": cang nhieu doi so that
   thi day cac so do sang phai, va N roi vao dung so ban muon. */

Ứng dụng: chọn macro theo số đối số

#define NOI_TRONG(a, b) a##b
#define NOI(a, b) NOI_TRONG(a, b)

#define VE_1(a)       ve_diem(a)
#define VE_2(a, b)    ve_duong(a, b)
#define VE_3(a, b, c) ve_tam_giac(a, b, c)

#define VE(...) NOI(VE_, DEM_DOI_SO(__VA_ARGS__))(__VA_ARGS__)

VE(p);              /* ve_diem(p) */
VE(p, q);           /* ve_duong(p, q) */
VE(p, q, r);        /* ve_tam_giac(p, q, r) */

/* Day la cach gan nhat ma C co voi "nap chong ham".

   Chu y: can HAI tang NOI, vi DEM_DOI_SO phai duoc bung
   thanh mot con so TRUOC khi ## chay. */

Nhưng đây là chỗ nên dừng lại

/* Thu thuat dem doi so:
     - khong xu ly duoc truong hop KHONG co doi so nao,
       tru khi dung __VA_OPT__
     - gioi han so doi so toi da la con so ban viet ra
     - thong bao loi tro vao dong #define
     - va nguoi doc ma phai hieu ca ba tang macro

   Neu ban thay minh can no, hay hoi:

     1. Ba ham co ten khac nhau co du khong?
          ve_diem(p); ve_duong(p, q);  <- ro rang hon nhieu

     2. Mot ham nhan mot mang co du khong?
          ve(ds, n);

     3. _Generic co giai quyet duoc khong, neu van de la KIEU
        chu khong phai SO LUONG? Bai 51.3

   Trong chin muoi phan tram truong hop, cau tra loi la co.

   Ngoai le hop ly: khi ban viet mot thu vien ma nguoi dung se goi
   hang nghin lan, va su tien loi do dang gia. Vi du cac khung
   kiem thu va cac thu vien ghi nhat ky. */

Tự làm thử

Viết macro ghi nhật ký và gọi nó không có đối số nào ngoài chuỗi.
Sửa nó bằng cả ba cách: ##__VA_ARGS__, __VA_OPT__, và hàm va_list.
Chứng minh # không mở rộng macro trong đối số, rồi sửa bằng hai tầng.
Dùng ## để sinh tên hàm cho ba kiểu khác nhau.
Cài macro đếm số đối số và kiểm tra với một tới tám đối số.
Viết macro chọn hàm theo số đối số, rồi viết lại bằng ba hàm có tên khác nhau và so hai cách.

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

__VA_ARGS__ là một chuỗi token gồm cả dấu phẩy, không phải danh sách duyệt được.
Trường hợp không có đối số nào để lại một dấu phẩy thừa; ##__VA_ARGS__ của GNU và __VA_OPT__ của C23 đều chữa được, còn cách chuẩn là gọi vào hàm va_list.
# và ## đều không mở rộng macro trong đối số, và cách chữa cho cả hai là thêm một tầng macro.
# thoát dấu nháy và dấu chéo ngược chỉ khi chúng nằm trong chuỗi con hoặc hằng ký tự của đối số.
Đếm đối số làm được nhưng thường không nên: ba hàm tên khác nhau rõ ràng hơn nhiều.