]>
Commit | Line | Data |
---|---|---|
c84142e8 | 1 | /* Word-wrapping and line-truncating streams |
50304ef0 | 2 | Copyright (C) 1997, 1998 Free Software Foundation, Inc. |
c84142e8 UD |
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 Library General Public License as | |
8 | published by the Free Software Foundation; either version 2 of the | |
9 | 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 | Library General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU Library General Public | |
17 | License along with the GNU C Library; see the file COPYING.LIB. If not, | |
18 | write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
19 | Boston, MA 02111-1307, USA. */ | |
20 | ||
21 | /* This package emulates glibc `line_wrap_stream' semantics for systems that | |
22 | don't have that. */ | |
23 | ||
24 | #ifdef HAVE_CONFIG_H | |
25 | #include <config.h> | |
26 | #endif | |
27 | ||
28 | #include <stdlib.h> | |
29 | #include <string.h> | |
30 | #include <errno.h> | |
31 | #include <stdarg.h> | |
32 | #include <ctype.h> | |
33 | ||
34 | #include "argp-fmtstream.h" | |
35 | #include "argp-namefrob.h" | |
36 | ||
37 | #ifndef ARGP_FMTSTREAM_USE_LINEWRAP | |
38 | ||
39 | #ifndef isblank | |
40 | #define isblank(ch) ((ch)==' ' || (ch)=='\t') | |
41 | #endif | |
42 | ||
50304ef0 | 43 | #if defined _LIBC && defined USE_IN_LIBIO |
08a0d60a | 44 | # include <libio/libioP.h> |
50304ef0 UD |
45 | # define __vsnprintf(s, l, f, a) _IO_vsnprintf (s, l, f, a) |
46 | #endif | |
47 | ||
c84142e8 UD |
48 | #define INIT_BUF_SIZE 200 |
49 | #define PRINTF_SIZE_GUESS 150 | |
50 | \f | |
51 | /* Return an argp_fmtstream that outputs to STREAM, and which prefixes lines | |
52 | written on it with LMARGIN spaces and limits them to RMARGIN columns | |
53 | total. If WMARGIN >= 0, words that extend past RMARGIN are wrapped by | |
54 | replacing the whitespace before them with a newline and WMARGIN spaces. | |
55 | Otherwise, chars beyond RMARGIN are simply dropped until a newline. | |
56 | Returns NULL if there was an error. */ | |
57 | argp_fmtstream_t | |
58 | __argp_make_fmtstream (FILE *stream, | |
59 | size_t lmargin, size_t rmargin, ssize_t wmargin) | |
60 | { | |
61 | argp_fmtstream_t fs = malloc (sizeof (struct argp_fmtstream)); | |
62 | if (fs) | |
63 | { | |
64 | fs->stream = stream; | |
65 | ||
66 | fs->lmargin = lmargin; | |
67 | fs->rmargin = rmargin; | |
68 | fs->wmargin = wmargin; | |
69 | fs->point_col = 0; | |
70 | fs->point_offs = 0; | |
71 | ||
72 | fs->buf = malloc (INIT_BUF_SIZE); | |
73 | if (! fs->buf) | |
74 | { | |
75 | free (fs); | |
76 | fs = 0; | |
77 | } | |
78 | else | |
79 | { | |
80 | fs->p = fs->buf; | |
81 | fs->end = fs->buf + INIT_BUF_SIZE; | |
82 | } | |
83 | } | |
84 | ||
85 | return fs; | |
86 | } | |
87 | #ifdef weak_alias | |
88 | weak_alias (__argp_make_fmtstream, argp_make_fmtstream) | |
89 | #endif | |
90 | ||
91 | /* Flush FS to its stream, and free it (but don't close the stream). */ | |
92 | void | |
93 | __argp_fmtstream_free (argp_fmtstream_t fs) | |
94 | { | |
95 | __argp_fmtstream_update (fs); | |
96 | if (fs->p > fs->buf) | |
50304ef0 | 97 | fwrite_unlocked (fs->buf, 1, fs->p - fs->buf, fs->stream); |
c84142e8 UD |
98 | free (fs->buf); |
99 | free (fs); | |
100 | } | |
101 | #ifdef weak_alias | |
102 | weak_alias (__argp_fmtstream_free, argp_fmtstream_free) | |
103 | #endif | |
104 | \f | |
105 | /* Process FS's buffer so that line wrapping is done from POINT_OFFS to the | |
106 | end of its buffer. This code is mostly from glibc stdio/linewrap.c. */ | |
107 | void | |
108 | __argp_fmtstream_update (argp_fmtstream_t fs) | |
109 | { | |
110 | char *buf, *nl; | |
111 | size_t len; | |
112 | ||
113 | /* Scan the buffer for newlines. */ | |
114 | buf = fs->buf + fs->point_offs; | |
115 | while (buf < fs->p) | |
116 | { | |
117 | size_t r; | |
118 | ||
119 | if (fs->point_col == 0 && fs->lmargin != 0) | |
120 | { | |
121 | /* We are starting a new line. Print spaces to the left margin. */ | |
122 | const size_t pad = fs->lmargin; | |
123 | if (fs->p + pad < fs->end) | |
124 | { | |
125 | /* We can fit in them in the buffer by moving the | |
126 | buffer text up and filling in the beginning. */ | |
127 | memmove (buf + pad, buf, fs->p - buf); | |
128 | fs->p += pad; /* Compensate for bigger buffer. */ | |
129 | memset (buf, ' ', pad); /* Fill in the spaces. */ | |
130 | buf += pad; /* Don't bother searching them. */ | |
131 | } | |
132 | else | |
133 | { | |
134 | /* No buffer space for spaces. Must flush. */ | |
135 | size_t i; | |
136 | for (i = 0; i < pad; i++) | |
50304ef0 | 137 | putc_unlocked (' ', fs->stream); |
c84142e8 UD |
138 | } |
139 | fs->point_col = pad; | |
140 | } | |
141 | ||
142 | len = fs->p - buf; | |
143 | nl = memchr (buf, '\n', len); | |
144 | ||
145 | if (fs->point_col < 0) | |
146 | fs->point_col = 0; | |
147 | ||
148 | if (!nl) | |
149 | { | |
150 | /* The buffer ends in a partial line. */ | |
151 | ||
152 | if (fs->point_col + len < fs->rmargin) | |
153 | { | |
154 | /* The remaining buffer text is a partial line and fits | |
155 | within the maximum line width. Advance point for the | |
156 | characters to be written and stop scanning. */ | |
157 | fs->point_col += len; | |
158 | break; | |
159 | } | |
160 | else | |
161 | /* Set the end-of-line pointer for the code below to | |
162 | the end of the buffer. */ | |
163 | nl = fs->p; | |
164 | } | |
c131718c | 165 | else if (fs->point_col + (nl - buf) < (ssize_t) fs->rmargin) |
c84142e8 UD |
166 | { |
167 | /* The buffer contains a full line that fits within the maximum | |
168 | line width. Reset point and scan the next line. */ | |
169 | fs->point_col = 0; | |
170 | buf = nl + 1; | |
171 | continue; | |
172 | } | |
173 | ||
174 | /* This line is too long. */ | |
175 | r = fs->rmargin - 1; | |
176 | ||
177 | if (fs->wmargin < 0) | |
178 | { | |
179 | /* Truncate the line by overwriting the excess with the | |
180 | newline and anything after it in the buffer. */ | |
181 | if (nl < fs->p) | |
182 | { | |
183 | memmove (buf + (r - fs->point_col), nl, fs->p - nl); | |
184 | fs->p -= buf + (r - fs->point_col) - nl; | |
185 | /* Reset point for the next line and start scanning it. */ | |
186 | fs->point_col = 0; | |
187 | buf += r + 1; /* Skip full line plus \n. */ | |
188 | } | |
189 | else | |
190 | { | |
191 | /* The buffer ends with a partial line that is beyond the | |
192 | maximum line width. Advance point for the characters | |
193 | written, and discard those past the max from the buffer. */ | |
194 | fs->point_col += len; | |
195 | fs->p -= fs->point_col - r; | |
196 | break; | |
197 | } | |
198 | } | |
199 | else | |
200 | { | |
201 | /* Do word wrap. Go to the column just past the maximum line | |
202 | width and scan back for the beginning of the word there. | |
203 | Then insert a line break. */ | |
204 | ||
205 | char *p, *nextline; | |
206 | int i; | |
207 | ||
208 | p = buf + (r + 1 - fs->point_col); | |
209 | while (p >= buf && !isblank (*p)) | |
210 | --p; | |
211 | nextline = p + 1; /* This will begin the next line. */ | |
212 | ||
213 | if (nextline > buf) | |
214 | { | |
215 | /* Swallow separating blanks. */ | |
2698e32c | 216 | if (p >= buf) |
c84142e8 UD |
217 | do |
218 | --p; | |
2698e32c | 219 | while (p >= buf && isblank (*p)); |
c84142e8 UD |
220 | nl = p + 1; /* The newline will replace the first blank. */ |
221 | } | |
222 | else | |
223 | { | |
224 | /* A single word that is greater than the maximum line width. | |
225 | Oh well. Put it on an overlong line by itself. */ | |
226 | p = buf + (r + 1 - fs->point_col); | |
227 | /* Find the end of the long word. */ | |
228 | do | |
229 | ++p; | |
230 | while (p < nl && !isblank (*p)); | |
231 | if (p == nl) | |
232 | { | |
233 | /* It already ends a line. No fussing required. */ | |
234 | fs->point_col = 0; | |
235 | buf = nl + 1; | |
236 | continue; | |
237 | } | |
238 | /* We will move the newline to replace the first blank. */ | |
239 | nl = p; | |
240 | /* Swallow separating blanks. */ | |
241 | do | |
242 | ++p; | |
243 | while (isblank (*p)); | |
244 | /* The next line will start here. */ | |
245 | nextline = p; | |
246 | } | |
247 | ||
5a97622d UD |
248 | /* Note: There are a bunch of tests below for |
249 | NEXTLINE == BUF + LEN + 1; this case is where NL happens to fall | |
250 | at the end of the buffer, and NEXTLINE is in fact empty (and so | |
251 | we need not be careful to maintain its contents). */ | |
252 | ||
253 | if (nextline == buf + len + 1 | |
254 | ? fs->end - nl < fs->wmargin + 1 | |
255 | : nextline - (nl + 1) < fs->wmargin) | |
c84142e8 UD |
256 | /* The margin needs more blanks than we removed. */ |
257 | if (fs->end - fs->p > fs->wmargin + 1) | |
258 | /* Make some space for them. */ | |
259 | { | |
260 | size_t mv = fs->p - nextline; | |
261 | memmove (nl + 1 + fs->wmargin, nextline, mv); | |
262 | nextline = nl + 1 + fs->wmargin; | |
263 | len = nextline + mv - buf; | |
264 | *nl++ = '\n'; | |
265 | } | |
266 | else | |
267 | /* Output the first line so we can use the space. */ | |
268 | { | |
269 | if (nl > fs->buf) | |
50304ef0 UD |
270 | fwrite_unlocked (fs->buf, 1, nl - fs->buf, fs->stream); |
271 | putc_unlocked ('\n', fs->stream); | |
c84142e8 UD |
272 | len += buf - fs->buf; |
273 | nl = buf = fs->buf; | |
274 | } | |
275 | else | |
276 | /* We can fit the newline and blanks in before | |
277 | the next word. */ | |
278 | *nl++ = '\n'; | |
279 | ||
5a97622d UD |
280 | if (nextline - nl >= fs->wmargin |
281 | || (nextline == buf + len + 1 && fs->end - nextline >= fs->wmargin)) | |
c84142e8 UD |
282 | /* Add blanks up to the wrap margin column. */ |
283 | for (i = 0; i < fs->wmargin; ++i) | |
284 | *nl++ = ' '; | |
285 | else | |
286 | for (i = 0; i < fs->wmargin; ++i) | |
50304ef0 | 287 | putc_unlocked (' ', fs->stream); |
c84142e8 UD |
288 | |
289 | /* Copy the tail of the original buffer into the current buffer | |
290 | position. */ | |
5a97622d | 291 | if (nl < nextline) |
c84142e8 UD |
292 | memmove (nl, nextline, buf + len - nextline); |
293 | len -= nextline - buf; | |
294 | ||
295 | /* Continue the scan on the remaining lines in the buffer. */ | |
296 | buf = nl; | |
297 | ||
298 | /* Restore bufp to include all the remaining text. */ | |
299 | fs->p = nl + len; | |
300 | ||
301 | /* Reset the counter of what has been output this line. If wmargin | |
302 | is 0, we want to avoid the lmargin getting added, so we set | |
303 | point_col to a magic value of -1 in that case. */ | |
304 | fs->point_col = fs->wmargin ? fs->wmargin : -1; | |
305 | } | |
306 | } | |
307 | ||
308 | /* Remember that we've scanned as far as the end of the buffer. */ | |
309 | fs->point_offs = fs->p - fs->buf; | |
310 | } | |
311 | \f | |
312 | /* Ensure that FS has space for AMOUNT more bytes in its buffer, either by | |
313 | growing the buffer, or by flushing it. True is returned iff we succeed. */ | |
314 | int | |
315 | __argp_fmtstream_ensure (struct argp_fmtstream *fs, size_t amount) | |
316 | { | |
c131718c | 317 | if ((size_t) (fs->end - fs->p) < amount) |
c84142e8 UD |
318 | { |
319 | ssize_t wrote; | |
320 | ||
321 | /* Flush FS's buffer. */ | |
322 | __argp_fmtstream_update (fs); | |
323 | ||
50304ef0 | 324 | wrote = fwrite_unlocked (fs->buf, 1, fs->p - fs->buf, fs->stream); |
c84142e8 UD |
325 | if (wrote == fs->p - fs->buf) |
326 | { | |
327 | fs->p = fs->buf; | |
328 | fs->point_offs = 0; | |
329 | } | |
330 | else | |
331 | { | |
332 | fs->p -= wrote; | |
333 | fs->point_offs -= wrote; | |
334 | memmove (fs->buf, fs->buf + wrote, fs->p - fs->buf); | |
335 | return 0; | |
336 | } | |
337 | ||
c131718c | 338 | if ((size_t) (fs->end - fs->buf) < amount) |
c84142e8 UD |
339 | /* Gotta grow the buffer. */ |
340 | { | |
341 | size_t new_size = fs->end - fs->buf + amount; | |
342 | char *new_buf = realloc (fs->buf, new_size); | |
343 | ||
344 | if (! new_buf) | |
345 | { | |
346 | __set_errno (ENOMEM); | |
347 | return 0; | |
348 | } | |
349 | ||
350 | fs->buf = new_buf; | |
351 | fs->end = new_buf + new_size; | |
352 | fs->p = fs->buf; | |
353 | } | |
354 | } | |
355 | ||
356 | return 1; | |
357 | } | |
358 | \f | |
359 | ssize_t | |
360 | __argp_fmtstream_printf (struct argp_fmtstream *fs, const char *fmt, ...) | |
361 | { | |
c131718c | 362 | int out; |
c84142e8 UD |
363 | size_t size_guess = PRINTF_SIZE_GUESS; /* How much space to reserve. */ |
364 | ||
365 | do | |
366 | { | |
367 | va_list args; | |
368 | ||
369 | if (! __argp_fmtstream_ensure (fs, size_guess)) | |
370 | return -1; | |
371 | size_guess += size_guess; | |
372 | ||
373 | va_start (args, fmt); | |
374 | out = __vsnprintf (fs->p, fs->end - fs->p, fmt, args); | |
375 | va_end (args); | |
376 | } | |
377 | while (out == -1); | |
378 | ||
379 | fs->p += out; | |
380 | ||
381 | return out; | |
382 | } | |
383 | #ifdef weak_alias | |
384 | weak_alias (__argp_fmtstream_printf, argp_fmtstream_printf) | |
385 | #endif | |
386 | ||
387 | #endif /* !ARGP_FMTSTREAM_USE_LINEWRAP */ |