source: trunk/source/lib/format.lisp @ 16668

Last change on this file since 16668 was 16668, checked in by svspire, 4 years ago

Added some links to papers about float printing, especially improvements
on Steele and White.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 110.1 KB
Line 
1;;; -*- Mode: Lisp; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2009 Clozure Associates
4;;;   Copyright (C) 1994-2001 Digitool, Inc
5;;;   This file is part of Clozure CL. 
6;;;
7;;;   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
8;;;   License , known as the LLGPL and distributed with Clozure CL as the
9;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
10;;;   which is distributed with Clozure CL as the file "LGPL".  Where these
11;;;   conflict, the preamble takes precedence. 
12;;;
13;;;   Clozure CL is referenced in the preamble as the "LIBRARY."
14;;;
15;;;   The LLGPL is also available online at
16;;;   http://opensource.franz.com/preamble.html
17
18;;; Functions to implement FORMAT.
19;;;
20
21(in-package "CCL")
22
23;;; Special variables local to FORMAT
24;;; why do these have top-level bindings ????? - seems wrong or at least unnecessary
25
26(defvar *format-control-string* ""
27  "The current FORMAT control string")
28
29(defvar *format-index* 0
30  "The current index into *format-control-string*")
31
32(defvar *format-length* 0
33  "The length of the current FORMAT control string")
34
35(defvar *format-arguments* ()
36  "Arguments to the current call of FORMAT")
37
38(defvar *format-original-arguments* ()
39  "Saved arglist from top-level FORMAT call for ~* and ~@*")
40
41(defvar *format-arguments-variance* nil
42  "Non-NIL only during compile-time scanning of a format string, in which case it is the
43number of additional elements at the front of *format-arguments* that may be already used
44up at runtime.  I.e. the actual *format-arguments* may be anything between *format-arguments*
45and (nthcdr *format-arguments-variance* *format-arguments*)")
46
47(def-standard-initial-binding *format-stream-stack* nil "A stack of string streams for collecting FORMAT output")
48
49(defvar *format-pprint* nil
50  "Has a pprint format directive (~W ~I ~_ ~:T) or logical-block directive been seen?")
51
52(defvar *format-justification-semi* nil
53  "Has a ~<...~:;...~> been seen?")
54
55(defvar *format-colon-rest* nil
56  )
57
58;;; prevent circle checking rest args. Really EVIL when dynamic-extent
59(def-standard-initial-binding *format-top-level* nil)
60
61
62;;; ERRORS
63
64;;; Since errors may occur while an indirect control string is being
65;;; processed, i.e. by ~? or ~{~:}, some sort of backtrace is necessary
66;;; in order to indicate the location in the control string where the
67;;; error was detected.  To this end, errors detected by format are
68;;; signalled by throwing a list of the form ((control-string args))
69;;; to the tag FORMAT-ERROR.  This throw will be caught at each level
70;;; of indirection, and the list of error messages re-thrown with an
71;;; additional message indicating that indirection was present CONSed
72;;; onto it.  Ultimately, the last throw will be caught by the top level
73;;; FORMAT function, which will then signal an error to the Slisp error
74;;; system in such a way that all the errror messages will be displayed
75;;; in reverse order.
76
77(defun format-error (complaint &rest args)
78  (throw 'format-error
79         (list (list "~1{~:}~%~S~%~V@T^" complaint args
80                    *format-control-string* (1+ *format-index*)))))
81
82
83;;; MACROS
84
85;;; This macro establishes the correct environment for processing
86;;; an indirect control string.  CONTROL-STRING is the string to
87;;; process, and FORMS are the forms to do the processing.  They
88;;; invariably will involve a call to SUB-FORMAT.  CONTROL-STRING
89;;; is guaranteed to be evaluated exactly once.
90(eval-when (compile eval #-bccl load)
91
92; does this need to exist?????
93#|| ; put it out of its misery
94(defmacro format-with-control-string (control-string &rest forms)
95  `(let ((string (if (simple-string-p ,control-string)
96                     ,control-string
97                     (coerce ,control-string 'simple-base-string))))
98        (declare (simple-string string))
99        (let ((error (catch 'format-error
100                            (let ((*format-control-string* string)
101                                  (*format-length* (length string))
102                                  (*format-index* 0))
103                                 ,@forms
104                                 nil))))
105         
106             (when error
107                   (throw 'format-error
108                          (cons (list "While processing indirect control string~%~S~%~V@T^"
109                                      *format-control-string*
110                                      (1+ *format-index*))
111                                error))))))
112||#
113(defmacro format-indirect-error (error)
114  `(throw 'format-error
115         (cons (list "While processing indirect control string~%~S~%~V@T^"
116                     *format-control-string*
117                     (1+ *format-index*))
118               ,error)))
119
120
121(defmacro get-a-format-string-stream ()
122  '(or (pop *format-stream-stack*) (make-string-output-stream :element-type 'base-char))) ; ??
123
124;;; This macro rebinds collects output to the standard output stream
125;;; in a string.  For efficiency, we avoid consing a new stream on
126;;; every call.  A stack of string streams is maintained in order to
127;;; guarantee re-entrancy.
128
129(defmacro with-format-string-output (stream-sym &rest forms)
130  `(let ((,stream-sym nil))
131     (unwind-protect
132       (progn
133         (setq ,stream-sym (get-a-format-string-stream))
134         ,@forms
135         (prog1
136           (get-output-stream-string ,stream-sym)
137           (push ,stream-sym *format-stream-stack*)))
138       (when ,stream-sym (file-position ,stream-sym 0)))))
139
140;;; This macro decomposes the argument list returned by PARSE-FORMAT-OPERATION.
141;;; PARMVAR is the list of parameters.  PARMDEFS is a list of lists of the form
142;;; (<var> <default>).  The FORMS are evaluated in an environment where each
143;;; <var> is bound to either the value of the parameter supplied in the
144;;; parameter list, or to its <default> value if the parameter was omitted or
145;;; explicitly defaulted.
146
147(defmacro with-format-parameters (parmvar parmdefs &body  body &environment env)
148  (do ((parmdefs parmdefs (cdr parmdefs))
149       (bindings () (cons `(,(caar parmdefs) (or (if ,parmvar (pop ,parmvar))
150                                                 ,(cadar parmdefs)))
151                          bindings)))
152      ((null parmdefs)
153       (multiple-value-bind (forms decls) (parse-body body env)
154         `(let ,(nreverse bindings)
155            ,@decls
156            (when ,parmvar
157              (format-error "Too many parameters"))
158            ,@forms)))))
159
160
161
162;;; Returns the index of the first occurrence of the specified character
163;;; between indices START (inclusive) and END (exclusive) in the control
164;;; string.
165
166
167(defmacro format-find-char (char start end)
168  `(%str-member  ,char *format-control-string*
169                   ,start ,end))
170
171
172) ;end of eval-when for macros
173
174;;; CONTROL STRING PARSING
175
176;;; The current control string is kept in *format-control-string*.
177;;; The variable *format-index* is the position of the last character
178;;; processed, indexing from zero.  The variable *format-length* is the
179;;; length of the control string, which is one greater than the maximum
180;;; value of *format-index*. 
181
182
183;;; Gets the next character from the current control string.  It is an
184;;; error if there is none.  Leave *format-index* pointing to the
185;;; character returned.
186
187(defun format-nextchar ()
188  (let ((index (%i+ 1 *format-index*)))   
189    (if (%i< (setq *format-index* index) *format-length*)
190      (schar *format-control-string* index)
191      (format-error "Syntax error"))))
192
193
194
195;;; Returns the current character, i.e. the one pointed to by *format-index*.
196
197(defmacro format-peek ()
198  `(schar *format-control-string* *format-index*))
199
200
201
202
203;;; Attempts to parse a parameter, starting at the current index.
204;;; Returns the value of the parameter, or NIL if none is found.
205;;; On exit, *format-index* points to the first character which is
206;;; not a part of the recognized parameter.
207
208(defun format-get-parameter (ch)
209  (case ch
210    (#\# (format-nextchar)
211     (let ((n (or *format-arguments-variance* 0))
212           (len (length *format-arguments*)))
213       (declare (fixnum n len))
214       (if (eql n 0)
215         len
216         `(the (integer ,(- len n) ,len) (length *format-arguments*)))))
217    ((#\V #\v)
218     (prog1 (pop-format-arg) (format-nextchar)))
219    (#\' (prog1 (format-nextchar) (format-nextchar)))
220    (t (cond ((or (eq ch #\-) (eq ch #\+) (digit-char-p ch))
221              (let ((neg-parm (eq ch #\-)))
222                (unless (setq ch (digit-char-p ch))
223                  (unless (setq ch (digit-char-p (format-nextchar)))
224                    (format-error "Illegal parameter")))
225                (do ((number ch (+ ch (* number 10))))
226                    ((not (setq ch (digit-char-p (format-nextchar))))
227                     (if neg-parm (- number) number)))))
228             (t nil)))))
229
230(defun format-skip-parameter (ch) ; only caller is parse-format-operation
231  "Might someday want to add proper format error checking for negative
232      parameters"
233  (let ()
234    (case ch
235      ((#\V #\v #\#)
236       (format-nextchar))
237      (#\' (format-nextchar) (format-nextchar))
238      (#\,)
239      (t (when (or (eq ch #\-) (eq ch #\+)) (format-nextchar))
240         (while (digit-char-p (format-nextchar)))))))
241
242(defun format-no-semi (char &optional colon atsign)
243  (when *format-justification-semi*
244    (format-error "~~~:[~;:~]~:[~;@~]~c illegal in this context" colon atsign char))
245  (setq *format-pprint* t))
246
247;;; Parses a format directive, including flags and parameters.  On entry,
248;;; *format-index* should point to the "~" preceding the command.  On
249;;; exit, *format-index* points to the command character itself.
250;;; Returns the list of parameters, the ":" flag, the "@" flag, and the
251;;; command character as multiple values.  Explicitly defaulted parameters
252;;; appear in the list of parameters as NIL.  Omitted parameters are simply
253;;; not included in the list at all.
254
255(defun parse-format-operation (&optional get-params) ; only caller is format-find-command
256  (let ((ch (format-nextchar)) parms colon atsign)
257    (when (or (digit-char-p ch)
258              ;(%str-member ch ",#Vv'"))
259              (memq ch '(#\- #\, #\# #\V #\v #\')))     
260      (cond (get-params
261             (setq parms (list (format-get-parameter ch)))
262             (until (neq (setq ch (format-peek)) #\,)
263               (setq ch (format-nextchar))
264               (push (format-get-parameter ch) parms)))
265            (t (setq parms t)  ; tell caller there were some so we get correct error msgs
266               (format-skip-parameter ch)
267               (until (neq (setq ch (format-peek)) #\,)
268                 (setq ch (format-nextchar))
269                 (format-skip-parameter ch)))))
270    ; allow either order
271    (case ch
272      (#\: (setq colon t ch (format-nextchar))
273           (when (eq ch #\@)
274             (setq atsign t ch (format-nextchar))))
275      (#\@ (setq atsign t ch (format-nextchar))
276           (when (eq ch #\:)
277             (setq colon t ch (format-nextchar)))))
278    (values (if (consp parms) (nreverse parms) parms)
279            colon
280            atsign
281            ch)))
282
283
284;;; Starting at the current value of *format-index*, finds the first
285;;; occurrence of one of the specified directives. Embedded constructs,
286;;; i.e. those inside ~(~), ~[~], ~{~}, or ~<~>, are ignored.  And error is
287;;; signalled if no satisfactory command is found.  Otherwise, the
288;;; following are returned as multiple values:
289;;;
290;;;     The value of *format-index* at the start of the search
291;;;     The index of the "~" character preceding the command
292;;;     The parameter list of the command
293;;;     The ":" flag
294;;;     The "@" flag
295;;;     The command character
296;;;
297;;; Implementation note:  The present implementation is not particulary
298;;; careful with storage allocation.  It would be a good idea to have
299;;; a separate function for skipping embedded constructs which did not
300;;; bother to cons parameter lists and then throw them away. This issue has been addressed. (akh)
301;;;
302;;; We go to some trouble here to use POSITION for most of the searching.
303;;; God only knows why!!!!
304
305;; and interesting note - the only caller who wants parameters is format-get-segments for
306;; ~< .... ~n:; ...~>
307(defun format-find-command (command-list &optional get-params evil-commands)
308  (let* ((start *format-index*)
309         (length *format-length*)
310         tilde)
311    (loop
312      (setq tilde (format-find-char #\~ *format-index* length))
313      (if (not tilde) (format-error "Expecting one of ~S" command-list))
314      (setq *format-index* tilde)
315      (multiple-value-bind (parms colon atsign command)
316                           (parse-format-operation get-params)
317        (when (memq command command-list)
318          (return (values start tilde parms colon atsign command)))
319        (when (and evil-commands
320                   (or (memq command  '(#\w #\_ #\i #\W #\I))
321                       (and colon (memq command '(#\t #\T)))))
322          (format-error "Illegal in this context"))
323        (case command
324          (#\{ (format-nextchar) (format-find-command '(#\})))
325          (#\( (format-nextchar) (format-find-command '(#\))))
326          (#\[ (format-nextchar) (format-find-command '(#\])))
327          (#\< (format-nextchar) 
328               (multiple-value-bind (prev tilde parms colon atsign cmd)
329                   (format-find-command '(#\>))
330                 (declare (ignore prev tilde parms atsign cmd))
331                 (if (and evil-commands colon)
332                     (format-error "Logical-block directive not allowed inside justification directive"))))
333          (#\~ (format-nextchar))
334          ((#\} #\> #\) #\])
335           (format-error "No matching bracket")))))))
336
337(defun format-find-command-no-params (command-list &key (colon t) (atsign t))
338  (multiple-value-bind (prev tilde parms colon-flag atsign-flag command)
339                       (format-find-command command-list)
340    (with-format-parameters parms ()
341      (format-no-flags (and (not colon) colon-flag) (and (not atsign) atsign-flag)))
342    (values prev tilde command colon-flag atsign-flag)))
343
344;;; This is the FORMAT top-level function.
345
346(defun format (stream control-string &rest format-arguments)
347  (declare (dynamic-extent format-arguments))
348  (if (null stream)
349    (with-output-to-string (s)
350                           (apply #'format s control-string format-arguments))
351    (if (stringp stream)
352      (with-output-to-string (s stream)
353                             (apply #'format s control-string format-arguments))
354      (let ((*format-top-level* t))
355        (when (xp-structure-p stream)(setq stream (xp-stream-stream stream))) ; for xp tests only! They call format on a structure
356        (setq stream (if (eq stream t)
357                       *standard-output*
358                       (require-type stream 'stream)))     
359        (if (functionp control-string)
360          (apply control-string stream format-arguments)
361          (let* ((control-string (ensure-simple-string control-string))
362                 (*format-control-string* control-string)
363                 (*format-pprint* nil)
364                 (*format-justification-semi* nil))
365            (declare (type simple-string control-string))
366            (cond
367              ;; Try to avoid pprint overhead in this case.
368              ((not (position #\~ control-string))
369               (write-string control-string stream))
370              ((and (or *print-pretty* *print-circle*)
371                    (not (typep stream 'xp-stream)))
372               (maybe-initiate-xp-printing
373                #'(lambda (s o)
374                    (do-sub-format-1 s o))
375                stream format-arguments))
376              (t 
377               (let ((*format-original-arguments* format-arguments)
378                     (*format-arguments* format-arguments)
379                     (*format-colon-rest* 'error)) ; what should this be??
380                 (do-sub-format stream))))))
381        nil))))
382
383(defun format-to-string (string control-string &rest format-arguments)
384  (declare (dynamic-extent format-arguments))
385  (if string
386    (with-output-to-string (stream string)
387      (apply #'format stream control-string format-arguments))
388    (with-output-to-string (stream)
389      (apply #'format stream control-string format-arguments))))
390
391(defun do-sub-format (stream)
392  (let (errorp)
393    (setq errorp
394          (catch 'format-error
395            (catch 'format-escape 
396              (sub-format stream 0 (length *format-control-string*)))
397            nil))   
398    (when errorp
399      (error "~%~:{~@?~%~}" (nreverse errorp)))))
400
401
402
403;;; This function does the real work of format.  The segment of the control
404;;; string between indiced START (inclusive) and END (exclusive) is processed
405;;; as follows: Text not part of a directive is output without further
406;;; processing.  Directives are parsed along with their parameters and flags,
407;;; and the appropriate handlers invoked with the arguments COLON, ATSIGN, and
408;;; PARMS.
409;;;
410
411;;; POP-FORMAT-ARG also defined in l1-format
412
413; in l1-format
414(def-standard-initial-binding *logical-block-xp* nil)
415
416(without-duplicate-definition-warnings
417 (defun pop-format-arg (&aux (args *format-arguments*) (xp *logical-block-xp*) (av *format-arguments-variance*))
418   (when (and (null args) (null xp))
419     (format-error "Missing argument"))
420   (when xp
421     (if (null av)
422       (when (pprint-pop-check+ args xp)    ; gets us level and length stuff in logical block
423         (throw 'logical-block nil))
424       ;; Could record that might exit here, but nobody cares.
425       #+no (note-format-scan-option *logical-block-options*)))
426   (if (or (null av) (eql av 0))
427     (progn
428       (setq *format-arguments* (cdr args))
429       (%car args))
430     (let ((types (loop for x in args as i from 0 below av
431                    collect (nx-form-type x))))
432       (when (eql av (length args))
433         (setq *format-arguments-variance* (1- av)))
434       (setq *format-arguments* (cdr args))
435       `(the (or ,@types) (car *format-arguments*))))))
436
437; SUB-FORMAT is now defined in L1-format.lisp
438; DEFFORMAT is also defined there.
439
440;;;;;;;;;;;;;;;;;;;;;;;;;;
441;;; pretty-printing stuff
442;;;
443
444(defformat #\W format-write (stream colon atsign)
445  (format-no-semi #\W)
446  (let ((arg (pop-format-arg)))
447    (cond (atsign
448       (let ((*print-level* nil)
449             (*print-length* nil))
450         (if colon
451           (let ((*print-pretty* t))
452             (write-1 arg stream))
453           (write-1 arg stream))))
454      (t (if colon
455           (let ((*print-pretty* t))
456             (write-1 arg stream))
457           (write-1 arg stream))))))
458
459(defformat #\I format-indent (stream colon atsign &rest parms)
460  (declare (dynamic-extent parms))
461  (declare (ignore atsign))
462  (format-no-semi #\I)
463  (with-format-parameters parms ((n 0))
464    (pprint-indent (if colon :current :block) n stream)))
465
466(defformat #\_ format-conditional-newline (stream colon atsign)
467  (format-no-semi #\_)
468  (let ((option
469         (cond (atsign
470                (cond (colon  :mandatory)
471                      (t :miser)))
472               (colon :fill)
473               (t :linear))))
474    (pprint-newline option stream)))
475
476;;; Tabulation  ~T
477
478(defformat #\T format-tab (stream colon atsign &rest parms)
479  (declare (dynamic-extent parms))
480  (when colon
481    (format-no-semi #\T t))
482  (with-format-parameters parms ((colnum 1) (colinc 1))
483    (cond ((or (typep stream 'xp-stream) (xp-structure-p stream))
484           (let ((kind (if colon
485                           (if atsign :section-relative :section)
486                           (if atsign :line-relative :line))))
487             (cond ((xp-structure-p stream)
488                    (pprint-tab+ kind colnum colinc stream))
489                   ((typep stream 'xp-stream)
490                    (pprint-tab+ kind colnum colinc
491                                 (slot-value stream 'xp-structure))))))
492          ((not colon)
493           (pprint-tab-not-pretty stream colnum colinc atsign)))))
494
495(defun pprint-tab-not-pretty (stream colnum colinc &optional atsign)
496  (let* ((position (column stream))
497         (count (if atsign
498                  (if position
499                    (if (zerop colinc)
500                      colnum (+ colnum (mod (- (+ position colnum)) colinc)))
501                    colnum)
502                  (if position
503                    (if (<= colnum position)
504                      (if (zerop colinc)
505                        0 (- colinc (mod (- position colnum) colinc)))
506                      (- colnum position))
507                    2))))
508    (while (> count 0)
509      (write-string "                                                                                "
510                           stream :start 
511                           0 :end (min count 80))
512      (setq count (- count 80)))))
513
514
515;;; ~/ call function
516(defformat #\/ format-call-function (stream colon atsign &rest parms)
517  (let* ((string *format-control-string*)
518         (ipos (1+ *format-index*))
519         (epos (format-find-char #\/ ipos *format-length*)))   
520    ; the spec is DUMB here - it requires that : and :: be treated the same
521    (when (not epos) (format-error "Unmatched ~~/"))
522    (let ((cpos (format-find-char #\: ipos epos))
523          package)
524      (cond (cpos 
525             (setq package (or (find-package (string-upcase (%substr string ipos cpos)))
526                               (format-error "Unknown package")))
527             (when (eql #\: (schar string (%i+ 1 cpos)))
528               (setq cpos (%i+ cpos 1)))
529             (setq ipos (%i+ cpos 1)))
530            (t (setq package (find-package "CL-USER"))))
531      (let ((thing (intern (string-upcase (%substr string ipos epos)) package)))
532        (setq *format-index* epos) ; or 1+ epos?
533        (apply thing stream (pop-format-arg) colon atsign parms)))))
534
535;;; Conditional case conversion  ~( ... ~)
536
537#| coral's old version
538(defformat #\( format-capitalization (stream colon atsign)
539  (format-nextchar)
540  (multiple-value-bind (prev tilde) (format-find-command-no-params '(#\)))
541   (let* (finished
542          (string (with-format-string-output stream
543                    (setq finished (catch 'format-escape (sub-format stream prev tilde) t)))))
544     (write-string
545         (cond ((and atsign colon)
546                (nstring-upcase string))
547               (colon
548                (nstring-capitalize string))
549               (atsign
550                (let ((strlen (length string)))
551                     ;; Capitalize the first word only
552                     (nstring-downcase string)
553                     (do ((i 0 (1+ i)))
554                         ((or (<= strlen i) (alpha-char-p (char string i)))
555                          (setf (char string i) (char-upcase (char string i)))
556                          string))))
557               (t (nstring-downcase string)))
558         stream :start
559         0 :end (length string))
560     (unless finished (throw 'format-escape nil)))))
561
562|#
563
564(defformat #\( format-capitalization (stream colon atsign)
565  (format-nextchar)
566  (multiple-value-bind (prev tilde) (format-find-command-no-params '(#\)))
567    (let (catchp)
568      (cond ((typep stream 'xp-stream)
569             (let ((xp (slot-value stream 'xp-structure)))
570               (push-char-mode xp (cond ((and colon atsign) :UP)
571                                         (colon :CAP1)
572                                         (atsign :CAP0)
573                                         (T :DOWN)))
574               (setq catchp
575                     (catch 'format-escape
576                       (sub-format stream prev tilde)
577                       nil))
578               (pop-char-mode xp)))
579            (t
580             (let* ((string (with-format-string-output stream                     
581                              (setq catchp (catch 'format-escape
582                                             (sub-format stream prev tilde)
583                                             nil)))))
584               (write-string
585                (cond ((and atsign colon)
586                       (nstring-upcase string))
587                      (colon
588                       (nstring-capitalize string))
589                      (atsign
590                       ;; Capitalize the first word only
591                       (nstring-downcase string)
592                       (dotimes (i (length string) string)
593                         (let ((ch (char string i)))
594                           (when (alpha-char-p ch)
595                             (setf (char string i) (char-upcase ch))
596                             (return string)))))
597                      (t (nstring-downcase string)))         
598                stream :start 
599                0 :end (length string)))))
600      (when catchp
601        (throw 'format-escape catchp))
602      )))
603
604;;; Up and Out (Escape)  ~^
605
606(defformat #\^ format-escape (stream colon atsign &optional p1 p2 p3)
607  (declare (ignore stream))
608  (when atsign
609    (format-error "FORMAT command ~~~:[~;:~]@^ is undefined" colon))
610  (when (cond (p3 (etypecase p2
611                    (real
612                     (<= p1 p2 p3))
613                    (character
614                     (char< p1 p2 p3))))
615              (p2 (equal p1 p2))
616              (p1 (eql p1 0))
617              (t (null (if colon *format-colon-rest* *format-arguments*))))
618    (throw 'format-escape (if colon 'format-colon-escape t))))
619
620;;; Conditional expression  ~[ ... ]
621
622
623;;; ~[  - Maybe these guys should deal with ~^ too - i.e. catch format-escape etc.
624;;; but I cant think of a case where just throwing to the { catcher fails
625
626(defun format-untagged-condition (stream)
627  (let ((test (pop-format-arg)))
628    (unless (integerp test)
629      (format-error "Argument to ~~[ must be integer - ~S" test))
630    (do ((count 0 (1+ count)))
631        ((= count test)
632         (multiple-value-bind (prev tilde cmd colon atsign)
633                              (format-find-command-no-params '(#\; #\]) :atsign nil)
634           (declare (ignore colon atsign))
635           (sub-format stream prev tilde)
636           (unless (eq cmd #\])
637             (format-find-command '(#\])))))
638      (multiple-value-bind (prev tilde cmd colon atsign)
639                           (format-find-command-no-params '(#\; #\]) :atsign nil)
640        (declare (ignore prev tilde atsign))
641        (when (eq cmd #\]) (return))
642        (format-nextchar)
643        (when colon
644          (multiple-value-bind (prev tilde cmd colon atsign)
645                               (format-find-command-no-params '(#\; #\]))
646            (declare (ignore colon atsign))
647            (sub-format stream prev tilde)
648            (unless (eq cmd #\])
649              (format-find-command-no-params '(#\]))))
650          (return))))))
651
652
653;;; ~@[
654
655(defun format-funny-condition (stream)
656  (multiple-value-bind (prev tilde) (format-find-command-no-params '(#\]))
657    (if *format-arguments*
658      (if (car *format-arguments*)
659        (sub-format stream prev tilde)
660        (pop *format-arguments*))
661      (format-error "Missing argument"))))
662
663
664;;; ~:[
665
666(defun format-boolean-condition (stream)
667  (multiple-value-bind (prev tilde command) (format-find-command-no-params '(#\; #\]))
668    (when (eq command #\])
669      (format-error "Two clauses separated by ~~; are required for ~~:["))
670    (format-nextchar)
671    (if (pop-format-arg)
672      (multiple-value-bind (prev tilde)
673          (format-find-command-no-params '(#\]) :colon nil :atsign nil)
674        (sub-format stream prev tilde))
675      (progn
676        (sub-format stream prev tilde)
677        (format-find-command-no-params '(#\]))))))
678
679
680(defformat #\[ format-condition (stream colon atsign &optional p)
681  (when p (push p *format-arguments*))
682  (format-nextchar)
683  (cond (colon
684         (when atsign
685           (format-error  "~~:@[ undefined"))
686         (format-boolean-condition stream))
687        (atsign
688         (format-funny-condition stream))
689        (t (format-untagged-condition stream))))
690
691
692;;; Iteration  ~{ ... ~}
693
694(defformat #\{ format-iteration (stream colon atsign &rest parms)
695  (declare (dynamic-extent parms))
696  (with-format-parameters parms ((max-iter -1))
697    (format-nextchar)
698    (multiple-value-bind (prev tilde end-cmd end-colon end-atsign)
699                         (format-find-command-no-params '(#\}) :atsign nil)
700      (declare (ignore end-cmd end-atsign))
701      (if (= prev tilde)
702        ;; Use an argument as the control string if ~{~} is empty
703        (let ((string (pop-format-arg)))
704          (cond ((stringp string)
705                 (when (not (simple-string-p string)) ; fix here too
706                   (setq string (coerce string 'simple-string))))
707                ((not (functionp string))
708                 (format-error "Control string is not a string or function")))         
709          (let ((error 
710                 (catch 'format-error
711                   (cond
712                    ((stringp string)
713                     (let* ((length (length (the simple-string string)))
714                            (*format-control-string* string)
715                            (*format-length* length)
716                            (*format-index* 0))
717                       (format-do-iteration stream 0 length
718                                            max-iter colon atsign end-colon)))
719                    (t ;(functionp string)
720                     (format-do-iteration stream string nil 
721                                          max-iter colon atsign end-colon)))
722                   nil)))
723            (when error (format-indirect-error error))))
724        (format-do-iteration stream prev tilde 
725                             max-iter colon atsign end-colon)))))
726
727
728;;; The two catch tags FORMAT-ESCAPE and FORMAT-COLON-ESCAPE are needed here
729;;; to correctly implement ~^ and ~:^.  The former aborts only the current
730;;; iteration, but the latter aborts the entire iteration process.
731;;; ~{ arg is a list  ~:{ arg is list of sublists, ~@{  arg is spread ~:@{ spread lists
732;;; We have nuked two catch tags. Instead throw two different values:
733;;; T if ~^ and 'format-colon-escape if ~:^
734
735(defun format-do-iteration (stream start end max-iter colon atsign at-least-once-p)
736  (flet ((do-iteration-1 (stream start end colon at-least-once-p)
737           (let (catchp)
738             (do* ((count 0 (1+ count)))
739                  ((or (= count max-iter)
740                       (and (null *format-arguments*)
741                            (if (= count 0) (not at-least-once-p) t))))
742               (setq catchp
743                     (catch 'format-escape
744                       (if colon
745                         (let* ((args (unless (and at-least-once-p (null *format-arguments*))
746                                        (pop-format-arg)))
747                                (*format-top-level* nil)
748                                (*format-colon-rest* *format-arguments*)
749                                (*format-arguments* args)
750                                (*format-original-arguments* args))
751                           (unless (listp *format-arguments*)
752                             (report-bad-arg *format-arguments* 'list))
753                           (if (functionp start)
754                             (apply start stream args)
755                             (sub-format stream start end)))
756                         (let ((*format-original-arguments* *format-arguments*))
757                           (if (functionp start)
758                             (setq *format-arguments* (apply start stream *format-arguments*))
759                             (sub-format stream start end))))
760                       nil))
761               (when (or (eq catchp 'format-colon-escape)
762                         (and catchp (null colon)))
763                 (return-from do-iteration-1  nil))))))
764      (if atsign
765        (do-iteration-1 stream start end colon at-least-once-p)       
766        ; no atsign - munch on first arg
767        (let* ((*format-arguments* (pop-format-arg))
768               (*format-top-level* nil)
769               (*format-original-arguments* *format-arguments*))
770          (unless (listp *format-arguments*)
771            (report-bad-arg *format-arguments* 'list))
772          (do-iteration-1 stream start end colon at-least-once-p)))))
773 
774
775;;; Justification  ~< ... ~>
776
777;;; Parses a list of clauses delimited by ~; and terminated by ~>.
778;;; Recursively invoke SUB-FORMAT to process them, and return a list
779;;; of the results, the length of this list, and the total number of
780;;; characters in the strings composing the list.
781
782
783(defun format-get-trailing-segments ()
784  (format-nextchar)
785  (multiple-value-bind (prev tilde parms colon atsign cmd)
786                       (format-find-command '(#\; #\>) nil T)
787    (with-format-parameters parms ()
788      (when colon
789        (format-error "~~:; allowed only after first segment in ~~<"))
790      (format-no-flags nil atsign))
791    (let ((str (catch 'format-escape
792                 (with-format-string-output stream
793                   (sub-format stream prev tilde)))))     
794      (if (stringp str)
795        (if (eq cmd #\;)
796          (multiple-value-bind
797            (segments numsegs numchars)
798            (format-get-trailing-segments)
799            (values (cons str segments)
800                    (1+ numsegs)
801                    (+ numchars
802                       (length str))))
803          (values (list str)
804                  1
805                  (length str)))
806        (progn
807          (unless (eq cmd #\>) (format-find-command '(#\>) nil T))
808          (values () 0 0))))))
809
810
811;;; Gets the first segment, which is treated specially.  Call
812;;; FORMAT-GET-TRAILING-SEGMENTS to get the rest.
813
814(defun format-get-segments ()
815  (let (ignore)
816    (declare (ignore-if-unused ignore)) ; why??
817    (multiple-value-bind (prev tilde parms colon atsign cmd)
818                         (format-find-command '(#\; #\>) nil T) ; skipping
819      (when atsign
820        (format-error "Atsign flag not allowed"))
821      ;(setq *format-arguments* blech)
822      (let ((first-seg (catch 'format-escape
823                         (with-format-string-output stream
824                           (sub-format stream prev tilde)))))
825        (if (stringp first-seg)
826          (if (eq cmd #\;)
827            (progn
828              (when parms
829                (setq *format-index* tilde)
830                ; now get the parameters if any - do this way cause of the V thingies
831                ; maybe only necessary in the : case
832                (multiple-value-setq (ignore ignore parms)
833                                     (format-find-command '(#\; #\>) t T)))             
834              (multiple-value-bind
835                (segments numsegs numchars)
836                (format-get-trailing-segments)
837                (if colon
838                  (values first-seg parms segments numsegs numchars)
839                  (values nil nil (cons first-seg segments)
840                          (1+ numsegs)
841                          (+ (length first-seg) numchars)))))
842            (values nil nil (list first-seg) 1 (length first-seg)))
843          (progn
844            (unless (eq cmd #\>) (format-find-command '(#\>) nil T))
845            (values nil nil () 0 0)))))))
846
847
848#|
849;;; Given the total number of SPACES needed for padding, and the number
850;;; of padding segments needed (PADDINGS), returns a list of such segments.
851;;; We try to allocate the spaces equally to each segment.  When this is
852;;; not possible, we allocate the left-over spaces randomly, to improve the
853;;; appearance of many successive lines of justified text.
854;;;
855;;; Query:  Is this right?  Perhaps consistency might be better for the kind
856;;; of applications ~<~> is used for.
857
858(defun make-pad-segs (spaces paddings)
859  (do* ((extra-space () (and (plusp extra-spaces)
860                             (< (random (float 1)) (/ segs extra-spaces))))
861        (result () (cons (if extra-space (1+ min-space) min-space) result))
862        (min-space (truncate spaces paddings))
863        (extra-spaces (- spaces (* paddings min-space))
864                      (if extra-space (1- extra-spaces) extra-spaces))
865        (segs paddings (1- segs)))
866       ((zerop segs) result)))
867|#
868(defun make-pad-segs (spaces segments)
869  (multiple-value-bind (min-space extra-spaces) (truncate spaces segments)
870    (declare (fixnum min-space extra-spaces))
871    (let* ((result (make-list segments :initial-element min-space))
872           (res result))
873      (setq min-space (1+ min-space))
874      (dotimes (i extra-spaces)
875        (rplaca res min-space)
876        (setq res (%cdr res)))
877      result)))
878
879;;; Determine the actual width to be used for a field requiring WIDTH
880;;; characters according to the following rule:  If WIDTH is less than or
881;;; equal to MINCOL, use WIDTH as the actual width.  Otherwise, round up
882;;; to MINCOL + k * COLINC for the smallest possible positive integer k.
883
884(defun format-round-columns (width mincol colinc)
885  (if (< width mincol)
886    (+ width (* colinc (ceiling (- mincol width) colinc)))
887    width))
888
889(defun format-justification-round-columns (width mincol colinc)
890  (if (< width mincol)
891    mincol
892    (+ mincol (* colinc (ceiling (- width mincol) colinc)))))
893
894(defformat #\< format-justification (stream colon atsign &rest parms)
895  (declare (dynamic-extent parms))
896  (multiple-value-bind (start tilde ecmd ecolon eatsign)
897                       (format-find-command-no-params '(#\>)) ; bumps format-index
898    (declare (ignore tilde ecmd))
899    (cond
900     (ecolon
901      (format-logical-block stream colon atsign eatsign start *format-index* parms))
902     (t (setq *format-index* start)
903        (with-format-parameters parms ((mincol 0) (colinc 1) (minpad 0) (padchar #\space))
904          (unless (integerp mincol)
905            (format-error "Mincol must be an integer - ~S" mincol))
906          (unless (and (integerp colinc) (plusp colinc))
907            (format-error "Colinc must be a positive integer - ~S" colinc))
908          (unless (integerp minpad)
909            (format-error "Minpad must be an integer - ~S" minpad))
910          (unless (characterp padchar)
911            (if (typep padchar `(integer 0 #.char-code-limit))
912              (setq padchar (code-char padchar))
913              (format-error "Padchar must be a character or integer from 0 to ~a - ~S"
914                            char-code-limit padchar)))
915          (format-nextchar)
916          (multiple-value-bind (special-arg special-parms segments numsegs numchars)
917                               (format-get-segments)
918            (when (= numsegs 1) (setq minpad 0))
919            (when segments
920              (let* ((padsegs (+ (if (or colon (= numsegs 1)) 1 0)
921                                 (1- numsegs)
922                                 (if atsign 1 0)))
923                     (width (format-justification-round-columns (+ numchars (* minpad padsegs))
924                                                  mincol colinc))
925                     (spaces (if (and atsign (not colon) (= numsegs 1)) ;dirty but works
926                                 (list 0 (- width numchars))
927                                 (append (if (or colon (= numsegs 1)) () '(0))
928                                         (make-pad-segs (- width numchars) padsegs)
929                                         (if atsign () '(0))))))
930                (when special-arg
931                  (if *format-pprint*
932                      (format-error "Justification illegal in this context"))
933                  (setq *format-justification-semi* t)
934                  (with-format-parameters special-parms ((spare 0)
935                                                         (linel (stream-line-length stream)))
936                     
937                    (let ((pos (column stream)))
938                      (when (> (+ pos width spare) linel)
939                        (stream-write-entire-string stream special-arg)))))
940                (do ((segs segments (cdr segs))
941                     (spcs spaces (cdr spcs)))
942                    ((null segs) (dotimes (i (car spcs)) (write-char padchar stream)))
943                  (dotimes (i (car spcs)) (write-char padchar stream))
944                  (stream-write-entire-string stream (car segs)))))))))))
945
946
947(defun format-logical-block (stream colon atsign end-atsign start end &rest parms)
948  (declare (ignore parms))
949  (flet ((format-check-simple (str)
950           (when (and str (or (%str-member #\~ str) (%str-member #\newline str)))
951             (format-error "Suffix and prefix must be simple")))
952         (first-block-p (start)
953           (let* ((*format-index* 0))
954             (loop
955               (parse-format-operation)
956               (when (eq (format-peek) #\<)
957                 (cond ((eq *format-index* start)
958                        (return t))
959                       (t (return nil))))))))
960    (format-no-semi #\<)
961    (let ((format-string *format-control-string*)
962          (prefix (if colon "(" ""))
963          (suffix (if colon ")" ""))
964          body-string start1 tilde ignore colon1 atsign1 per-line-p)
965      (declare (ignore-if-unused ignore colon1))
966      (setq *format-index* start)
967      (multiple-value-setq (start1 tilde ignore colon1 atsign1)
968        (format-find-command  '(#\; #\>)))
969      (setq body-string (%substr format-string (1+ start) tilde))
970      (when (not (eql *format-index* end)) ; > 1 segment
971        (setq prefix body-string)
972        (if atsign1 (setq per-line-p t))
973        (multiple-value-setq (start1 tilde)
974          (format-find-command '(#\; #\>)))
975        (setq body-string (%substr format-string (1+ start1) tilde))
976        (when (neq *format-index* end)
977          (multiple-value-setq (start1 tilde)(format-find-command  '(#\; #\>)))
978          (setq suffix (%substr format-string (1+ start1) tilde))
979          (when (neq *format-index* end)
980            (format-error "Too many chunks"))))
981      (when end-atsign (setq body-string (format-fill-transform body-string)))
982      (format-check-simple prefix)
983      (format-check-simple suffix)
984      (unless *format-arguments*
985        (setq *format-index* start)
986        (format-error "Missing argument"))
987      (let ((args (if (not atsign)
988                    ; This piece of garbage is needed to avoid double length counting from (formatter ...) things
989                    ; but also to allow (flet . t) not to barf.
990                    ; Was formerly simply  (if *format-arguments* (pop-format-arg))
991                    ; Actually wanna not count the arg iff the ~< is at the top level
992                    ; in a format string i.e. "is this the first ~< in THIS string?"                   
993                    (when *format-arguments*
994                      (if  (and (listp *format-arguments*)
995                                (first-block-p start))
996                        (pop *format-arguments*)  ; dont count
997                        (pop-format-arg))) ; unless not listp or not first
998                    (prog1 *format-arguments*
999                      (setq *format-arguments* nil))))
1000            (*format-control-string* body-string)
1001            (*format-top-level* (and atsign *format-top-level*)))
1002        (let ((*logical-block-p* t)
1003              (xp-struct (cond ((xp-structure-p stream) stream)
1004                               ((typep stream 'xp-stream)
1005                                (slot-value stream 'xp-structure)))))
1006          ; lets avoid unnecessary closures
1007          (cond (xp-struct (logical-block-sub xp-struct args  prefix suffix per-line-p atsign))
1008                (t (maybe-initiate-xp-printing
1009                    #'(lambda (s o)
1010                        (logical-block-sub s o  prefix suffix per-line-p atsign))
1011                    stream args))))))))
1012
1013
1014   
1015; flet?
1016(defun logical-block-sub (stream args  prefix suffix per-line-p atsign)
1017  ;(push (list args body-string) barf)
1018  (let ((circle-chk (not (or *format-top-level* (and atsign (eq *current-length* -1)))))) ; i.e. ~<~@<
1019    (let ((*current-level* (1+ *current-level*)) ; these are for pprint
1020          (*current-length* -1))
1021      (declare (special *current-level* *current-length*))
1022      (unless (check-block-abbreviation stream args circle-chk) ;(neq args *format-original-arguments*)) ;??
1023        (start-block stream prefix per-line-p suffix)
1024        (let ((*logical-block-xp* stream)    ; for pop-format-arg
1025              (my-stream (if (xp-structure-p stream) (get-xp-stream stream) stream)))
1026          (catch 'logical-block
1027            (do-sub-format-1 my-stream args)))
1028        (end-block stream suffix)))))
1029
1030; bash in fill conditional newline after white space (except blanks after ~<newline>)
1031; I think this is silly!
1032(defun format-fill-transform (string)
1033  (let ((pos 0)(end (length (the string string)))(result "") ch)
1034    (while (%i< pos end)
1035      (let ((wsp-pos (min (or (%str-member #\space string pos) end)
1036                          (or (%str-member #\tab string pos) end)))
1037            (yes nil))
1038        (when (%i< wsp-pos end)
1039          (when (not (and (%i> wsp-pos 1)
1040                          (eq (schar string (%i- wsp-pos 1)) #\newline)
1041                          (or (eq (setq ch (schar string (%i- wsp-pos 2))) #\~)
1042                              (and (%i> wsp-pos 2)
1043                                   (memq ch '(#\: #\@))
1044                                   (eq (schar string (%i- wsp-pos 3)) #\~)))))
1045            (setq yes t))
1046          (loop 
1047            (while (%i< wsp-pos end)
1048              (setq ch (schar string wsp-pos))
1049              (when (Not (%str-member ch wsp)) (return))
1050              (setq wsp-pos (%i+ 1 wsp-pos)))
1051            (return)))
1052        (setq result (%str-cat result (%substr string pos  wsp-pos) (if yes "~:_" "")))
1053      (setq pos wsp-pos)))
1054    result))
1055
1056
1057;;;;some functions needed for dealing with floats
1058
1059;;;; Floating Point printing
1060;;;
1061;;;  Written by Bill Maddox
1062;;;
1063;;;
1064;;;
1065;;; FLONUM-TO-STRING (and its subsidiary function FLOAT-STRING) does most of
1066;;; the work for all printing of floating point numbers in the printer and in
1067;;; FORMAT.  It converts a floating point number to a string in a free or
1068;;; fixed format with no exponent.  The interpretation of the arguments is as
1069;;; follows:
1070;;;
1071;;;     X        - The floating point number to convert, which must not be
1072;;;                negative.
1073;;;     WIDTH    - The preferred field width, used to determine the number
1074;;;                of fraction digits to produce if the FDIGITS parameter
1075;;;                is unspecified or NIL.  If the non-fraction digits and the
1076;;;                decimal point alone exceed this width, no fraction digits
1077;;;                will be produced unless a non-NIL value of FDIGITS has been
1078;;;                specified.  Field overflow is not considerd an error at this
1079;;;                level.
1080;;;     FDIGITS  - The number of fractional digits to produce. Insignificant
1081;;;                trailing zeroes may be introduced as needed.  May be
1082;;;                unspecified or NIL, in which case as many digits as possible
1083;;;                are generated, subject to the constraint that there are no
1084;;;                trailing zeroes.
1085;;;     SCALE    - If this parameter is specified or non-NIL, then the number
1086;;;                printed is (* x (expt 10 scale)).  This scaling is exact,
1087;;;                and cannot lose precision.
1088;;;     FMIN     - This parameter, if specified or non-NIL, is the minimum
1089;;;                number of fraction digits which will be produced, regardless
1090;;;                of the value of WIDTH or FDIGITS.  This feature is used by
1091;;;                the ~E format directive to prevent complete loss of
1092;;;                significance in the printed value due to a bogus choice of
1093;;;                scale factor.
1094;;;
1095;;; Most of the optional arguments are for the benefit for FORMAT and are not
1096;;; used by the printer.
1097;;;
1098;;; Returns:
1099;;; (VALUES DIGIT-STRING DIGIT-LENGTH LEADING-POINT TRAILING-POINT DECPNT)
1100;;; where the results have the following interpretation:
1101;;;
1102;;;     DIGIT-STRING    - The decimal representation of X, with decimal point.
1103;;;     DIGIT-LENGTH    - The length of the string DIGIT-STRING.
1104;;;     LEADING-POINT   - True if the first character of DIGIT-STRING is the
1105;;;                       decimal point.
1106;;;     TRAILING-POINT  - True if the last character of DIGIT-STRING is the
1107;;;                       decimal point.
1108;;;     POINT-POS       - The position of the digit preceding the decimal
1109;;;                       point.  Zero indicates point before first digit.
1110;;;     NZEROS          - number of zeros after point
1111;;;
1112;;; WARNING: For efficiency, there is a single string object *digit-string*
1113;;; which is modified destructively and returned as the value of
1114;;; FLONUM-TO-STRING.  Thus the returned value is not valid across multiple
1115;;; calls.
1116;;;
1117;;; NOTE:  FLONUM-TO-STRING goes to a lot of trouble to guarantee accuracy.
1118;;; Specifically, the decimal number printed is the closest possible
1119;;; approximation to the true value of the binary number to be printed from
1120;;; among all decimal representations  with the same number of digits.  In
1121;;; free-format output, i.e. with the number of digits unconstrained, it is
1122;;; guaranteed that all the information is preserved, so that a properly-
1123;;; rounding reader can reconstruct the original binary number, bit-for-bit,
1124;;; from its printed decimal representation. Furthermore, only as many digits
1125;;; as necessary to satisfy this condition will be printed.
1126;;;
1127;;;
1128;;; FLOAT-STRING actually generates the digits for positive numbers.  The
1129;;; algorithm is essentially that of algorithm Dragon4 in "How to Print
1130;;; Floating-Point Numbers Accurately" by Steele and White.  The current
1131;;; (draft) version of this paper may be found in [CMUC]<steele>tradix.press.
1132;;; DO NOT EVEN THINK OF ATTEMPTING TO UNDERSTAND THIS CODE WITHOUT READING
1133;;; THE PAPER!
1134
1135#| Improvements beyond Steele and White:
1136 Steele and White (original and retrospective included): http://kurtstephens.com/files/p372-steele.pdf
1137 Bryan O'Sullivan: http://www.serpentine.com/blog/2011/06/29/here-be-dragons-advances-in-problems-you-didnt-even-know-you-had/
1138 Burger and Dybvig: http://www.cs.indiana.edu/~dyb/pubs/FP-Printing-PLDI96.pdf
1139 Loitsch: http://www.cs.tufts.edu/~nr/cs257/archive/florian-loitsch/printf.pdf
1140 Ryan Juckett: http://www.ryanjuckett.com/programming/printing-floating-point-numbers/part-2/
1141 Gay: http://citeseer.ist.psu.edu/viewdoc/summary?doi=10.1.1.31.4049
1142|#
1143
1144(defun flonum-to-string (n &optional width fdigits scale)
1145  (let ((*print-radix* nil))
1146    (cond ((zerop n)(values "" 0 0))
1147          ((and (not (or width fdigits scale))
1148                (double-float-p n)
1149                ; cheat for the only (?) number that fails to be aesthetically pleasing
1150                (= n 1e23))
1151           (values "1" 24 23))
1152          (t (let ((string (make-array 12 :element-type 'base-char
1153                                       :fill-pointer 0 :adjustable t)))
1154               (multiple-value-bind (sig exp)(integer-decode-float n)
1155                 (float-string string sig exp (integer-length sig) width fdigits scale)))))))
1156
1157;;; if width given and fdigits nil then if exponent is >= 0 returns at
1158;;; most width-1 digits if exponent is < 0 returns (- width (- exp) 1)
1159;;; digits if fdigits given width is ignored, returns fdigits after
1160;;; (implied) point The Steele/White algorithm can produce a leading
1161;;; zero for 1e23 which lies exactly between two double floats -
1162;;; rounding picks the float whose rational is
1163;;; 99999999999999991611392. This guy wants to print as
1164;;; 9.999999999999999E+22. The untweaked algorithm generates a leading
1165;;; zero in this case.  (actually wants to print as 1e23!)  If we
1166;;; choose s such that r < s - m/2, and r = s/10 - m/2 (which it does
1167;;; in this case) then r * 10 < s => first digit is zero and
1168;;; (remainder (* r 10) s) is r * 10 = new-r, 10 * m = new-m new-r = s
1169;;; - new-m/2 so high will be false and she won't round up we do r *
1170;;; (expt 2 (- e (- scale))) and s * (expt 5 (- scale)) i.e. both less
1171;;; by (expt 2 (- scale))
1172
1173(defun float-string (string f e p &optional width fdigits scale)
1174  (macrolet ((nth-digit (n) `(%code-char (%i+ ,n (%char-code #\0)))))   
1175    (let ((r f)(s 1)(m- 1)(m+ 1)(k 0) cutoff roundup (mm nil))
1176      (when (= f (if (eql p 53) #.(ash 1 52) (ash 1 (1- p))))
1177        (setq mm t))
1178      (when (or (null scale)(zerop scale))
1179        ; approximate k
1180        (let ((fudge 0))
1181          (setq fudge (truncate (*  (%i+ e p) .301)))
1182          (when (neq fudge 0)
1183            (setq k fudge)
1184            (setq scale (- k)))))
1185      (when (and scale (not (eql scale 0)))     
1186        (if (minusp scale)
1187          (setq s (* s (5-to-e  (- scale))))
1188          (let ((scale-factor (5-to-e scale)))
1189            (setq r (* r scale-factor))
1190            (setq m+ scale-factor)
1191            (when mm (setq m- scale-factor)))))
1192      (let ((shift (- e (if scale (- scale) 0))))
1193        (declare (fixnum shift))
1194        ;(print (list e scale shift))
1195        (cond ((> shift 0)
1196               (setq r (ash f shift))
1197               (setq m+ (ash m+ shift))
1198               (when mm (setq m- (ash m- shift))))
1199              ((< shift 0)
1200               (setq s (ash s (- shift))))))
1201      (when mm
1202        (setq m+ (+ m+ m+))
1203        (setq r (+ r r))
1204        (setq s (+ s s)))   
1205      (let ((ceil (ceiling s 10))(fudge 1))
1206        (while (< r ceil)
1207          (setq k (1- k))
1208          (setq r (* r 10))
1209          (setq fudge (* fudge 10)))
1210        (when (> fudge 1)
1211          (setq m+ (* m+ fudge))
1212          (when mm (setq m- (* m- fudge)))))   
1213      (let ((2r (+ r r)))
1214        (loop
1215          (let ((2rm+ (+ 2r m+)))         
1216            (while
1217              (if (not roundup)  ; guarantee no leading zero
1218                (> 2rm+ (+ s s))
1219                (>=  2rm+ (+ s s)))
1220              (setq s (* s 10))
1221              (setq k (1+ k))))
1222          (when (not (or fdigits width))(return))
1223          (cond 
1224           (fdigits (setq cutoff (- fdigits)))
1225           (width
1226            (setq cutoff
1227                  (if (< k 0) (- 1 width)(1+ (- k width))))
1228            ;(if (and fmin (> cutoff (- fmin))) (setq cutoff (- fmin)))
1229            ))
1230          (let ((a (if cutoff (- cutoff k) 0))
1231                (y s))
1232            (DECLARE (FIXNUM A))
1233            (if (>= a 0)
1234              (when (> a 0)(setq y (* y (10-to-e a))))
1235              (setq y (ceiling y (10-to-e (the fixnum (- a))))))
1236            (when mm (setq m- (max y m-)))
1237            (setq m+ (max y m+))
1238            (when (= m+ y) (setq roundup t)))
1239          (when (if (not roundup)   ; tweak as above
1240                  (<= (+ 2r m+)(+ s s))
1241                  (< (+ 2r m+)(+ s s)))
1242            (return))))
1243      (let* ((h k)
1244             (half-m+ (* m+ 5))  ; 10 * m+/2
1245             (half-m- (if mm (* m- 5)))
1246             u high low 
1247             )
1248        ;(print (list r s m+ roundup))
1249        (unless (and fdigits (>= (- k) fdigits))
1250          (loop
1251            (setq k (1- k))
1252            (multiple-value-setq (u r) (truncate (* r 10) s))         
1253            (setq low (< r (if mm half-m- half-m+)))
1254            (setq high 
1255                  (if (not roundup)
1256                    (> r (- s half-m+))
1257                    (>= r (- s half-m+))))                   
1258            (if (or low high)
1259              (return)
1260              (progn
1261                (vector-push-extend (nth-digit u) string)))
1262            (when mm (setq half-m- (* half-m- 10) ))
1263            (setq half-m+ (* half-m+ 10)))
1264          ;(print (list r s  high low h k))
1265          (vector-push-extend
1266           (nth-digit (cond
1267                       ((and low (not high)) u) 
1268                       ((and high (not low))(+ u 1))
1269                       
1270                       (t ;(and high low)
1271                        (if (<= (+ r r) s) u (1+ u)))))
1272           string))
1273        ; second value is exponent, third is exponent - # digits generated
1274        (values string h k)))))
1275
1276
1277(defparameter integer-powers-of-10 (make-array (+ 12 (floor 324 12))))
1278
1279; e better be positive
1280(defun 10-to-e (e)
1281  (declare (fixnum e)(optimize (speed 3)(safety 0)))
1282  (if (> e 335)
1283    (* (10-to-e 334) (10-to-e (%i- e 334)))
1284    (if (< e 12)
1285      (svref integer-powers-of-10 e)
1286      (multiple-value-bind (q r) (truncate e 12)
1287        (declare (fixnum q r))       
1288        (if (eql r 0)
1289          (svref integer-powers-of-10 (%i+ q 11))
1290          (* (svref integer-powers-of-10 r)
1291             (svref integer-powers-of-10 (%i+ q 11))))))))
1292
1293
1294(let ((array integer-powers-of-10))
1295  (dotimes (i 12)
1296    (setf (svref array i)  (expt 10 i)))
1297  (dotimes (i (floor 324 12))
1298    (setf (svref array (+ i 12)) (expt 10 (* 12 (1+ i))))))
1299#|
1300(defun 10-to-e (e)
1301  (ash (5-to-e e) e))
1302|#
1303     
1304;;; Given a non-negative floating point number, SCALE-EXPONENT returns a
1305;;; new floating point number Z in the range (0.1, 1.0] and and exponent
1306;;; E such that Z * 10^E is (approximately) equal to the original number.
1307;;; There may be some loss of precision due the floating point representation.
1308;;; JUST do the EXPONENT since thats all we use
1309
1310(defconstant single-float-min-e
1311  (nth-value 1 (decode-float least-positive-single-float)))
1312(defconstant double-float-min-e
1313  (nth-value 1 (decode-float least-positive-double-float)))
1314
1315;;; Adapted from CMUCL.
1316
1317;; This is a modified version of the scale computation from Burger and
1318;; Dybvig's paper "Printing floating-point quickly and accurately."
1319;; We only want the exponent, so most things not needed for the
1320;; computation of the exponent have been removed.  We also implemented
1321;; the floating-point log approximation given in Burger and Dybvig.
1322;; This is very noticeably faster for large and small numbers.  It is
1323;; slower for intermediate sized numbers.
1324(defun accurate-scale-exponent (v)
1325  (declare (type float v))
1326  (if (zerop v)
1327      1
1328      (let ((float-radix 2)             ; b
1329            (float-digits (float-digits v)) ; p
1330            (min-e
1331             (etypecase v
1332               (single-float single-float-min-e)
1333               (double-float double-float-min-e))))
1334        (multiple-value-bind (f e)
1335            (integer-decode-float v)
1336          (let ( ;; FIXME: these even tests assume normal IEEE rounding
1337                ;; mode.  I wonder if we should cater for non-normal?
1338                (high-ok (evenp f)))
1339            ;; We only want the exponent here.
1340            (labels ((flog (x)
1341                       (declare (type (float (0.0)) x))
1342                       (let ((xd (etypecase x
1343                                   (single-float
1344                                    (float x 1d0))
1345                                   (double-float
1346                                    x))))
1347                         (ceiling (- (the (double-float -400d0 400d0)
1348                                          (log xd 10d0))
1349                                     1d-10))))
1350                     (fixup (r s m+ k)
1351                       (if (if high-ok
1352                               (>= (+ r m+) s)
1353                               (> (+ r m+) s))
1354                           (+ k 1)
1355                           k))
1356                     (scale (r s m+)
1357                       (let* ((est (flog v))
1358                              (scale (the integer (10-to-e (abs est)))))
1359                         (if (>= est 0)
1360                             (fixup r (* s scale) m+ est)
1361                             (fixup (* r scale) s (* m+ scale) est)))))
1362              (let (r s m+)
1363                (if (>= e 0)
1364                    (let* ((be (expt float-radix e))
1365                           (be1 (* be float-radix)))
1366                      (if (/= f (expt float-radix (1- float-digits)))
1367                          (setf r (* f be 2)
1368                                s 2
1369                                m+ be)
1370                          (setf r (* f be1 2)
1371                                s (* float-radix 2)
1372                                m+ be1)))
1373                    (if (or (= e min-e) 
1374                            (/= f (expt float-radix (1- float-digits))))
1375                        (setf r (* f 2)
1376                              s (* (expt float-radix (- e)) 2)
1377                              m+ 1)
1378                        (setf r (* f float-radix 2)
1379                              s (* (expt float-radix (- 1 e)) 2)
1380                              m+ float-radix)))
1381                (scale r s m+))))))))
1382
1383;;; Page  ~|
1384
1385(defformat #\| format-page (stream colon atsign &rest parms)
1386  (declare (dynamic-extent parms))
1387  (format-no-flags colon atsign)
1388  (with-format-parameters parms ((repeat-count 1))
1389    (declare (fixnum repeat-count))
1390    (dotimes (i repeat-count) (write-char #\page stream))))
1391
1392
1393(defun format-eat-whitespace ()
1394  (do* ((i *format-index* (1+ i))
1395        (s *format-control-string*)
1396        (n *format-length*))
1397       ((or (= i n)
1398            (not (whitespacep (schar s i))))
1399        (setq *format-index* (1- i)))))
1400
1401(defun format-newline (stream colon atsign parms)
1402  (with-format-parameters parms ()
1403    (cond (colon
1404           (when atsign
1405             (format-error "~:@<newline> is undefined")))
1406          (atsign (terpri stream) (format-eat-whitespace))
1407          (t (format-eat-whitespace)))))
1408 
1409(defformat  #\newline format-newline (stream colon atsign &rest parms)
1410  (declare (dynamic-extent parms))
1411  (format-newline stream colon atsign parms))
1412
1413(defformat #\return format-newline (stream colon atsign &rest parms)
1414  (declare (dynamic-extent parms))
1415  (format-newline stream colon atsign parms))
1416
1417;;; Indirection  ~?
1418
1419(defformat #\? format-indirection (stream colon atsign)
1420  (format-no-flags colon nil)
1421  (let ((string (pop-format-arg)))
1422    (unless (or (stringp string)(functionp string))
1423      (format-error "Indirected control string is not a string or function"))
1424    (when (and (stringp string) (not (simple-string-p string)))
1425      (setq string (coerce string 'simple-string)))
1426    (catch 'format-escape
1427      (let ((error 
1428             (catch 'format-error
1429               (cond 
1430                ((stringp string)
1431                 (let* ((length (length (the simple-string string)))
1432                        (*format-control-string* string)
1433                        (*format-length* length)
1434                        (*format-index* 0))
1435                    (if atsign
1436                      (sub-format stream 0 length)
1437                      (let ((args (pop-format-arg)))
1438                        (let ((*format-top-level* nil)
1439                              (*format-arguments* args)
1440                              (*format-original-arguments* args))
1441                          (sub-format stream 0 length))))))
1442                (T ;(functionp string)
1443                 (if (not atsign)
1444                   (apply string stream (pop-format-arg))
1445                   ; account for the args it eats
1446                   (setq *format-arguments* (apply string stream *format-arguments*)))))
1447               nil)))
1448        (when error (format-indirect-error error))))))
1449
1450
1451
1452
1453;;; Ascii  ~A
1454
1455(defformat #\A format-princ (stream colon atsign &rest parms)
1456  (declare (dynamic-extent parms))
1457  (let ((arg (pop-format-arg)))
1458    (if (null parms)
1459      (princ (or arg (if colon "()" nil)) stream)
1460      (with-format-parameters parms ((mincol 0) (colinc 1) (minpad 0) (padchar #\space))
1461        (format-write-field
1462         stream
1463         (if (or arg (not colon))
1464           (princ-to-string arg)
1465           "()")
1466         mincol colinc minpad padchar atsign)))))
1467
1468
1469
1470;;; S-expression  ~S
1471           
1472(defformat #\S format-prin1 (stream colon atsign &rest parms)
1473  (declare (dynamic-extent parms))
1474  (let ((arg (pop-format-arg)))
1475    (if (null parms)
1476      (if (or arg (not colon)) (prin1 arg stream) (princ "()" stream))
1477      (with-format-parameters parms ((mincol 0) (colinc 1) (minpad 0) (padchar #\space))
1478        (format-write-field
1479         stream
1480         (if (or arg (not colon))
1481           (prin1-to-string arg)
1482           "()")
1483         mincol colinc minpad padchar atsign)))))
1484
1485
1486
1487;;; Character  ~C
1488
1489(defformat #\C format-print-character (stream colon atsign)
1490  (let* ((char (character (pop-format-arg)))
1491         (code (char-code char))
1492         (name (char-name char)))
1493    (cond ((and atsign (not colon))
1494           (prin1 char stream))
1495          (colon
1496           (if (or (eql char #\space)
1497                   (not (graphic-char-p char)))
1498             (princ name stream)
1499             (write-char char stream)))
1500          ((not (or atsign colon))
1501           (write-char char stream))
1502          ((and (< code 32) atsign)
1503           (setq char (code-char (logxor code 64)))
1504           (if (or colon (%str-member char "@CGHIJKLM[\\]^_"))
1505               (princ name stream)
1506               (progn
1507                 (write-char #\^ stream)
1508                 (write-char char stream)))
1509           (princ " (" stream)
1510           (princ "Control " stream)
1511           (write-char char stream)
1512           (write-char #\) stream))
1513          (name (princ name stream))
1514          (t (write-char char stream)))))
1515
1516
1517;;; NUMERIC PRINTING
1518
1519
1520
1521;;; Output a string in a field at MINCOL wide, padding with PADCHAR.
1522;;; Pads on the left if PADLEFT is true, else on the right.  If the
1523;;; length of the string plus the minimum permissible padding, MINPAD,
1524;;; is greater than MINCOL, the actual field size is rounded up to
1525;;; MINCOL + k * COLINC for the smallest possible positive integer k.
1526
1527(defun format-write-field (stream string mincol colinc minpad padchar padleft)
1528  (unless (or (null mincol)
1529              (integerp mincol))
1530    (format-error "Mincol must be an integer - ~S" mincol))
1531  (unless (and (integerp colinc) (plusp colinc))
1532    (format-error "Colinc must be a positive integer - ~S" colinc))
1533  (unless (integerp minpad)
1534    (format-error "Minpad must be an integer - ~S" minpad))
1535  (unless (characterp padchar)
1536    (if (typep padchar `(integer 0 #.char-code-limit))
1537      (setq padchar (code-char padchar))
1538      (format-error "Padchar must be a character or integer from 0 to ~a - ~S"
1539                    char-code-limit padchar)))
1540  (let* ((strlen (length (the string string)))
1541         (strwid (+ strlen minpad))
1542         (width (if mincol
1543                  (format-round-columns strwid mincol colinc)
1544                  strwid)))
1545    (if padleft
1546      (dotimes (i (the fixnum (- width strlen))) (write-char padchar stream)))
1547    (write-string string stream :start  0 :end strlen)
1548    (unless padleft
1549      (dotimes (i (the fixnum (- width strlen))) (write-char padchar stream)))))
1550
1551
1552;;; This functions does most of the work for the numeric printing
1553;;; directives.  The parameters are interpreted as defined for ~D.
1554
1555(defun format-print-number (stream number radix print-commas-p print-sign-p parms)
1556  (declare (dynamic-extent parms))
1557  (declare (type t number) (type fixnum radix))
1558  #+wrong
1559  (when (> (length parms) 2) (setq print-commas-p t)) ; print commas if char or interval provided
1560  (if (not (integerp number))
1561      (let ((*print-base* radix)
1562            (*print-escape* nil)
1563            (*print-radix* nil))
1564        (declare (special *print-base* *print-radix*))
1565        (princ number stream))
1566    (with-format-parameters parms
1567          ((mincol 0) (padchar #\space) (commachar #\,) (commainterval 3))
1568      ; look out for ",0D" - should be ",'0D"
1569      (unless (characterp padchar)
1570        (error "Use '~A instead of ~A for padchar in format directive" padchar padchar))
1571       (setq print-sign-p 
1572             (cond ((and print-sign-p (>= number 0)) #\+)
1573                   ((< number 0) #\-)))
1574       (setq number (abs number))
1575       (block HAIRY
1576         (block SIMPLE
1577           (if (and (not print-commas-p) (eql 0 mincol))
1578             (return-from SIMPLE))
1579           (let ((lg 0)
1580                 (commas 0))
1581             (declare (type fixnum lg commas))
1582             (do ((n (abs number) (floor n radix)))
1583                 ((%i< n radix))
1584               (declare (type integer n))
1585               (setq lg (%i+ lg 1))) ; lg is 1- significant digits             
1586             (setq commas (if print-commas-p
1587                              (floor lg commainterval)
1588                              0))
1589             (when print-sign-p
1590               (setq lg (1+ lg)))
1591             (when (and (eq commas 0)
1592                        (%i<= mincol lg))
1593               (return-from SIMPLE))
1594             ;; Cons-o-rama no more !
1595             (let* ((s (make-string-output-stream)))
1596               (when  (neq padchar #\space)
1597                 (dotimes (i (- mincol (+ lg commas) 1))
1598                   (write-char padchar s)))
1599               (when print-sign-p (write-char print-sign-p s))
1600               (%pr-integer  number radix s)                           
1601               (dotimes (i (the fixnum commas)) (write-char commachar s))
1602               (let ((text (get-output-stream-string s)))
1603                 (declare (type string text))
1604                 ;; -1234567,, => -1,234,567
1605                 (when (%i> commas 0)
1606                   (do* ((dest (%i- (length text) 1))
1607                         (source (%i- dest commas)))
1608                        ((= source dest))
1609                     (declare (type fixnum dest source))
1610                     (dotimes (i (the fixnum commainterval))
1611                       (setf (char text dest) (char text source)
1612                             dest (1- dest) 
1613                             source (1- source)))
1614                     (setf (char text dest) commachar
1615                           dest (1- dest))))
1616                 (format-write-field stream text mincol 1 0 padchar t)
1617                 (return-from HAIRY)))))
1618         ;; SIMPLE case         
1619         (when print-sign-p (write-char print-sign-p stream))
1620         (%pr-integer number radix stream))))
1621  nil)
1622
1623;;; Print a cardinal number in English
1624
1625(eval-when (:compile-toplevel :execute)
1626(defmacro cardinal-ones ()
1627  "Table of cardinal ones-place digits in English"
1628        '#(nil "one" "two" "three" "four" "five" "six" "seven" "eight" "nine"))
1629(defmacro cardinal-tens ()
1630  "Table of cardinal tens-place digits in English"
1631        '#(nil nil "twenty" "thirty" "forty"
1632           "fifty" "sixty" "seventy" "eighty" "ninety"))
1633(defmacro cardinal-teens ()
1634        '#("ten" "eleven" "twelve" "thirteen" "fourteen"  ;;; RAD
1635           "fifteen" "sixteen" "seventeen" "eighteen" "nineteen"))
1636)
1637
1638
1639(defun format-print-small-cardinal (stream n)
1640  (multiple-value-bind (hundreds rem) (truncate n 100)
1641    (when (plusp hundreds)
1642      (write-string (svref (cardinal-ones) hundreds) stream)
1643      (write-string " hundred" stream)
1644      (when (plusp rem) (write-char #\space stream)))    ; ; ; RAD
1645    (when (plusp rem)
1646      (multiple-value-bind (tens ones) (truncate rem 10)
1647        (cond ((< 1 tens)
1648               (write-string (svref (cardinal-tens) tens) stream)
1649               (when (plusp ones)
1650                 (write-char #\- stream)
1651                 (write-string (svref (cardinal-ones) ones) stream)))
1652              ((= tens 1)
1653               (write-string (svref (cardinal-teens) ones) stream))
1654              ((plusp ones)
1655               (write-string (svref (cardinal-ones) ones) stream)))))))
1656
1657(eval-when (:compile-toplevel :execute)
1658  (defmacro cardinal-periods ()
1659    "Table of cardinal 'teens' digits in English"
1660    '#("" " thousand" " million" " billion" " trillion" " quadrillion"
1661       " quintillion" " sextillion" " septillion" " octillion" " nonillion" 
1662       " decillion"))
1663)
1664
1665
1666(defun format-print-cardinal (stream n)
1667  (cond ((minusp n)
1668         (stream-write-entire-string stream "negative ")
1669         (format-print-cardinal-aux stream (- n) 0 n))
1670        ((zerop n)
1671         (stream-write-entire-string stream "zero"))
1672        (t (format-print-cardinal-aux stream n 0 n))))
1673
1674(defun format-print-cardinal-aux (stream n period err)
1675  (multiple-value-bind (beyond here) (truncate n 1000)
1676    (unless (<= period 10)
1677      (format-error "Number too large to print in English: ~:D" err))
1678    (unless (zerop beyond)
1679      (format-print-cardinal-aux stream beyond (1+ period) err))
1680    (unless (zerop here)
1681      (unless (zerop beyond) (write-char #\space stream))
1682      (format-print-small-cardinal stream here)
1683      (stream-write-entire-string stream (svref (cardinal-periods) period)))))
1684
1685
1686;;; Print an ordinal number in English
1687
1688
1689(eval-when (:compile-toplevel :execute)
1690(defmacro ordinal-ones ()
1691  "Table of ordinal ones-place digits in English"
1692  '#(nil "first" "second" "third" "fourth"
1693         "fifth" "sixth" "seventh" "eighth" "ninth"))
1694(defmacro ordinal-tens ()
1695  "Table of ordinal tens-place digits in English"
1696  '#(nil "tenth" "twentieth" "thirtieth" "fortieth"
1697         "fiftieth" "sixtieth" "seventieth" "eightieth" "ninetieth"))
1698)
1699
1700(defun format-print-ordinal (stream n)
1701  (when (minusp n)
1702    (stream-write-entire-string stream "negative "))
1703  (let ((number (abs n)))
1704    (multiple-value-bind (top bot) (truncate number 100)
1705      (unless (zerop top) (format-print-cardinal stream (- number bot)))
1706      (when (and (plusp top) (plusp bot)) (write-char #\space stream))
1707      (multiple-value-bind (tens ones) (truncate bot 10)
1708        (cond ((= bot 12) (stream-write-entire-string stream "twelfth"))
1709              ((= tens 1)
1710               (stream-write-entire-string stream (svref (cardinal-teens) ones));;;RAD
1711               (stream-write-entire-string stream "th"))
1712              ((and (zerop tens) (plusp ones))
1713               (stream-write-entire-string stream (svref (ordinal-ones) ones)))
1714              ((and (zerop ones)(plusp tens))
1715               (stream-write-entire-string stream (svref (ordinal-tens) tens)))
1716              ((plusp bot)
1717               (stream-write-entire-string stream (svref (cardinal-tens) tens))
1718               (write-char #\- stream)
1719               (stream-write-entire-string stream (svref (ordinal-ones) ones)))
1720              ((plusp number) (write-string "th" stream :start  0 :end 2))
1721              (t (stream-write-entire-string stream "zeroth")))))))
1722
1723
1724;;; Print Roman numerals
1725
1726(defun format-print-old-roman (stream n)
1727  (unless (< 0 n 5000)
1728          (format-error "Number out of range for old Roman numerals: ~:D" n))
1729  (do ((char-list '(#\D #\C #\L #\X #\V #\I) (cdr char-list))
1730       (val-list '(500 100 50 10 5 1) (cdr val-list))
1731       (cur-char #\M (car char-list))
1732       (cur-val 1000 (car val-list))
1733       (start n (do ((i start (progn (write-char cur-char stream) (- i cur-val))))
1734                    ((< i cur-val) i))))
1735      ((zerop start))))
1736
1737
1738(defun format-print-roman (stream n)
1739  (unless (< 0 n 4000)
1740          (format-error "Number out of range for Roman numerals: ~:D" n))
1741  (do ((char-list '(#\D #\C #\L #\X #\V #\I) (cdr char-list))
1742       (val-list '(500 100 50 10 5 1) (cdr val-list))
1743       (sub-chars '(#\C #\X #\X #\I #\I) (cdr sub-chars))
1744       (sub-val '(100 10 10 1 1 0) (cdr sub-val))
1745       (cur-char #\M (car char-list))
1746       (cur-val 1000 (car val-list))
1747       (cur-sub-char #\C (car sub-chars))
1748       (cur-sub-val 100 (car sub-val))
1749       (start n (do ((i start (progn (write-char cur-char stream) (- i cur-val))))
1750                    ((< i cur-val)
1751                     (cond ((<= (- cur-val cur-sub-val) i)
1752                            (write-char cur-sub-char stream)
1753                            (write-char cur-char stream)
1754                            (- i (- cur-val cur-sub-val)))
1755                           (t i))))))
1756      ((zerop start))))
1757
1758
1759;;; Decimal  ~D
1760
1761(defformat #\D format-print-decimal (stream colon atsign &rest parms)
1762  (declare (dynamic-extent parms))
1763  (format-print-number stream (pop-format-arg) 10 colon atsign parms))
1764
1765
1766;;; Binary  ~B
1767
1768(defformat #\B format-print-binary (stream colon atsign &rest parms)
1769  (declare (dynamic-extent parms))
1770  (format-print-number stream (pop-format-arg) 2 colon atsign parms))
1771
1772
1773;;; Octal  ~O
1774
1775(defformat #\O format-print-octal (stream colon atsign &rest parms)
1776  (declare (dynamic-extent parms))
1777  (format-print-number stream (pop-format-arg) 8 colon atsign parms))
1778
1779
1780;;; Hexadecimal  ~X
1781
1782(defformat #\X format-print-hexadecimal (stream colon atsign &rest parms)
1783  (declare (dynamic-extent parms))
1784  (format-print-number stream (pop-format-arg) 16 colon atsign parms))
1785
1786
1787;;; Radix  ~R
1788
1789(defformat #\R format-print-radix (stream colon atsign &rest parms)
1790  (declare (dynamic-extent parms))
1791  (let ((number (pop-format-arg))
1792        (parm (if parms (pop parms) nil)))
1793    (if parm
1794        (format-print-number stream number parm colon atsign parms)
1795        (if atsign
1796            (if colon
1797                (format-print-old-roman stream number)
1798                (format-print-roman stream number))
1799            (if colon
1800                (format-print-ordinal stream number)
1801                (format-print-cardinal stream number))))))
1802
1803;;; FLOATING-POINT NUMBERS
1804
1805
1806;;; Fixed-format floating point  ~F
1807
1808(defformat #\F format-fixed (stream colon atsign &rest parms)
1809  (declare (dynamic-extent parms))
1810  (when colon
1811    (format-error "Colon flag not allowed"))
1812  (with-format-parameters parms ((w nil) (d nil) (k nil) (ovf nil) (pad #\space))
1813    ;;Note that the scale factor k defaults to nil.  This is interpreted as
1814    ;;zero by flonum-to-string, but more efficiently.
1815    (let ((number (pop-format-arg))(*print-escape* nil))
1816      (if (floatp number)
1817        (format-fixed-aux stream number w d k ovf pad atsign)
1818        (if (rationalp number)
1819          (format-fixed-aux stream (coerce number 'float) w d k ovf pad atsign)
1820          (let ((*print-base* 10))
1821            (format-write-field stream (princ-to-string number) w 1 0 #\space t)))))))
1822
1823; do something ad hoc if d > w - happens if (format nil "~15g" (- 2.3 .1))
1824; called with w = 11 d = 16 - dont do it after all.
1825
1826(defun format-fixed-aux (stream number w d k ovf pad atsign)
1827  (and w (<= w 0) (setq w nil))  ; if width is unreasonable, ignore it.
1828  (if (not (or w d))
1829    (print-float-free-form number stream)
1830    (let ((spaceleft w)
1831          (abs-number (abs number))
1832          strlen zsuppress flonum-to-string-width)
1833      (when (and w (or atsign (minusp number)))
1834        (decf spaceleft))
1835      (when (and d w (<= w (+ 1 d (if atsign 1 0))))
1836        (setq zsuppress t))
1837      (when (and d (minusp d))
1838          (format-error "Illegal value for d"))
1839      (setq flonum-to-string-width
1840            (and w
1841                 (if (and (< abs-number 1) (not zsuppress))
1842                   (1- spaceleft)   ; room for leading 0
1843                   spaceleft)))
1844      (when (and w (not (plusp flonum-to-string-width)))
1845        (if ovf 
1846          (progn
1847            (dotimes (i w) (write-char ovf stream))
1848            (return-from format-fixed-aux))
1849          (setq spaceleft nil w nil flonum-to-string-width nil)))
1850      (multiple-value-bind (str before-pt after-pt)
1851                           (flonum-to-string abs-number
1852                                             flonum-to-string-width
1853                                             d k)
1854        (setq strlen (length str))
1855        (cond (w (decf spaceleft (+ (max before-pt 0) 1))
1856                 (when (and (< before-pt 1) (not zsuppress))
1857                   (decf spaceleft))
1858                 (if d
1859                   (decf spaceleft d)
1860                   (setq d (max (min spaceleft (- after-pt))
1861                                (if (> spaceleft 0) 1 0))
1862                         spaceleft (- spaceleft d))))
1863              ((null d) (setq d (max (- after-pt) 1))))
1864        (cond ((and w (< spaceleft 0) ovf)
1865               ;;field width overflow
1866               (dotimes (i w) (declare (fixnum i)) (write-char ovf stream)))
1867              (t (when w (dotimes (i spaceleft) (declare (fixnum i)) (write-char pad stream)))
1868                 (if (minusp (float-sign number)) ; 5/25
1869                   (write-char #\- stream)
1870                   (if atsign (write-char #\+ stream)))
1871                 (cond
1872                  ((> before-pt 0)
1873                   (cond ((> strlen before-pt)
1874                          (write-string str stream :start  0 :end before-pt)
1875                          (write-char #\. stream)
1876                          (write-string str stream :start  before-pt :end strlen)
1877                          (dotimes (i (- d (- strlen before-pt)))
1878                            (write-char #\0 stream)))
1879                         (t ; 0's after
1880                          (stream-write-entire-string stream str)
1881                          (dotimes (i (-  before-pt strlen))
1882                            (write-char #\0 stream))
1883                          (write-char #\. stream)
1884                          (dotimes (i d)
1885                            (write-char #\0 stream)))))
1886                  (t (unless zsuppress (write-char #\0 stream))
1887                     (write-char #\. stream)
1888                     (dotimes (i (- before-pt)) 
1889                       (write-char #\0 stream))
1890                     (stream-write-entire-string stream str)
1891                     (dotimes (i (+ d after-pt)) 
1892                      (write-char #\0 stream))))))))))
1893#|
1894; (format t "~7,3,-2f" 8.88)
1895; (format t "~10,5,2f" 8.88)
1896; (format t "~10,5,-2f" 8.88)
1897; (format t "~10,5,2f" 0.0)
1898; (format t "~10,5,2f" 9.999999999)
1899; (format t "~7,,,-2e" 8.88) s.b. .009e+3 ??
1900; (format t "~10,,2f" 8.88)
1901; (format t "~10,,-2f" 8.88)
1902; (format t "~10,,2f" 0.0)
1903; (format t "~10,,2f" 0.123454)
1904; (format t "~10,,2f" 9.9999999)
1905 (defun foo (x)
1906    (format nil "~6,2f|~6,2,1,'*f|~6,2,,'?f|~6f|~,2f|~F"
1907     x x x x x x))
1908
1909|#
1910
1911                 
1912
1913;;; Exponential-format floating point  ~E
1914
1915
1916(defformat #\E format-exponential (stream colon atsign &rest parms)
1917  (declare (dynamic-extent parms))
1918  (when colon
1919    (format-error "Colon flag not allowed"))
1920  (with-format-parameters parms ((w nil) (d nil) (e nil) (k 1) (ovf nil) (pad #\space) (marker nil))
1921    (let ((number (pop-format-arg)))
1922      (if (floatp number)
1923        (format-exp-aux stream number w d e k ovf pad marker atsign)
1924        (if (rationalp number)
1925          (format-exp-aux stream (coerce number 'float) w d e k ovf pad marker atsign)
1926          (let ((*print-base* 10))
1927            (format-write-field stream (princ-to-string number) w 1 0 #\space t)))))))
1928#|
1929(defun format-exponent-marker (number)
1930  (if (typep number *read-default-float-format*)
1931      #\E
1932      (cond ((double-floatp) #\D)
1933            ((short-floatp number) #\S)
1934            ((single-floatp number) #\F)
1935            ((long-floatp) #\L))))
1936|#
1937(eval-when (eval compile #-bccl load)
1938  (defmacro format-exponent-marker (number)
1939    `(float-exponent-char ,number))
1940)
1941
1942;;;Here we prevent the scale factor from shifting all significance out of
1943;;;a number to the right.  We allow insignificant zeroes to be shifted in
1944;;;to the left right, athough it is an error to specify k and d such that this
1945;;;occurs.  Perhaps we should detect both these condtions and flag them as
1946;;;errors.  As for now, we let the user get away with it, and merely guarantee
1947;;;that at least one significant digit will appear.
1948;;; THE ABOVE COMMENT no longer applies
1949
1950(defun format-exp-aux (stream number w d e k ovf pad marker atsign &optional string exp)
1951  (when (not k) (setq k 1))
1952  (if (not (or w d e marker (neq k 1)))
1953    (print-a-float number stream t)
1954    (prog () 
1955      (when d
1956        (when (or (minusp d)
1957                  (and (plusp k)(>= k (+ d 2)))
1958                  (and (minusp k)(< k (- d))))
1959          (format-error "incompatible values for k and d")))
1960      (when (not exp) (setq exp (accurate-scale-exponent (abs number))))
1961      AGAIN
1962      (let* ((expt (- exp k))
1963             (estr (let ((*print-base* 10))
1964                     (princ-to-string (abs expt))))
1965             (elen (max (length estr) (or e 0)))
1966             (spaceleft (if w (- w 2 elen) nil))
1967             (fwidth) scale)
1968        (when (and w (or atsign (minusp (float-sign number)))) ; 5/25
1969          (setq spaceleft (1- spaceleft)))
1970        (if w
1971          (progn 
1972          (setq fwidth (if d 
1973                         (if (> k 0)(+ d 2)(+ d k 1))
1974                         (if (> k 0) spaceleft (+ spaceleft k))))
1975          (when (minusp exp) ; i don't claim to understand this
1976            (setq fwidth (- fwidth exp))
1977            (when (< k 0) (setq fwidth (1- fwidth)))))         
1978          (when (and d  (not (zerop number))) ; d and no w
1979            (setq scale (- 2  k exp))))  ; 2 used to be 1  - 5/31
1980        (when (or (and w e ovf (> elen e))(and w fwidth (not (plusp fwidth))))
1981          ;;exponent overflow
1982          (dotimes (i w) (declare (fixnum i)) (write-char ovf stream))
1983          (if (plusp fwidth)
1984            (return-from format-exp-aux nil)
1985            (setq fwidth nil)))
1986        (when (not string)
1987          (multiple-value-bind (new-string before-pt) (flonum-to-string number fwidth 
1988                                                                        (if (not fwidth) d)
1989                                                                        (if (not fwidth) scale))
1990            (setq string new-string)
1991            (when scale (setq before-pt (- (+ 1 before-pt) k scale))) ; sign right?           
1992            (when (neq exp before-pt)
1993              ;(print (list 'agn exp before-pt))
1994              ;(setq string new-string)
1995              (setq exp before-pt)
1996              (go again))))
1997          (let ((strlen (length string)))
1998            (when w
1999              (if d 
2000                (setq spaceleft (- spaceleft (+ d 2)))
2001                (if (< k 1)
2002                  (setq spaceleft (- spaceleft (+ 2 (- k)(max strlen 1))))
2003                  (setq spaceleft (- spaceleft (+ 1 k (max 1 (- strlen k))))))))
2004            (when (and w (< spaceleft 0))
2005              (if (and ovf (or (plusp k)(< spaceleft -1)))           
2006                (progn (dotimes (i w) (declare (fixnum i)) (write-char ovf stream))
2007                       (return-from format-exp-aux nil))))
2008            (when w
2009              (dotimes (i  spaceleft)
2010                (declare (fixnum i))
2011                (write-char pad stream)))
2012            (if (minusp (float-sign number)) ; 5/25
2013              (write-char #\- stream)
2014              (if atsign (write-char #\+ stream)))
2015            (cond 
2016             ((< k 1)
2017              (when (not (minusp spaceleft))(write-char #\0 stream))
2018              (write-char #\. stream)
2019              (dotimes (i (- k))
2020                (write-char #\0 stream))
2021              (if (and (eq strlen 0)(not d))
2022                (write-char #\0 stream)
2023                (stream-write-entire-string stream string))
2024              (if d
2025                (dotimes (i (- (+ d k) strlen))
2026                  (write-char #\0 stream))))
2027             (t 
2028              (write-string string stream :start 0 :end (min k strlen))
2029              (dotimes (i (- k strlen))
2030                (write-char #\0 stream))                   
2031              (write-char #\. stream)
2032              (when (> strlen k)
2033                (write-string string stream :start k :end strlen))
2034              (if (not d) 
2035                (when (<= strlen k)(write-char #\0 stream))
2036                (dotimes (i (1+ (- d k (max 0 (- strlen k)))))
2037                  (write-char #\0 stream)))))
2038            (write-char (if marker
2039                          marker
2040                          (format-exponent-marker number))
2041                        stream)
2042            (write-char (if (minusp expt) #\- #\+) stream)
2043            (when e 
2044              ;;zero-fill before exponent if necessary
2045              (dotimes (i (- e (length estr)))
2046                (declare (fixnum i))
2047                (write-char #\0 stream)))
2048            (stream-write-entire-string stream estr))))))
2049#|
2050; (format t "~7,3,,-2e" 8.88) s.b. .009e+3
2051; (format t "~10,5,,2e" 8.888888888) ; "88.8889E-1"
2052; (format t "~10,5,,-2e" 8.88)   "0.00888E+3"
2053; (format t "~10,5,,-2e" .00123445) ; "0.00123E+0"
2054; (format t "~10,5,,-3e" .00123445) ; "0.00012E+1"
2055; (format t "~10,,,-2e" .123445)
2056; (format t "~10,5,,2e" .0012349999e-4)
2057; (format t "~10,5,,2e" 9.9999999)
2058; (format t "~10,5,,2e" 0.0)
2059; (format t "~10,5,,0e" 40000000.0)
2060; (format t "~10,5,,2e" 9.9999999)
2061; (format t "~7,,,-2e" 8.88) s.b. .009e+3 ??
2062; (format t "~10,,,2e" 8.888888)
2063; (format t "~10,,,-2e" 8.88)
2064; (format t "~10,,,-2e" 0.0)
2065; (format t "~10,,,2e" 0.0)
2066; (format t "~10,,,2e" 9.9999999)
2067; (format t "~10,,,2e" 9.9999999e100)
2068; (format t "~10,5,3,2,'xe" 10e100)
2069; (format t "~9,3,2,-2e" 1100.0)
2070(defun foo (x)
2071  (format nil
2072          "~9,2,1,,'*e|~10,3,2,2,'?,,'$e|~9,3,2,-2,'%@e|~9,2e"
2073          x x x x))
2074|#
2075
2076
2077;;; General Floating Point -  ~G
2078
2079(defformat #\G format-general-float (stream colon atsign &rest parms)
2080  (declare (dynamic-extent parms))
2081  (when colon
2082    (format-error "Colon flag not allowed"))
2083  (with-format-parameters parms ((w nil) (d nil) (e nil) (k nil) (ovf nil) (pad #\space) (marker nil))
2084    (let ((number (pop-format-arg)))
2085      ;;The Excelsior edition does not say what to do if
2086      ;;the argument is not a float.  Here, we adopt the
2087      ;;conventions used by ~F and ~E.
2088      (if (floatp number)
2089        (format-general-aux stream number w d e k ovf pad marker atsign)
2090        (if (rationalp number)
2091          (format-general-aux stream (coerce number 'float) w d e k ovf pad marker atsign)
2092          (let ((*print-base* 10))
2093            (format-write-field stream (princ-to-string number) w 1 0 #\space t)))))))
2094
2095#|
2096; completely broken
2097(defun foo (x)
2098  (format nil
2099          "~9,2,1,,'*g|~10,3,2,2,'?,,'$g|~9,3,2,-2,'%@g|~9,2g"
2100          x x x x))
2101|#
2102
2103
2104(defun format-general-aux (stream number w d e k ovf pad marker atsign)
2105  (multiple-value-bind (str n #|after-pt|#)(flonum-to-string number)
2106    ;;Default d if omitted.  The procedure is taken directly
2107    ;;from the definition given in the manual, and is not
2108    ;;very efficient, since we generate the digits twice.
2109    ;;Future maintainers are encouraged to improve on this.
2110    (let* ((d2 (or d (max (length str) (min n 7))))
2111           (ee (if e (+ e 2) 4))
2112           (ww (if w (- w ee) nil))
2113           (dd (- d2 n)))
2114      (cond ((<= 0 dd d2)
2115             ; this causes us to print 1.0 as 1. - seems weird
2116             (format-fixed-aux stream number ww dd nil ovf pad atsign)
2117             (dotimes (i ee) (declare (fixnum i)) (write-char #\space stream)))
2118            (t (format-exp-aux stream number w d e (or k 1) ovf pad marker atsign nil n))))))
2119
2120
2121;;; Dollars floating-point format  ~$
2122
2123(defformat #\$ format-dollars (stream colon atsign &rest parms)
2124  (declare (dynamic-extent parms))
2125  (with-format-parameters parms ((d 2) (n 1) (w 0) (pad #\space))
2126    (let* ((number (float (pop-format-arg)))
2127           (signstr (if (minusp (float-sign number)) "-" (if atsign "+" "")))
2128           (spaceleft)
2129           strlen)
2130      (multiple-value-bind (str before-pt after-pt) (flonum-to-string number nil d)
2131        (setq strlen (length str))
2132        (setq spaceleft (- w (+ (length signstr) (max before-pt n) 1 d)))
2133        (when colon (stream-write-entire-string stream signstr))
2134        (dotimes (i spaceleft) (write-char pad stream))
2135        (unless colon (stream-write-entire-string stream signstr))
2136        (cond
2137         ((> before-pt 0)
2138          (dotimes (i (- n before-pt))
2139            (write-char #\0 stream))
2140          (cond ((> strlen before-pt)
2141                 (write-string str stream :start 0 :end before-pt)
2142                 (write-char #\. stream)
2143                 (write-string str stream :start before-pt :end strlen)
2144                 (dotimes (i (- d (- strlen before-pt)))
2145                   (write-char #\0 stream)))
2146                (t ; 0's after
2147                 (stream-write-entire-string stream str)
2148                 (dotimes (i (-  before-pt strlen))
2149                   (write-char #\0 stream))
2150                 (write-char #\. stream)
2151                 (dotimes (i d)
2152                   (write-char #\0 stream)))))
2153         (t (dotimes (i n)
2154              (write-char #\0 stream))
2155            (write-char #\. stream)
2156            (dotimes (i (- before-pt))
2157              (write-char #\0 stream))
2158            (stream-write-entire-string stream str)
2159            (dotimes (i (+ d after-pt))
2160              (write-char #\0 stream))))))))
2161
2162(defun y-or-n-p (&optional format-string &rest arguments &aux response)
2163  "Y-OR-N-P prints the message, if any, and reads characters from
2164   *QUERY-IO* until the user enters y or Y as an affirmative, or either
2165   n or N as a negative answer. It asks again if you enter any other
2166   characters."
2167  (declare (dynamic-extent arguments))
2168  (with-terminal-input
2169      (clear-input *query-io*)
2170      (loop
2171        (when format-string
2172          (fresh-line *query-io*)
2173          (apply 'format *query-io* format-string arguments))
2174        (princ " (y or n)  " *query-io*)
2175        (setq response (read-char *query-io*))
2176        ;; Consume input up to trailing newline
2177        (when (peek-char #\NewLine *query-io* nil)
2178          ;; And consume the #\newline
2179          (read-char *query-io*))
2180        (clear-input *query-io*)
2181        (if (char-equal response #\y) (return t))
2182        (if (char-equal response #\n) (return nil))
2183        (format *query-io* "Please answer y or n."))))
2184
2185(defun yes-or-no-p (&optional format-string &rest arguments &aux response)
2186  "YES-OR-NO-P is similar to Y-OR-N-P, except that it clears the
2187   input buffer, beeps, and uses READ-LINE to get the strings
2188   YES or NO."
2189  (declare (dynamic-extent arguments))
2190  (with-terminal-input
2191      (loop
2192        (when format-string
2193          (fresh-line *query-io*)
2194          (apply 'format *query-io* format-string arguments))
2195        (princ " (yes or no)  " *query-io*)
2196        (format *query-io* "~A" #\Bell)
2197        (setq response (read-line *query-io*))
2198        (clear-input *query-io*)
2199        (when response
2200          (setq response (string-trim wsp response))
2201          (if (string-equal response "yes") (return t))
2202          (if (string-equal response "no") (return nil))
2203          (format *query-io* "Please answer yes or no.")))))
2204
2205
2206;; Compile-time format-scanning support.
2207;;
2208;; All this assumes it's called from the compiler, but it has to be kept in sync with code
2209;; here more than with the code in the compiler, so keep it in here.
2210
2211(defun note-format-scan-option (cell)
2212  (when cell
2213    (if (null (cdr cell))
2214      (setf (car cell) *format-arguments* (cdr cell) *format-arguments-variance*)
2215      (let* ((new-args *format-arguments*)
2216             (new-var *format-arguments-variance*)
2217             (new-max (length new-args))
2218             (old-args (car cell))
2219             (old-var (cdr cell))
2220             (old-max (length old-args))
2221             (min (min (- new-max new-var) (- old-max old-var))))
2222        (if (>= new-max old-max)
2223          (setf (car cell) new-args (cdr cell) (- new-max min))
2224          (setf (cdr cell) (- old-max min))))))
2225  cell)
2226
2227(defmacro with-format-scan-options ((var) &body body)
2228  (let ((cell (gensym)))
2229    ;; CELL is used to record range of arg variations that should be deferred til the end
2230    ;; of BODY because they represent possible non-local exits.
2231    `(let* ((,cell (cons nil nil))
2232            (,var ,cell))
2233       (declare (dynamic-extent ,cell))
2234       (prog1
2235           (progn
2236             ,@body)
2237         (setq *format-arguments* (car ,cell)
2238               *format-arguments-variance* (cdr ,cell))))))
2239
2240(defvar *format-escape-options* nil)
2241
2242(defun nx1-check-format-call (control-string format-arguments &optional (env *nx-lexical-environment*))
2243  "Format-arguments are expressions that will evaluate to the actual arguments.
2244  Pre-scan process the format string, nx1-whine if find errors"
2245  (let* ((*nx-lexical-environment* env)
2246         (*format-top-level* t)
2247         (*logical-block-xp* nil)
2248         (*format-pprint* nil)
2249         (*format-justification-semi* nil))
2250    (let ((error (catch 'format-error
2251                   (format-scan control-string format-arguments 0)
2252                   nil)))
2253      (when error
2254        (setf (cadar error) (concatenate 'string (cadar error) " in format string:"))
2255        (nx1-whine :format-error (nreverse error))
2256        t))))
2257
2258(defun format-scan (string args var)
2259  (let ((*format-original-arguments* args)
2260        (*format-arguments* args)
2261        (*format-arguments-variance* var)
2262        (*format-colon-rest* 'error)
2263        (*format-control-string* (ensure-simple-string string)))
2264    (with-format-scan-options (*format-escape-options*)
2265      (catch 'format-escape
2266        (sub-format-scan 0 (length *format-control-string*))
2267        (note-format-scan-option *format-escape-options*)))
2268    (when (> (length *format-arguments*) *format-arguments-variance*)
2269      (format-error "Too many format arguments"))))
2270
2271(defun sub-format-scan (i end)
2272  (let ((*format-index* i)
2273        (*format-length* end)
2274        (string *format-control-string*))
2275    (loop while (setq *format-index* (position #\~ string :start *format-index* :end end)) do
2276      (multiple-value-bind (params colon atsign char) (parse-format-operation t)
2277        (setq char (char-upcase char))
2278        (let ((code (%char-code char)))
2279          (unless (and (< -1 code (length *format-char-table*))
2280                       (svref *format-char-table* code))
2281            (format-error "Unknown directive ~c" char)))
2282        (format-scan-directive char colon atsign params)
2283        (incf *format-index*)))))
2284
2285(defun nx-could-be-type (form type &optional transformed &aux (env *nx-lexical-environment*))
2286  (unless transformed (setq form (nx-transform form env)))
2287  (if (nx-form-constant-p form env)
2288    (typep (nx-form-constant-value form env) type env)
2289    (not (types-disjoint-p (nx-form-type form env) type env))))
2290
2291(defun format-require-type (form type &optional description)
2292  (unless (nx-could-be-type form type)
2293    (format-error "~a must be of type ~s" (or description form) type)))
2294
2295
2296(defun format-scan-directive (char colon atsign parms)
2297  (ecase char
2298    ((#\% #\& #\~ #\|)
2299     (with-format-parameters parms ((repeat-count 1))
2300       (format-no-flags colon atsign)
2301       (format-require-type repeat-count '(integer 0))))
2302    ((#\newline #\return)
2303     (with-format-parameters parms ()
2304       (when (and atsign colon) (format-error "~:@<newline> is undefined"))
2305       (unless colon
2306         (format-eat-whitespace))))
2307    ((#\P)
2308     (with-format-parameters parms ()
2309       (when colon
2310         (loop with end = *format-arguments*
2311            for list on *format-original-arguments*
2312            when (eq (cdr list) end) return (setq *format-arguments* list)
2313            finally (if (> (or *format-arguments-variance* 0) 0)
2314                        (decf *format-arguments-variance*)
2315                        (format-error "No previous argument"))))
2316       (pop-format-arg)))
2317    ((#\A #\S)
2318     (with-format-parameters parms ((mincol 0) (colinc 1) (minpad 0) (padchar #\space))
2319       (format-require-type mincol 'integer "mincol (first parameter)")
2320       (format-require-type colinc '(integer 1) "colinc (second parameter)")
2321       (format-require-type minpad 'integer "minpad (third parameter)")
2322       (format-require-type padchar '(or (integer 0 #.char-code-limit) character) "padchar (fourth parameter)"))
2323     (pop-format-arg))
2324    ((#\I)
2325     (with-format-parameters parms ((n 0))
2326       (format-no-flags nil atsign)
2327       (format-no-semi char)
2328       (format-require-type n 'real)))
2329    ((#\_)
2330     (with-format-parameters parms ()
2331       (format-no-semi char)))
2332    ((#\T)
2333     (with-format-parameters parms ((colnum 1) (colinc 1))
2334       (when colon
2335         (format-no-semi char t))
2336       (format-require-type colnum 'integer "colnum (first parameter)")
2337       (format-require-type colinc 'integer "colinc (second parameter)")))
2338    ((#\W)
2339     (with-format-parameters parms ()
2340       (format-no-semi #\W))
2341     (pop-format-arg))
2342    ((#\C)
2343     (with-format-parameters parms ())
2344     (format-require-type (pop-format-arg) '(or character fixnum (string 1))))
2345    ((#\D #\B #\O #\X #\R)
2346     (when (eql char #\R)
2347       (let ((radix (pop parms)))
2348         (when radix
2349           (format-require-type radix '(integer 2 36)))))
2350     (with-format-parameters parms ((mincol 0) (padchar #\space) (commachar #\,) (commainterval 3))
2351       (format-require-type mincol 'integer "mincol (first parameter)")
2352       (format-require-type padchar 'character "padchar (second parameter)")
2353       (format-require-type commachar 'character "comma char (third parameter)")
2354       (format-require-type commainterval 'integer "comma interval (fourth parameter)"))
2355     (pop-format-arg))
2356    ((#\F)
2357     (format-no-flags colon nil)
2358     (with-format-parameters parms ((w nil) (d nil) (k nil) (ovf nil) (pad #\space))
2359       (format-require-type w '(or null (integer 0)) "w (first parameter)")
2360       (format-require-type d '(or null (integer 0)) "d (second parameter)")
2361       (format-require-type k '(or null integer) "k (third parameter)")
2362       (format-require-type ovf '(or null character) "overflowchar (fourth parameter)")
2363       (format-require-type pad '(or null character) "padchar (fifth parameter)"))
2364     (pop-format-arg))
2365    ((#\E #\G)
2366     (format-no-flags colon nil)
2367     (with-format-parameters parms ((w nil) (d nil) (e nil) (k 1) (ovf nil) (pad #\space) (marker nil))
2368       (format-require-type w '(or null (integer 0)) "w (first parameter)")
2369       (format-require-type d '(or null (integer 0)) "d (second parameter)")
2370       (format-require-type e '(or null (integer 0)) "e (third parameter)")
2371       (format-require-type k '(or null integer) "k (fourth parameter)")
2372       (format-require-type ovf '(or null character) "overflowchar (fifth parameter)")
2373       (format-require-type pad '(or null character) "padchar (sixth parameter)")
2374       (format-require-type marker '(or null character) "exponentchar (seventh parameter)"))
2375     (pop-format-arg))
2376    ((#\$)
2377     (with-format-parameters parms ((d 2) (n 1) (w 0) (pad #\space))
2378       (format-require-type d '(or null (integer 0)) "d (first parameter)")
2379       (format-require-type n '(or null (integer 0)) "n (second parameter)")
2380       (format-require-type w '(or null (integer 0)) "w (third parameter)")
2381       (format-require-type pad '(or null character) "pad (fourth parameter)"))
2382     (format-require-type (pop-format-arg) 'real))
2383    ((#\*)
2384     (with-format-parameters parms ((count nil))
2385       (when count
2386         (format-require-type count 'integer "count parameter"))
2387       (if (typep (setq count (nx-transform count)) '(or null integer))
2388         (format-scan-goto colon atsign count)
2389         ;; Else can't tell how much going back or forth, could be anywhere.
2390         (setq *format-arguments* *format-original-arguments*
2391               *format-arguments-variance* (length *format-arguments*)))))
2392    ((#\?)
2393     (with-format-parameters parms ()
2394       (format-no-flags colon nil))
2395     (let ((string (pop-format-arg)))
2396       (format-require-type string '(or string function))
2397       (if atsign
2398         (setq *format-arguments-variance* (length *format-arguments*))
2399         (let ((arg (pop-format-arg)))
2400           (format-require-type arg 'list)))))
2401    ((#\/)
2402     (let* ((string *format-control-string*)
2403            (ipos (1+ *format-index*))
2404            (epos (format-find-char #\/ ipos *format-length*)))
2405       (when (not epos) (format-error "Unmatched ~~/"))
2406       (let* ((cpos (format-find-char #\: ipos epos))
2407              (name (if cpos
2408                      (prog1
2409                          (string-upcase (%substr string ipos cpos))
2410                        (when (eql #\: (schar string (%i+ 1 cpos)))
2411                          (setq cpos (%i+ cpos 1)))
2412                        (setq ipos (%i+ cpos 1)))
2413                      "CL-USER"))
2414              (package (find-package name))
2415              (sym (and package (find-symbol (string-upcase (%substr string ipos epos)) package)))
2416              (arg (pop-format-arg)))
2417         (setq *format-index* epos) ; or 1+ epos?
2418         ;; TODO: should we complain if the symbol doesn't exit?  Perhaps it will be defined
2419         ;; later, and to detect that would need to intern it.  What if the package doesn't exist?
2420         ;; Would need to extend :undefined-function warnings to handle previously-undefined package.
2421         (when sym
2422           (when (nx1-check-typed-call sym (list* '*standard-output* arg colon atsign parms))
2423             ;; Whined, just get out now.
2424             (throw 'format-error nil))))))
2425    ((#\[)
2426     (when (and colon atsign) (format-error  "~~:@[ undefined"))
2427     (format-nextchar)
2428     (cond (colon
2429            (format-scan-boolean-condition parms))
2430           (atsign
2431            (format-scan-funny-condition parms))
2432           (t (format-scan-untagged-condition parms))))
2433    ((#\()
2434     (with-format-parameters parms ()
2435       (format-nextchar)
2436       (multiple-value-bind (prev tilde parms colon atsign) (format-find-command '(#\)))
2437         (with-format-parameters parms () (format-no-flags colon atsign))
2438         (sub-format-scan prev tilde))))
2439    ((#\^)
2440     (format-no-flags nil atsign)
2441     (with-format-parameters parms ((p1 nil) (p2 nil) (p3 nil))
2442       (let ((val (nx-transform (cond (p3
2443                                       (if (every (lambda (p) (nx-could-be-type p 'real)) parms)
2444                                         ;; If the params could also be chars, don't know enough to constant fold
2445                                         ;; anyway, so this test will do.
2446                                         `(< ,p1 ,p2 ,p3)
2447                                         (if (every (lambda (p) (nx-could-be-type p 'character)) parms)
2448                                           `(char< ,p1 ,p2 ,p3)
2449                                           ;; At least one can't be real, at least one can't be char.
2450                                           (format-error "Wrong type of parameters for three-way comparison"))))
2451                                      (p2 `(equal ,p1 ,p2))
2452                                      (p1 `(eq ,p1 0))
2453                                      (t (null (if colon *format-colon-rest* *format-arguments*)))))))
2454         (when val
2455           (note-format-scan-option *format-escape-options*)
2456           (unless (nx-could-be-type val 'null t)
2457             (throw 'format-escape t))))))
2458    ((#\{)
2459     (with-format-parameters parms ((max-iter -1))
2460       (format-require-type max-iter 'integer "max-iter parameter")
2461       (format-nextchar)
2462       (multiple-value-bind (prev tilde end-parms end-colon end-atsign) (format-find-command '(#\}))
2463         (declare (ignore end-colon))
2464         (with-format-parameters end-parms () (format-no-flags nil end-atsign))
2465         (when (= prev tilde)
2466           ;; Use an argument as the control string if ~{~} is empty
2467           (let ((string (pop-format-arg)))
2468             (unless (nx-could-be-type string '(or string function))
2469               (format-error "Control string is not a string or function"))))
2470         ;; Could try to actually scan the iteration if string is a compile-time string,
2471         ;; by that seems unlikely.
2472         (if atsign
2473           (setq *format-arguments-variance* (length *format-arguments*))
2474           (format-require-type (pop-format-arg) 'list)))))
2475    ((#\<)
2476     (multiple-value-bind (start tilde eparms ecolon eatsign) (format-find-command '(#\>))
2477       (declare (ignore tilde eparms eatsign))
2478       (setq *format-index* start)
2479       (if ecolon
2480         (format-logical-block-scan colon atsign parms)
2481         (format-justification-scan colon atsign parms))))
2482    ))
2483
2484(defun format-justification-scan (colon atsign parms)
2485  (declare (ignore colon atsign))
2486  (with-format-parameters parms ((mincol 0) (colinc 1) (minpad 0) (padchar #\space))
2487    (format-require-type mincol 'integer "mincol (first parameter)")
2488    (format-require-type colinc '(integer 1) "colinc (second parameter)")
2489    (format-require-type minpad 'integer "minpad (third parameter)")
2490    (format-require-type padchar `(or character (integer 0 #.char-code-limit)) "padchar (fourth parameter)"))
2491  (let ((first-parms nil) (first-colon nil) (count 0))
2492    (with-format-scan-options (*format-escape-options*)
2493      (loop
2494         (format-nextchar)
2495         (multiple-value-bind (prev tilde parms colon atsign cmd)
2496             (format-find-command '(#\; #\>) nil T)
2497           (if (and (eql count 0) (eql cmd #\;) colon)
2498             (progn
2499               (format-no-flags nil atsign)
2500               (setq first-colon t)
2501               (setq *format-index* tilde)
2502               (setq first-parms (nth-value 2 (format-find-command '(#\; #\>) t T))))
2503             (with-format-parameters parms ()
2504               (format-no-flags colon atsign)))
2505           (when (catch 'format-escape
2506                   (sub-format-scan prev tilde)
2507                   nil)
2508             (unless (eq cmd #\>) (format-find-command '(#\>) nil t))
2509             (return))
2510           (incf count)
2511           (when (eq cmd #\>)
2512             (return))))
2513      (note-format-scan-option *format-escape-options*))
2514    (when first-colon
2515      (when *format-pprint*
2516        (format-error "Justification illegal in this context"))
2517      (setq *format-justification-semi* t)
2518      (with-format-parameters first-parms ((spare 0) (linel 0))
2519        (format-require-type spare 'integer "spare (first parameter)")
2520        (format-require-type linel 'integer "line length (second parameter)")))))
2521     
2522
2523
2524(defun format-logical-block-scan (colon atsign params)
2525  (declare (ignore colon))
2526  (with-format-parameters params ()
2527    (format-no-semi #\<))
2528    ;; First section can be termined by ~@;
2529  (let ((format-string *format-control-string*)
2530        (prefix "")
2531        (suffix "")
2532        (body-string nil))
2533    (multiple-value-bind (start1 tilde parms1 colon1 atsign1 cmd) (format-find-command  '(#\; #\>))
2534      (setq body-string (%substr format-string (1+ start1) tilde))
2535      (with-format-parameters parms1 ())
2536      (when (eq cmd #\;)
2537        (format-no-flags colon1 nil)
2538        (setq prefix body-string)
2539        (multiple-value-setq (start1 tilde parms1 colon1 atsign1 cmd) (format-find-command '(#\; #\>)))
2540        (with-format-parameters parms1 ())
2541        (setq body-string (%substr format-string (1+ start1) tilde))
2542        (when (eq cmd #\;)
2543          (format-no-flags colon1 atsign1)
2544          (multiple-value-setq (start1 tilde parms1 colon1 atsign1 cmd) (format-find-command  '(#\; #\>)))
2545          (with-format-parameters parms1 ())
2546          (setq suffix (%substr format-string (1+ start1) tilde))
2547          (when (eq cmd #\;)
2548            (format-error "Too many sections")))))
2549    (flet ((format-check-simple (str where)
2550             (when (and str (or (%str-member #\~ str) (%str-member #\newline str)))
2551               (format-error "~A must be simple" where))))
2552      (format-check-simple prefix "Prefix")
2553      (format-check-simple suffix "Suffix"))
2554    (if atsign
2555      (let ((*logical-block-p* t))
2556        (format-scan body-string *format-arguments* *format-arguments-variance*)
2557        (setq *format-arguments* nil *format-arguments-variance* 0))
2558      ;; If no atsign, we just use up an arg.  Don't bother trying to scan it, unlikely to be a constant.
2559      (when *format-arguments*
2560        (pop-format-arg)))))
2561
2562
2563(defun format-scan-untagged-condition (parms)
2564  (with-format-parameters parms ((index nil))
2565    (unless index (setq index (pop-format-arg)))
2566    (format-require-type index 'integer)
2567    (with-format-scan-options (cond-options)
2568      (loop with default = nil do
2569           (multiple-value-bind (prev tilde parms colon atsign cmd)
2570               (format-find-command '(#\; #\]))
2571             (when (and default (eq cmd #\;))
2572               (format-error "~:; must be the last clause"))
2573             (with-format-parameters parms ()
2574               (format-no-flags (if (eq cmd #\]) colon) atsign)
2575               (when colon (setq default t)))
2576             (format-scan-optional-clause prev tilde cond-options)
2577             (when (eq cmd #\])
2578               (unless default    ;; Could just skip the whole thing
2579                 (note-format-scan-option cond-options))
2580               (return))
2581             (format-nextchar))))))
2582
2583(defun format-scan-funny-condition (parms)
2584  (with-format-parameters parms ())
2585  (multiple-value-bind (prev tilde parms colon atsign) (format-find-command '(#\]))
2586    (with-format-parameters parms ()
2587      (format-no-flags colon atsign))
2588    (when (null *format-arguments*) (pop-format-arg)) ;; invoke std error
2589    (with-format-scan-options (cond-options)
2590      (let ((arg (nx-transform (car *format-arguments*))))
2591        (when (nx-could-be-type arg 'null t)
2592          (let ((*format-arguments* *format-arguments*)
2593                (*format-arguments-variance* *format-arguments-variance*))
2594            (when (eql *format-arguments-variance* (length *format-arguments*))
2595              (decf *format-arguments-variance*))
2596            (pop *format-arguments*)
2597            (note-format-scan-option cond-options)))
2598        (when arg
2599          (format-scan-optional-clause prev tilde cond-options))))))
2600
2601
2602(defun format-scan-boolean-condition (parms)
2603  (with-format-parameters parms ())
2604  (multiple-value-bind (prev tilde parms colon atsign cmd) (format-find-command '(#\; #\]))
2605    (when (eq cmd #\])
2606      (format-error "Two clauses separated by ~~; are required for ~~:["))
2607    (with-format-parameters parms () (format-no-flags colon atsign))
2608    (format-nextchar)
2609    (with-format-scan-options (cond-options)
2610      (let ((arg (nx-transform (pop-format-arg))))
2611        (when (nx-could-be-type arg 'null t)
2612          (format-scan-optional-clause prev tilde cond-options))
2613        (multiple-value-bind (prev tilde parms colon atsign) (format-find-command '(#\]))
2614          (with-format-parameters parms () (format-no-flags colon atsign))
2615          (when arg
2616            (format-scan-optional-clause prev tilde cond-options)))))))
2617
2618
2619(defun format-scan-optional-clause (start end cond-option)
2620  (let ((*format-arguments* *format-arguments*)
2621        (*format-arguments-variance* *format-arguments-variance*))
2622    ;; Let the branch points collect in outer *format-escape-options*, but don't
2623    ;; throw there because need to consider the other clauses.
2624    (catch 'format-escape
2625      (sub-format-scan start end)
2626      (note-format-scan-option cond-option)
2627      nil)))
2628
2629(defun format-scan-goto (colon atsign count)
2630  (if atsign 
2631    (let* ((orig *format-original-arguments*)
2632           (orig-pos (- (length orig) (length *format-arguments*)))
2633           (new-pos (or count 0)))
2634      (format-no-flags colon nil)
2635      ;; After backing up, we may not use up all the arguments we backed over,
2636      ;; so even though real variance here is 0, increase variance so we don't
2637      ;; complain.
2638      (setq *format-arguments-variance* (max 0 (- orig-pos new-pos)))
2639      (setq *format-arguments* (nthcdr-no-overflow new-pos orig)))
2640    (progn
2641      (when (null count)(setq count 1))
2642      (when colon (setq count (- count)))
2643      (cond ((> count 0)
2644             (when (> count (length *format-arguments*))
2645               (format-error "Target position for ~~* out of bounds"))
2646             (setq *format-arguments* (nthcdr count *format-arguments*))
2647             (when *format-arguments-variance*
2648               (setq *format-arguments-variance*
2649                     (min *format-arguments-variance* (length *format-arguments*)))))
2650            ((< count 0)
2651             (let* ((orig *format-original-arguments*)
2652                    (orig-pos (- (length orig) (length *format-arguments*)))
2653                    (pos (+ orig-pos count))
2654                    (max-pos (+ pos (or *format-arguments-variance* 0))))
2655               (when (< max-pos 0)
2656                 (format-error "Target position for ~~* out of bounds"))
2657               ;; After backing up, we may not use up all the arguments we backed over.
2658               ;; Increase the variance allowed to cover those arguments, so we don't
2659               ;; complain about not using them.  E.g. (format t "~a ~a ~2:*~a" 1 2) should
2660               ;; be ok, (format t "~a ~a ~2:*" 1 2) should warn.
2661               (setq max-pos (1- (- max-pos count)))
2662               (if (< pos 0)
2663                 (setq *format-arguments* orig
2664                       *format-arguments-variance* max-pos)
2665                 (setq *format-arguments* (nthcdr pos orig)
2666                       *format-arguments-variance* (- max-pos pos)))))))))
Note: See TracBrowser for help on using the repository browser.