lib/argp-fmtstream.h

   1 /* Word-wrapping and line-truncating streams.
   2    Copyright (C) 1997-2020 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Written by Miles Bader <miles@gnu.ai.mit.edu>.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  18
  19 /* This package emulates glibc 'line_wrap_stream' semantics for systems that
  20    don't have that.  If the system does have it, it is just a wrapper for
  21    that.  This header file is only used internally while compiling argp, and
  22    shouldn't be installed.  */
  23
  24 #ifndef _ARGP_FMTSTREAM_H
  25 #define _ARGP_FMTSTREAM_H
  26
  27 #include <stdio.h>
  28 #include <string.h>
  29 #include <unistd.h>
  30
  31 /* The __attribute__ feature is available in gcc versions 2.5 and later.
  32    The __-protected variants of the attributes 'format' and 'printf' are
  33    accepted by gcc versions 2.6.4 (effectively 2.7) and later.
  34    We enable _GL_ATTRIBUTE_FORMAT only if these are supported too, because
  35    gnulib and libintl do '#define printf __printf__' when they override
  36    the 'printf' function.  */
  37 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
  38 # define _GL_ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
  39 #else
  40 # define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
  41 #endif
  42
  43 #if defined (__GNU_LIBRARY__) && defined (HAVE_LINEWRAP_H)
  44 /* line_wrap_stream is available, so use that.  */
  45 #define ARGP_FMTSTREAM_USE_LINEWRAP
  46 #endif
  47
  48 #ifdef ARGP_FMTSTREAM_USE_LINEWRAP
  49 /* Just be a simple wrapper for line_wrap_stream; the semantics are
  50    *slightly* different, as line_wrap_stream doesn't actually make a new
  51    object, it just modifies the given stream (reversibly) to do
  52    line-wrapping.  Since we control who uses this code, it doesn't matter.  */
  53
  54 #include <linewrap.h>
  55
  56 typedef FILE *argp_fmtstream_t;
  57
  58 #define argp_make_fmtstream line_wrap_stream
  59 #define __argp_make_fmtstream line_wrap_stream
  60 #define argp_fmtstream_free line_unwrap_stream
  61 #define __argp_fmtstream_free line_unwrap_stream
  62
  63 #define __argp_fmtstream_putc(fs,ch) putc(ch,fs)
  64 #define argp_fmtstream_putc(fs,ch) putc(ch,fs)
  65 #define __argp_fmtstream_puts(fs,str) fputs(str,fs)
  66 #define argp_fmtstream_puts(fs,str) fputs(str,fs)
  67 #define __argp_fmtstream_write(fs,str,len) fwrite(str,1,len,fs)
  68 #define argp_fmtstream_write(fs,str,len) fwrite(str,1,len,fs)
  69 #define __argp_fmtstream_printf fprintf
  70 #define argp_fmtstream_printf fprintf
  71
  72 #define __argp_fmtstream_lmargin line_wrap_lmargin
  73 #define argp_fmtstream_lmargin line_wrap_lmargin
  74 #define __argp_fmtstream_set_lmargin line_wrap_set_lmargin
  75 #define argp_fmtstream_set_lmargin line_wrap_set_lmargin
  76 #define __argp_fmtstream_rmargin line_wrap_rmargin
  77 #define argp_fmtstream_rmargin line_wrap_rmargin
  78 #define __argp_fmtstream_set_rmargin line_wrap_set_rmargin
  79 #define argp_fmtstream_set_rmargin line_wrap_set_rmargin
  80 #define __argp_fmtstream_wmargin line_wrap_wmargin
  81 #define argp_fmtstream_wmargin line_wrap_wmargin
  82 #define __argp_fmtstream_set_wmargin line_wrap_set_wmargin
  83 #define argp_fmtstream_set_wmargin line_wrap_set_wmargin
  84 #define __argp_fmtstream_point line_wrap_point
  85 #define argp_fmtstream_point line_wrap_point
  86
  87 #else /* !ARGP_FMTSTREAM_USE_LINEWRAP */
  88 /* Guess we have to define our own version.  */
  89
  90 \f
  91 struct argp_fmtstream
  92 {
  93   FILE *stream;                 /* The stream we're outputting to.  */
  94
  95   size_t lmargin, rmargin;      /* Left and right margins.  */
  96   ssize_t wmargin;              /* Margin to wrap to, or -1 to truncate.  */
  97
  98   /* Point in buffer to which we've processed for wrapping, but not output.  */
  99   size_t point_offs;
 100   /* Output column at POINT_OFFS, or -1 meaning 0 but don't add lmargin.  */
 101   ssize_t point_col;
 102
 103   char *buf;                    /* Output buffer.  */
 104   char *p;                      /* Current end of text in BUF. */
 105   char *end;                    /* Absolute end of BUF.  */
 106 };
 107
 108 typedef struct argp_fmtstream *argp_fmtstream_t;
 109
 110 /* Return an argp_fmtstream that outputs to STREAM, and which prefixes lines
 111    written on it with LMARGIN spaces and limits them to RMARGIN columns
 112    total.  If WMARGIN >= 0, words that extend past RMARGIN are wrapped by
 113    replacing the whitespace before them with a newline and WMARGIN spaces.
 114    Otherwise, chars beyond RMARGIN are simply dropped until a newline.
 115    Returns NULL if there was an error.  */
 116 extern argp_fmtstream_t __argp_make_fmtstream (FILE *__stream,
 117                                                size_t __lmargin,
 118                                                size_t __rmargin,
 119                                                ssize_t __wmargin);
 120 extern argp_fmtstream_t argp_make_fmtstream (FILE *__stream,
 121                                              size_t __lmargin,
 122                                              size_t __rmargin,
 123                                              ssize_t __wmargin);
 124
 125 /* Flush __FS to its stream, and free it (but don't close the stream).  */
 126 extern void __argp_fmtstream_free (argp_fmtstream_t __fs);
 127 extern void argp_fmtstream_free (argp_fmtstream_t __fs);
 128
 129 extern ssize_t __argp_fmtstream_printf (argp_fmtstream_t __fs,
 130                                         const char *__fmt, ...)
 131      _GL_ATTRIBUTE_FORMAT ((printf, 2, 3));
 132 extern ssize_t argp_fmtstream_printf (argp_fmtstream_t __fs,
 133                                       const char *__fmt, ...)
 134      _GL_ATTRIBUTE_FORMAT ((printf, 2, 3));
 135
 136 #if _LIBC
 137 extern int __argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch);
 138 extern int argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch);
 139
 140 extern int __argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str);
 141 extern int argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str);
 142
 143 extern size_t __argp_fmtstream_write (argp_fmtstream_t __fs,
 144                                       const char *__str, size_t __len);
 145 extern size_t argp_fmtstream_write (argp_fmtstream_t __fs,
 146                                     const char *__str, size_t __len);
 147 #endif
 148 \f
 149 /* Access macros for various bits of state.  */
 150 #define argp_fmtstream_lmargin(__fs) ((__fs)->lmargin)
 151 #define argp_fmtstream_rmargin(__fs) ((__fs)->rmargin)
 152 #define argp_fmtstream_wmargin(__fs) ((__fs)->wmargin)
 153 #define __argp_fmtstream_lmargin argp_fmtstream_lmargin
 154 #define __argp_fmtstream_rmargin argp_fmtstream_rmargin
 155 #define __argp_fmtstream_wmargin argp_fmtstream_wmargin
 156
 157 #if _LIBC
 158 /* Set __FS's left margin to LMARGIN and return the old value.  */
 159 extern size_t argp_fmtstream_set_lmargin (argp_fmtstream_t __fs,
 160                                           size_t __lmargin);
 161 extern size_t __argp_fmtstream_set_lmargin (argp_fmtstream_t __fs,
 162                                             size_t __lmargin);
 163
 164 /* Set __FS's right margin to __RMARGIN and return the old value.  */
 165 extern size_t argp_fmtstream_set_rmargin (argp_fmtstream_t __fs,
 166                                           size_t __rmargin);
 167 extern size_t __argp_fmtstream_set_rmargin (argp_fmtstream_t __fs,
 168                                             size_t __rmargin);
 169
 170 /* Set __FS's wrap margin to __WMARGIN and return the old value.  */
 171 extern size_t argp_fmtstream_set_wmargin (argp_fmtstream_t __fs,
 172                                           size_t __wmargin);
 173 extern size_t __argp_fmtstream_set_wmargin (argp_fmtstream_t __fs,
 174                                             size_t __wmargin);
 175
 176 /* Return the column number of the current output point in __FS.  */
 177 extern size_t argp_fmtstream_point (argp_fmtstream_t __fs);
 178 extern size_t __argp_fmtstream_point (argp_fmtstream_t __fs);
 179 #endif
 180
 181 /* Internal routines.  */
 182 extern void _argp_fmtstream_update (argp_fmtstream_t __fs);
 183 extern void __argp_fmtstream_update (argp_fmtstream_t __fs);
 184 extern int _argp_fmtstream_ensure (argp_fmtstream_t __fs, size_t __amount);
 185 extern int __argp_fmtstream_ensure (argp_fmtstream_t __fs, size_t __amount);
 186 \f
 187 #if !_LIBC || defined __OPTIMIZE__
 188 /* Inline versions of above routines.  */
 189
 190 #if !_LIBC
 191 #define __argp_fmtstream_putc argp_fmtstream_putc
 192 #define __argp_fmtstream_puts argp_fmtstream_puts
 193 #define __argp_fmtstream_write argp_fmtstream_write
 194 #define __argp_fmtstream_set_lmargin argp_fmtstream_set_lmargin
 195 #define __argp_fmtstream_set_rmargin argp_fmtstream_set_rmargin
 196 #define __argp_fmtstream_set_wmargin argp_fmtstream_set_wmargin
 197 #define __argp_fmtstream_point argp_fmtstream_point
 198 #define __argp_fmtstream_update _argp_fmtstream_update
 199 #define __argp_fmtstream_ensure _argp_fmtstream_ensure
 200 #ifndef _GL_INLINE_HEADER_BEGIN
 201  #error "Please include config.h first."
 202 #endif
 203 _GL_INLINE_HEADER_BEGIN
 204 #ifndef ARGP_FS_EI
 205 # define ARGP_FS_EI _GL_INLINE
 206 #endif
 207 #endif
 208
 209 #ifndef ARGP_FS_EI
 210 #define ARGP_FS_EI extern inline
 211 #endif
 212
 213 ARGP_FS_EI size_t
 214 __argp_fmtstream_write (argp_fmtstream_t __fs, const char *__str, size_t __len)
 215 {
 216   if (__fs->p + __len <= __fs->end || __argp_fmtstream_ensure (__fs, __len))
 217     {
 218       memcpy (__fs->p, __str, __len);
 219       __fs->p += __len;
 220       return __len;
 221     }
 222   else
 223     return 0;
 224 }
 225
 226 ARGP_FS_EI int
 227 __argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str)
 228 {
 229   size_t __len = strlen (__str);
 230   if (__len)
 231     {
 232       size_t __wrote = __argp_fmtstream_write (__fs, __str, __len);
 233       return __wrote == __len ? 0 : -1;
 234     }
 235   else
 236     return 0;
 237 }
 238
 239 ARGP_FS_EI int
 240 __argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch)
 241 {
 242   if (__fs->p < __fs->end || __argp_fmtstream_ensure (__fs, 1))
 243     return *__fs->p++ = __ch;
 244   else
 245     return EOF;
 246 }
 247
 248 /* Set __FS's left margin to __LMARGIN and return the old value.  */
 249 ARGP_FS_EI size_t
 250 __argp_fmtstream_set_lmargin (argp_fmtstream_t __fs, size_t __lmargin)
 251 {
 252   size_t __old;
 253   if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
 254     __argp_fmtstream_update (__fs);
 255   __old = __fs->lmargin;
 256   __fs->lmargin = __lmargin;
 257   return __old;
 258 }
 259
 260 /* Set __FS's right margin to __RMARGIN and return the old value.  */
 261 ARGP_FS_EI size_t
 262 __argp_fmtstream_set_rmargin (argp_fmtstream_t __fs, size_t __rmargin)
 263 {
 264   size_t __old;
 265   if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
 266     __argp_fmtstream_update (__fs);
 267   __old = __fs->rmargin;
 268   __fs->rmargin = __rmargin;
 269   return __old;
 270 }
 271
 272 /* Set FS's wrap margin to __WMARGIN and return the old value.  */
 273 ARGP_FS_EI size_t
 274 __argp_fmtstream_set_wmargin (argp_fmtstream_t __fs, size_t __wmargin)
 275 {
 276   size_t __old;
 277   if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
 278     __argp_fmtstream_update (__fs);
 279   __old = __fs->wmargin;
 280   __fs->wmargin = __wmargin;
 281   return __old;
 282 }
 283
 284 /* Return the column number of the current output point in __FS.  */
 285 ARGP_FS_EI size_t
 286 __argp_fmtstream_point (argp_fmtstream_t __fs)
 287 {
 288   if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
 289     __argp_fmtstream_update (__fs);
 290   return __fs->point_col >= 0 ? __fs->point_col : 0;
 291 }
 292
 293 #if !_LIBC
 294 #undef __argp_fmtstream_putc
 295 #undef __argp_fmtstream_puts
 296 #undef __argp_fmtstream_write
 297 #undef __argp_fmtstream_set_lmargin
 298 #undef __argp_fmtstream_set_rmargin
 299 #undef __argp_fmtstream_set_wmargin
 300 #undef __argp_fmtstream_point
 301 #undef __argp_fmtstream_update
 302 #undef __argp_fmtstream_ensure
 303 _GL_INLINE_HEADER_END
 304 #endif
 305
 306 #endif /* !_LIBC || __OPTIMIZE__ */
 307
 308 #endif /* ARGP_FMTSTREAM_USE_LINEWRAP */
 309
 310 #endif /* argp-fmtstream.h */