Commit | Line | Data |
---|---|---|
2da09c3f MV |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Guile Reference Manual. | |
3 | @c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004 | |
4 | @c Free Software Foundation, Inc. | |
5 | @c See the file guile.texi for copying conditions. | |
6 | ||
a0e07ba4 NJ |
7 | @page |
8 | @node Pretty Printing | |
3229f68b | 9 | @section Pretty Printing |
a0e07ba4 NJ |
10 | |
11 | @c FIXME::martin: Review me! | |
12 | ||
13 | @cindex pretty printing | |
14 | The module @code{(ice-9 pretty-print)} provides the procedure | |
15 | @code{pretty-print}, which provides nicely formatted output of Scheme | |
16 | objects. This is especially useful for deeply nested or complex data | |
17 | structures, such as lists and vectors. | |
18 | ||
19 | The module is loaded by simply saying. | |
20 | ||
21 | @lisp | |
22 | (use-modules (ice-9 pretty-print)) | |
23 | @end lisp | |
24 | ||
25 | This makes the procedure @code{pretty-print} available. As an example | |
26 | how @code{pretty-print} will format the output, see the following: | |
27 | ||
28 | @lisp | |
29 | (pretty-print '(define (foo) (lambda (x) | |
385dbc8b KR |
30 | (cond ((zero? x) #t) ((negative? x) -x) (else |
31 | (if (= x 1) 2 (* x x x))))))) | |
a0e07ba4 NJ |
32 | @print{} |
33 | (define (foo) | |
34 | (lambda (x) | |
35 | (cond ((zero? x) #t) | |
36 | ((negative? x) -x) | |
37 | (else (if (= x 1) 2 (* x x x)))))) | |
38 | @end lisp | |
39 | ||
385dbc8b | 40 | @deffn {Scheme Procedure} pretty-print obj [port] [keyword-options] |
a0e07ba4 NJ |
41 | Print the textual representation of the Scheme object @var{obj} to |
42 | @var{port}. @var{port} defaults to the current output port, if not | |
43 | given. | |
385dbc8b KR |
44 | |
45 | The further @var{keyword-options} are keywords and parameters as | |
46 | follows, | |
47 | ||
48 | @table @asis | |
49 | @item @nicode{#:display?} @var{flag} | |
50 | If @var{flag} is true then print using @code{display}. The default is | |
51 | @code{#f} which means use @code{write} style. (@pxref{Writing}) | |
52 | ||
53 | @item @nicode{#:per-line-prefix} @var{string} | |
54 | Print the given @var{string} as a prefix on each line. The default is | |
55 | no prefix. | |
56 | ||
57 | @item @nicode{#:width} @var{columns} | |
58 | Print within the given @var{columns}. The default is 79. | |
59 | @end table | |
a0e07ba4 NJ |
60 | @end deffn |
61 | ||
2a946b44 | 62 | |
a0e07ba4 NJ |
63 | @page |
64 | @node Formatted Output | |
3229f68b | 65 | @section Formatted Output |
a0e07ba4 | 66 | @cindex formatted output |
a0e07ba4 | 67 | |
76d3f3d4 KR |
68 | @c For reference, in this section escapes like ~a are given in |
69 | @c @nicode, to give code font in TeX etc, but leave them unadorned in | |
70 | @c Info. | |
71 | @c | |
72 | @c The idea is to reduce clutter around what's shown, and avoid any | |
73 | @c possible confusion over whether the ` ' quotes are part of what | |
74 | @c should be entered. (In particular for instance of course ' is | |
75 | @c meaningful in a format string, introducing a char parameter). | |
76 | ||
77 | The @code{format} function is a powerful way to print numbers, strings | |
78 | and other objects together with literal text under the control of a | |
79 | format string. This function is available from | |
80 | ||
81 | @example | |
82 | (use-modules (ice-9 format)) | |
83 | @end example | |
84 | ||
85 | A format string is generally more compact and easier than using just | |
86 | the standard procedures like @code{display}, @code{write} and | |
87 | @code{newline}. Parameters in the output string allow various output | |
88 | styles, and parameters can be taken from the arguments for runtime | |
89 | flexibility. | |
90 | ||
91 | @code{format} is similar to the Common Lisp procedure of the same | |
92 | name, but it's not identical and doesn't have quite all the features | |
93 | found in Common Lisp. | |
94 | ||
95 | C programmers will note the similarity between @code{format} and | |
96 | @code{printf}, though escape sequences are marked with @nicode{~} | |
97 | instead of @nicode{%}, and are more powerful. | |
98 | ||
99 | @sp 1 | |
100 | @deffn {Scheme Procedure} format dest fmt [args@dots{}] | |
101 | Write output specified by the @var{fmt} string to @var{dest}. | |
102 | @var{dest} can be an output port, @code{#t} for | |
103 | @code{current-output-port} (@pxref{Default Ports}), a number for | |
104 | @code{current-error-port}, or @code{#f} to return the output as a | |
105 | string. | |
106 | ||
107 | @var{fmt} can contain literal text to be output, and @nicode{~} | |
108 | escapes. Each escape has the form | |
109 | ||
110 | @example | |
111 | ~ [param [, param@dots{}] [:] [@@] code | |
112 | @end example | |
113 | ||
114 | @nicode{code} is a character determining the escape sequence. The | |
115 | @nicode{:} and @nicode{@@} characters are optional modifiers, one or | |
116 | both of which change the way various codes operate. Optional | |
117 | parameters are accepted by some codes too. Parameters have the | |
118 | following forms, | |
a0e07ba4 | 119 | |
76d3f3d4 | 120 | @table @asis |
80a894c9 | 121 | @item @nicode{[+/-]number} |
76d3f3d4 KR |
122 | An integer, with optional @nicode{+} or @nicode{-}. |
123 | @item @nicode{'} (apostrophe) | |
124 | The following character in the format string, for instance @nicode{'z} | |
125 | for @nicode{z}. | |
126 | @item @nicode{v} | |
127 | The next function argument as the parameter. @nicode{v} stands for | |
128 | ``variable'', a parameter can be calculated at runtime and included in | |
129 | the arguments. Upper case @nicode{V} can be used too. | |
130 | @item @nicode{#} | |
131 | The number of arguments remaining. (See @nicode{~*} below for some | |
132 | usages.) | |
a0e07ba4 NJ |
133 | @end table |
134 | ||
76d3f3d4 KR |
135 | Parameters are separated by commas (@nicode{,}). A parameter can be |
136 | left empty to keep its default value when supplying later parameters. | |
a0e07ba4 | 137 | |
76d3f3d4 KR |
138 | @sp 1 |
139 | The following escapes are available. The code letters are not | |
140 | case-sensitive, upper and lower case are the same. | |
a0e07ba4 | 141 | |
76d3f3d4 KR |
142 | @table @asis |
143 | @item @nicode{~a} | |
144 | @itemx @nicode{~s} | |
145 | Object output. Parameters: @var{minwidth}, @var{padinc}, | |
146 | @var{minpad}, @var{padchar}. | |
147 | ||
148 | @nicode{~a} outputs an argument like @code{display}, @nicode{~s} | |
149 | outputs an argument like @code{write} (@pxref{Writing}). | |
150 | ||
151 | @example | |
152 | (format #t "~a" "foo") @print{} foo | |
153 | (format #t "~s" "foo") @print{} "foo" | |
154 | @end example | |
155 | ||
80a894c9 KR |
156 | @nicode{~:a} and @nicode{~:s} put objects that don't have an external |
157 | representation in quotes like a string. | |
76d3f3d4 KR |
158 | |
159 | @example | |
160 | (format #t "~:a" car) @print{} "#<primitive-procedure car>" | |
161 | @end example | |
162 | ||
163 | If the output is less than @var{minwidth} characters (default 0), it's | |
80a894c9 KR |
164 | padded on the right with @var{padchar} (default space). @nicode{~@@a} |
165 | and @nicode{~@@s} put the padding on the left instead. | |
76d3f3d4 KR |
166 | |
167 | @example | |
168 | (format #f "~5a" 'abc) @result{} "abc " | |
169 | (format #f "~5,,,'-@@a" 'abc) @result{} "--abc" | |
170 | @end example | |
171 | ||
172 | @var{minpad} is a minimum for the padding then plus a multiple of | |
173 | @var{padinc}. Ie.@: the padding is @math{@var{minpad} + @var{N} * | |
174 | @var{padinc}}, where @var{n} is the smallest integer making the total | |
175 | object plus padding greater than or equal to @var{minwidth}. The | |
176 | default @var{minpad} is 0 and the default @var{padinc} is 1 (imposing | |
177 | no minimum or multiple). | |
178 | ||
179 | @example | |
180 | (format #f "~5,1,4a" 'abc) @result{} "abc " | |
181 | @end example | |
182 | ||
183 | @item @nicode{~c} | |
184 | Character. Parameter: @var{charnum}. | |
185 | ||
186 | Output a character. The default is to simply output, as per | |
80a894c9 KR |
187 | @code{write-char} (@pxref{Writing}). @nicode{~@@c} prints in |
188 | @code{write} style. @nicode{~:c} prints control characters (ASCII 0 | |
189 | to 31) in @nicode{^X} form. | |
76d3f3d4 KR |
190 | |
191 | @example | |
192 | (format #t "~c" #\z) @print{} z | |
193 | (format #t "~@@c" #\z) @print{} #\z | |
194 | (format #t "~:c" #\newline) @print{} ^J | |
195 | @end example | |
196 | ||
197 | If the @var{charnum} parameter is given then an argument is not taken | |
198 | but instead the character is @code{(integer->char @var{charnum})} | |
199 | (@pxref{Characters}). This can be used for instance to output | |
200 | characters given by their ASCII code. | |
201 | ||
202 | @example | |
203 | (format #t "~65c") @print{} A | |
204 | @end example | |
205 | ||
206 | @item @nicode{~d} | |
207 | @itemx @nicode{~x} | |
208 | @itemx @nicode{~o} | |
209 | @itemx @nicode{~b} | |
210 | Integer. Parameters: @var{minwidth}, @var{padchar}, @var{commachar}, | |
211 | @var{commawidth}. | |
212 | ||
213 | Output an integer argument as a decimal, hexadecimal, octal or binary | |
214 | integer (respectively). | |
215 | ||
216 | @example | |
217 | (format #t "~d" 123) @print{} 123 | |
218 | @end example | |
219 | ||
80a894c9 | 220 | @nicode{~@@d} etc shows a @nicode{+} sign is shown on positive |
76d3f3d4 KR |
221 | numbers. |
222 | ||
223 | @c FIXME: "+" is not shown on zero, unlike in Common Lisp. Should | |
224 | @c that be changed in the code, or is it too late and should just be | |
225 | @c documented that way? | |
226 | ||
227 | @example | |
228 | (format #t "~@@b" 12) @print{} +1100 | |
229 | @end example | |
230 | ||
231 | If the output is less than the @var{minwidth} parameter (default no | |
232 | minimum), it's padded on the left with the @var{padchar} parameter | |
233 | (default space). | |
234 | ||
235 | @example | |
236 | (format #t "~5,'*d" 12) @print{} ***12 | |
237 | (format #t "~5,'0d" 12) @print{} 00012 | |
238 | (format #t "~3d" 1234) @print{} 1234 | |
239 | @end example | |
240 | ||
80a894c9 KR |
241 | @nicode{~:d} adds commas (or the @var{commachar} parameter) every |
242 | three digits (or the @var{commawidth} parameter many). | |
76d3f3d4 KR |
243 | |
244 | @example | |
245 | (format #t "~:d" 1234567) @print{} 1,234,567 | |
246 | (format #t "~10,'*,'/,2:d" 12345) @print{} ***1/23/45 | |
247 | @end example | |
248 | ||
249 | Hexadecimal @nicode{~x} output is in lower case, but the @nicode{~(} | |
250 | and @nicode{~)} case conversion directives described below can be used | |
251 | to get upper case. | |
252 | ||
253 | @example | |
254 | (format #t "~x" 65261) @print{} feed | |
255 | (format #t "~:@@(~x~)" 65261) @print{} FEED | |
256 | @end example | |
257 | ||
258 | @item @nicode{~r} | |
259 | Integer in words, roman numerals, or a specified radix. Parameters: | |
260 | @var{radix}, @var{minwidth}, @var{padchar}, @var{commachar}, | |
261 | @var{commawidth}. | |
262 | ||
263 | With no parameters output is in words as a cardinal like ``ten'', or | |
80a894c9 | 264 | @nicode{~:r} prints an ordinal like ``tenth''. |
76d3f3d4 KR |
265 | |
266 | @example | |
267 | (format #t "~r" 9) @print{} nine ;; cardinal | |
268 | (format #t "~r" -9) @print{} minus nine ;; cardinal | |
269 | (format #t "~:r" 9) @print{} ninth ;; ordinal | |
270 | @end example | |
271 | ||
80a894c9 KR |
272 | And also with no parameters, @nicode{~@@r} gives roman numerals and |
273 | @nicode{~@@:r} gives old roman numerals. In old roman numerals | |
274 | there's no ``subtraction'', so 9 is @nicode{VIIII} instead of | |
275 | @nicode{IX}. In both cases only positive numbers can be output. | |
76d3f3d4 KR |
276 | |
277 | @example | |
278 | (format #t "~@@r" 89) @print{} LXXXIX ;; roman | |
279 | (format #t "~@@:r" 89) @print{} LXXXVIIII ;; old roman | |
280 | @end example | |
281 | ||
282 | When a parameter is given it means numeric output in the specified | |
283 | @var{radix}. The modifiers and parameters following the radix are the | |
284 | same as described for @nicode{~d} etc above. | |
285 | ||
286 | @example | |
287 | (format #f "~3r" 27) @result{} "1000" ;; base 3 | |
288 | (format #f "~3,5r" 26) @result{} " 222" ;; base 3 width 5 | |
289 | @end example | |
290 | ||
291 | @item @nicode{~f} | |
292 | Fixed-point float. Parameters: @var{width}, @var{decimals}, | |
293 | @var{scale}, @var{overflowchar}, @var{padchar}. | |
294 | ||
295 | Output a number or number string in fixed-point format, ie.@: with a | |
296 | decimal point. | |
297 | ||
298 | @example | |
299 | (format #t "~f" 5) @print{} 5.0 | |
300 | (format #t "~f" "123") @print{} 123.0 | |
301 | (format #t "~f" "1e-1") @print{} 0.1 | |
302 | @end example | |
303 | ||
80a894c9 KR |
304 | @nicode{~@@f} prints a @nicode{+} sign on positive numbers (including |
305 | zero). | |
76d3f3d4 KR |
306 | |
307 | @example | |
308 | (format #t "~@@f" 0) @print{} +0.0 | |
309 | @end example | |
310 | ||
311 | If the output is less than @var{width} characters it's padded on the | |
312 | left with @var{padchar} (space by default). If the output equals or | |
313 | exceeds @var{width} then there's no padding. The default for | |
314 | @var{width} is no padding. | |
315 | ||
316 | @example | |
317 | (format #f "~6f" -1.5) @result{} " -1.5" | |
318 | (format #f "~6,,,,'*f" 23) @result{} "**23.0" | |
319 | (format #f "~6f" 1234567.0) @result{} "1234567.0" | |
320 | @end example | |
321 | ||
322 | @var{decimals} is how many digits to print after the decimal point, | |
323 | with the value rounded or padded with zeros as necessary. (The | |
324 | default is to output as many decimals as required.) | |
325 | ||
326 | @example | |
327 | (format #t "~1,2f" 3.125) @print{} 3.13 | |
328 | (format #t "~1,2f" 1.5) @print{} 1.50 | |
329 | @end example | |
330 | ||
331 | @var{scale} is a power of 10 applied to the value, moving the decimal | |
332 | point that many places. A positive @var{scale} increases the value | |
333 | shown, a negative decreases it. | |
334 | ||
335 | @example | |
336 | (format #t "~,,2f" 1234) @print{} 123400.0 | |
337 | (format #t "~,,-2f" 1234) @print{} 12.34 | |
338 | @end example | |
339 | ||
340 | If @var{overflowchar} and @var{width} are both given and if the output | |
341 | would exceed @var{width}, then that many @var{overflowchar}s are | |
342 | printed instead of the value. | |
343 | ||
344 | @example | |
345 | (format #t "~5,,,'xf" 12345) @print{} 12345 | |
346 | (format #t "~4,,,'xf" 12345) @print{} xxxx | |
347 | @end example | |
348 | ||
349 | @item @nicode{~e} | |
350 | Exponential float. Parameters: @var{width}, @var{mantdigits}, | |
351 | @var{expdigits}, @var{intdigits}, @var{overflowchar}, @var{padchar}, | |
352 | @var{expchar}. | |
353 | ||
354 | Output a number or number string in exponential notation. | |
355 | ||
356 | @example | |
357 | (format #t "~e" 5000.25) @print{} 5.00025E+3 | |
358 | (format #t "~e" "123.4") @print{} 1.234E+2 | |
359 | (format #t "~e" "1e4") @print{} 1.0E+4 | |
360 | @end example | |
361 | ||
80a894c9 KR |
362 | @nicode{~@@e} prints a @nicode{+} sign on positive numbers (including |
363 | zero). (This is for the mantissa, a @nicode{+} or @nicode{-} sign is | |
364 | always shown on the exponent.) | |
76d3f3d4 KR |
365 | |
366 | @example | |
367 | (format #t "~@@e" 5000.0) @print{} +5.0E+3 | |
368 | @end example | |
369 | ||
370 | If the output is less than @var{width} characters it's padded on the | |
371 | left with @var{padchar} (space by default). The default for | |
372 | @var{width} is to output with no padding. | |
373 | ||
374 | @example | |
375 | (format #f "~10e" 1234.0) @result{} " 1.234E+3" | |
376 | (format #f "~10,,,,,'*e" 0.5) @result{} "****5.0E-1" | |
377 | @end example | |
378 | ||
379 | @c FIXME: Describe what happens when the number is bigger than WIDTH. | |
380 | @c There seems to be a bit of dodginess about this, or some deviation | |
381 | @c from Common Lisp. | |
382 | ||
383 | @var{mantdigits} is the number of digits shown in the mantissa after | |
384 | the decimal point. The value is rounded or trailing zeros are added | |
385 | as necessary. The default @var{mantdigits} is to show as much as | |
386 | needed by the value. | |
387 | ||
388 | @example | |
389 | (format #f "~,3e" 11111.0) @result{} "1.111E+4" | |
390 | (format #f "~,8e" 123.0) @result{} "1.23000000E+2" | |
391 | @end example | |
392 | ||
393 | @var{expdigits} is the minimum number of digits shown for the | |
394 | exponent, with leading zeros added if necessary. The default for | |
395 | @var{expdigits} is to show only as many digits as required. At least | |
396 | 1 digit is always shown. | |
397 | ||
398 | @example | |
399 | (format #f "~,,1e" 1.0e99) @result{} "1.0E+99" | |
400 | (format #f "~,,6e" 1.0e99) @result{} "1.0E+000099" | |
401 | @end example | |
402 | ||
403 | @var{intdigits} (default 1) is the number of digits to show before the | |
404 | decimal point in the mantissa. @var{intdigits} can be zero, in which | |
405 | case the integer part is a single @nicode{0}, or it can be negative, | |
406 | in which case leading zeros are shown after the decimal point. | |
407 | ||
408 | @c FIXME: When INTDIGITS is 0, Common Lisp format apparently only | |
409 | @c shows the single 0 digit if it fits in WIDTH. format.scm seems to | |
410 | @c show it always. Is it meant to? | |
411 | ||
412 | @example | |
413 | (format #t "~,,,3e" 12345.0) @print{} 123.45E+2 | |
414 | (format #t "~,,,0e" 12345.0) @print{} 0.12345E+5 | |
415 | (format #t "~,,,-3e" 12345.0) @print{} 0.00012345E+8 | |
416 | @end example | |
417 | ||
418 | @c FIXME: MANTDIGITS with negative INTDIGITS doesn't match CL spec, | |
419 | @c believe the spec says it ought to still show mantdigits+1 sig | |
420 | @c figures, ie. leading zeros don't count towards MANTDIGITS, but it | |
421 | @c seems to just treat MANTDIGITS as how many digits after the | |
422 | @c decimal point. | |
423 | ||
424 | If @var{overflowchar} is given then @var{width} is a hard limit. If | |
425 | the output would exceed @var{width} then instead that many | |
426 | @var{overflowchar}s are printed. | |
427 | ||
428 | @example | |
429 | (format #f "~6,,,,'xe" 100.0) @result{} "1.0E+2" | |
430 | (format #f "~3,,,,'xe" 100.0) @result{} "xxx" | |
431 | @end example | |
432 | ||
433 | @var{expchar} is the exponent marker character (default @nicode{E}). | |
434 | ||
435 | @example | |
436 | (format #t "~,,,,,,'ee" 100.0) @print{} 1.0e+2 | |
437 | @end example | |
438 | ||
439 | @item @nicode{~g} | |
440 | General float. Parameters: @var{width}, @var{mantdigits}, | |
441 | @var{expdigits}, @var{intdigits}, @var{overflowchar}, @var{padchar}, | |
442 | @var{expchar}. | |
443 | ||
444 | Output a number or number string in either exponential format the same | |
445 | as @nicode{~e}, or fixed-point format like @nicode{~f} but aligned | |
446 | where the mantissa would have been and followed by padding where the | |
447 | exponent would have been. | |
448 | ||
449 | @c FIXME: The default MANTDIGITS is apparently max(needed,min(n,7)) | |
450 | @c where 10^(n-1)<=abs(x)<=10^n. But the Common Lisp spec seems to | |
451 | @c ask for "needed" to be without leading or trailing zeros, whereas | |
452 | @c format.scm seems to include trailing zeros, ending up with it | |
453 | @c using fixed format for bigger values than it should. | |
454 | ||
455 | Fixed-point is used when the absolute value is 0.1 or more and it | |
456 | takes no more space than the mantissa in exponential format, ie.@: | |
457 | basically up to @var{mantdigits} digits. | |
458 | ||
459 | @example | |
460 | (format #f "~12,4,2g" 999.0) @result{} " 999.0 " | |
461 | (format #f "~12,4,2g" "100000") @result{} " 1.0000E+05" | |
462 | @end example | |
463 | ||
464 | The parameters are interpreted as per @nicode{~e} above. When | |
465 | fixed-point is used, the @var{decimals} parameter to @nicode{~f} is | |
466 | established from @var{mantdigits}, so as to give a total | |
467 | @math{@var{mantdigits}+1} figures. | |
468 | ||
469 | @item @nicode{~$} | |
470 | Monetary style fixed-point float. Parameters: @var{decimals}, | |
471 | @var{intdigits}, @var{width}, @var{padchar}. | |
472 | ||
473 | @c For reference, fmtdoc.txi from past versions of slib showed the | |
474 | @c INTDIGITS parameter as SCALE. That looks like a typo, in the code | |
475 | @c and in the Common Lisp spec it's a minimum digits for the integer | |
476 | @c part, it isn't a power of 10 like in ~f. | |
477 | ||
478 | Output a number or number string in fixed-point format, ie.@: with a | |
479 | decimal point. @var{decimals} is the number of decimal places to | |
480 | show, default 2. | |
481 | ||
482 | @example | |
483 | (format #t "~$" 5) @print{} 5.00 | |
484 | (format #t "~4$" "2.25") @print{} 2.2500 | |
485 | (format #t "~4$" "1e-2") @print{} 0.0100 | |
486 | @end example | |
487 | ||
80a894c9 KR |
488 | @nicode{~@@$} prints a @nicode{+} sign on positive numbers (including |
489 | zero). | |
76d3f3d4 KR |
490 | |
491 | @example | |
492 | (format #t "~@@$" 0) @print{} +0.00 | |
493 | @end example | |
494 | ||
495 | @var{intdigits} is a minimum number of digits to show in the integer | |
496 | part of the value (default 1). | |
497 | ||
498 | @example | |
499 | (format #t "~,3$" 9.5) @print{} 009.50 | |
500 | (format #t "~,0$" 0.125) @print{} .13 | |
501 | @end example | |
502 | ||
503 | If the output is less than @var{width} characters (default 0), it's | |
80a894c9 KR |
504 | padded on the left with @var{padchar} (default space). @nicode{~:$} |
505 | puts the padding after the sign. | |
76d3f3d4 KR |
506 | |
507 | @example | |
508 | (format #f "~,,8$" -1.5) @result{} " -1.50" | |
509 | (format #f "~,,8:$" -1.5) @result{} "- 1.50" | |
510 | (format #f "~,,8,'.@@:$" 3) @result{} "+...3.00" | |
511 | @end example | |
512 | ||
513 | Note that floating point for dollar amounts is generally not a good | |
514 | idea, because a cent @math{0.01} cannot be represented exactly in the | |
515 | binary floating point Guile uses, which leads to slowly accumulating | |
516 | rounding errors. Keeping values as cents (or fractions of a cent) in | |
517 | integers then printing with the scale option in @nicode{~f} may be a | |
518 | better approach. | |
519 | ||
520 | @c For reference, fractions don't work with ~$ (or any of the float | |
521 | @c conversions) currently. If they did work then we could perhaps | |
522 | @c suggest keeping dollar amounts as rationals, which would of course | |
523 | @c give exact cents. An integer as cents is probably still a better | |
524 | @c recommendation though, since it forces one to think about where | |
525 | @c and when rounding can or should occur. | |
526 | ||
527 | @item @nicode{~i} | |
528 | Complex fixed-point float. Parameters: @var{width}, @var{decimals}, | |
529 | @var{scale}, @var{overflowchar}, @var{padchar}. | |
530 | ||
531 | @c For reference, in Common Lisp ~i is an indent, but slib fmtdoc.txi | |
532 | @c described it as complex number output, so we keep that. | |
533 | ||
534 | Output the argument as a complex number, with both real and imaginary | |
535 | part shown (even if one or both are zero). | |
536 | ||
537 | The parameters and modifiers are the same as for fixed-point | |
538 | @nicode{~f} described above. The real and imaginary parts are both | |
539 | output with the same given parameters and modifiers, except that for | |
540 | the imaginary part the @nicode{@@} modifier is always enabled, so as | |
541 | to print a @nicode{+} sign between the real and imaginary parts. | |
542 | ||
543 | @example | |
544 | (format #t "~i" 1) @print{} 1.0+0.0i | |
545 | @end example | |
546 | ||
547 | @item @nicode{~p} | |
548 | Plural. No parameters. | |
549 | ||
550 | Output nothing if the argument is 1, or @samp{s} for any other | |
551 | value. | |
552 | ||
553 | @example | |
554 | (format #t "enter name~p" 1) @print{} enter name | |
555 | (format #t "enter name~p" 2) @print{} enter names | |
556 | @end example | |
557 | ||
80a894c9 | 558 | @nicode{~@@p} prints @samp{y} for 1 or @samp{ies} otherwise. |
76d3f3d4 KR |
559 | |
560 | @example | |
561 | (format #t "pupp~@@p" 1) @print{} puppy | |
562 | (format #t "pupp~@@p" 2) @print{} puppies | |
563 | @end example | |
564 | ||
80a894c9 KR |
565 | @nicode{~:p} re-uses the preceding argument instead of taking a new |
566 | one, which can be convenient when printing some sort of count. | |
76d3f3d4 KR |
567 | |
568 | @example | |
80a894c9 KR |
569 | (format #t "~d cat~:p" 9) @print{} 9 cats |
570 | (format #t "~d pupp~@@:p" 5) @print{} 5 puppies | |
76d3f3d4 KR |
571 | @end example |
572 | ||
80a894c9 KR |
573 | @nicode{~p} is designed for English plurals and there's no attempt to |
574 | support other languages. @nicode{~[} conditionals (below) may be able | |
575 | to help. When using @code{gettext} to translate messages | |
576 | @code{ngettext} is probably best though | |
577 | (@pxref{Internationalization}). | |
578 | ||
76d3f3d4 KR |
579 | @item @nicode{~y} |
580 | Pretty print. No parameters. | |
581 | ||
582 | Output an argument with @code{pretty-print} (@pxref{Pretty Printing}). | |
583 | ||
584 | @item @nicode{~?} | |
585 | @itemx @nicode{~k} | |
586 | Sub-format. No parameters. | |
587 | ||
588 | Take a format string argument and a second argument which is a list of | |
80a894c9 KR |
589 | arguments for that string, and output the result. |
590 | ||
591 | @example | |
592 | (format #t "~?" "~d ~d" '(1 2)) @print{} 1 2 | |
593 | @end example | |
594 | ||
595 | @nicode{~@@?} takes arguments for the sub-format directly rather than | |
596 | in a list. | |
76d3f3d4 KR |
597 | |
598 | @example | |
76d3f3d4 KR |
599 | (format #t "~@@? ~s" "~d ~d" 1 2 "foo") @print{} 1 2 "foo" |
600 | @end example | |
601 | ||
602 | @nicode{~?} and @nicode{~k} are the same, @nicode{~k} is provided for | |
603 | T-Scheme compatibility. | |
604 | ||
605 | @item @nicode{~*} | |
606 | Argument jumping. Parameter: @var{N}. | |
607 | ||
80a894c9 KR |
608 | Move forward @var{N} arguments (default 1) in the argument list. |
609 | @nicode{~:*} moves backwards. (@var{N} cannot be negative.) | |
a0e07ba4 | 610 | |
76d3f3d4 | 611 | @example |
471d2c6d KR |
612 | (format #f "~d ~2*~d" 1 2 3 4) @result{} "1 4" |
613 | (format #f "~d ~:*~d" 6) @result{} "6 6" | |
76d3f3d4 | 614 | @end example |
a0e07ba4 | 615 | |
80a894c9 KR |
616 | @nicode{~@@*} moves to argument number @var{N}. The first argument is |
617 | number 0 (and that's the default for @var{N}). | |
a0e07ba4 | 618 | |
76d3f3d4 KR |
619 | @example |
620 | (format #f "~d~d again ~@@*~d~d" 1 2) @result{} "12 again 12" | |
621 | (format #f "~d~d~d ~1@@*~d~d" 1 2 3) @result{} "123 23" | |
622 | @end example | |
a0e07ba4 | 623 | |
471d2c6d KR |
624 | A @nicode{#} move to the end followed by a @nicode{:} modifier move |
625 | back can be used for an absolute position relative to the end of the | |
626 | argument list, a reverse of what the @nicode{@@} modifier does. | |
a0e07ba4 | 627 | |
76d3f3d4 | 628 | @example |
471d2c6d | 629 | (format #t "~#*~2:*~a" 'a 'b 'c 'd) @print{} c |
76d3f3d4 | 630 | @end example |
a0e07ba4 | 631 | |
80a894c9 | 632 | At the end of the format string the current argument postion doesn't |
471d2c6d | 633 | matter, any further arguments are ignored. |
a0e07ba4 | 634 | |
76d3f3d4 KR |
635 | @item @nicode{~t} |
636 | Advance to a column position. Parameters: @var{colnum}, @var{colinc}, | |
637 | @var{padchar}. | |
a0e07ba4 | 638 | |
76d3f3d4 KR |
639 | Output @var{padchar} (space by default) to move to the given |
640 | @var{colnum} column. The start of the line is column 0, the default | |
641 | for @var{colnum} is 1. | |
a0e07ba4 | 642 | |
76d3f3d4 KR |
643 | @example |
644 | (format #f "~tX") @result{} " X" | |
645 | (format #f "~3tX") @result{} " X" | |
646 | @end example | |
a0e07ba4 | 647 | |
76d3f3d4 KR |
648 | If the current column is already past @var{colnum}, then the move is |
649 | to there plus a multiple of @var{colinc}, ie.@: column | |
650 | @math{@var{colnum} + @var{N} * @var{colinc}} for the smallest @var{N} | |
651 | which makes that value greater than or equal to the current column. | |
652 | The default @var{colinc} is 1 (which means no further move). | |
a0e07ba4 | 653 | |
76d3f3d4 KR |
654 | @example |
655 | (format #f "abcd~2,5,'.tx") @result{} "abcd...x" | |
656 | @end example | |
a0e07ba4 | 657 | |
80a894c9 KR |
658 | @nicode{~@@t} takes @var{colnum} as an offset from the current column. |
659 | @var{colnum} many pad characters are output, then further padding to | |
660 | make the current column a multiple of @var{colinc}, if it isn't | |
661 | already so. | |
76d3f3d4 KR |
662 | |
663 | @example | |
664 | (format #f "a~3,5'*@@tx") @result{} "a****x" | |
665 | @end example | |
666 | ||
471d2c6d KR |
667 | @nicode{~t} is implemented using @code{port-column} (@pxref{Reading}), |
668 | so it works even there has been other output before @code{format}. | |
669 | ||
76d3f3d4 KR |
670 | @item @nicode{~~} |
671 | Tilde character. Parameter: @var{n}. | |
672 | ||
673 | Output a tilde character @nicode{~}, or @var{n} many if a parameter is | |
674 | given. Normally @nicode{~} introduces an escape sequence, @nicode{~~} | |
675 | is the way to output a literal tilde. | |
676 | ||
677 | @item @nicode{~%} | |
678 | Newline. Parameter: @var{n}. | |
679 | ||
680 | Output a newline character, or @var{n} many if a parameter is given. | |
681 | A newline (or a few newlines) can of course be output just by | |
682 | including them in the format string. | |
683 | ||
684 | @item @nicode{~&} | |
685 | Start a new line. Parameter: @var{n}. | |
686 | ||
687 | Output a newline if not already at the start of a line. With a | |
688 | parameter, output that many newlines, but with the first only if not | |
689 | already at the start of a line. So for instance 3 would be a newline | |
690 | if not already at the start of a line, and 2 further newlines. | |
691 | ||
692 | @item @nicode{~_} | |
693 | Space character. Parameter: @var{n}. | |
694 | ||
695 | @c For reference, in Common Lisp ~_ is a conditional newline, but | |
696 | @c slib fmtdoc.txi described it as a space, so we keep that. | |
697 | ||
698 | Output a space character, or @var{n} many if a parameter is given. | |
699 | ||
700 | With a variable parameter this is one way to insert runtime calculated | |
701 | padding (@nicode{~t} or the various field widths can do similar | |
702 | things). | |
703 | ||
704 | @example | |
705 | (format #f "~v_foo" 4) @result{} " foo" | |
706 | @end example | |
707 | ||
708 | @item @nicode{~/} | |
709 | Tab character. Parameter: @var{n}. | |
710 | ||
711 | Output a tab character, or @var{n} many if a parameter is given. | |
712 | ||
713 | @item @nicode{~|} | |
714 | Formfeed character. Parameter: @var{n}. | |
715 | ||
716 | Output a formfeed character, or @var{n} many if a parameter is given. | |
717 | ||
718 | @item @nicode{~!} | |
719 | Force output. No parameters. | |
720 | ||
721 | At the end of output, call @code{force-output} to flush any buffers on | |
722 | the destination (@pxref{Writing}). @nicode{~!} can occur anywhere in | |
723 | the format string, but the force is done at the end of output. | |
724 | ||
725 | When output is to a string (destination @code{#f}), @nicode{~!} does | |
726 | nothing. | |
727 | ||
728 | @item @nicode{~newline} (ie.@: newline character) | |
729 | Continuation line. No parameters. | |
730 | ||
731 | Skip this newline and any following whitespace in the format string, | |
80a894c9 KR |
732 | ie.@: don't send it to the output. This can be used to break up a |
733 | long format string for readability, but not print the extra | |
76d3f3d4 KR |
734 | whitespace. |
735 | ||
76d3f3d4 KR |
736 | @example |
737 | (format #f "abc~ | |
738 | ~d def~ | |
739 | ~d" 1 2) @result{} "abc1 def2" | |
740 | @end example | |
741 | ||
80a894c9 KR |
742 | @nicode{~:newline} skips the newline but leaves any further whitespace |
743 | to be printed normally. | |
744 | ||
745 | @nicode{~@@newline} prints the newline then skips following | |
746 | whitespace. | |
747 | ||
76d3f3d4 | 748 | @item @nicode{~(} @nicode{~)} |
f0a9ab4d KR |
749 | Case conversion. No parameters. |
750 | ||
751 | Between @nicode{~(} and @nicode{~)} the case of all output is changed. | |
752 | The modifiers on @nicode{~(} control the conversion. | |
76d3f3d4 | 753 | |
f47029a1 | 754 | @itemize @w{} |
76d3f3d4 | 755 | @item |
80a894c9 | 756 | @nicode{~(} --- lower case. |
76d3f3d4 KR |
757 | @c |
758 | @c FIXME: The : and @ modifiers are not yet documented because the | |
759 | @c code applies string-capitalize and string-capitalize-first to each | |
760 | @c separate format:out-str call, which has various subtly doubtful | |
761 | @c effects. And worse they're applied to individual characters, | |
762 | @c including literal characters in the format string, which has the | |
763 | @c silly effect of being always an upcase. | |
764 | @c | |
765 | @c The Common Lisp spec is apparently for the capitalization to be | |
766 | @c applied in one hit to the whole of the output between ~( and ~). | |
767 | @c (This can no doubt be implemented without accumulating all that | |
768 | @c text, just by keeping a state or the previous char to tell whether | |
769 | @c within a word.) | |
770 | @c | |
771 | @c @item | |
772 | @c @nicode{:} --- first letter of each word upper case, the rest lower | |
773 | @c case, as per the @code{string-capitalize} function (@pxref{Alphabetic | |
774 | @c Case Mapping}). | |
775 | @c @item | |
776 | @c @nicode{@@} --- first letter of just the first word upper case, the | |
777 | @c rest lower case. | |
778 | @c | |
779 | @item | |
80a894c9 | 780 | @nicode{~@@:(} --- upper case. |
76d3f3d4 KR |
781 | @end itemize |
782 | ||
783 | For example, | |
784 | ||
785 | @example | |
786 | (format #t "~(Hello~)") @print{} hello | |
787 | (format #t "~@@:(Hello~)") @print{} HELLO | |
788 | @end example | |
789 | ||
790 | In the future it's intended the modifiers @nicode{:} and @nicode{@@} | |
791 | alone will capitalize the first letters of words, as per Common Lisp | |
792 | @code{format}, but the current implementation of this is flawed and | |
793 | not recommended for use. | |
794 | ||
795 | Case conversions do not nest, currently. This might change in the | |
796 | future, but if it does then it will be to Common Lisp style where the | |
797 | outermost conversion has priority, overriding inner ones (making those | |
798 | fairly pointless). | |
799 | ||
800 | @item @nicode{~@{} @nicode{~@}} | |
801 | Iteration. Parameter: @var{maxreps} (for @nicode{~@{}). | |
802 | ||
803 | The format between @nicode{~@{} and @nicode{~@}} is iterated. The | |
804 | modifiers to @nicode{~@{} determine how arguments are taken. The | |
805 | default is a list argument with each iteration successively consuming | |
806 | elements from it. This is a convenient way to output a whole list. | |
807 | ||
808 | @example | |
809 | (format #t "~@{~d~@}" '(1 2 3)) @print{} 123 | |
810 | (format #t "~@{~s=~d ~@}" '("x" 1 "y" 2)) @print{} "x"=1 "y"=2 | |
811 | @end example | |
812 | ||
80a894c9 KR |
813 | @nicode{~:@{} takes a single argument which is a list of lists, each |
814 | of those contained lists gives the arguments for the iterated format. | |
76d3f3d4 KR |
815 | |
816 | @example | |
817 | (format #t "~:@{~dx~d ~@}" '((1 2) (3 4) (5 6))) @print{} 1x2 3x4 5x6 | |
818 | @end example | |
819 | ||
80a894c9 KR |
820 | @nicode{~@@@{} takes arguments directly, with each iteration |
821 | successively consuming arguments. | |
76d3f3d4 KR |
822 | |
823 | @example | |
824 | (format #t "~@@@{~d~@}" 1 2 3) @print{} 123 | |
825 | (format #t "~@@@{~s=~d ~@}" "x" 1 "y" 2) @print{} "x"=1 "y"=2 | |
826 | @end example | |
827 | ||
80a894c9 KR |
828 | @nicode{~@@:@{} takes list arguments, one argument for each iteration, |
829 | using that list for the format. | |
76d3f3d4 KR |
830 | |
831 | @example | |
80a894c9 | 832 | (format #t "~@@:@{~dx~d ~@}" '(1 2) '(3 4) '(5 6)) @print{} 1x2 3x4 5x6 |
76d3f3d4 KR |
833 | @end example |
834 | ||
835 | Iterating stops when there are no more arguments or when the | |
836 | @var{maxreps} parameter to @nicode{~@{} is reached (default no | |
837 | maximum). | |
838 | ||
839 | @example | |
840 | (format #t "~2@{~d~@}" '(1 2 3 4)) @print{} 12 | |
841 | @end example | |
842 | ||
843 | If the format between @nicode{~@{} and @nicode{~@}} is empty, then a | |
844 | format string argument is taken (before iteration argument(s)) and | |
845 | used instead. This allows a sub-format (like @nicode{~?} above) to be | |
846 | iterated. | |
847 | ||
848 | @example | |
849 | (format #t "~@{~@}" "~d" '(1 2 3)) @print{} 123 | |
850 | @end example | |
851 | ||
852 | @c FIXME: What is the @nicode{:} modifier to ~} meant to do? The | |
853 | @c Common Lisp spec says it's a minimum of 1 iteration, but the | |
854 | @c format.scm code seems to merely make it have MAXREPS default to 1. | |
855 | ||
856 | Iterations can be nested, an inner iteration operates in the same way | |
857 | as described, but of course on the arguments the outer iteration | |
858 | provides it. This can be used to work into nested list structures. | |
859 | For example in the following the inner @nicode{~@{~d~@}x} is applied | |
860 | to @code{(1 2)} then @code{(3 4 5)} etc. | |
861 | ||
862 | @example | |
863 | (format #t "~@{~@{~d~@}x~@}" '((1 2) (3 4 5))) @print{} 12x345x | |
864 | @end example | |
865 | ||
80a894c9 KR |
866 | See also @nicode{~^} below for escaping from iteration. |
867 | ||
76d3f3d4 KR |
868 | @item @nicode{~[} @nicode{~;} @nicode{~]} |
869 | Conditional. Parameter: @var{selector}. | |
870 | ||
871 | A conditional block is delimited by @nicode{~[} and @nicode{~]}, and | |
872 | @nicode{~;} separates clauses within the block. @nicode{~[} takes an | |
873 | integer argument and that number clause is used. The first clause is | |
874 | number 0. | |
875 | ||
876 | @example | |
877 | (format #f "~[peach~;banana~;mango~]" 1) @result{} "banana" | |
878 | @end example | |
879 | ||
880 | The @var{selector} parameter can be used for the clause number, | |
881 | instead of taking an argument. | |
882 | ||
883 | @example | |
884 | (format #f "~2[peach~;banana~;mango~]") @result{} "mango" | |
885 | @end example | |
886 | ||
887 | If the clause number is out of range then nothing is output. Or the | |
80a894c9 | 888 | last clause can be @nicode{~:;} to use that for a number out of range. |
76d3f3d4 KR |
889 | |
890 | @example | |
891 | (format #f "~[banana~;mango~]" 99) @result{} "" | |
892 | (format #f "~[banana~;mango~:;fruit~]" 99) @result{} "fruit" | |
893 | @end example | |
894 | ||
80a894c9 KR |
895 | @nicode{~:[} treats the argument as a flag, and expects two clauses. |
896 | The first is used if the argument is @code{#f} or the second | |
897 | otherwise. | |
76d3f3d4 KR |
898 | |
899 | @example | |
900 | (format #f "~:[false~;not false~]" #f) @result{} "false" | |
901 | (format #f "~:[false~;not false~]" 'abc) @result{} "not false" | |
902 | ||
903 | (let ((n 3)) | |
904 | (format #t "~d gnu~:[s are~; is~] here" n (= 1 n))) | |
905 | @print{} 3 gnus are here | |
906 | @end example | |
907 | ||
80a894c9 KR |
908 | @nicode{~@@[} also treats the argument as a flag, and expects one |
909 | clause. If the argument is @code{#f} then no output is produced and | |
910 | the argument is consumed, otherwise the clause is used and the | |
911 | argument is not consumed, it's left for the clause. This can be used | |
912 | for instance to suppress output if @code{#f} means something not | |
913 | available. | |
76d3f3d4 KR |
914 | |
915 | @example | |
916 | (format #f "~@@[temperature=~d~]" 27) @result{} "temperature=27" | |
917 | (format #f "~@@[temperature=~d~]" #f) @result{} "" | |
918 | @end example | |
919 | ||
920 | @item @nicode{~^} | |
921 | Escape. Parameters: @var{val1}, @var{val2}, @var{val3}. | |
922 | ||
923 | Stop formatting if there are no more arguments. This can be used for | |
80a894c9 | 924 | instance to have a format string adapt to a variable number of |
76d3f3d4 KR |
925 | arguments. |
926 | ||
927 | @example | |
928 | (format #t "~d~^ ~d" 1) @print{} 1 | |
929 | (format #t "~d~^ ~d" 1 2) @print{} 1 2 | |
930 | @end example | |
931 | ||
932 | Within a @nicode{~@{} @nicode{~@}} iteration, @nicode{~^} stops the | |
933 | current iteration step if there are no more arguments to that step, | |
80a894c9 KR |
934 | but continuing with possible further steps and the rest of the format. |
935 | This can be used for instance to avoid a separator on the last | |
936 | iteration, or to adapt to variable length argument lists. | |
76d3f3d4 KR |
937 | |
938 | @example | |
939 | (format #f "~@{~d~^/~@} go" '(1 2 3)) @result{} "1/2/3 go" | |
940 | (format #f "~:@{ ~d~^~d~@} go" '((1) (2 3))) @result{} " 1 23 go" | |
941 | @end example | |
942 | ||
943 | @c For reference, format.scm doesn't implement that Common Lisp ~:^ | |
944 | @c modifier which stops the entire iterating of ~:{ or ~@:{. | |
945 | ||
946 | @c FIXME: Believe the Common Lisp spec is for ~^ within ~[ ~] | |
947 | @c conditional to terminate the whole format (or iteration step if in | |
948 | @c an iteration). But format.scm seems to terminate just the | |
949 | @c conditional form. | |
950 | @c | |
951 | @c (format #f "~[abc~^def~;ghi~] blah" 0) | |
952 | @c @result{} "abc blah" ;; looks wrong | |
953 | ||
954 | @c FIXME: Believe the Common Lisp spec is for ~^ within ~( ~) to end | |
955 | @c that case conversion and then also terminate the whole format (or | |
956 | @c iteration step if in an iteration). But format.scm doesn't seem | |
957 | @c to do that quite right. | |
958 | @c | |
959 | @c (format #f "~d ~^ ~d" 1) @result{} "1 " | |
960 | @c (format #f "~(~d ~^ ~d~)" 1) @result{} ERROR | |
961 | ||
962 | Within a @nicode{~?} sub-format, @nicode{~^} operates just on that | |
963 | sub-format. If it terminates the sub-format then the originating | |
964 | format will still continue. | |
965 | ||
966 | @example | |
967 | (format #t "~? items" "~d~^ ~d" '(1)) @print{} 1 items | |
968 | (format #t "~? items" "~d~^ ~d" '(1 2)) @print{} 1 2 items | |
969 | @end example | |
970 | ||
971 | The parameters to @nicode{~^} (which are numbers) change the condition | |
972 | used to terminate. For a single parameter, termination is when that | |
973 | value is zero (notice this makes plain @nicode{~^} equivalent to | |
974 | @nicode{~#^}). For two parameters, termination is when those two are | |
975 | equal. For three parameters, termination is when @math{@var{val1} | |
976 | @le{} @var{val2}} and @math{@var{val2} @le{} @var{val3}}. | |
977 | ||
978 | @c FIXME: Good examples of these? | |
979 | ||
980 | @item @nicode{~q} | |
80a894c9 KR |
981 | Inquiry message. Insert a copyright message into the output. |
982 | ||
983 | @nicode{~:q} inserts the format implementation version. | |
a0e07ba4 NJ |
984 | @end table |
985 | ||
76d3f3d4 | 986 | @sp 1 |
471d2c6d KR |
987 | It's an error if there are not enough arguments for the escapes in the |
988 | format string, but any excess arguments are ignored. | |
76d3f3d4 KR |
989 | |
990 | Iterations @nicode{~@{} @nicode{~@}} and conditionals @nicode{~[} | |
991 | @nicode{~;} @nicode{~]} can be nested, but must be properly nested, | |
992 | meaning the inner form must be entirely within the outer form. So | |
993 | it's not possible, for instance, to try to conditionalize the endpoint | |
994 | of an iteration. | |
995 | ||
996 | @example | |
997 | (format #t "~@{ ~[ ... ~] ~@}" ...) ;; good | |
998 | (format #t "~@{ ~[ ... ~@} ... ~]" ...) ;; bad | |
999 | @end example | |
1000 | ||
1001 | The same applies to case conversions @nicode{~(} @nicode{~)}, they | |
1002 | must properly nest with respect to iterations and conditionals (though | |
1003 | currently a case conversion cannot nest within another case | |
1004 | conversion). | |
1005 | ||
1006 | When a sub-format (@nicode{~?}) is used, that sub-format string must | |
1007 | be self-contained. It cannot for instance give a @nicode{~@{} to | |
1008 | begin an iteration form and have the @nicode{~@}} up in the | |
1009 | originating format, or similar. | |
a0e07ba4 NJ |
1010 | @end deffn |
1011 | ||
76d3f3d4 KR |
1012 | @sp 1 |
1013 | Guile contains a @code{format} procedure even when the module | |
1014 | @code{(ice-9 format)} is not loaded. The default @code{format} is | |
1015 | @code{simple-format} (@pxref{Writing}), it doesn't support all escape | |
1016 | sequences documented in this section, and will signal an error if you | |
1017 | try to use one of them. The reason for two versions is that the full | |
1018 | @code{format} is fairly large and requires some time to load. | |
1019 | @code{simple-format} is often adequate too. | |
a0e07ba4 NJ |
1020 | |
1021 | ||
6da1534c | 1022 | @node File Tree Walk |
3229f68b | 1023 | @section File Tree Walk |
6da1534c KR |
1024 | @cindex file tree walk |
1025 | ||
1026 | The functions in this section traverse a tree of files and | |
1027 | directories, in a fashion similar to the C @code{ftw} and @code{nftw} | |
1028 | routines (@pxref{Working with Directory Trees,,, libc, GNU C Library | |
1029 | Reference Manual}). | |
1030 | ||
1031 | @example | |
1032 | (use-modules (ice-9 ftw)) | |
1033 | @end example | |
1034 | @sp 1 | |
1035 | ||
1036 | @defun ftw startname proc ['hash-size n] | |
1037 | Walk the filesystem tree descending from @var{startname}, calling | |
1038 | @var{proc} for each file and directory. | |
1039 | ||
1040 | Hard links and symbolic links are followed. A file or directory is | |
1041 | reported to @var{proc} only once, and skipped if seen again in another | |
1042 | place. One consequence of this is that @code{ftw} is safe against | |
1043 | circularly linked directory structures. | |
1044 | ||
1045 | Each @var{proc} call is @code{(@var{proc} filename statinfo flag)} and | |
1046 | it should return @code{#t} to continue, or any other value to stop. | |
1047 | ||
1048 | @var{filename} is the item visited, being @var{startname} plus a | |
1049 | further path and the name of the item. @var{statinfo} is the return | |
1050 | from @code{stat} (@pxref{File System}) on @var{filename}. @var{flag} | |
1051 | is one of the following symbols, | |
1052 | ||
1053 | @table @code | |
1054 | @item regular | |
1055 | @var{filename} is a file, this includes special files like devices, | |
1056 | named pipes, etc. | |
1057 | ||
1058 | @item directory | |
1059 | @var{filename} is a directory. | |
1060 | ||
1061 | @item invalid-stat | |
1062 | An error occurred when calling @code{stat}, so nothing is known. | |
1063 | @var{statinfo} is @code{#f} in this case. | |
1064 | ||
1065 | @item directory-not-readable | |
1066 | @var{filename} is a directory, but one which cannot be read and hence | |
1067 | won't be recursed into. | |
1068 | ||
1069 | @item symlink | |
1070 | @var{filename} is a dangling symbolic link. Symbolic links are | |
1071 | normally followed and their target reported, the link itself is | |
1072 | reported if the target does not exist. | |
1073 | @end table | |
1074 | ||
1075 | The return value from @code{ftw} is @code{#t} if it ran to completion, | |
1076 | or otherwise the non-@code{#t} value from @var{proc} which caused the | |
1077 | stop. | |
1078 | ||
1079 | Optional argument symbol @code{hash-size} and an integer can be given | |
1080 | to set the size of the hash table used to track items already visited. | |
1081 | (@pxref{Hash Table Reference}) | |
1082 | ||
1083 | @c Actually, it's probably safe to escape from ftw, just need to | |
1084 | @c check it. | |
1085 | @c | |
1086 | In the current implementation, returning non-@code{#t} from @var{proc} | |
1087 | is the only valid way to terminate @code{ftw}. @var{proc} must not | |
1088 | use @code{throw} or similar to escape. | |
1089 | @end defun | |
1090 | ||
1091 | ||
1092 | @defun nftw startname proc ['chdir] ['depth] ['hash-size n] ['mount] ['physical] | |
1093 | Walk the filesystem tree starting at @var{startname}, calling | |
1094 | @var{proc} for each file and directory. @code{nftw} has extra | |
1095 | features over the basic @code{ftw} described above. | |
1096 | ||
1097 | Hard links and symbolic links are followed, but a file or directory is | |
1098 | reported to @var{proc} only once, and skipped if seen again in another | |
1099 | place. One consequence of this is that @code{nftw} is safe against | |
1100 | circular linked directory structures. | |
1101 | ||
1102 | Each @var{proc} call is @code{(@var{proc} filename statinfo flag | |
1103 | basename level)} and it should return @code{#t} to continue, or any | |
1104 | other value to stop. | |
1105 | ||
1106 | @var{filename} is the item visited, being @var{startname} plus a | |
1107 | further path and the name of the item. @var{statinfo} is the return | |
1108 | from @code{stat} on @var{filename} (@pxref{File System}). | |
1109 | @var{basename} it the item name without any path. @var{level} is an | |
1110 | integer giving the directory nesting level, starting from 0 for the | |
1111 | contents of @var{startname} (or that item itself if it's a file). | |
1112 | @var{flag} is one of the following symbols, | |
1113 | ||
1114 | @table @code | |
1115 | @item regular | |
1116 | @var{filename} is a file, this includes special files like devices, | |
1117 | named pipes, etc. | |
1118 | ||
1119 | @item directory | |
1120 | @var{filename} is a directory. | |
1121 | ||
1122 | @item directory-processed | |
1123 | @var{filename} is a directory, and its contents have all been visited. | |
1124 | This flag is given instead of @code{directory} when the @code{depth} | |
1125 | option below is used. | |
1126 | ||
1127 | @item invalid-stat | |
1128 | An error occurred when applying @code{stat} to @var{filename}, so | |
1129 | nothing is known about it. @var{statinfo} is @code{#f} in this case. | |
1130 | ||
1131 | @item directory-not-readable | |
1132 | @var{filename} is a directory, but one which cannot be read and hence | |
1133 | won't be recursed into. | |
1134 | ||
1135 | @item symlink | |
1136 | @var{filename} is a dangling symbolic link. Symbolic links are | |
1137 | normally followed and their target reported, the link itself is | |
1138 | reported if the target does not exist. | |
1139 | ||
1140 | Under the @code{physical} option described below, @code{symlink} is | |
1141 | instead given for symbolic links whose target does exist. | |
1142 | ||
1143 | @item stale-symlink | |
1144 | Under the @code{physical} option described below, this indicates | |
1145 | @var{filename} is a dangling symbolic link, meaning its target does | |
1146 | not exist. Without the @code{physical} option plain @code{symlink} | |
1147 | indicates this. | |
1148 | @end table | |
1149 | ||
1150 | The following optional arguments can be given to modify the way | |
1151 | @code{nftw} works. Each is passed as a symbol (and @code{hash-size} | |
1152 | takes a following integer value). | |
1153 | ||
1154 | @table @asis | |
1155 | @item @code{chdir} | |
1156 | Change to the directory containing the item before calling @var{proc}. | |
1157 | When @code{nftw} returns the original current directory is restored. | |
1158 | ||
1159 | Under this option, generally the @var{basename} parameter should be | |
1160 | used to access the item in each @var{proc} call. The @var{filename} | |
1161 | parameter still has a path as normal and this will only be valid if | |
1162 | the @var{startname} directory was absolute. | |
1163 | ||
1164 | @item @code{depth} | |
1165 | Visit files ``depth first'', meaning @var{proc} is called for the | |
1166 | contents of each directory before it's called for the directory | |
1167 | itself. Normally a directory is reported first, then its contents. | |
1168 | ||
1169 | Under this option, the @var{flag} to @var{proc} for a directory is | |
1170 | @code{directory-processed} instead of @code{directory}. | |
1171 | ||
1172 | @item @code{hash-size @var{n}} | |
1173 | Set the size of the hash table used to track items already visited. | |
1174 | (@pxref{Hash Table Reference}) | |
1175 | ||
1176 | @item @code{mount} | |
1177 | Don't cross a mount point, meaning only visit items on the same | |
1178 | filesystem as @var{startname}. (Ie.@: the same @code{stat:dev}.) | |
1179 | ||
1180 | @item @code{physical} | |
1181 | Don't follow symbolic links, instead report them to @var{proc} as | |
1182 | @code{symlink}, and report dangling links as @code{stale-symlink}. | |
1183 | @end table | |
1184 | ||
1185 | The return value from @code{nftw} is @code{#t} if it ran to | |
1186 | completion, or otherwise the non-@code{#t} value from @var{proc} which | |
1187 | caused the stop. | |
1188 | ||
1189 | @c For reference, one reason not to esacpe is that the current | |
1190 | @c directory is not saved and restored with dynamic-wind. Maybe | |
1191 | @c changing that would be enough to allow escaping. | |
1192 | @c | |
1193 | In the current implementation, returning non-@code{#t} from @var{proc} | |
1194 | is the only valid way to terminate @code{ftw}. @var{proc} must not | |
1195 | use @code{throw} or similar to escape. | |
1196 | @end defun | |
1197 | ||
1198 | ||
2370f809 | 1199 | @node Queues |
3229f68b | 1200 | @section Queues |
d10196fc | 1201 | @cindex queues |
2370f809 KR |
1202 | @tindex Queues |
1203 | ||
1204 | @noindent | |
1205 | The functions in this section are provided by | |
1206 | ||
1207 | @example | |
1208 | (use-modules (ice-9 q)) | |
1209 | @end example | |
1210 | ||
1211 | This module implements queues holding arbitrary scheme objects and | |
1212 | designed for efficient first-in / first-out operations. | |
1213 | ||
1214 | @code{make-q} creates a queue, and objects are entered and removed | |
1215 | with @code{enq!} and @code{deq!}. @code{q-push!} and @code{q-pop!} | |
1216 | can be used too, treating the front of the queue like a stack. | |
1217 | ||
1218 | @sp 1 | |
1219 | ||
1220 | @deffn {Scheme Procedure} make-q | |
1221 | Return a new queue. | |
1222 | @end deffn | |
1223 | ||
1224 | @deffn {Scheme Procedure} q? obj | |
1225 | Return @code{#t} if @var{obj} is a queue, or @code{#f} if not. | |
1226 | ||
1227 | Note that queues are not a distinct class of objects but are | |
1228 | implemented with cons cells. For that reason certain list structures | |
1229 | can get @code{#t} from @code{q?}. | |
1230 | @end deffn | |
1231 | ||
1232 | @deffn {Scheme Procedure} enq! q obj | |
1233 | Add @var{obj} to the rear of @var{q}, and return @var{q}. | |
1234 | @end deffn | |
1235 | ||
1236 | @deffn {Scheme Procedure} deq! q | |
1237 | @deffnx {Scheme Procedure} q-pop! q | |
1238 | Remove and return the front element from @var{q}. If @var{q} is | |
1239 | empty, a @code{q-empty} exception is thrown. | |
1240 | ||
1241 | @code{deq!} and @code{q-pop!} are the same operation, the two names | |
1242 | just let an application match @code{enq!} with @code{deq!}, or | |
1243 | @code{q-push!} with @code{q-pop!}. | |
1244 | @end deffn | |
1245 | ||
1246 | @deffn {Scheme Procedure} q-push! q obj | |
1247 | Add @var{obj} to the front of @var{q}, and return @var{q}. | |
1248 | @end deffn | |
1249 | ||
1250 | @deffn {Scheme Procedure} q-length q | |
1251 | Return the number of elements in @var{q}. | |
1252 | @end deffn | |
1253 | ||
1254 | @deffn {Scheme Procedure} q-empty? q | |
1255 | Return true if @var{q} is empty. | |
1256 | @end deffn | |
1257 | ||
1258 | @deffn {Scheme Procedure} q-empty-check q | |
1259 | Throw a @code{q-empty} exception if @var{q} is empty. | |
1260 | @end deffn | |
1261 | ||
1262 | @deffn {Scheme Procedure} q-front q | |
1263 | Return the first element of @var{q} (without removing it). If @var{q} | |
1264 | is empty, a @code{q-empty} exception is thrown. | |
1265 | @end deffn | |
1266 | ||
1267 | @deffn {Scheme Procedure} q-rear q | |
1268 | Return the last element of @var{q} (without removing it). If @var{q} | |
1269 | is empty, a @code{q-empty} exception is thrown. | |
1270 | @end deffn | |
1271 | ||
1272 | @deffn {Scheme Procedure} q-remove! q obj | |
1273 | Remove all occurences of @var{obj} from @var{q}, and return @var{q}. | |
1274 | @var{obj} is compared to queue elements using @code{eq?}. | |
1275 | @end deffn | |
1276 | ||
1277 | @sp 1 | |
1278 | @cindex @code{q-empty} | |
1279 | The @code{q-empty} exceptions described above are thrown just as | |
1280 | @code{(throw 'q-empty)}, there's no message etc like an error throw. | |
1281 | ||
1282 | A queue is implemented as a cons cell, the @code{car} containing a | |
1283 | list of queued elements, and the @code{cdr} being the last cell in | |
1284 | that list (for ease of enqueuing). | |
1285 | ||
1286 | @example | |
1287 | (@var{list} . @var{last-cell}) | |
1288 | @end example | |
1289 | ||
1290 | @noindent | |
1291 | If the queue is empty, @var{list} is the empty list and | |
1292 | @var{last-cell} is @code{#f}. | |
1293 | ||
1294 | An application can directly access the queue list if desired, for | |
1295 | instance to search the elements or to insert at a specific point. | |
1296 | ||
1297 | @deffn {Scheme Procedure} sync-q! q | |
1298 | Recompute the @var{last-cell} field in @var{q}. | |
1299 | ||
1300 | All the operations above maintain @var{last-cell} as described, so | |
1301 | normally there's no need for @code{sync-q!}. But if an application | |
1302 | modifies the queue @var{list} then it must either maintain | |
1303 | @var{last-cell} similarly, or call @code{sync-q!} to recompute it. | |
1304 | @end deffn | |
1305 | ||
1306 | ||
458dd501 KR |
1307 | @node Streams |
1308 | @section Streams | |
1309 | @cindex streams | |
1310 | ||
1311 | A stream represents a sequence of values, each of which is calculated | |
1312 | only when required. This allows large or even infinite sequences to | |
1313 | be represented and manipulated with familiar operations like ``car'', | |
1314 | ``cdr'', ``map'' or ``fold''. In such manipulations only as much as | |
1315 | needed is actually held in memory at any one time. The functions in | |
1316 | this section are available from | |
1317 | ||
1318 | @example | |
1319 | (use-modules (ice-9 streams)) | |
1320 | @end example | |
1321 | ||
1322 | Streams are implemented using promises (@pxref{Delayed Evaluation}), | |
1323 | which is how the underlying calculation of values is made only when | |
1324 | needed, and the values then retained so the calculation is not | |
1325 | repeated. | |
1326 | ||
1327 | @noindent | |
1328 | Here is a simple example producing a stream of all odd numbers, | |
1329 | ||
1330 | @example | |
1331 | (define odds (make-stream (lambda (state) | |
1332 | (cons state (+ state 2))) | |
1333 | 1)) | |
1334 | (stream-car odds) @result{} 1 | |
1335 | (stream-car (stream-cdr odds)) @result{} 3 | |
1336 | @end example | |
1337 | ||
1338 | @noindent | |
1339 | @code{stream-map} could be used to derive a stream of odd squares, | |
1340 | ||
1341 | @example | |
1342 | (define (square n) (* n n)) | |
1343 | (define oddsquares (stream-map square odds)) | |
1344 | @end example | |
1345 | ||
1346 | These are infinite sequences, so it's not possible to convert them to | |
1347 | a list, but they could be printed (infinitely) with for example | |
1348 | ||
1349 | @example | |
1350 | (stream-for-each (lambda (n sq) | |
1351 | (format #t "~a squared is ~a\n" n sq)) | |
1352 | odds oddsquares) | |
1353 | @print{} | |
1354 | 1 squared is 1 | |
1355 | 3 squared is 9 | |
1356 | 5 squared is 25 | |
1357 | 7 squared is 49 | |
1358 | @dots{} | |
1359 | @end example | |
1360 | ||
1361 | @sp 1 | |
1362 | @defun make-stream proc initial-state | |
1363 | Return a new stream, formed by calling @var{proc} successively. | |
1364 | ||
1365 | Each call is @code{(@var{proc} @var{state})}, it should return a pair, | |
1366 | the @code{car} being the value for the stream, and the @code{cdr} | |
1367 | being the new @var{state} for the next call. For the first call | |
1368 | @var{state} is the given @var{initial-state}. At the end of the | |
1369 | stream, @var{proc} should return some non-pair object. | |
1370 | @end defun | |
1371 | ||
1372 | @defun stream-car stream | |
1373 | Return the first element from @var{stream}. @var{stream} must not be | |
1374 | empty. | |
1375 | @end defun | |
1376 | ||
1377 | @defun stream-cdr stream | |
1378 | Return a stream which is the second and subsequent elements of | |
1379 | @var{stream}. @var{stream} must not be empty. | |
1380 | @end defun | |
1381 | ||
1382 | @defun stream-null? stream | |
1383 | Return true if @var{stream} is empty. | |
1384 | @end defun | |
1385 | ||
1386 | @defun list->stream list | |
1387 | @defunx vector->stream vector | |
1388 | Return a stream with the contents of @var{list} or @var{vector}. | |
1389 | ||
1390 | @var{list} or @var{vector} should not be modified subsequently, since | |
1391 | it's unspecified whether changes there will be reflected in the stream | |
1392 | returned. | |
1393 | @end defun | |
1394 | ||
1395 | @defun port->stream port readproc | |
1396 | Return a stream which is the values obtained by reading from | |
1397 | @var{port} using @var{readproc}. Each read call is | |
1398 | @code{(@var{readproc} @var{port})}, and it should return an EOF object | |
1399 | (@pxref{Reading}) at the end of input. | |
1400 | ||
1401 | For example a stream of characters from a file, | |
1402 | ||
1403 | @example | |
1404 | (port->stream (open-input-file "/foo/bar.txt") read-char) | |
1405 | @end example | |
1406 | @end defun | |
1407 | ||
1408 | @defun stream->list stream | |
1409 | Return a list which is the entire contents of @var{stream}. | |
1410 | @end defun | |
1411 | ||
1412 | @defun stream->reversed-list stream | |
1413 | Return a list which is the entire contents of @var{stream}, but in | |
1414 | reverse order. | |
1415 | @end defun | |
1416 | ||
1417 | @defun stream->list&length stream | |
1418 | Return two values (@pxref{Multiple Values}) being a list which is the | |
1419 | entire contents of @var{stream}, and the number of elements in that | |
1420 | list. | |
1421 | @end defun | |
1422 | ||
1423 | @defun stream->reversed-list&length stream | |
1424 | Return two values (@pxref{Multiple Values}) being a list which is the | |
1425 | entire contents of @var{stream}, but in reverse order, and the number | |
1426 | of elements in that list. | |
1427 | @end defun | |
1428 | ||
1429 | @defun stream->vector stream | |
1430 | Return a vector which is the entire contents of @var{stream}. | |
1431 | @end defun | |
1432 | ||
1433 | @defun stream-fold proc init stream0 @dots{} streamN | |
1434 | Apply @var{proc} successively over the elements of the given streams, | |
1435 | from first to last until the end of the shortest stream is reached. | |
1436 | Return the result from the last @var{proc} call. | |
1437 | ||
1438 | Each call is @code{(@var{proc} elem0 @dots{} elemN prev)}, where each | |
1439 | @var{elem} is from the corresponding @var{stream}. @var{prev} is the | |
1440 | return from the previous @var{proc} call, or the given @var{init} for | |
1441 | the first call. | |
1442 | @end defun | |
1443 | ||
1444 | @defun stream-for-each proc stream0 @dots{} streamN | |
1445 | Call @var{proc} on the elements from the given @var{stream}s. The | |
1446 | return value is unspecified. | |
1447 | ||
1448 | Each call is @code{(@var{proc} elem0 @dots{} elemN)}, where each | |
1449 | @var{elem} is from the corresponding @var{stream}. | |
1450 | @code{stream-for-each} stops when it reaches the end of the shortest | |
1451 | @var{stream}. | |
1452 | @end defun | |
1453 | ||
1454 | @defun stream-map proc stream0 @dots{} streamN | |
1455 | Return a new stream which is the results of applying @var{proc} to the | |
1456 | elements of the given @var{stream}s. | |
1457 | ||
1458 | Each call is @code{(@var{proc} elem0 @dots{} elemN)}, where each | |
1459 | @var{elem} is from the corresponding @var{stream}. The new stream | |
1460 | ends when the end of teh shortest given @var{stream} is reached. | |
1461 | @end defun | |
1462 | ||
1463 | ||
a0e07ba4 NJ |
1464 | @c Local Variables: |
1465 | @c TeX-master: "guile.texi" | |
1466 | @c End: |