mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-15 07:00:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

spa/util: add spa_scnprintf to use over snprintf

Browse source 
Wraps the glibc snprintf/vsnprintf calls, but aborts if given a negative size
and zero-terminates the buffer on error.

The returned value is clipped to size - 1 which avoids issues like the one
fixed in c851349f17.
This commit is contained in:
Peter Hutterer 2021-05-30 20:21:00 +10:00
parent 5a054cfc9e
commit 47c173c83f
2 changed files with 107 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

45
spa/include/spa/utils/string.h
View file

@ -29,6 +29,7 @@
extern "C" {
#endif
#include <stdarg.h>
#include <stdbool.h>
#include <errno.h>
@ -178,6 +179,50 @@ static inline bool spa_atob(const char *str)
return spa_streq(str, "true") || spa_streq(str, "1");
}
/**
* "Safe" version of vsnprintf. Exactly the same as vsnprintf but the
* returned value is clipped to `size - 1` and a negative or zero size
* will abort() the program.
*
* \return The number of bytes printed, capped to `size-1`, or a negative
* number on error.
*/
SPA_PRINTF_FUNC(3, 0)
static inline int spa_vscnprintf(char *buffer, size_t size, const char *format, va_list args)
{
int r;
spa_assert((ssize_t)size > 0);
r = vsnprintf(buffer, size, format, args);
if (SPA_UNLIKELY(r < 0))
buffer[0] = '\0';
if (SPA_LIKELY(r < (ssize_t)size))
return r;
return size - 1;
}
/**
* "Safe" version of snprintf. Exactly the same as snprintf but the
* returned value is clipped to `size - 1` and a negative or zero size
* will abort() the program.
*
* \return The number of bytes printed, capped to `size-1`, or a negative
* number on error.
*/
SPA_PRINTF_FUNC(3, 4)
static inline int spa_scnprintf(char *buffer, size_t size, const char *format, ...)
{
int r;
va_list args;
va_start(args, format);
r = spa_vscnprintf(buffer, size, format, args);
va_end(args);
return r;
}
/**
* Convert \a str to a float and store the result in \a val.
*