warzone2100/lib/framework/printf_ext.h

83 lines
3.4 KiB
C

/*
This file is part of Warzone 2100.
Copyright (C) 2007 Giel van Schijndel
Copyright (C) 2007 Warzone Resurrection Project
Warzone 2100 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Warzone 2100 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __INCLUDE_LIB_FRAMEWORK_PRINTF_EXT_H__
#define __INCLUDE_LIB_FRAMEWORK_PRINTF_EXT_H__
#include "frame.h"
#include <stdarg.h>
/** A variant on snprintf which appends its output string to the given string
* buffer, rather than to replace it.
* \param str the string to append to
* \param size the size of the buffer \c str expressed in bytes
* \param format the formatting string
* \param ap a variable arguments list of variables to use in the formatting
* string
* \return the amount of characters appended to the string
*/
extern int vslcatprintf(char* str, size_t size, const char* format, va_list ap);
/** A variant on snprintf which appends its output string to the given string
* The function's interface is similar to vslcatprintf(), so look at that
* function's description.
*/
extern int slcatprintf(char* str, size_t size, const char* format, ...) WZ_DECL_FORMAT(printf, 3, 4);
#if defined(WZ_OS_WIN)
// These functions are GNU extensions; so make sure they are available on Windows also
extern int vasprintf(char** strp, const char* format, va_list ap);
extern int asprintf(char** strp, const char* format, ...) WZ_DECL_FORMAT(printf, 2, 3);
#endif
#if defined(WZ_CC_MSVC)
// Make sure that these functions are available, and work according to the C99 spec on MSVC also
extern int wz_vsnprintf(char* str, size_t size, const char* format, va_list ap);
extern int wz_snprintf(char* str, size_t size, const char* format, ...);
// Necessary to prevent conflicting symbols with MSVC's own (incorrect!) implementations of these functions
# define vsnprintf wz_vsnprintf
# define snprintf wz_snprintf
#elif defined(__cplusplus) && defined(WZ_CC_GNU)
// Do nothing here, and assume that G++ has a proper implementation of snprintf and vsnprintf
#elif !defined(WZ_CC_GNU) && !defined(WZ_C99)
# error "This code depends on a C99-compliant implementation of snprintf and vsnprintf; please compile as C99 or provide a compliant implementation!"
#endif
// A stack-allocating variant of sprintf
#define sasprintf(strp, format, ...) \
do { \
/* Make sure to evaluate "format" just once */ \
const char* fmt = format; \
/* Determine the size of the string we're going to produce */ \
size_t size = snprintf(NULL, 0, fmt, __VA_ARGS__); \
\
/* Let the compiler perform some static type-checking */ \
char** var = strp; \
\
/* Allocate a buffer large enough to hold our string on the stack*/ \
*var = (char*)alloca(size + 1); \
/* Print into our newly created string-buffer */ \
sprintf(*var, fmt, __VA_ARGS__); \
} while(0)
#endif // __INCLUDE_LIB_FRAMEWORK_PRINTF_EXT_H__