argp/argp-fmtstream.h

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