source: trunk/source/lib/format.lisp

Last change on this file was 16685, checked in by rme, 4 years ago

Update copyright/license headers in files.

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