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