lib/argp-fmtstream.h

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