1 /* Word-wrapping and line-truncating streams.
2 Copyright (C) 1997, 2006 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Written by Miles Bader <miles@gnu.ai.mit.edu>.
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.
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.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
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. */
24 #ifndef _ARGP_FMTSTREAM_H
25 #define _ARGP_FMTSTREAM_H
32 /* This feature is available in gcc versions 2.5 and later. */
33 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
34 # define __attribute__(Spec) /* empty */
36 /* The __-protected variants of `format' and `printf' attributes
37 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */
38 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7) || __STRICT_ANSI__
39 # define __format__ format
40 # define __printf__ printf
44 #if (_LIBC - 0 && !defined (USE_IN_LIBIO)) \
45 || (defined (__GNU_LIBRARY__) && defined (HAVE_LINEWRAP_H))
46 /* line_wrap_stream is available, so use that. */
47 #define ARGP_FMTSTREAM_USE_LINEWRAP
50 #ifdef ARGP_FMTSTREAM_USE_LINEWRAP
51 /* Just be a simple wrapper for line_wrap_stream; the semantics are
52 *slightly* different, as line_wrap_stream doesn't actually make a new
53 object, it just modifies the given stream (reversibly) to do
54 line-wrapping. Since we control who uses this code, it doesn't matter. */
58 typedef FILE *argp_fmtstream_t;
60 #define argp_make_fmtstream line_wrap_stream
61 #define __argp_make_fmtstream line_wrap_stream
62 #define argp_fmtstream_free line_unwrap_stream
63 #define __argp_fmtstream_free line_unwrap_stream
65 #define __argp_fmtstream_putc(fs,ch) putc(ch,fs)
66 #define argp_fmtstream_putc(fs,ch) putc(ch,fs)
67 #define __argp_fmtstream_puts(fs,str) fputs(str,fs)
68 #define argp_fmtstream_puts(fs,str) fputs(str,fs)
69 #define __argp_fmtstream_write(fs,str,len) fwrite(str,1,len,fs)
70 #define argp_fmtstream_write(fs,str,len) fwrite(str,1,len,fs)
71 #define __argp_fmtstream_printf fprintf
72 #define argp_fmtstream_printf fprintf
74 #define __argp_fmtstream_lmargin line_wrap_lmargin
75 #define argp_fmtstream_lmargin line_wrap_lmargin
76 #define __argp_fmtstream_set_lmargin line_wrap_set_lmargin
77 #define argp_fmtstream_set_lmargin line_wrap_set_lmargin
78 #define __argp_fmtstream_rmargin line_wrap_rmargin
79 #define argp_fmtstream_rmargin line_wrap_rmargin
80 #define __argp_fmtstream_set_rmargin line_wrap_set_rmargin
81 #define argp_fmtstream_set_rmargin line_wrap_set_rmargin
82 #define __argp_fmtstream_wmargin line_wrap_wmargin
83 #define argp_fmtstream_wmargin line_wrap_wmargin
84 #define __argp_fmtstream_set_wmargin line_wrap_set_wmargin
85 #define argp_fmtstream_set_wmargin line_wrap_set_wmargin
86 #define __argp_fmtstream_point line_wrap_point
87 #define argp_fmtstream_point line_wrap_point
89 #else /* !ARGP_FMTSTREAM_USE_LINEWRAP */
90 /* Guess we have to define our own version. */
94 FILE *stream; /* The stream we're outputting to. */
96 size_t lmargin, rmargin; /* Left and right margins. */
97 ssize_t wmargin; /* Margin to wrap to, or -1 to truncate. */
99 /* Point in buffer to which we've processed for wrapping, but not output. */
101 /* Output column at POINT_OFFS, or -1 meaning 0 but don't add lmargin. */
104 char *buf; /* Output buffer. */
105 char *p; /* Current end of text in BUF. */
106 char *end; /* Absolute end of BUF. */
109 typedef struct argp_fmtstream *argp_fmtstream_t;
111 /* Return an argp_fmtstream that outputs to STREAM, and which prefixes lines
112 written on it with LMARGIN spaces and limits them to RMARGIN columns
113 total. If WMARGIN >= 0, words that extend past RMARGIN are wrapped by
114 replacing the whitespace before them with a newline and WMARGIN spaces.
115 Otherwise, chars beyond RMARGIN are simply dropped until a newline.
116 Returns NULL if there was an error. */
117 extern argp_fmtstream_t __argp_make_fmtstream (FILE *__stream,
121 extern argp_fmtstream_t argp_make_fmtstream (FILE *__stream,
126 /* Flush __FS to its stream, and free it (but don't close the stream). */
127 extern void __argp_fmtstream_free (argp_fmtstream_t __fs);
128 extern void argp_fmtstream_free (argp_fmtstream_t __fs);
130 extern ssize_t __argp_fmtstream_printf (argp_fmtstream_t __fs,
131 const char *__fmt, ...)
132 __attribute__ ((__format__ (printf, 2, 3)));
133 extern ssize_t argp_fmtstream_printf (argp_fmtstream_t __fs,
134 const char *__fmt, ...)
135 __attribute__ ((__format__ (printf, 2, 3)));
137 extern int __argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch);
138 extern int argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch);
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);
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);
148 /* Access macros for various bits of state. */
149 #define argp_fmtstream_lmargin(__fs) ((__fs)->lmargin)
150 #define argp_fmtstream_rmargin(__fs) ((__fs)->rmargin)
151 #define argp_fmtstream_wmargin(__fs) ((__fs)->wmargin)
152 #define __argp_fmtstream_lmargin argp_fmtstream_lmargin
153 #define __argp_fmtstream_rmargin argp_fmtstream_rmargin
154 #define __argp_fmtstream_wmargin argp_fmtstream_wmargin
156 /* Set __FS's left margin to LMARGIN and return the old value. */
157 extern size_t argp_fmtstream_set_lmargin (argp_fmtstream_t __fs,
159 extern size_t __argp_fmtstream_set_lmargin (argp_fmtstream_t __fs,
162 /* Set __FS's right margin to __RMARGIN and return the old value. */
163 extern size_t argp_fmtstream_set_rmargin (argp_fmtstream_t __fs,
165 extern size_t __argp_fmtstream_set_rmargin (argp_fmtstream_t __fs,
168 /* Set __FS's wrap margin to __WMARGIN and return the old value. */
169 extern size_t argp_fmtstream_set_wmargin (argp_fmtstream_t __fs,
171 extern size_t __argp_fmtstream_set_wmargin (argp_fmtstream_t __fs,
174 /* Return the column number of the current output point in __FS. */
175 extern size_t argp_fmtstream_point (argp_fmtstream_t __fs);
176 extern size_t __argp_fmtstream_point (argp_fmtstream_t __fs);
178 /* Internal routines. */
179 extern void _argp_fmtstream_update (argp_fmtstream_t __fs);
180 extern void __argp_fmtstream_update (argp_fmtstream_t __fs);
181 extern int _argp_fmtstream_ensure (argp_fmtstream_t __fs, size_t __amount);
182 extern int __argp_fmtstream_ensure (argp_fmtstream_t __fs, size_t __amount);
185 /* Inline versions of above routines. */
188 #define __argp_fmtstream_putc argp_fmtstream_putc
189 #define __argp_fmtstream_puts argp_fmtstream_puts
190 #define __argp_fmtstream_write argp_fmtstream_write
191 #define __argp_fmtstream_set_lmargin argp_fmtstream_set_lmargin
192 #define __argp_fmtstream_set_rmargin argp_fmtstream_set_rmargin
193 #define __argp_fmtstream_set_wmargin argp_fmtstream_set_wmargin
194 #define __argp_fmtstream_point argp_fmtstream_point
195 #define __argp_fmtstream_update _argp_fmtstream_update
196 #define __argp_fmtstream_ensure _argp_fmtstream_ensure
200 #define ARGP_FS_EI extern inline
204 __argp_fmtstream_write (argp_fmtstream_t __fs,
205 const char *__str, size_t __len)
207 if (__fs->p + __len <= __fs->end || __argp_fmtstream_ensure (__fs, __len))
209 memcpy (__fs->p, __str, __len);
218 __argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str)
220 size_t __len = strlen (__str);
223 size_t __wrote = __argp_fmtstream_write (__fs, __str, __len);
224 return __wrote == __len ? 0 : -1;
231 __argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch)
233 if (__fs->p < __fs->end || __argp_fmtstream_ensure (__fs, 1))
234 return *__fs->p++ = __ch;
239 /* Set __FS's left margin to __LMARGIN and return the old value. */
241 __argp_fmtstream_set_lmargin (argp_fmtstream_t __fs, size_t __lmargin)
244 if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
245 __argp_fmtstream_update (__fs);
246 __old = __fs->lmargin;
247 __fs->lmargin = __lmargin;
251 /* Set __FS's right margin to __RMARGIN and return the old value. */
253 __argp_fmtstream_set_rmargin (argp_fmtstream_t __fs, size_t __rmargin)
256 if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
257 __argp_fmtstream_update (__fs);
258 __old = __fs->rmargin;
259 __fs->rmargin = __rmargin;
263 /* Set FS's wrap margin to __WMARGIN and return the old value. */
265 __argp_fmtstream_set_wmargin (argp_fmtstream_t __fs, size_t __wmargin)
268 if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
269 __argp_fmtstream_update (__fs);
270 __old = __fs->wmargin;
271 __fs->wmargin = __wmargin;
275 /* Return the column number of the current output point in __FS. */
277 __argp_fmtstream_point (argp_fmtstream_t __fs)
279 if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
280 __argp_fmtstream_update (__fs);
281 return __fs->point_col >= 0 ? __fs->point_col : 0;
285 #undef __argp_fmtstream_putc
286 #undef __argp_fmtstream_puts
287 #undef __argp_fmtstream_write
288 #undef __argp_fmtstream_set_lmargin
289 #undef __argp_fmtstream_set_rmargin
290 #undef __argp_fmtstream_set_wmargin
291 #undef __argp_fmtstream_point
292 #undef __argp_fmtstream_update
293 #undef __argp_fmtstream_ensure
296 #endif /* __OPTIMIZE__ */
298 #endif /* ARGP_FMTSTREAM_USE_LINEWRAP */
300 #endif /* argp-fmtstream.h */