blob: 864f7c25b286f5a49f8c833d1542f6bebd3730f1 [file] [log] [blame]
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* Polyfills snprintf() on platforms that don't provide it, and provides
* related utilities. */
#ifndef mozilla_Snprintf_h_
#define mozilla_Snprintf_h_
#include <stddef.h>
#include <stdio.h>
#include <stdarg.h>
// Older MSVC versions do not provide snprintf(), but they do provide
// vsnprintf(), which has the same semantics except that if the number of
// characters written equals the buffer size, it does not write a null
// terminator, so we wrap it to do so.
#if defined(_MSC_VER) && _MSC_VER < 1900
#include "mozilla/Attributes.h"
MOZ_ALWAYS_INLINE int snprintf(char* buffer, size_t n, const char* format, ...)
{
va_list args;
va_start(args, format);
int result = vsnprintf(buffer, n, format, args);
va_end(args);
buffer[n - 1] = '\0';
return result;
}
#endif
// In addition, in C++ code, on all platforms, provide an snprintf_literal()
// function which uses template argument deduction to deduce the size of the
// buffer, avoiding the need for the user to pass it in explicitly.
#ifdef __cplusplus
template <size_t N>
int snprintf_literal(char (&buffer)[N], const char* format, ...)
{
va_list args;
va_start(args, format);
int result = vsnprintf(buffer, N, format, args);
va_end(args);
buffer[N - 1] = '\0';
return result;
}
#endif
#endif /* mozilla_Snprintf_h_ */