__VA_ARGS__和va_start作用, 关于log

Posted 2021-08-30 想名真难

__VA_ARGS__ 是一个可变参数的宏，经常用来对系统的NSLog进行处理, 这个可变参数的宏是新的C99规范中新增的。
作用就是代替宏定义中参数列表的省略号（也就是三个点）。

MJExtension就是这样使用的,

##__VA_ARGS__ 宏前面加上##的作用在于，当可变参数的个数为0时，这里的##起到把前面多余的","去掉的作用,否则会编译出错

比如DDLog框架就用了这个,

最后,放上去一个集大成者: 

#ifdef DEBUG
#define NSDebugLog(...) NSLog(__VA_ARGS__)
#define NSDebugLog2(format,...) NSLog(format,##__VA_ARGS__)
#define NSDebugLog3(format,...) NSLog(@"%s %@",__func__,[NSString stringWithFormat:format,##__VA_ARGS__])
#define NSDebugLog4(...) NSLog(@"%s %@",__func__,[NSString stringWithFormat:__VA_ARGS__])
#define NSDebugLog5(...) NSLog(@"%@, file:%s line:%d func:%s",[NSString stringWithFormat:__VA_ARGS__],__FILE__,__LINE__,__func__)
#else
#define NSDebugLog(...)
#define NSDebugLog2(format,...)
#define NSDebugLog3(format,...)
#define NSDebugLog4(...)
#define NSDebugLog5(...)
#endif

---

  __VA_ARGS__是在宏定义中使用,在函数中可以使用va_start, va_end.

     va_list args：定义一个指向个数可变的参数列表指针;

　　va_start(args, argN)：使参数列表指针args指向函数参数列表中的第一个可选参数，说明：argN是位于第一个可选参数之前的固定参数，（或者说，最后一个固定参数；…之前的一个参数），函数参数列表中参数在内存中的顺序与函数声明时的顺序是一致的。
比如有一va函数的声明是void va_test(char a, char b, char c, …)，则它的固定参数依次是a,b,c，最后一个固定参数argN为c，因此就是va_start(args, c)。

     va_arg(args, type)：返回参数列表中指针args所指的参数，返回类型为type，并使指针args指向参数列表中下一个参数。
　　va_end(args)：清空参数列表，并置参数指针args无效。说明：指针args被置无效后，可以通过调用va_start()、va_copy()恢复args。每次调用va_start() / va_copy()后，必须得有相应的va_end()与之匹配。参数指针可以在参数列表中随意地来回移动，但必须在va_start() … va_end()之内。

　　va_copy(dest, src)：dest，src的类型都是va_list，va_copy()用于复制参数列表指针，将dest初始化为src。

在C中，当我们无法列出传递函数的所有实参的类型和数目时,可以用省略号指定参数表

int printf(const char * __restrict, ...); //比如printf , scanf
int scanf(const char * __restrict, ...)
void foo(...); // 我们也可以自定义
void foo(parm_list,...);

void NSLog(NSString *format, ...) // ios中的log
+ (instancetype)stringWithFormat:(NSString *)format, ... // 字符串format
- (instancetype)initWithObjects:(ObjectType)firstObj, ... // 数组初始化
这种方式和我们以前认识的不大一样，但我们要记住这是C中一种传参的形式，在后面我们就会用到它。

函数参数的传递原理

　　函数参数是以数据结构:栈的形式存取,从右至左入栈。

　　首先是参数的内存存放格式：参数存放在内存的堆栈段中，在执行函数的时候，从最后一个开始入栈。因此栈底高地址，栈顶低地址，举个例子如下：
void func(int x, float y, char z);
　　那么，调用函数的时候，实参 char z 先进栈，然后是 float y，最后是 int x，因此在内存中变量的存放次序是 x->y->z，因此，从理论上说，我们只要探测到任意一个变量的地址，并且知道其他变量的类型，通过指针移位运算，则总可以顺藤摸瓜找到其他的输入变量。

　　下面是 <stdarg.h> 里面重要的几个宏定义如下, ios的不太一样,可以参考下：
typedef char* va_list;
void va_start ( va_list ap, prev_param );
type va_arg ( va_list ap, type );
void va_end ( va_list ap );
va_list 是一个字符指针，可以理解为指向当前参数的一个指针，取参必须通过这个指针进行。
<Step 1> 在调用参数表之前，定义一个 va_list 类型的变量，(假设va_list 类型变量被定义为ap)；
<Step 2> 然后应该对ap 进行初始化，让它指向可变参数表里面的第一个参数，这是通过 va_start 来实现的，第一个参数是 ap 本身，第二个参数是在变参表前面紧挨着的一个变量,即“...”之前的那个参数；
<Step 3> 然后是获取参数，调用va_arg，它的第一个参数是ap，第二个参数是要获取的参数的指定类型，然后返回这个指定类型的值，并且把 ap 的位置指向变参表的下一个变量位置；
<Step 4> 获取所有的参数之后，我们有必要将这个 ap 指针关掉，以免发生危险，方法是调用 va_end，他是输入的参数 ap 置为 NULL，应该养成获取完参数表之后关闭指针的习惯。说白了，就是让我们的程序具有健壮性。通常va_start和va_end是成对出现。

例如 int max(int n, ...); 其函数内部应该如此实现：

#include <iostream.h>
void fun(int a, ...) {
　　int *temp = &a;
　　temp++;
　　for (int i = 0; i < a; ++i) {
　　　　cout << *temp << endl;
　　　　temp++;
　　}
}
int main()
{
　　int a = 1;
　　int b = 2;
　　int c = 3;
　　int d = 4;
　　fun(4, a, b, c, d);
　　system("pause");
　　return 0;
}

Output::
1
2
3
4

下面用2个ios的方法演示如何使用,

第一个方法把可变参数格式化成一个String, 应用的比较多, 很多三方库都是类似的用法; 
第二个函数演示了如何依次把可变参数的每个值取出来使用,

- (void)viewDidLoad {
    [super viewDidLoad];

    [self strFormat:@"123~~%@",@"124"];
    // 最后一定要放一个nil来标识可变参数的结束, 如果没有标识, 很容易出现野指针
    // 系统的NSArray初始化也要求最后一个值为nil
    [self list:@"123",@"456",@(789),[NSObject new],@[@"hhh"],nil];

}

- (void)strFormat:(NSString *)format,...{
   va_list args;
   va_start(args, format);
   NSString *message = [[NSString alloc] initWithFormat:format arguments:args];
   va_end(args);
   NSLog(@"%@",message);
}

- (void)list:(NSString *)string,...{
    //定义一个指向个数可变的参数列表指针
    va_list args ; // typedef char* va_list;
    //对args（列表指针）进行初始化,它指向可变参数表里面的第一个参数
//    第一个参数是args本身，第二个参数是在变参表前面紧挨着的一个变量,即“...”之前的那个参数；
    va_start(args, string);
    if (string) {
        NSObject *otherArg ;
        NSLog(@"第一个字符串(...之前的变量):%@",string); //输出第一个字符串
        while (1) {
            //va_arg: 第二个参数是获取了类型。然后返回这个指定类型的值
            //并把args的位置指向变参表的下一个变量位置
            otherArg = va_arg(args, id);
            if (otherArg == nil) {
                break;
            }else{
                NSLog(@"可变参数: %@",otherArg);
            }
        }

    }
    //va_end(arg_ptr)：清空参数列表，并置参数指针arg_ptr无效
    //获取完成后，需要将指针关掉，以避免发生野指针危险
    va_end(args);
}



123~~124

第一个字符串(...之前的变量):123
可变参数: 456
可变参数: 789
可变参数: <NSObject: 0x60000117c3c0>
可变参数: (
    hhh
)

DDLog, GCDWebServer的使用: 

参考: https://www.cnblogs.com/hanyonglu/archive/2011/04/19/2020738.html
https://www.cnblogs.com/hanyonglu/archive/2011/05/07/2039916.html
https://blog.csdn.net/grozy_sun/article/details/27634575

---

__func__ , __FUNCTION__ 和 __PRETTY_FUNCTION__的区别

在c语言的方法中,__PRETTY_FUNCTION__ 会把参数类型和返回值打印出来,

在OC的方法中,3者打印的内容完全一样,

__func__   是C99的标准，但是GCC只输出函数名称。

__FUNCTION__  同__func__，

__PRETTY_FUNCTION__  是一个非标准宏。这个宏比__FUNCTION__功能更强,  若用g++编译C++程序, __FUNCTION__只能输出类的成员名,不会输出类名;而__PRETTY_FUNCTION__则会以 <return-type>  <class-name>::<member-function-name>(<parameters-list>) 的格式输出成员函数的详悉信息. 
由于OC的方法是不区分参数类型的, 所以对于返回值和入参也没法打印, 在OC的方法中, 三者打印内容完全一样.