Created by 大刘 liuxing8807@126.com
参考：
https://juejin.im/post/58a0781861ff4b006b4cfe30
http://lldong.github.io/2014/02/24/key-paths-validation.html
https://onevcat.com/2014/01/black-magic-in-macro/
#define keypath(...) \
metamacro_if_eq(1, metamacro_argcount(__VA_ARGS__))(keypath1(__VA_ARGS__))(keypath2(__VA_ARGS__))
#define keypath1(PATH) \
(((void)(NO && ((void)PATH, NO)), strchr(# PATH, '.') + 1))
#define keypath2(OBJ, PATH) \
(((void)(NO && ((void)OBJ.PATH, NO)), # PATH))
假设我们这样写：
NSString *versionPath = @keypath(NSObject, version);
NSLog(@"%@", versionPath); // version
我们来分析一下，为什么@keypath(NSObject, version)就变成了字符串@"version"
由于我们传了两个参数：NSObject & version, 所以会走宏：
#define keypath2(OBJ, PATH) \
(((void)(NO && ((void)OBJ.PATH, NO)), # PATH))
这里面OBJ->NSObject, PATH->version
- 加void是为了防止逗号表达式warning, 例如：
int a=0; int b = 1;
int c = (a,b);
由于a没有被用到，所以会有警告。但是写成如下的样子就不会出现警告了：
int c = ((void)a,b);
所以上面加了几个void就是为了防止出现warning.
比如我们仿照着这种写法定义自己的宏:
#define ZZ_KEY_PATH(OBJ, PATH) \
(((NO && ((void)OBJ.PATH, NO)), # PATH))
NSString *s = @ZZ_KEY_PATH(self.view, backgroundColor);
NSLog(@"%@", s); // backgroundColor
如果在写宏ZZ_KEY_PATH(OBJ, PATH)的时候把void去掉：
#define ZZ_KEY_PATH(OBJ, PATH) \
(((NO && (OBJ.PATH, NO)), # PATH))
程序运行不受影响，但编译器就会提示警告：
这就是上面的宏定义加void的原因
- 加NO是C语言判断条件短路表达式。增加NO && 以后，预编译的时候看见了NO，就会很快的跳过判断条件。即：
#define keypath2(OBJ, PATH) \
(((void)(NO && ((void)OBJ.PATH, NO)), # PATH))
其最终结果相当于：#path
但是为什么要加这个NO，这是因为为了代码提示，有了OBJ.PATH，由于这里的点，所以输入第二个参数时编辑器会给出正确的代码提示(关于代码提示等下还会说)
3.) # PATH, 这个#操作符可以在预处理阶段将后面的宏参数展开为一个C的字符串常量，比如：
#define ZZ_STR(s) # s
NSString *str = @ZZ_STR(我的心太乱);
NSLog(@"%@", str);
@, @keypath加这个@是因为宏定义keypath生成了一个C字符串，加上@即OC字符串，就像上面的ZZ_STR(s) #s -> @ZZ_STR(s) -> @#s -> @"s表示的字符串"
关于keypath1的strchr(# PATH, '.')
#define keypath1(PATH) \
(((void)(NO && ((void)PATH, NO)), strchr(# PATH, '.') + 1))
strchar函数是C中<string.h>中定义的函数，用来查找某字符在字符串中首次出现的位置，其原型为：
char * strchr (const char *str, int c);
【参数】str 为字符串，c 为要查找的字符。
strchr() 将会找出 str 字符串中第一次出现的字符 c 的地址，然后将该地址返回。
注意：字符串 str 的结束标志 NUL 也会被纳入检索范围，所以 str 的组后一个字符也可以被定位。
【返回值】如果找到指定的字符则返回该字符所在地址，否则返回 NULL。
返回的地址是字符串在内存中随机分配的地址再加上你所搜索的字符在字符串位置。设字符在字符串中首次出现的位置为 i，那么返回的地址可以理解为 str + i。
示例：
#include <stdio.h>
#include <string.h>
int main(int argc, const char * argv[]) {
const char *s = "Hello world, hello china!";
char *p = strchr(s, 'e');
printf("%p\n", s); // 0x100000f8c
printf("%p\n", p); // 0x100000f8d
printf("%s\n", p); // ello world, hello china!
return 0;
}
也就是说，strchr(str, 'c'), 返回的是一个C字符串，这个字符串从找到str中为‘c’的字符开始往后：
#define ZZ_KEY_PATH(PATH) \
strchr(# PATH, '.')
int main(int argc, const char * argv[]) {
printf("%s\n", strchr("Hello.china.shanghai", '.')); // .china.shanghai
printf("%s\n", ZZ_KEY_PATH(Hello.china.shanghai)); // .china.shanghai
return 0;
}
再来看keypath1的宏定义：
#define keypath1(PATH) \
(((void)(NO && ((void)PATH, NO)), strchr(# PATH, '.') + 1))
我们先把它简化一下为：
#define keypath1(PATH) \
strchr(# PATH, '.') + 1)
#include <stdio.h>
#include <string.h>
#define keypath1(PATH) \
strchr(# PATH, '.') + 1
int main(int argc, const char * argv[]) {
printf("%s\n", keypath1(Hello.china.shanghai)); // china.shanghai
return 0;
}
- 关于代码提示
为什么在输入keypath1或keypath2宏的时候，会出现代码提示？并且编译器可以检测到是否合法。
来看示例：
#include <stdio.h>
#include <string.h>
#define my_keypath1(PATH) \
strchr(# PATH, '.') + 1
#define keypath1(PATH) \
(((void)(NO && ((void)PATH, NO)), strchr(# PATH, '.') + 1))
int main(int argc, const char * argv[]) {
printf("%s\n", my_keypath1(Hello.china.shanghai)); // china.shanghai
printf("%s\n", keypath1(Hello.china.shanghai)); // 编译不通过：Use of undeclared identifier 'Hello'
return 0;
}
keypath1编译不通过，这是因为逗号表达式的第一项：
((void)(NO && ((void)PATH, NO))
即，如果PATH输入的是Hello.china.shanghai, 它就会作为表达式的一部分，它不是一个合法的表达式，因此编译不通过。
另外再说一下代码提示：
之所以会提示，也是由于这个表达式的原因。只要是作为表达式的一部分，XCode工具自动会提示, 这并没有什么神奇的地方：
END
