chiark - git - mdw - mLib/blob - utils/gprintf.h

   1 /* -*-c-*-
   2  *
   3  * Generalized string formatting
   4  *
   5  * (c) 2023 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the mLib utilities library.
  11  *
  12  * mLib is free software: you can redistribute it and/or modify it under
  13  * the terms of the GNU Library General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or (at
  15  * your option) any later version.
  16  *
  17  * mLib is distributed in the hope that it will be useful, but WITHOUT
  18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  20  * License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with mLib.  If not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  25  * USA.
  26  */
  27
  28 #ifndef MLIB_GPRINTF_H
  29 #define MLIB_GPRINTF_H
  30
  31 #ifdef __cplusplus
  32   extern "C" {
  33 #endif
  34
  35 /*----- Header files ------------------------------------------------------*/
  36
  37 #include <stdarg.h>
  38
  39 #ifndef MLIB_ARENA_H
  40 #  include "arena.h"
  41 #endif
  42
  43 #ifndef MLIB_MACROS_H
  44 #  include "macros.h"
  45 #endif
  46
  47 /*----- Data structures ---------------------------------------------------*/
  48
  49 struct gprintf_ops {
  50   int (*putch)(void */*out*/, int /*ch*/);
  51   int (*putm)(void */*out*/, const char */*p*/, size_t /*sz*/);
  52   PRINTF_LIKE(3, 4)
  53     int (*nputf)(void */*out*/, size_t /*maxsz*/, const char */*p*/, ...);
  54 };
  55
  56 extern const struct gprintf_ops file_printops;
  57
  58 /*----- Functions provided ------------------------------------------------*/
  59
  60 /* --- @gprintf@, @vgprintf@ --- *
  61  *
  62  * Arguments:   @const struct gprintf_ops *ops@ = output operations
  63  *              @void *out@ = context for output operations
  64  *              @const char *p@ = pointer to @printf@-style format string
  65  *              @...@ = format arguments
  66  *              @va_list *ap@ = captured format-arguments tail
  67  *
  68  * Returns:     The number of characters written to the string.
  69  *
  70  * Use:         Formats a @printf@-like message and writes the result using
  71  *              the given output operations.  This is the backend machinery
  72  *              for @dstr_putf@, for example.
  73  *
  74  *              The @gprintf@ function receives its format arguments as a
  75  *              variable-length argument tail; the @vgprintf@ function
  76  *              receives them as %%\emph{a pointer to}%% a captured argument
  77  *              tail; it updates @*ap@, leaving it ready to read the next
  78  *              unused argument.
  79  */
  80
  81 extern PRINTF_LIKE(3, 4)
  82   int gprintf(const struct gprintf_ops */*ops*/, void */*out*/,
  83               const char */*p*/, ...);
  84 extern int vgprintf(const struct gprintf_ops */*ops*/, void */*out*/,
  85                     const char */*p*/, va_list */*ap*/);
  86
  87 /* --- @gprintf_memputf@ --- *
  88  *
  89  * Arguments:   @arena *a@ = memory allocation arena
  90  *              @char **buf_inout@ = address of output buffer pointer
  91  *              @size_t *sz_inout@ = address of buffer size
  92  *              @size_t maxsz@ = buffer size needed for this operation
  93  *              @const char *p@ = pointer to format string
  94  *              @va_list *ap@ = captured format-arguments tail
  95  *
  96  * Returns:     The formatted length.
  97  *
  98  * Use:         Generic utility for mostly implementing the @nputf@ output
  99  *              function, if you don't have a better option.
 100  *
 101  *              On entry, @*buf_inout@ should be null or a buffer pointer,
 102  *              with @*sz_inout@ either zero or the buffer's size,
 103  *              respectively.  On exit, @*buf_input@ and @*sz_inout@ will be
 104  *              updated, if necessary, to describe a sufficiently large
 105  *              buffer, and the formatted string will have been written to
 106  *              the buffer.
 107  *
 108  *              When the buffer is no longer required, free it using
 109  *              @x_free@.
 110  */
 111
 112 extern size_t gprintf_memputf(arena */*a*/,
 113                               char **/*buf_inout*/, size_t */*sz_inout*/,
 114                               size_t /*maxsz*/,
 115                               const char */*p*/, va_list /*ap*/);
 116
 117 /*----- That's all, folks -------------------------------------------------*/
 118
 119 #ifdef __cplusplus
 120   }
 121 #endif
 122
 123 #endif