asprintf

sprintf() 的整个介面长的样子的是：

　　int sprintf ( char * str, const char * format, ... )

　　也就是在使用前，必须要先建立好一个字元阵列的空间，再用这个函式把内容填入，下面就是简单的例子：

　　int tmp = 10;

　　char cstr[20];

　　sprintf( cstr, "%d * %d = %d", tmp, tmp, tmp * tmp );

　　在这个例子里，cstr 最后的值，会是「10 * 10 = 100」，看起来好像很好？但是如果把 tmp 的值改成 10000 的话，cstr 则应该要变成「10000 * 10000 = 100000000」，但是由於这时候的字串所需长度为 26，而要写入的 cstr 的长度只有 20，所以就会造成 buffer overflow 的问题。

　　像如果是以 Visual C++ 2006 来编译的话，如果程式里有用到 sprintf()，他在编译时就会显示一个警告讯息：

　　warning C4996: 'sprintf': This function or variable may be unsafe. Consider using sprintf_s instead.

　　而要怎麼避免 sprintf 的 buffer overflow 的问题呢？除了微软建议的 sprintf_s() 外，实际上在 C99 里， 也多了一个 snprinf() 是用来取代现有的 sprintf() 了～他的介面是：

　　int snprintf(char *str, size_t size, const char * restrict format, ...)

　　应该可以明显看得出来，snprinf() 这个函式比 sprintf() 多了一个参数 size；这个参数的用处，就是用来限制最大的写入资料量，可以用来避免 buffer overflow。以上面的例子来说，本来写：

　　int tmp = 10000;

　　char cstr[20];

　　sprintf( cstr, "%d * %d = %d", tmp, tmp, tmp * tmp );

　　的话，会产生 buffer overflow 的问题。而如果改成用 snprinf() 的话，就是变成：

　　int tmp = 10000;

　　char cstr[20];

　　snprintf( cstr, sizeof( cstr ), "%d * %d = %d", tmp, tmp, tmp * tmp );

　　这样一来，snprinf() 在把资料写到 cstr 时，最多就只会写入 20 个字元（cstr 的长度），而不会有 buffer overflow 的问题了～

　　不过比较讨厌的是，MSVC 似乎并没有直接给这个函式，而是另外给了一个 _snprinf()…虽然功能和参数都大同小异，但是光函式名称不一样，就已经增加了些麻烦，更别说在行为模式上也有些不同了。而 _snprinf() 和 snprintf() 主要的差别在於：

　　_snprintf() (MSVC) snprintf()

　　回传值当 len <= size 时，会回传 len

　　当 len > size 时，会回传负值（-1）

　　正常状况会回传 len。

　　如果有错误，回传负值（-1）

　　字串内容当 len < size 时，str 会包含结尾的 '\0'

　　当 len >= size 时，str 不会有结尾的 '\0'

　　str 会包含结尾的 '\0'

　　len：要输出的字串应有的长度，不包含结尾的 '\0'。

　　size：snprintf / _snprintf 的第二个参数，写到 str 的最大资料量。

　　所以如果要跨平台，大致上应该可以：

　　如果是使用 MSVC 的话，自行定义 snprintf，让它变成 _snprintf

　　#ifdef _MSC_VER

　　#define snprintf _snprintf

　　#endif

　　实际使用，则就可以直接用 snprintf

　　int tmp = 10000;

　　char cstr[20];

　　int size = sizeof( cstr );

　　int c = snprintf( cstr, size, "%d * %d = %d", tmp, tmp, tmp*tmp );

　　if( c > size || c < 0 )

　　cstr[ size 1 ] = '\0';

　　这样应该就可以在 g++ 和 MSVC 的环境里，都可以避免 buffer overflow 和字串结尾没有 '\0' 的问题了～

　　但是这样的做法，实际上是产生一个最大长度为 20 的字串，如果超过的话，虽然不会有 buffer overflow 的问题，但是过长的部分还是要切掉。而如果希望可以针对需要，产生一个够长的字串的话，其实还可以使用 asprintf() 这个函式。他的用法很简单，基本上和 sprintf() 很像，只是将第一个参数改成一个 char** 而已；下方就是简单的范例：

　　char* cstr;

　　int c = asprintf( &cstr, "%d * %d = %d", tmp, tmp, tmp*tmp );

　　如此一来，他就会自动替 cstr 产生一块够大的记忆体空间，来存放字串了～

　　不过 asprintf() 这个函式应该不在 C 语言的标准内，而是 GNU 的 extension（可能要加上「#define _GNU_SOURCE」才能使用），所以在 MSVC 里并没有提供 asprintf() 可以使用。不过虽然没有现成的可以用，但是还是可以透过执行两次 snprintf() 来做到同样的功能～实作的方法，大致上就是：

　　char* cstr;

　　int c = snprintf( NULL, 0, "%d * %d = %d", tmp, tmp, tmp*tmp );

　　cstr = new char[ c + 1 ];

　　snprintf( cstr, c + 1, "%d * %d = %d", tmp, tmp, tmp*tmp );

　　做法的主要概念，就是第一次的 _snprintf() 实际上并不真正的将字串写到某个空间，而是单纯用来取得字串所需要的长度，然后再根据需要的长度来产生字元阵列，并将资料写入。