可变参数列表-C++学习笔记#1

本文章首发于我的个人博客，希望大家多多支持！

---

Hi! This is Showhoop Studio!

在开始游戏开发之路后，一直在写C#和Javascript相关的脚本代码，接触C++的时间越来越少，直到最近开始研究游戏引擎架构之后，才开始慢慢重新拾起C++。在学习游戏引擎底层代码的过程中，又发现了许多之前不曾用过的C++特性，于是决定将其一一记录下来供自己随时学习。

概览

当一个函数中的参数个数不确定时，就需要使用带有可变参数列表的函数。实际上，C库函数中的printf就是一个可变参数的函数。我们先来看看它的原型：

int printf(const char *format, ...);

我们可以看到在变量format之后还有一个...，而这个...所表示的就是这个函数除了第一个format是固定的参数以外，之后的参数的类型和个数都是可变的。所以，对于printf我们可以有以下几个不同的调用方法：

printf("%d", output1);
printf("%s", output2);
printf("%d%s", output1, output2);

这就是带可变参数的函数。

实现

对可变参数的操作是通过几个宏来实现的：

void va_start (va_list ap, paramN);
void va_end (va_list ap);
type va_arg (va_list ap, type);
int vsprint (char *s, const *format, va_list arg);

值得一提的是，一个va_start一定对应一个va_end，而且C++的函数形参的入栈顺序为从右至左，所以栈顶是第一个参数。

使用

介绍

首先，要使用可变参数就需要引入对应的头文件：

// 以下两种根据具体环境使用
#include <cstarg>
#include <starg.h>

va_list

一个用来存储可变参数的数据类型：

va_list ap;

va_arg

这个宏可以表示可变参数列表中type类型的当前参数的值。每次调用这个宏都会改变va_list的状态，会使其指针后移一位。然而这个宏并不会确定目前所访问的参数是否是列表中的最后一个参数，所以在使用的时候我们必须设计某种方法来确定参数个数。例如之前所提到的：

printf("%d", output1);
printf("%s", output2);
printf("%d%s", output1, output2);

printf中固定的参数format就能够确定接下来会有几个参数被传入这个函数。

va_start

调用这个宏可以让va_list去获取paramN（最后一个固定参数，因为固定参数可能不止一个）之后的第一个可变参数，并以此初始化va_list。

va_end

清空参数列表，并使参数指针无效。

vsprintf

将参数列表中的数据格式化地写入到指定字符串中。第一个参数表示最终的字符串结果，第二个参数则是格式，第三个是已初始化的参数列表。

实例

#include <cstdio>
#include <cstdarg>

void PrintError (const char *format, ...)
{
    char buffer[256];
    va_list args;
    va_start (args, format);
    vsprintf (buffer, format, args);
    perror (buffer);
    va_end (args);
}

int main()
{
    FILE *pFile;
    char szFileName[] = "myfile.txt";

    pFile = fopen(szFileName, "r");
    if(pFile == NULL)
    {
        PrintError("Error opning '%s'", szFileName);
    }
    else
    {
        fclose(pFile);
    }
    return 0;
}

相信阅读完这个实例和之前的printf，你对可变参数应该已经有一定了解并且能试着使用它了。

参考

[1] C++ Mannual link

---

欢迎在评论区留下自己的问题，我会尽快给出回复。你也可以指出文章的纰漏，或是给出你对文章的其他看法。你也可以在文章页面右侧的在线聊天室与我取得联系。如果你喜欢这篇文章，可以点击文末或者页面左侧的分享按钮分享给其他人，非常感谢！