喜歡研讀開源專案源碼的人,總會發現大神的代碼裡有那麼一些簡短而高效的宏定義,點進去一看卻晦澀難懂,別說學習,有時連理解都頗費力。其實宏定義本身並不難,但要寫出一個好的宏,仍需要豐富的經驗與技術積累。接下來就來聊聊宏定義——看懂大神的宏是第一步,偶爾自己寫一個也是相當有成就感的事。
定義:
宏定義分為兩種:一種是對象宏(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,若有人剛好也用了 __a、__b,就會因變量名重複而編譯報錯。真遇到這種情況,你大可拿起鍵盤砸他一臉——原因當然不是 __a 讓你的宏出錯,而是變量命名的重要性不言而喻,除非你和看代碼的人有仇,否則請使用有意義的變量名。接下來看看官方的 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 這是 Foundation 框架中的 MAX 定義,我們一步一步解析。首先看到的是:
#define __NSX_PASTE__(A,B) A##B
// 將A和B連接到一塊
它的作用是把 A 和 B 連接起來,用來生成一個新的標識符,比如 A##12 就成了 A12。
接著我們看到一個有三個參數的宏定義 __NSMAX_IMPL__(A,B,__COUNTER__)
#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 先解釋 __COUNTER__ 是什麼:它是一個預編譯宏,每次編譯都會加 1,如此可保證 __NSX_PASTE__(__b,__COUNTER__) 生成的變量名不易重複。當然這仍有點風險——要是你偏偏把變量命名成 __a20,那就真的無計可施了。
可變參數宏
說到可變參數,我們用得最多的莫過於 NSLog(...)。可變參數意味著參數個數不固定,而 NSLog 作為我們除錯時的重要工具,卻只能列印時間和參數資訊,文件名、行數、方法名等關鍵資訊都付之闕如。今天我們就借此打造一個超級版 NSLog 宏~
#define NSLog(format, ...) do { fprintf(stderr, "<%s : %d> %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(@"%@",@"Fuck");
就會出現無論如何都會執行後兩個列印的問題。那我們直接用 {} 括起來不就行了?實測確實能解決,但再延伸一下,當我們使用 if{} else if{} 時又會冒出新問題:
if (100 > 99) NSLog(@"%@",@"Fuck"); else { } // 展開後可得 if (100 > 99) { fprintf(stderr, "<%s : %d> %s\n", [[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], __LINE__, __func__); (NSLog)((format), ##__VA_ARGS__); fprintf(stderr, "-------\n");}; else { } 會出現編譯錯誤。大家也發現了 NSLog 後面會跟一個 ;,如果我們直接用 {},編譯時會在外面多加一個 ;,導致出錯;而使用 do{}while(0) 循環後就不會有這個問題:
if (100 > 99) do { fprintf(stderr, "<%s : %d> %s\n", [[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], __LINE__, __func__); (NSLog)((format), ##__VA_ARGS__); fprintf(stderr, "-------\n");} while(0); else { } 至此問題基本解決。看一下內部結構:__FILE__ 是編譯的檔案路徑,__LINE__ 是行數,__func__ 是編譯的方法名。接著我們又看到:
(NSLog)((format), ##__VA_ARGS__);
## 前面見過了,這裡作用類似,也是連接之意;__VA_ARGS__ 是剩下的所有參數,用 ## 連接起來後就成了 NSLog(format,__VA_ARGS__),這正是 NSLog 的用法。但不曉得你有沒有注意到一個細節:若 __VA_ARGS__ 為空,豈不是變成 NSLog(format,),這樣一定會編譯報錯?蘋果的大神們早就想到了——若 __VA_ARGS__ 為空,此處的 ## 會吞掉前面的 ,,如此便不會出問題了。然後我們就能安心使用這個強大的 NSLog() 了。
接著談談多參數函數的使用
- (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 來聲明多參數變量 args,然後透過 va_start(args, code) 開始取值,code 是第一個值;再用 va_arg(args, NSString *) 指定取出的值類型,取值方式有點像生成器,取完之後調用 va_end(args) 收尾。這就是整個流程。平時較少使用這種方式,如果你有什麼實用的方法,歡迎留言指教~
感謝閱讀,希望能幫助到大家,也謝謝大家對本站的支持!