讀開源專案原始碼時,總會遇到一些簡短卻高效的宏定義。點進去看,往往晦澀難懂,別說模仿,光是理解就頗費力。宏本身其實不難,但要寫得漂亮,仍需豐富的經驗與功力。看懂大神的宏是第一步,偶爾自己寫一個,也是種樂趣。
宏分為兩種:對象宏(object-like macro)與函數宏(function-like macro)。
對象宏用來定義一個量,之後透過宏名取得它。例如定義圓周率:
#define PI 3.1415926
此後需要用到 π 時,直接寫 PI 就等同寫入這個常量。它的本質是在編譯階段把 PI 替換成真正的常量,常用於螢幕寬高、系統版本號這類高頻值。
但要注意:定義表達式時,必須看穿它編譯後的樣子。例如
#define MARGIN 10 + 20
若用它計算寬度並寫成 MARGIN * 2,結果會不如預期——你得到的是 50,而不是 60。展開來看就清楚了:
MARGIN * 2 // 展開後是 10 + 20 * 2 = 50
解法很簡單,在外層補一對括號:
#define MARGIN (10 + 20) // MARGIN * 2 → (10 + 20) * 2 = 60
函數宏的用法近似函數,可以接收參數並進行運算。例如求兩數最大值:
#define MAX(A,B) A > B ? A : B
單純比較 MAX(1,2) 沒問題,但遇到更複雜的巢狀運算就會出事:
int a = 3; int b = 2; int c = 1; MAX(a, b > c ? b : c); // 得到 2
最大值明顯是 3,結果卻是 2。展開宏來看:
MAX(a, b > c ? b : c); // 展開:a > b > c ? b : c ? a : b > c ? b : c // 依優先級:(a > (b > c ? b : c) ? a : b) > c ? b : c // 代入:(3 > (2 > 1 ? 2 : 1) ? 3 : 2) > 1 ? 2 : 1 // → (3 > 2 ? 3 : 2) > 1 ? 2 : 1 // → 3 > 1 ? 2 : 1
問題依舊出在優先級。所以請牢記:多寫兩個括號不會累到你,加上括號總是保險一些。
但總有人寫出更清奇的用法,而且看起來還挺有道理:
c = MAX(a++, b); // 展開:c = a++ > b ? a++ : b // c = 3++ > 2 ? 3++ : 2 // c = 4,a = 5
不管寫這段程式碼的人有多欠揍,我們仍得處理這種情況,而普通的括號已經無效。這時就要請出賦值擴展 ({...}):
int a = ({
int b = 10;
int c = 20;
b + c;
}); // a = 30
int b; // 之後再用 b、c 當變量名也沒問題
int c;它能形成小範圍的作用域來計算特殊值,不必浪費額外的變量名。
回到剛才的問題,改裝後的宏如下:
#define MAX(A,B) ({ __typeof(A) __a = (A); __typeof(B) __b = (B); __a > __b ? __a : __b; })__typeof() 會轉成相同型別的變量,問題就完美解決了。不過還有一個不太會發生、但確實存在的隱患:我們產生了 __a、__b 兩個變量,若有人也用了同樣的名字,就會因為變量重複而編譯失敗。這時問題不在宏,而在變量命名的品質——變量名的重要性不言而喻。
以下取自 Foundation 框架的 MAX 定義:
#define __NSX_PASTE__(A,B) A##B
#if !defined(MAX)
#define __NSMAX_IMPL__(A,B,L) ({ __typeof__(A) __NSX_PASTE__(__a,L) = (A); __typeof__(B) __NSX_PASTE__(__b,L) = (B); (__NSX_PASTE__(__a,L) < __NSX_PASTE__(__b,L)) ? __NSX_PASTE__(__b,L) : __NSX_PASTE__(__a,L); })
#define MAX(A,B) __NSMAX_IMPL__(A,B,__COUNTER__)
#endif逐層拆解。首先是
#define __NSX_PASTE__(A,B) A##B // 將 A 與 B 連接起來
## 用來拼接標記,例如 A##12 會變成 A12。
接著是接收三個參數的 __NSMAX_IMPL__。其中 __COUNTER__ 是預編譯宏,每次編譯都會加一,因此 __NSX_PASTE__(__b, __COUNTER__) 產生的變量名幾乎不會重複。當然,如果你偏要變量名叫 __a20,那就真的無解了。
說到可變參數,最常用的莫過於 NSLog(...)。但它在除錯時實在偏弱:只印時間與內容,檔名、行數、方法名全欠奉。我們就用它來做一個強化版:
#define NSLog(format, ...) do {\
fprintf(stderr, " %s\n", [[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], __LINE__, __func__);\
(NSLog)((format), ##__VA_ARGS__);\
fprintf(stderr, "-------\n");\
} while (0)先看定義 NSLog(format, ...),... 代表可變參數,而 __VA_ARGS__ 就是除 format 之外的所有參數。
接著會發現外層包了 do {} while(0)。這個迴圈只跑一次就會停,看似多此一舉,實際上是防禦式編程的經典手法。如果有人這樣寫:
if (100 > 99)
NSLog(@"%@", @"666");原本單行的宏展開成多行之後,後面的語句會無條件執行。直接用 {} 包起來確實能解決,但再往下想一步:
if (100 > 99)
NSLog(@"%@", @"666");
else { }
// 展開後:if (100 > 99) { ... }; else { }因為呼叫處會補上分號,{...}; 之後接 else 就編譯失敗了。而 do {...} while(0) 正好吃掉這個分號:
if (100 > 99)
do { ... } while (0);
else { }再看內部:__FILE__ 是編譯檔案路徑,__LINE__ 是行號,__func__ 是方法名。
而
(NSLog)((format), ##__VA_ARGS__);
這裡的 ## 同樣是連接,把 format 與剩下的參數接成一次完整的 NSLog 呼叫。聰明的讀者可能已經想到:如果 __VA_ARGS__ 是空的,不就變成 NSLog(format,) 而編譯報錯?Apple 的工程師早有答案——當 __VA_ARGS__ 為空時,## 會順手吞掉前面那個逗號,於是問題自動消失。
順帶談一下怎麼自己寫一個接收可變參數的方法:
- (void)say:(NSString *)code, ... {
va_list args;
va_start(args, code);
NSLog(@"%@", code);
while (YES) {
NSString *string = va_arg(args, NSString *);
if (!string) {
break;
}
NSLog(@"%@", string);
}
va_end(args);
}先用 va_list args 宣告可變參數鏈,接著 va_start(args, code) 開始取值(code 是第一個參數),再用 va_arg(args, NSString *) 指定取出的型別,取法有點像生成器;取完呼叫 va_end(args) 收尾。
平常較少有機會用到這種寫法,如果你手上有更實用的案例,歡迎一起交流。
文章轉自 SSBun 的簡書