git.sur5r.net Git - cc65/blob - src/common/xsprintf.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                xsprintf.h                                 */
   4 /*                                                                           */
   5 /*                       Replacement sprintf function                        */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2008 Ullrich von Bassewitz                                       */
  10 /*               Roemerstrasse 52                                            */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 /* We need a way to output a StrBuf, but on the other side, we don't want to
  37 ** switch off gcc's printf format string checking. So we cheat as follows:
  38 ** %m (which is a gcc extension and doesn't take an argument) switches %p
  39 ** between outputting a pointer and a string buf. This works just one time,
  40 ** so each StrBuf needs in fact a %m%p spec. There's no way to apply a width
  41 ** and precision to such a StrBuf, but *not* using %p would bring up a warning
  42 ** about a wrong argument type each time. Maybe gcc will one day allow custom
  43 ** format specifiers and we can change this ...
  44 */
  45
  46
  47
  48 #ifndef XSPRINTF_H
  49 #define XSPRINTF_H
  50
  51
  52
  53 #include <stdlib.h>
  54 #include <stdarg.h>
  55
  56 #include "attrib.h"
  57
  58
  59
  60 /*****************************************************************************/
  61 /*                                   Code                                    */
  62 /*****************************************************************************/
  63
  64
  65
  66 int xvsnprintf (char* Buf, size_t Size, const char* Format, va_list ap)
  67         attribute ((format (printf, 3, 0)));
  68 /* A basic vsnprintf implementation. Does currently only support integer
  69 ** formats.
  70 */
  71
  72 int xsnprintf (char* Buf, size_t Size, const char* Format, ...)
  73         attribute ((format (printf, 3, 4)));
  74 /* A basic snprintf implementation. Does currently only support integer
  75 ** formats.
  76 */
  77
  78 int xsprintf (char* Buf, size_t BufSize, const char* Format, ...)
  79         attribute ((format (printf, 3, 4)));
  80 /* Replacement function for sprintf. Will FAIL on errors. */
  81
  82 int xvsprintf (char* Buf, size_t BufSize, const char* Format, va_list ap)
  83         attribute ((format (printf, 3, 0)));
  84 /* Replacement function for sprintf. Will FAIL on errors. */
  85
  86
  87
  88 /* End of xsprintf.h */
  89
  90 #endif