src/share/grabbag/snprintf.c

   1 /* libFLAC - Free Lossless Audio Codec library
   2  * Copyright (C) 2013  Xiph.org Foundation
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * - Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * - Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution.
  14  *
  15  * - Neither the name of the Xiph.org Foundation nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #if HAVE_CONFIG_H
  33 #  include <config.h>
  34 #endif
  35
  36 #include <stdio.h>
  37 #include <stdarg.h>
  38
  39 #include "share/compat.h"
  40
  41 /*
  42  * FLAC needs to compile and work correctly on systems with a norrmal ISO C99
  43  * snprintf as well as Microsoft Visual Studio which has an non-standards
  44  * conformant snprint_s function.
  45  *
  46  * The important difference occurs when the resultant string (plus string
  47  * terminator) would have been longer than the supplied size parameter. When
  48  * this happens, ISO C's snprintf returns the length of resultant string, but
  49  * does not over-write the end of the buffer. MS's snprintf_s in this case
  50  * returns -1.
  51  *
  52  * The _MSC_VER code below attempts to modify the return code for snprintf_s
  53  * to something that is more compatible with the behaviour of the ISO C version.
  54  */
  55
  56 int
  57 flac_snprintf(char *str, size_t size, const char *fmt, ...)
  58 {
  59         va_list va;
  60         int rc ;
  61
  62         va_start (va, fmt);
  63
  64 #ifdef _MSC_VER
  65         rc = vsnprintf_s (str, size, fmt, va);
  66         rc = (rc > 0) ? rc : (size == 0 ? 1024 : size * 2);
  67 #else
  68         rc = vsnprintf (str, size, fmt, va);
  69 #endif
  70         va_end (va);
  71
  72         return rc;
  73 }