source: vendor/tar/1.16.1/lib/argp-fmtstream.h@ 3342

Last change on this file since 3342 was 3342, checked in by bird, 18 years ago

tar 1.16.1
File size: 10.6 KB
Line 
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>.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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#include <stdio.h>
29#include <string.h>
30#include <unistd.h>
31
32#ifndef __attribute__
33/* This feature is available in gcc versions 2.5 and later. */
34# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
35# define __attribute__(Spec) /* empty */
36# endif
37/* The __-protected variants of `format' and `printf' attributes
38 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */
39# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7) || __STRICT_ANSI__
40# define __format__ format
41# define __printf__ printf
42# endif
43#endif
44
45#if (_LIBC - 0 && !defined (USE_IN_LIBIO)) \
46 || (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
59typedef 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
94struct 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
111typedef 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. */
119extern argp_fmtstream_t __argp_make_fmtstream (FILE *__stream,
120 size_t __lmargin,
121 size_t __rmargin,
122 ssize_t __wmargin);
123extern 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). */
129extern void __argp_fmtstream_free (argp_fmtstream_t __fs);
130extern void argp_fmtstream_free (argp_fmtstream_t __fs);
131
132extern ssize_t __argp_fmtstream_printf (argp_fmtstream_t __fs,
133 const char *__fmt, ...)
134 __attribute__ ((__format__ (printf, 2, 3)));
135extern ssize_t argp_fmtstream_printf (argp_fmtstream_t __fs,
136 const char *__fmt, ...)
137 __attribute__ ((__format__ (printf, 2, 3)));
138
139extern int __argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch);
140extern int argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch);
141
142extern int __argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str);
143extern int argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str);
144
145extern size_t __argp_fmtstream_write (argp_fmtstream_t __fs,
146 const char *__str, size_t __len);
147extern size_t argp_fmtstream_write (argp_fmtstream_t __fs,
148 const char *__str, size_t __len);
149
150
151/* Access macros for various bits of state. */
152#define argp_fmtstream_lmargin(__fs) ((__fs)->lmargin)
153#define argp_fmtstream_rmargin(__fs) ((__fs)->rmargin)
154#define argp_fmtstream_wmargin(__fs) ((__fs)->wmargin)
155#define __argp_fmtstream_lmargin argp_fmtstream_lmargin
156#define __argp_fmtstream_rmargin argp_fmtstream_rmargin
157#define __argp_fmtstream_wmargin argp_fmtstream_wmargin
158
159/* Set __FS's left margin to LMARGIN and return the old value. */
160extern size_t argp_fmtstream_set_lmargin (argp_fmtstream_t __fs,
161 size_t __lmargin);
162extern size_t __argp_fmtstream_set_lmargin (argp_fmtstream_t __fs,
163 size_t __lmargin);
164
165/* Set __FS's right margin to __RMARGIN and return the old value. */
166extern size_t argp_fmtstream_set_rmargin (argp_fmtstream_t __fs,
167 size_t __rmargin);
168extern size_t __argp_fmtstream_set_rmargin (argp_fmtstream_t __fs,
169 size_t __rmargin);
170
171/* Set __FS's wrap margin to __WMARGIN and return the old value. */
172extern size_t argp_fmtstream_set_wmargin (argp_fmtstream_t __fs,
173 size_t __wmargin);
174extern size_t __argp_fmtstream_set_wmargin (argp_fmtstream_t __fs,
175 size_t __wmargin);
176
177/* Return the column number of the current output point in __FS. */
178extern size_t argp_fmtstream_point (argp_fmtstream_t __fs);
179extern size_t __argp_fmtstream_point (argp_fmtstream_t __fs);
180
181/* Internal routines. */
182extern void _argp_fmtstream_update (argp_fmtstream_t __fs);
183extern void __argp_fmtstream_update (argp_fmtstream_t __fs);
184extern int _argp_fmtstream_ensure (argp_fmtstream_t __fs, size_t __amount);
185extern int __argp_fmtstream_ensure (argp_fmtstream_t __fs, size_t __amount);
186
187
188#ifdef __OPTIMIZE__
189/* Inline versions of above routines. */
190
191#if !_LIBC
192#define __argp_fmtstream_putc argp_fmtstream_putc
193#define __argp_fmtstream_puts argp_fmtstream_puts
194#define __argp_fmtstream_write argp_fmtstream_write
195#define __argp_fmtstream_set_lmargin argp_fmtstream_set_lmargin
196#define __argp_fmtstream_set_rmargin argp_fmtstream_set_rmargin
197#define __argp_fmtstream_set_wmargin argp_fmtstream_set_wmargin
198#define __argp_fmtstream_point argp_fmtstream_point
199#define __argp_fmtstream_update _argp_fmtstream_update
200#define __argp_fmtstream_ensure _argp_fmtstream_ensure
201#endif
202
203#ifndef ARGP_FS_EI
204#define ARGP_FS_EI extern inline
205#endif
206
207ARGP_FS_EI size_t
208__argp_fmtstream_write (argp_fmtstream_t __fs,
209 const char *__str, size_t __len)
210{
211 if (__fs->p + __len <= __fs->end || __argp_fmtstream_ensure (__fs, __len))
212 {
213 memcpy (__fs->p, __str, __len);
214 __fs->p += __len;
215 return __len;
216 }
217 else
218 return 0;
219}
220
221ARGP_FS_EI int
222__argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str)
223{
224 size_t __len = strlen (__str);
225 if (__len)
226 {
227 size_t __wrote = __argp_fmtstream_write (__fs, __str, __len);
228 return __wrote == __len ? 0 : -1;
229 }
230 else
231 return 0;
232}
233
234ARGP_FS_EI int
235__argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch)
236{
237 if (__fs->p < __fs->end || __argp_fmtstream_ensure (__fs, 1))
238 return *__fs->p++ = __ch;
239 else
240 return EOF;
241}
242
243/* Set __FS's left margin to __LMARGIN and return the old value. */
244ARGP_FS_EI size_t
245__argp_fmtstream_set_lmargin (argp_fmtstream_t __fs, size_t __lmargin)
246{
247 size_t __old;
248 if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
249 __argp_fmtstream_update (__fs);
250 __old = __fs->lmargin;
251 __fs->lmargin = __lmargin;
252 return __old;
253}
254
255/* Set __FS's right margin to __RMARGIN and return the old value. */
256ARGP_FS_EI size_t
257__argp_fmtstream_set_rmargin (argp_fmtstream_t __fs, size_t __rmargin)
258{
259 size_t __old;
260 if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
261 __argp_fmtstream_update (__fs);
262 __old = __fs->rmargin;
263 __fs->rmargin = __rmargin;
264 return __old;
265}
266
267/* Set FS's wrap margin to __WMARGIN and return the old value. */
268ARGP_FS_EI size_t
269__argp_fmtstream_set_wmargin (argp_fmtstream_t __fs, size_t __wmargin)
270{
271 size_t __old;
272 if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
273 __argp_fmtstream_update (__fs);
274 __old = __fs->wmargin;
275 __fs->wmargin = __wmargin;
276 return __old;
277}
278
279/* Return the column number of the current output point in __FS. */
280ARGP_FS_EI size_t
281__argp_fmtstream_point (argp_fmtstream_t __fs)
282{
283 if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
284 __argp_fmtstream_update (__fs);
285 return __fs->point_col >= 0 ? __fs->point_col : 0;
286}
287
288#if !_LIBC
289#undef __argp_fmtstream_putc
290#undef __argp_fmtstream_puts
291#undef __argp_fmtstream_write
292#undef __argp_fmtstream_set_lmargin
293#undef __argp_fmtstream_set_rmargin
294#undef __argp_fmtstream_set_wmargin
295#undef __argp_fmtstream_point
296#undef __argp_fmtstream_update
297#undef __argp_fmtstream_ensure
298#endif
299
300#endif /* __OPTIMIZE__ */
301
302#endif /* ARGP_FMTSTREAM_USE_LINEWRAP */
303
304#endif /* argp-fmtstream.h */
Note: See TracBrowser for help on using the repository browser.