source: vendor/glibc/2.3.x/argp/argp-fmtstream.h

Last change on this file was 2141, checked in by bird, 20 years ago

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