source: trunk/abcl/src/org/armedbear/lisp/format.lisp @ 11625

Last change on this file since 11625 was 11625, checked in by ehuelsmann, 13 years ago

Fix COERCE.20 (a regression since 0.12).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 118.2 KB
Line 
1;;; format.lisp
2;;;
3;;; Copyright (C) 2004-2007 Peter Graves
4;;; $Id: format.lisp 11625 2009-02-05 08:46:06Z ehuelsmann $
5;;;
6;;; This program is free software; you can redistribute it and/or
7;;; modify it under the terms of the GNU General Public License
8;;; as published by the Free Software Foundation; either version 2
9;;; of the License, or (at your option) any later version.
10;;;
11;;; This program is distributed in the hope that it will be useful,
12;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14;;; GNU General Public License for more details.
15;;;
16;;; You should have received a copy of the GNU General Public License
17;;; along with this program; if not, write to the Free Software
18;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
19;;;
20;;; As a special exception, the copyright holders of this library give you
21;;; permission to link this library with independent modules to produce an
22;;; executable, regardless of the license terms of these independent
23;;; modules, and to copy and distribute the resulting executable under
24;;; terms of your choice, provided that you also meet, for each linked
25;;; independent module, the terms and conditions of the license of that
26;;; module.  An independent module is a module which is not derived from
27;;; or based on this library.  If you modify this library, you may extend
28;;; this exception to your version of the library, but you are not
29;;; obligated to do so.  If you do not wish to do so, delete this
30;;; exception statement from your version.
31
32;;; Adapted from CMUCL/SBCL.
33
34(in-package "SYSTEM")
35
36;;; From primordial-extensions.lisp.
37
38;;; Concatenate together the names of some strings and symbols,
39;;; producing a symbol in the current package.
40(eval-when (:compile-toplevel :load-toplevel :execute)
41  (defun symbolicate (&rest things)
42    (let ((name (apply #'concatenate 'string (mapcar #'string things))))
43      (values (intern name)))))
44
45;;; a helper function for various macros which expect clauses of a
46;;; given length, etc.
47;;;
48;;; Return true if X is a proper list whose length is between MIN and
49;;; MAX (inclusive).
50(eval-when (:compile-toplevel :load-toplevel :execute)
51  (defun proper-list-of-length-p (x min &optional (max min))
52    ;; FIXME: This implementation will hang on circular list
53    ;; structure. Since this is an error-checking utility, i.e. its
54    ;; job is to deal with screwed-up input, it'd be good style to fix
55    ;; it so that it can deal with circular list structure.
56    (cond ((minusp max) nil)
57          ((null x) (zerop min))
58          ((consp x)
59           (and (plusp max)
60                (proper-list-of-length-p (cdr x)
61                                         (if (plusp (1- min))
62                                             (1- min)
63                                             0)
64                                         (1- max))))
65          (t nil))))
66
67;;; From early-extensions.lisp.
68
69(defconstant form-feed-char-code 12)
70
71(defmacro named-let (name binds &body body)
72  (dolist (x binds)
73    (unless (proper-list-of-length-p x 2)
74      (error "malformed NAMED-LET variable spec: ~S" x)))
75  `(labels ((,name ,(mapcar #'first binds) ,@body))
76     (,name ,@(mapcar #'second binds))))
77
78;;;; ONCE-ONLY
79;;;;
80;;;; "The macro ONCE-ONLY has been around for a long time on various
81;;;; systems [..] if you can understand how to write and when to use
82;;;; ONCE-ONLY, then you truly understand macro." -- Peter Norvig,
83;;;; _Paradigms of Artificial Intelligence Programming: Case Studies
84;;;; in Common Lisp_, p. 853
85
86;;; ONCE-ONLY is a utility useful in writing source transforms and
87;;; macros. It provides a concise way to wrap a LET around some code
88;;; to ensure that some forms are only evaluated once.
89;;;
90;;; Create a LET* which evaluates each value expression, binding a
91;;; temporary variable to the result, and wrapping the LET* around the
92;;; result of the evaluation of BODY. Within the body, each VAR is
93;;; bound to the corresponding temporary variable.
94(defmacro once-only (specs &body body)
95  (named-let frob ((specs specs)
96       (body body))
97             (if (null specs)
98                 `(progn ,@body)
99                 (let ((spec (first specs)))
100                   ;; FIXME: should just be DESTRUCTURING-BIND of SPEC
101                   (unless (proper-list-of-length-p spec 2)
102                     (error "malformed ONCE-ONLY binding spec: ~S" spec))
103                   (let* ((name (first spec))
104                          (exp-temp (gensym (symbol-name name))))
105                     `(let ((,exp-temp ,(second spec))
106                            (,name (gensym "ONCE-ONLY-")))
107                        `(let ((,,name ,,exp-temp))
108                           ,,(frob (rest specs) body))))))))
109
110;;; From print.lisp.
111
112;;; FLONUM-TO-STRING (and its subsidiary function FLOAT-STRING) does
113;;; most of the work for all printing of floating point numbers in the
114;;; printer and in FORMAT. It converts a floating point number to a
115;;; string in a free or fixed format with no exponent. The
116;;; interpretation of the arguments is as follows:
117;;;
118;;;     X - The floating point number to convert, which must not be
119;;;   negative.
120;;;     WIDTH    - The preferred field width, used to determine the number
121;;;   of fraction digits to produce if the FDIGITS parameter
122;;;   is unspecified or NIL. If the non-fraction digits and the
123;;;   decimal point alone exceed this width, no fraction digits
124;;;   will be produced unless a non-NIL value of FDIGITS has been
125;;;   specified. Field overflow is not considerd an error at this
126;;;   level.
127;;;     FDIGITS  - The number of fractional digits to produce. Insignificant
128;;;   trailing zeroes may be introduced as needed. May be
129;;;   unspecified or NIL, in which case as many digits as possible
130;;;   are generated, subject to the constraint that there are no
131;;;   trailing zeroes.
132;;;     SCALE    - If this parameter is specified or non-NIL, then the number
133;;;   printed is (* x (expt 10 scale)). This scaling is exact,
134;;;   and cannot lose precision.
135;;;     FMIN     - This parameter, if specified or non-NIL, is the minimum
136;;;   number of fraction digits which will be produced, regardless
137;;;   of the value of WIDTH or FDIGITS. This feature is used by
138;;;   the ~E format directive to prevent complete loss of
139;;;   significance in the printed value due to a bogus choice of
140;;;   scale factor.
141;;;
142;;; Most of the optional arguments are for the benefit for FORMAT and are not
143;;; used by the printer.
144;;;
145;;; Returns:
146;;; (VALUES DIGIT-STRING DIGIT-LENGTH LEADING-POINT TRAILING-POINT DECPNT)
147;;; where the results have the following interpretation:
148;;;
149;;;     DIGIT-STRING    - The decimal representation of X, with decimal point.
150;;;     DIGIT-LENGTH    - The length of the string DIGIT-STRING.
151;;;     LEADING-POINT   - True if the first character of DIGIT-STRING is the
152;;;          decimal point.
153;;;     TRAILING-POINT  - True if the last character of DIGIT-STRING is the
154;;;          decimal point.
155;;;     POINT-POS       - The position of the digit preceding the decimal
156;;;          point. Zero indicates point before first digit.
157;;;
158;;; NOTE: FLONUM-TO-STRING goes to a lot of trouble to guarantee
159;;; accuracy. Specifically, the decimal number printed is the closest
160;;; possible approximation to the true value of the binary number to
161;;; be printed from among all decimal representations with the same
162;;; number of digits. In free-format output, i.e. with the number of
163;;; digits unconstrained, it is guaranteed that all the information is
164;;; preserved, so that a properly- rounding reader can reconstruct the
165;;; original binary number, bit-for-bit, from its printed decimal
166;;; representation. Furthermore, only as many digits as necessary to
167;;; satisfy this condition will be printed.
168;;;
169;;; FLOAT-STRING actually generates the digits for positive numbers.
170;;; The algorithm is essentially that of algorithm Dragon4 in "How to
171;;; Print Floating-Point Numbers Accurately" by Steele and White. The
172;;; current (draft) version of this paper may be found in
173;;; [CMUC]<steele>tradix.press. DO NOT EVEN THINK OF ATTEMPTING TO
174;;; UNDERSTAND THIS CODE WITHOUT READING THE PAPER!
175
176(defun flonum-to-string (x &optional width fdigits scale fmin)
177  (declare (ignore fmin)) ; FIXME
178  (cond ((zerop x)
179   ;; Zero is a special case which FLOAT-STRING cannot handle.
180   (if fdigits
181       (let ((s (make-string (1+ fdigits) :initial-element #\0)))
182         (setf (schar s 0) #\.)
183         (values s (length s) t (zerop fdigits) 0))
184       (values "." 1 t t 0)))
185  (t
186         (when scale
187           (setf x (* x (expt 10 scale))))
188         (let* ((s (float-string x))
189                (length (length s))
190                (index (position #\. s)))
191           (when (and (< x 1)
192                      (> length 0)
193                      (eql (schar s 0) #\0))
194             (setf s (subseq s 1)
195                   length (length s)
196                   index (position #\. s)))
197           (when fdigits
198             ;; "Leading zeros are not permitted, except that a single zero
199             ;; digit is output before the decimal point if the printed value
200             ;; is less than one, and this single zero digit is not output at
201             ;; all if w=d+1."
202             (let ((actual-fdigits (- length index 1)))
203               (cond ((< actual-fdigits fdigits)
204                      ;; Add the required number of trailing zeroes.
205                      (setf s (concatenate 'string s
206                                           (make-string (- fdigits actual-fdigits)
207                                                        :initial-element #\0))
208                            length (length s)))
209                     ((> actual-fdigits fdigits)
210                      (let* ((desired-length (+ index 1 fdigits))
211                             (c (schar s desired-length)))
212                        (setf s (subseq s 0 (+ index 1 fdigits))
213                              length (length s)
214                              index (position #\. s))
215                        (when (char>= c #\5)
216                          (setf s (round-up s)
217                                length (length s)
218                                index (position #\. s))))))))
219           (when (and width (> length width))
220             ;; The string is too long. Shorten it by removing insignificant
221             ;; trailing zeroes if possible.
222             (let ((minimum-width (+ (1+ index) (or fdigits 0))))
223               (when (< minimum-width width)
224                 (setf minimum-width width))
225               (when (> length minimum-width)
226                 ;; But we don't want to shorten e.g. "1.7d100"...
227                 (when (every #'digit-char-p (subseq s (1+ index)))
228                   (let ((c (schar s minimum-width)))
229                     (setf s (subseq s 0 minimum-width)
230                           length minimum-width)
231                     (when (char>= c #\5)
232                       (setf s (round-up s)
233                             length (length s)
234                             index (position #\. s))))))))
235           (values s length (eql index 0) (eql index (1- length)) index)))))
236
237(defun round-up (string)
238  (let* ((index (position #\. string))
239         (n (read-from-string (setf string (remove #\. string))))
240         (s (princ-to-string (incf n))))
241    (loop for char across string
242      while (equal char #\0)
243      do (setf s (concatenate 'string "0" s)))
244    (cond ((null index)
245           s)
246          (t
247           (when (> (length s) (length string))
248             ;; Rounding up made the string longer, which means we went from (say) 99
249             ;; to 100. Drop the trailing #\0 and move the #\. one character to the
250             ;; right.
251             (setf s (subseq s 0 (1- (length s))))
252             (incf index))
253           (concatenate 'string (subseq s 0 index) "." (subseq s index))))))
254
255
256(eval-when (:compile-toplevel :execute)
257    ;; the code below needs to its floats to be read as long-floats
258    (defvar *saved-default-float-format* *read-default-float-format*)
259    (setf *read-default-float-format* 'double-float))
260
261(defun scale-exponent (original-x)
262  (let* ((x (coerce original-x 'long-float)))
263    (multiple-value-bind (sig exponent) (decode-float x)
264      (declare (ignore sig))
265      (if (= x 0.0e0)
266    (values (float 0.0e0 original-x) 1)
267    (let* ((ex (locally (declare (optimize (safety 0)))
268                       (the fixnum
269                            (round (* exponent (log 2e0 10))))))
270     (x (if (minusp ex)
271      (if (float-denormalized-p x)
272          (* x 1.0e16 (expt 10.0e0 (- (- ex) 16)))
273          (* x 10.0e0 (expt 10.0e0 (- (- ex) 1))))
274      (/ x 10.0e0 (expt 10.0e0 (1- ex))))))
275      (do ((d 10.0e0 (* d 10.0e0))
276     (y x (/ x d))
277     (ex ex (1+ ex)))
278    ((< y 1.0e0)
279     (do ((m 10.0e0 (* m 10.0e0))
280          (z y (* y m))
281          (ex ex (1- ex)))
282         ((>= z 0.1e0)
283          (values (float z original-x) ex))
284                   (declare (long-float m) (integer ex))))
285              (declare (long-float d))))))))
286
287(defconstant double-float-exponent-byte
288  (byte 11 20))
289
290(defun float-denormalized-p (x)
291  "Return true if the double-float X is denormalized."
292  (and (zerop (ldb double-float-exponent-byte (double-float-high-bits x)))
293       (not (zerop x))))
294
295;;; From early-format.lisp.
296
297(in-package #:format)
298
299(defparameter *format-whitespace-chars*
300  (vector #\space
301    #\newline
302          #\tab))
303
304(defvar *format-directive-expanders*
305  (make-array char-code-limit :initial-element nil))
306(defvar *format-directive-interpreters*
307  (make-array char-code-limit :initial-element nil))
308
309(defvar *default-format-error-control-string* nil)
310(defvar *default-format-error-offset* nil)
311
312;;;; specials used to communicate information
313
314;;; Used both by the expansion stuff and the interpreter stuff. When it is
315;;; non-NIL, up-up-and-out (~:^) is allowed. Otherwise, ~:^ isn't allowed.
316(defvar *up-up-and-out-allowed* nil)
317
318;;; Used by the interpreter stuff. When it's non-NIL, it's a function
319;;; that will invoke PPRINT-POP in the right lexical environemnt.
320(declaim (type (or null function) *logical-block-popper*))
321(defvar *logical-block-popper* nil)
322
323;;; Used by the expander stuff. This is bindable so that ~<...~:>
324;;; can change it.
325(defvar *expander-next-arg-macro* 'expander-next-arg)
326
327;;; Used by the expander stuff. Initially starts as T, and gets set to NIL
328;;; if someone needs to do something strange with the arg list (like use
329;;; the rest, or something).
330(defvar *only-simple-args*)
331
332;;; Used by the expander stuff. We do an initial pass with this as NIL.
333;;; If someone doesn't like this, they (THROW 'NEED-ORIG-ARGS NIL) and we try
334;;; again with it bound to T. If this is T, we don't try to do anything
335;;; fancy with args.
336(defvar *orig-args-available* nil)
337
338;;; Used by the expander stuff. List of (symbol . offset) for simple args.
339(defvar *simple-args*)
340
341;;; From late-format.lisp.
342
343(in-package #:format)
344
345(define-condition format-error (error)
346  ((complaint :reader format-error-complaint :initarg :complaint)
347   (args :reader format-error-args :initarg :args :initform nil)
348   (control-string :reader format-error-control-string
349       :initarg :control-string
350       :initform *default-format-error-control-string*)
351   (offset :reader format-error-offset :initarg :offset
352     :initform *default-format-error-offset*)
353   (print-banner :reader format-error-print-banner :initarg :print-banner
354     :initform t))
355  (:report %print-format-error))
356
357(defun %print-format-error (condition stream)
358  (format stream
359    "~:[~;error in format: ~]~
360           ~?~@[~%  ~A~%  ~V@T^~]"
361    (format-error-print-banner condition)
362    (format-error-complaint condition)
363    (format-error-args condition)
364    (format-error-control-string condition)
365    (format-error-offset condition)))
366
367(defstruct format-directive
368  (string (missing-arg) :type simple-string)
369  (start (missing-arg) :type (and unsigned-byte fixnum))
370  (end (missing-arg) :type (and unsigned-byte fixnum))
371  (character (missing-arg) :type base-char)
372  (colonp nil :type (member t nil))
373  (atsignp nil :type (member t nil))
374  (params nil :type list))
375(defmethod print-object ((x format-directive) stream)
376  (print-unreadable-object (x stream)
377                           (write-string (format-directive-string x)
378                                         stream
379                                         :start (format-directive-start x)
380                                         :end (format-directive-end x))))
381
382;;;; TOKENIZE-CONTROL-STRING
383
384(defun tokenize-control-string (string)
385  (declare (simple-string string))
386  (let ((index 0)
387  (end (length string))
388  (result nil)
389  (in-block nil)
390  (pprint nil)
391  (semi nil)
392  (justification-semi 0))
393    (declare (type index fixnum))
394    (loop
395      (let ((next-directive (or (position #\~ string :start index) end)))
396        (declare (type index next-directive))
397  (when (> next-directive index)
398    (push (subseq string index next-directive) result))
399  (when (= next-directive end)
400    (return))
401  (let* ((directive (parse-directive string next-directive))
402         (directive-char (format-directive-character directive)))
403          (declare (type character directive-char))
404    ;; We are looking for illegal combinations of format
405    ;; directives in the control string.  See the last paragraph
406    ;; of CLHS 22.3.5.2: "an error is also signaled if the
407    ;; ~<...~:;...~> form of ~<...~> is used in the same format
408    ;; string with ~W, ~_, ~<...~:>, ~I, or ~:T."
409    (cond ((char= #\< directive-char)
410     ;; Found a justification or logical block
411     (setf in-block t))
412    ((and in-block (char= #\; directive-char))
413     ;; Found a semi colon in a justification or logical block
414     (setf semi t))
415    ((char= #\> directive-char)
416     ;; End of justification or logical block.  Figure out which.
417     (setf in-block nil)
418     (cond ((format-directive-colonp directive)
419      ;; A logical-block directive.  Note that fact, and also
420      ;; note that we don't care if we found any ~;
421      ;; directives in the block.
422      (setf pprint t)
423      (setf semi nil))
424           (semi
425      ;; A justification block with a ~; directive in it.
426      (incf justification-semi))))
427    ((and (not in-block)
428          (or (and (char= #\T directive-char) (format-directive-colonp directive))
429        (char= #\W directive-char)
430        (char= #\_ directive-char)
431        (char= #\I directive-char)))
432     (setf pprint t)))
433    (push directive result)
434    (setf index (format-directive-end directive)))))
435    (when (and pprint (plusp justification-semi))
436      (error 'format-error
437       :complaint "A justification directive cannot be in the same format string~%~
438             as ~~W, ~~I, ~~:T, or a logical-block directive."
439       :control-string string
440       :offset 0))
441    (nreverse result)))
442
443(defun parse-directive (string start)
444  (let ((posn (1+ start)) (params nil) (colonp nil) (atsignp nil)
445  (end (length string)))
446    (flet ((get-char ()
447                     (if (= posn end)
448                         (error 'format-error
449                                :complaint "String ended before directive was found."
450                                :control-string string
451                                :offset start)
452                         (schar string posn)))
453     (check-ordering ()
454                           (when (or colonp atsignp)
455                             (error 'format-error
456                                    :complaint "parameters found after #\\: or #\\@ modifier"
457                                    :control-string string
458                                    :offset posn))))
459      (loop
460  (let ((char (get-char)))
461    (cond ((or (char<= #\0 char #\9) (char= char #\+) (char= char #\-))
462     (check-ordering)
463     (multiple-value-bind (param new-posn)
464                   (parse-integer string :start posn :junk-allowed t)
465       (push (cons posn param) params)
466       (setf posn new-posn)
467       (case (get-char)
468         (#\,)
469         ((#\: #\@)
470          (decf posn))
471         (t
472          (return)))))
473    ((or (char= char #\v)
474         (char= char #\V))
475     (check-ordering)
476     (push (cons posn :arg) params)
477     (incf posn)
478     (case (get-char)
479       (#\,)
480       ((#\: #\@)
481        (decf posn))
482       (t
483        (return))))
484    ((char= char #\#)
485     (check-ordering)
486     (push (cons posn :remaining) params)
487     (incf posn)
488     (case (get-char)
489       (#\,)
490       ((#\: #\@)
491        (decf posn))
492       (t
493        (return))))
494    ((char= char #\')
495     (check-ordering)
496     (incf posn)
497     (push (cons posn (get-char)) params)
498     (incf posn)
499     (unless (char= (get-char) #\,)
500       (decf posn)))
501    ((char= char #\,)
502     (check-ordering)
503     (push (cons posn nil) params))
504    ((char= char #\:)
505     (if colonp
506         (error 'format-error
507          :complaint "too many colons supplied"
508          :control-string string
509          :offset posn)
510         (setf colonp t)))
511    ((char= char #\@)
512     (if atsignp
513         (error 'format-error
514          :complaint "too many #\\@ characters supplied"
515          :control-string string
516          :offset posn)
517         (setf atsignp t)))
518    (t
519     (when (and (char= (schar string (1- posn)) #\,)
520          (or (< posn 2)
521        (char/= (schar string (- posn 2)) #\')))
522       (check-ordering)
523       (push (cons (1- posn) nil) params))
524     (return))))
525  (incf posn))
526      (let ((char (get-char)))
527  (when (char= char #\/)
528    (let ((closing-slash (position #\/ string :start (1+ posn))))
529      (if closing-slash
530    (setf posn closing-slash)
531    (error 'format-error
532           :complaint "no matching closing slash"
533           :control-string string
534           :offset posn))))
535  (make-format-directive
536   :string string :start start :end (1+ posn)
537   :character (char-upcase char)
538   :colonp colonp :atsignp atsignp
539   :params (nreverse params))))))
540
541;;;; FORMATTER stuff
542
543(defmacro formatter (control-string)
544  `#',(%formatter control-string))
545
546(defun %formatter (control-string)
547  (block nil
548    (catch 'need-orig-args
549      (let* ((*simple-args* nil)
550       (*only-simple-args* t)
551       (guts (expand-control-string control-string))
552       (args nil))
553  (dolist (arg *simple-args*)
554    (push `(,(car arg)
555      (error
556       'format-error
557       :complaint "required argument missing"
558       :control-string ,control-string
559       :offset ,(cdr arg)))
560    args))
561  (return `(lambda (stream &optional ,@args &rest args)
562       ,guts
563       args))))
564    (let ((*orig-args-available* t)
565    (*only-simple-args* nil))
566      `(lambda (stream &rest orig-args)
567   (let ((args orig-args))
568     ,(expand-control-string control-string)
569     args)))))
570
571(defun expand-control-string (string)
572  (let* ((string (etypecase string
573       (simple-string
574        string)
575       (string
576        (coerce string 'simple-string))))
577   (*default-format-error-control-string* string)
578   (directives (tokenize-control-string string)))
579    `(block nil
580       ,@(expand-directive-list directives))))
581
582(defun expand-directive-list (directives)
583  (let ((results nil)
584  (remaining-directives directives))
585    (loop
586      (unless remaining-directives
587  (return))
588      (multiple-value-bind (form new-directives)
589        (expand-directive (car remaining-directives)
590                          (cdr remaining-directives))
591  (push form results)
592  (setf remaining-directives new-directives)))
593    (reverse results)))
594
595(defun expand-directive (directive more-directives)
596  (etypecase directive
597    (format-directive
598     (let ((expander
599      (aref *format-directive-expanders*
600      (char-code (format-directive-character directive))))
601     (*default-format-error-offset*
602      (1- (format-directive-end directive))))
603       (declare (type (or null function) expander))
604       (if expander
605     (funcall expander directive more-directives)
606     (error 'format-error
607      :complaint "unknown directive ~@[(character: ~A)~]"
608      :args (list (char-name (format-directive-character directive)))))))
609    (simple-string
610     (values `(write-string ,directive stream)
611       more-directives))))
612
613(defmacro expander-next-arg (string offset)
614  `(if args
615       (pop args)
616       (error 'format-error
617        :complaint "no more arguments"
618        :control-string ,string
619        :offset ,offset)))
620
621(defun expand-next-arg (&optional offset)
622  (if (or *orig-args-available* (not *only-simple-args*))
623      `(,*expander-next-arg-macro*
624  ,*default-format-error-control-string*
625  ,(or offset *default-format-error-offset*))
626      (let ((symbol (gensym "FORMAT-ARG-")))
627  (push (cons symbol (or offset *default-format-error-offset*))
628        *simple-args*)
629  symbol)))
630
631(defmacro expand-bind-defaults (specs params &body body)
632  (sys::once-only ((params params))
633                  (if specs
634                      (collect ((expander-bindings) (runtime-bindings))
635                               (dolist (spec specs)
636                                 (destructuring-bind (var default) spec
637                                                     (let ((symbol (gensym)))
638                                                       (expander-bindings
639                                                        `(,var ',symbol))
640                                                       (runtime-bindings
641                                                        `(list ',symbol
642                                                               (let* ((param-and-offset (pop ,params))
643                                                                      (offset (car param-and-offset))
644                                                                      (param (cdr param-and-offset)))
645                                                                 (case param
646                                                                   (:arg `(or ,(expand-next-arg offset)
647                                                                              ,,default))
648                                                                   (:remaining
649                                                                    (setf *only-simple-args* nil)
650                                                                    '(length args))
651                                                                   ((nil) ,default)
652                                                                   (t param))))))))
653                               `(let ,(expander-bindings)
654                                  `(let ,(list ,@(runtime-bindings))
655                                     ,@(if ,params
656                                           (error
657                                            'format-error
658                                            :complaint
659                                            "too many parameters, expected no more than ~W"
660                                            :args (list ,(length specs))
661                                            :offset (caar ,params)))
662                                     ,,@body)))
663                      `(progn
664                         (when ,params
665                           (error 'format-error
666                                  :complaint "too many parameters, expected none"
667                                  :offset (caar ,params)))
668                         ,@body))))
669
670;;;; format directive machinery
671
672;;; FIXME: only used in this file, could be SB!XC:DEFMACRO in EVAL-WHEN
673(defmacro def-complex-format-directive (char lambda-list &body body)
674  (let ((defun-name
675          (intern (concatenate 'string
676                               (let ((name (char-name char)))
677                                 (cond (name
678                                        (string-capitalize name))
679                                       (t
680                                        (string char))))
681                               "-FORMAT-DIRECTIVE-EXPANDER")))
682  (directive (gensym))
683  (directives (if lambda-list (car (last lambda-list)) (gensym))))
684    `(progn
685       (defun ,defun-name (,directive ,directives)
686   ,@(if lambda-list
687         `((let ,(mapcar (lambda (var)
688         `(,var
689           (,(sys::symbolicate "FORMAT-DIRECTIVE-" var)
690            ,directive)))
691             (butlast lambda-list))
692       ,@body))
693         `((declare (ignore ,directive ,directives))
694     ,@body)))
695       (%set-format-directive-expander ,char #',defun-name))))
696
697;;; FIXME: only used in this file, could be SB!XC:DEFMACRO in EVAL-WHEN
698(defmacro def-format-directive (char lambda-list &body body)
699  (let ((directives (gensym))
700  (declarations nil)
701  (body-without-decls body))
702    (loop
703      (let ((form (car body-without-decls)))
704  (unless (and (consp form) (eq (car form) 'declare))
705    (return))
706  (push (pop body-without-decls) declarations)))
707    (setf declarations (reverse declarations))
708    `(def-complex-format-directive ,char (,@lambda-list ,directives)
709       ,@declarations
710       (values (progn ,@body-without-decls)
711         ,directives))))
712
713(eval-when (:compile-toplevel :load-toplevel :execute)
714
715  (defun %set-format-directive-expander (char fn)
716    (setf (aref *format-directive-expanders* (char-code (char-upcase char))) fn)
717    char)
718
719  (defun %set-format-directive-interpreter (char fn)
720    (setf (aref *format-directive-interpreters*
721                (char-code (char-upcase char)))
722          fn)
723    char)
724
725  (defun find-directive (directives kind stop-at-semi)
726    (if directives
727        (let ((next (car directives)))
728          (if (format-directive-p next)
729              (let ((char (format-directive-character next)))
730                (if (or (char= kind char)
731                        (and stop-at-semi (char= char #\;)))
732                    (car directives)
733                    (find-directive
734                     (cdr (flet ((after (char)
735                                   (member (find-directive (cdr directives)
736                                                           char
737                                                           nil)
738                                           directives)))
739                            (case char
740                              (#\( (after #\)))
741                              (#\< (after #\>))
742                              (#\[ (after #\]))
743                              (#\{ (after #\}))
744                              (t directives))))
745                     kind stop-at-semi)))
746              (find-directive (cdr directives) kind stop-at-semi)))))
747
748  ) ; EVAL-WHEN
749
750;;;; format directives for simple output
751
752(def-format-directive #\A (colonp atsignp params)
753  (if params
754      (expand-bind-defaults ((mincol 0) (colinc 1) (minpad 0)
755           (padchar #\space))
756                            params
757                            `(format-princ stream ,(expand-next-arg) ',colonp ',atsignp
758                                           ,mincol ,colinc ,minpad ,padchar))
759      `(princ ,(if colonp
760       `(or ,(expand-next-arg) "()")
761       (expand-next-arg))
762        stream)))
763
764(def-format-directive #\S (colonp atsignp params)
765  (cond (params
766   (expand-bind-defaults ((mincol 0) (colinc 1) (minpad 0)
767        (padchar #\space))
768                               params
769                               `(format-prin1 stream ,(expand-next-arg) ,colonp ,atsignp
770                                              ,mincol ,colinc ,minpad ,padchar)))
771  (colonp
772   `(let ((arg ,(expand-next-arg)))
773      (if arg
774    (prin1 arg stream)
775    (princ "()" stream))))
776  (t
777   `(prin1 ,(expand-next-arg) stream))))
778
779(def-format-directive #\C (colonp atsignp params)
780  (expand-bind-defaults () params
781                        (if colonp
782                            `(format-print-named-character ,(expand-next-arg) stream)
783                            (if atsignp
784                                `(prin1 ,(expand-next-arg) stream)
785                                `(write-char ,(expand-next-arg) stream)))))
786
787(def-format-directive #\W (colonp atsignp params)
788  (expand-bind-defaults () params
789                        (if (or colonp atsignp)
790                            `(let (,@(when colonp
791                                       '((*print-pretty* t)))
792                                   ,@(when atsignp
793                                       '((*print-level* nil)
794                                         (*print-length* nil))))
795                               (sys::output-object ,(expand-next-arg) stream))
796                            `(sys::output-object ,(expand-next-arg) stream))))
797
798;;;; format directives for integer output
799
800(defun expand-format-integer (base colonp atsignp params)
801  (if (or colonp atsignp params)
802      (expand-bind-defaults
803       ((mincol 0) (padchar #\space) (commachar #\,) (commainterval 3))
804       params
805       `(format-print-integer stream ,(expand-next-arg) ,colonp ,atsignp
806                              ,base ,mincol ,padchar ,commachar
807                              ,commainterval))
808      `(write ,(expand-next-arg) :stream stream :base ,base :radix nil
809        :escape nil)))
810
811(def-format-directive #\D (colonp atsignp params)
812  (expand-format-integer 10 colonp atsignp params))
813
814(def-format-directive #\B (colonp atsignp params)
815  (expand-format-integer 2 colonp atsignp params))
816
817(def-format-directive #\O (colonp atsignp params)
818  (expand-format-integer 8 colonp atsignp params))
819
820(def-format-directive #\X (colonp atsignp params)
821  (expand-format-integer 16 colonp atsignp params))
822
823(def-format-directive #\R (colonp atsignp params)
824  (expand-bind-defaults
825   ((base nil) (mincol 0) (padchar #\space) (commachar #\,)
826    (commainterval 3))
827   params
828   (let ((n-arg (gensym)))
829     `(let ((,n-arg ,(expand-next-arg)))
830        (if ,base
831            (format-print-integer stream ,n-arg ,colonp ,atsignp
832                                  ,base ,mincol
833                                  ,padchar ,commachar ,commainterval)
834            ,(if atsignp
835                 (if colonp
836                     `(format-print-old-roman stream ,n-arg)
837                     `(format-print-roman stream ,n-arg))
838                 (if colonp
839                     `(format-print-ordinal stream ,n-arg)
840                     `(format-print-cardinal stream ,n-arg))))))))
841
842;;;; format directive for pluralization
843
844(def-format-directive #\P (colonp atsignp params end)
845  (expand-bind-defaults () params
846                        (let ((arg (cond
847                                    ((not colonp)
848                                     (expand-next-arg))
849                                    (*orig-args-available*
850                                     `(if (eq orig-args args)
851                                          (error 'format-error
852                                                 :complaint "no previous argument"
853                                                 :offset ,(1- end))
854                                          (do ((arg-ptr orig-args (cdr arg-ptr)))
855                                              ((eq (cdr arg-ptr) args)
856                                               (car arg-ptr)))))
857                                    (*only-simple-args*
858                                     (unless *simple-args*
859                                       (error 'format-error
860                                              :complaint "no previous argument"))
861                                     (caar *simple-args*))
862                                    (t
863                                     (throw 'need-orig-args nil)))))
864                          (if atsignp
865                              `(write-string (if (eql ,arg 1) "y" "ies") stream)
866                              `(unless (eql ,arg 1) (write-char #\s stream))))))
867
868;;;; format directives for floating point output
869
870(def-format-directive #\F (colonp atsignp params)
871  (when colonp
872    (error 'format-error
873     :complaint
874     "The colon modifier cannot be used with this directive."))
875  (expand-bind-defaults ((w nil) (d nil) (k nil) (ovf nil) (pad #\space)) params
876                        `(format-fixed stream ,(expand-next-arg) ,w ,d ,k ,ovf ,pad ,atsignp)))
877
878(def-format-directive #\E (colonp atsignp params)
879  (when colonp
880    (error 'format-error
881     :complaint
882     "The colon modifier cannot be used with this directive."))
883  (expand-bind-defaults
884   ((w nil) (d nil) (e nil) (k 1) (ovf nil) (pad #\space) (mark nil))
885   params
886   `(format-exponential stream ,(expand-next-arg) ,w ,d ,e ,k ,ovf ,pad ,mark
887                        ,atsignp)))
888
889(def-format-directive #\G (colonp atsignp params)
890  (when colonp
891    (error 'format-error
892     :complaint
893     "The colon modifier cannot be used with this directive."))
894  (expand-bind-defaults
895   ((w nil) (d nil) (e nil) (k nil) (ovf nil) (pad #\space) (mark nil))
896   params
897   `(format-general stream ,(expand-next-arg) ,w ,d ,e ,k ,ovf ,pad ,mark ,atsignp)))
898
899(def-format-directive #\$ (colonp atsignp params)
900  (expand-bind-defaults ((d 2) (n 1) (w 0) (pad #\space)) params
901                        `(format-dollars stream ,(expand-next-arg) ,d ,n ,w ,pad ,colonp
902                                         ,atsignp)))
903
904;;;; format directives for line/page breaks etc.
905
906(def-format-directive #\% (colonp atsignp params)
907  (when (or colonp atsignp)
908    (error 'format-error
909     :complaint
910     "The colon and atsign modifiers cannot be used with this directive."
911     ))
912  (if params
913      (expand-bind-defaults ((count 1)) params
914                            `(dotimes (i ,count)
915                               (terpri stream)))
916      '(terpri stream)))
917
918(def-format-directive #\& (colonp atsignp params)
919  (when (or colonp atsignp)
920    (error 'format-error
921     :complaint
922     "The colon and atsign modifiers cannot be used with this directive."
923     ))
924  (if params
925      (expand-bind-defaults ((count 1)) params
926                            `(progn
927                               (fresh-line stream)
928                               (dotimes (i (1- ,count))
929                                 (terpri stream))))
930      '(fresh-line stream)))
931
932(def-format-directive #\| (colonp atsignp params)
933  (when (or colonp atsignp)
934    (error 'format-error
935     :complaint
936     "The colon and atsign modifiers cannot be used with this directive."
937     ))
938  (if params
939      (expand-bind-defaults ((count 1)) params
940                            `(dotimes (i ,count)
941                               (write-char (code-char sys::form-feed-char-code) stream)))
942      '(write-char (code-char sys::form-feed-char-code) stream)))
943
944(def-format-directive #\~ (colonp atsignp params)
945  (when (or colonp atsignp)
946    (error 'format-error
947     :complaint
948     "The colon and atsign modifiers cannot be used with this directive."
949     ))
950  (if params
951      (expand-bind-defaults ((count 1)) params
952                            `(dotimes (i ,count)
953                               (write-char #\~ stream)))
954      '(write-char #\~ stream)))
955
956(def-complex-format-directive #\newline (colonp atsignp params directives)
957  (when (and colonp atsignp)
958    (error 'format-error
959     :complaint "both colon and atsign modifiers used simultaneously"))
960  (values (expand-bind-defaults () params
961                                (if atsignp
962                                    '(write-char #\newline stream)
963                                    nil))
964    (if (and (not colonp)
965       directives
966       (simple-string-p (car directives)))
967        (cons (string-left-trim *format-whitespace-chars*
968              (car directives))
969        (cdr directives))
970        directives)))
971
972;;;; format directives for tabs and simple pretty printing
973
974(def-format-directive #\T (colonp atsignp params)
975  (if colonp
976      (expand-bind-defaults ((n 1) (m 1)) params
977                            `(pprint-tab ,(if atsignp :section-relative :section)
978                                         ,n ,m stream))
979      (if atsignp
980    (expand-bind-defaults ((colrel 1) (colinc 1)) params
981                                `(format-relative-tab stream ,colrel ,colinc))
982    (expand-bind-defaults ((colnum 1) (colinc 1)) params
983                                `(format-absolute-tab stream ,colnum ,colinc)))))
984
985(def-format-directive #\_ (colonp atsignp params)
986  (expand-bind-defaults () params
987                        `(pprint-newline ,(if colonp
988                                              (if atsignp
989                                                  :mandatory
990                                                  :fill)
991                                              (if atsignp
992                                                  :miser
993                                                  :linear))
994                                         stream)))
995
996(def-format-directive #\I (colonp atsignp params)
997  (when atsignp
998    (error 'format-error
999     :complaint
1000     "cannot use the at-sign modifier with this directive"))
1001  (expand-bind-defaults ((n 0)) params
1002                        `(pprint-indent ,(if colonp :current :block) ,n stream)))
1003
1004;;;; format directive for ~*
1005
1006(def-format-directive #\* (colonp atsignp params end)
1007  (if atsignp
1008      (if colonp
1009    (error 'format-error
1010     :complaint
1011     "both colon and atsign modifiers used simultaneously")
1012    (expand-bind-defaults ((posn 0)) params
1013                                (unless *orig-args-available*
1014                                  (throw 'need-orig-args nil))
1015                                `(if (<= 0 ,posn (length orig-args))
1016                                     (setf args (nthcdr ,posn orig-args))
1017                                     (error 'format-error
1018                                            :complaint "Index ~W out of bounds. Should have been ~
1019                                            between 0 and ~W."
1020                                            :args (list ,posn (length orig-args))
1021                                            :offset ,(1- end)))))
1022      (if colonp
1023    (expand-bind-defaults ((n 1)) params
1024                                (unless *orig-args-available*
1025                                  (throw 'need-orig-args nil))
1026                                `(do ((cur-posn 0 (1+ cur-posn))
1027                                      (arg-ptr orig-args (cdr arg-ptr)))
1028                                     ((eq arg-ptr args)
1029                                      (let ((new-posn (- cur-posn ,n)))
1030                                        (if (<= 0 new-posn (length orig-args))
1031                                            (setf args (nthcdr new-posn orig-args))
1032                                            (error 'format-error
1033                                                   :complaint
1034                                                   "Index ~W is out of bounds; should have been ~
1035                                                    between 0 and ~W."
1036                                                   :args (list new-posn (length orig-args))
1037                                                   :offset ,(1- end)))))))
1038    (if params
1039        (expand-bind-defaults ((n 1)) params
1040                                    (setf *only-simple-args* nil)
1041                                    `(dotimes (i ,n)
1042                                       ,(expand-next-arg)))
1043        (expand-next-arg)))))
1044
1045;;;; format directive for indirection
1046
1047(def-format-directive #\? (colonp atsignp params string end)
1048  (when colonp
1049    (error 'format-error
1050     :complaint "cannot use the colon modifier with this directive"))
1051  (expand-bind-defaults () params
1052                        `(handler-bind
1053                           ((format-error
1054                             (lambda (condition)
1055                               (error 'format-error
1056                                      :complaint
1057                                      "~A~%while processing indirect format string:"
1058                                      :args (list condition)
1059                                      :print-banner nil
1060                                      :control-string ,string
1061                                      :offset ,(1- end)))))
1062                           ,(if atsignp
1063                                (if *orig-args-available*
1064                                    `(setf args (%format stream ,(expand-next-arg) orig-args args))
1065                                    (throw 'need-orig-args nil))
1066                                `(%format stream ,(expand-next-arg) ,(expand-next-arg))))))
1067
1068;;;; format directives for capitalization
1069
1070(def-complex-format-directive #\( (colonp atsignp params directives)
1071  (let ((close (find-directive directives #\) nil)))
1072    (unless close
1073      (error 'format-error
1074       :complaint "no corresponding close parenthesis"))
1075    (let* ((posn (position close directives))
1076     (before (subseq directives 0 posn))
1077     (after (nthcdr (1+ posn) directives)))
1078      (values
1079       (expand-bind-defaults () params
1080                             `(let ((stream (sys::make-case-frob-stream stream
1081                                                                        ,(if colonp
1082                                                                             (if atsignp
1083                                                                                 :upcase
1084                                                                                 :capitalize)
1085                                                                             (if atsignp
1086                                                                                 :capitalize-first
1087                                                                                 :downcase)))))
1088                                ,@(expand-directive-list before)))
1089       after))))
1090
1091(def-complex-format-directive #\) ()
1092  (error 'format-error
1093   :complaint "no corresponding open parenthesis"))
1094
1095;;;; format directives and support functions for conditionalization
1096
1097(def-complex-format-directive #\[ (colonp atsignp params directives)
1098  (multiple-value-bind (sublists last-semi-with-colon-p remaining)
1099      (parse-conditional-directive directives)
1100    (values
1101     (if atsignp
1102   (if colonp
1103       (error 'format-error
1104        :complaint
1105        "both colon and atsign modifiers used simultaneously")
1106       (if (cdr sublists)
1107     (error 'format-error
1108      :complaint
1109      "Can only specify one section")
1110     (expand-bind-defaults () params
1111                   (expand-maybe-conditional (car sublists)))))
1112   (if colonp
1113       (if (= (length sublists) 2)
1114     (expand-bind-defaults () params
1115                   (expand-true-false-conditional (car sublists)
1116                                                  (cadr sublists)))
1117     (error 'format-error
1118      :complaint
1119      "must specify exactly two sections"))
1120       (expand-bind-defaults ((index nil)) params
1121               (setf *only-simple-args* nil)
1122               (let ((clauses nil)
1123                     (case `(or ,index ,(expand-next-arg))))
1124                 (when last-semi-with-colon-p
1125                   (push `(t ,@(expand-directive-list (pop sublists)))
1126                         clauses))
1127                 (let ((count (length sublists)))
1128                   (dolist (sublist sublists)
1129                     (push `(,(decf count)
1130                             ,@(expand-directive-list sublist))
1131                           clauses)))
1132                 `(case ,case ,@clauses)))))
1133     remaining)))
1134
1135(defun parse-conditional-directive (directives)
1136  (let ((sublists nil)
1137  (last-semi-with-colon-p nil)
1138  (remaining directives))
1139    (loop
1140      (let ((close-or-semi (find-directive remaining #\] t)))
1141  (unless close-or-semi
1142    (error 'format-error
1143     :complaint "no corresponding close bracket"))
1144  (let ((posn (position close-or-semi remaining)))
1145    (push (subseq remaining 0 posn) sublists)
1146    (setf remaining (nthcdr (1+ posn) remaining))
1147    (when (char= (format-directive-character close-or-semi) #\])
1148      (return))
1149    (setf last-semi-with-colon-p
1150    (format-directive-colonp close-or-semi)))))
1151    (values sublists last-semi-with-colon-p remaining)))
1152
1153(defun expand-maybe-conditional (sublist)
1154  (flet ((hairy ()
1155           `(let ((prev-args args)
1156                  (arg ,(expand-next-arg)))
1157              (when arg
1158                (setf args prev-args)
1159                ,@(expand-directive-list sublist)))))
1160    (if *only-simple-args*
1161  (multiple-value-bind (guts new-args)
1162            (let ((*simple-args* *simple-args*))
1163              (values (expand-directive-list sublist)
1164                      *simple-args*))
1165    (cond ((and new-args (eq *simple-args* (cdr new-args)))
1166     (setf *simple-args* new-args)
1167     `(when ,(caar new-args)
1168        ,@guts))
1169    (t
1170     (setf *only-simple-args* nil)
1171     (hairy))))
1172  (hairy))))
1173
1174(defun expand-true-false-conditional (true false)
1175  (let ((arg (expand-next-arg)))
1176    (flet ((hairy ()
1177             `(if ,arg
1178                  (progn
1179                    ,@(expand-directive-list true))
1180                  (progn
1181                    ,@(expand-directive-list false)))))
1182      (if *only-simple-args*
1183    (multiple-value-bind (true-guts true-args true-simple)
1184            (let ((*simple-args* *simple-args*)
1185                  (*only-simple-args* t))
1186              (values (expand-directive-list true)
1187                      *simple-args*
1188                      *only-simple-args*))
1189      (multiple-value-bind (false-guts false-args false-simple)
1190              (let ((*simple-args* *simple-args*)
1191                    (*only-simple-args* t))
1192                (values (expand-directive-list false)
1193                        *simple-args*
1194                        *only-simple-args*))
1195        (if (= (length true-args) (length false-args))
1196      `(if ,arg
1197           (progn
1198       ,@true-guts)
1199           ,(do ((false false-args (cdr false))
1200           (true true-args (cdr true))
1201           (bindings nil (cons `(,(caar false) ,(caar true))
1202             bindings)))
1203          ((eq true *simple-args*)
1204           (setf *simple-args* true-args)
1205           (setf *only-simple-args*
1206           (and true-simple false-simple))
1207           (if bindings
1208         `(let ,bindings
1209            ,@false-guts)
1210         `(progn
1211            ,@false-guts)))))
1212      (progn
1213        (setf *only-simple-args* nil)
1214        (hairy)))))
1215    (hairy)))))
1216
1217(def-complex-format-directive #\; ()
1218  (error 'format-error
1219   :complaint
1220   "~~; directive not contained within either ~~[...~~] or ~~<...~~>"))
1221
1222(def-complex-format-directive #\] ()
1223  (error 'format-error
1224   :complaint
1225   "no corresponding open bracket"))
1226
1227;;;; format directive for up-and-out
1228
1229(def-format-directive #\^ (colonp atsignp params)
1230  (when atsignp
1231    (error 'format-error
1232     :complaint "cannot use the at-sign modifier with this directive"))
1233  (when (and colonp (not *up-up-and-out-allowed*))
1234    (error 'format-error
1235     :complaint "attempt to use ~~:^ outside a ~~:{...~~} construct"))
1236  `(when ,(expand-bind-defaults ((arg1 nil) (arg2 nil) (arg3 nil)) params
1237                                `(cond (,arg3 (<= ,arg1 ,arg2 ,arg3))
1238                                       (,arg2 (eql ,arg1 ,arg2))
1239                                       (,arg1 (eql ,arg1 0))
1240                                       (t ,(if colonp
1241                                               '(null outside-args)
1242                                               (progn
1243                                                 (setf *only-simple-args* nil)
1244                                                 '(null args))))))
1245     ,(if colonp
1246    '(return-from outside-loop nil)
1247    '(return))))
1248
1249;;;; format directives for iteration
1250
1251(def-complex-format-directive #\{ (colonp atsignp params string end directives)
1252  (let ((close (find-directive directives #\} nil)))
1253    (unless close
1254      (error 'format-error
1255       :complaint "no corresponding close brace"))
1256    (let* ((closed-with-colon (format-directive-colonp close))
1257     (posn (position close directives)))
1258      (labels
1259        ((compute-insides ()
1260           (if (zerop posn)
1261               (if *orig-args-available*
1262                   `((handler-bind
1263                       ((format-error
1264                         (lambda (condition)
1265                           (error 'format-error
1266                                  :complaint
1267                                  "~A~%while processing indirect format string:"
1268                                  :args (list condition)
1269                                  :print-banner nil
1270                                  :control-string ,string
1271                                  :offset ,(1- end)))))
1272                       (setf args
1273                             (%format stream inside-string orig-args args))))
1274                   (throw 'need-orig-args nil))
1275               (let ((*up-up-and-out-allowed* colonp))
1276                 (expand-directive-list (subseq directives 0 posn)))))
1277         (compute-loop (count)
1278           (when atsignp
1279             (setf *only-simple-args* nil))
1280           `(loop
1281              ,@(unless closed-with-colon
1282                  '((when (null args)
1283                      (return))))
1284              ,@(when count
1285                  `((when (and ,count (minusp (decf ,count)))
1286                      (return))))
1287              ,@(if colonp
1288                    (let ((*expander-next-arg-macro* 'expander-next-arg)
1289                          (*only-simple-args* nil)
1290                          (*orig-args-available* t))
1291                      `((let* ((orig-args ,(expand-next-arg))
1292                               (outside-args args)
1293                               (args orig-args))
1294                          (declare (ignorable orig-args outside-args args))
1295                          (block nil
1296                            ,@(compute-insides)))))
1297                    (compute-insides))
1298              ,@(when closed-with-colon
1299                  '((when (null args)
1300                      (return))))))
1301         (compute-block (count)
1302           (if colonp
1303               `(block outside-loop
1304                  ,(compute-loop count))
1305               (compute-loop count)))
1306         (compute-bindings (count)
1307            (if atsignp
1308                (compute-block count)
1309                `(let* ((orig-args ,(expand-next-arg))
1310                        (args orig-args))
1311                   (declare (ignorable orig-args args))
1312                   ,(let ((*expander-next-arg-macro* 'expander-next-arg)
1313                          (*only-simple-args* nil)
1314                          (*orig-args-available* t))
1315                      (compute-block count))))))
1316  (values (if params
1317                    (expand-bind-defaults ((count nil)) params
1318                                          (if (zerop posn)
1319                                              `(let ((inside-string ,(expand-next-arg)))
1320                                                 ,(compute-bindings count))
1321                                              (compute-bindings count)))
1322                    (if (zerop posn)
1323                        `(let ((inside-string ,(expand-next-arg)))
1324                           ,(compute-bindings nil))
1325                        (compute-bindings nil)))
1326    (nthcdr (1+ posn) directives))))))
1327
1328(def-complex-format-directive #\} ()
1329  (error 'format-error
1330   :complaint "no corresponding open brace"))
1331
1332;;;; format directives and support functions for justification
1333
1334(defparameter *illegal-inside-justification*
1335  (mapcar (lambda (x) (parse-directive x 0))
1336    '("~W" "~:W" "~@W" "~:@W"
1337      "~_" "~:_" "~@_" "~:@_"
1338      "~:>" "~:@>"
1339      "~I" "~:I" "~@I" "~:@I"
1340      "~:T" "~:@T")))
1341
1342(defun illegal-inside-justification-p (directive)
1343  (member directive *illegal-inside-justification*
1344    :test (lambda (x y)
1345      (and (format-directive-p x)
1346           (format-directive-p y)
1347           (eql (format-directive-character x) (format-directive-character y))
1348           (eql (format-directive-colonp x) (format-directive-colonp y))
1349           (eql (format-directive-atsignp x) (format-directive-atsignp y))))))
1350
1351(def-complex-format-directive #\< (colonp atsignp params string end directives)
1352  (multiple-value-bind (segments first-semi close remaining)
1353    (parse-format-justification directives)
1354    (values
1355     (if (format-directive-colonp close)
1356   (multiple-value-bind (prefix per-line-p insides suffix)
1357           (parse-format-logical-block segments colonp first-semi
1358                                       close params string end)
1359     (expand-format-logical-block prefix per-line-p insides
1360          suffix atsignp))
1361   (let ((count (reduce #'+ (mapcar (lambda (x) (count-if #'illegal-inside-justification-p x)) segments))))
1362     (when (> count 0)
1363       ;; ANSI specifies that "an error is signalled" in this
1364       ;; situation.
1365       (error 'format-error
1366        :complaint "~D illegal directive~:P found inside justification block"
1367        :args (list count)))
1368     (expand-format-justification segments colonp atsignp
1369                                        first-semi params)))
1370     remaining)))
1371
1372(def-complex-format-directive #\> ()
1373  (error 'format-error
1374   :complaint "no corresponding open bracket"))
1375
1376(defun parse-format-logical-block
1377  (segments colonp first-semi close params string end)
1378  (when params
1379    (error 'format-error
1380     :complaint "No parameters can be supplied with ~~<...~~:>."
1381     :offset (caar params)))
1382  (multiple-value-bind (prefix insides suffix)
1383    (multiple-value-bind (prefix-default suffix-default)
1384      (if colonp (values "(" ")") (values "" ""))
1385      (flet ((extract-string (list prefix-p)
1386                             (let ((directive (find-if #'format-directive-p list)))
1387                               (if directive
1388                                   (error 'format-error
1389                                          :complaint
1390                                          "cannot include format directives inside the ~
1391                                           ~:[suffix~;prefix~] segment of ~~<...~~:>"
1392                                          :args (list prefix-p)
1393                                          :offset (1- (format-directive-end directive)))
1394                                   (apply #'concatenate 'string list)))))
1395  (case (length segments)
1396    (0 (values prefix-default nil suffix-default))
1397    (1 (values prefix-default (car segments) suffix-default))
1398    (2 (values (extract-string (car segments) t)
1399         (cadr segments) suffix-default))
1400    (3 (values (extract-string (car segments) t)
1401         (cadr segments)
1402         (extract-string (caddr segments) nil)))
1403    (t
1404     (error 'format-error
1405      :complaint "too many segments for ~~<...~~:>")))))
1406    (when (format-directive-atsignp close)
1407      (setf insides
1408      (add-fill-style-newlines insides
1409             string
1410             (if first-semi
1411           (format-directive-end first-semi)
1412           end))))
1413    (values prefix
1414      (and first-semi (format-directive-atsignp first-semi))
1415      insides
1416      suffix)))
1417
1418(defun add-fill-style-newlines (list string offset &optional last-directive)
1419  (cond
1420   (list
1421    (let ((directive (car list)))
1422      (cond
1423       ((simple-string-p directive)
1424        (let* ((non-space (position #\Space directive :test #'char/=))
1425               (newlinep (and last-directive
1426                              (char=
1427                               (format-directive-character last-directive)
1428                               #\Newline))))
1429          (cond
1430           ((and newlinep non-space)
1431            (nconc
1432             (list (subseq directive 0 non-space))
1433             (add-fill-style-newlines-aux
1434              (subseq directive non-space) string (+ offset non-space))
1435             (add-fill-style-newlines
1436              (cdr list) string (+ offset (length directive)))))
1437           (newlinep
1438            (cons directive
1439                  (add-fill-style-newlines
1440                   (cdr list) string (+ offset (length directive)))))
1441           (t
1442            (nconc (add-fill-style-newlines-aux directive string offset)
1443                   (add-fill-style-newlines
1444                    (cdr list) string (+ offset (length directive))))))))
1445       (t
1446        (cons directive
1447              (add-fill-style-newlines
1448               (cdr list) string
1449               (format-directive-end directive) directive))))))
1450   (t nil)))
1451
1452(defun add-fill-style-newlines-aux (literal string offset)
1453  (let ((end (length literal))
1454  (posn 0))
1455    (collect ((results))
1456             (loop
1457               (let ((blank (position #\space literal :start posn)))
1458                 (when (null blank)
1459                   (results (subseq literal posn))
1460                   (return))
1461                 (let ((non-blank (or (position #\space literal :start blank
1462                                                :test #'char/=)
1463                                      end)))
1464                   (results (subseq literal posn non-blank))
1465                   (results (make-format-directive
1466                             :string string :character #\_
1467                             :start (+ offset non-blank) :end (+ offset non-blank)
1468                             :colonp t :atsignp nil :params nil))
1469                   (setf posn non-blank))
1470                 (when (= posn end)
1471                   (return))))
1472             (results))))
1473
1474(defun parse-format-justification (directives)
1475  (let ((first-semi nil)
1476  (close nil)
1477  (remaining directives))
1478    (collect ((segments))
1479             (loop
1480               (let ((close-or-semi (find-directive remaining #\> t)))
1481                 (unless close-or-semi
1482                   (error 'format-error
1483                          :complaint "no corresponding close bracket"))
1484                 (let ((posn (position close-or-semi remaining)))
1485                   (segments (subseq remaining 0 posn))
1486                   (setf remaining (nthcdr (1+ posn) remaining)))
1487                 (when (char= (format-directive-character close-or-semi)
1488                              #\>)
1489                   (setf close close-or-semi)
1490                   (return))
1491                 (unless first-semi
1492                   (setf first-semi close-or-semi))))
1493             (values (segments) first-semi close remaining))))
1494
1495(defmacro expander-pprint-next-arg (string offset)
1496  `(progn
1497     (when (null args)
1498       (error 'format-error
1499        :complaint "no more arguments"
1500        :control-string ,string
1501        :offset ,offset))
1502     (pprint-pop)
1503     (pop args)))
1504
1505(defun expand-format-logical-block (prefix per-line-p insides suffix atsignp)
1506  `(let ((arg ,(if atsignp 'args (expand-next-arg))))
1507     ,@(when atsignp
1508   (setf *only-simple-args* nil)
1509   '((setf args nil)))
1510     (pprint-logical-block
1511      (stream arg
1512              ,(if per-line-p :per-line-prefix :prefix) ,prefix
1513              :suffix ,suffix)
1514      (let ((args arg)
1515            ,@(unless atsignp
1516                `((orig-args arg))))
1517        (declare (ignorable args ,@(unless atsignp '(orig-args))))
1518        (block nil
1519          ,@(let ((*expander-next-arg-macro* 'expander-pprint-next-arg)
1520                  (*only-simple-args* nil)
1521                  (*orig-args-available*
1522                   (if atsignp *orig-args-available* t)))
1523              (expand-directive-list insides)))))))
1524
1525(defun expand-format-justification (segments colonp atsignp first-semi params)
1526  (let ((newline-segment-p
1527   (and first-semi
1528        (format-directive-colonp first-semi))))
1529    (expand-bind-defaults
1530     ((mincol 0) (colinc 1) (minpad 0) (padchar #\space))
1531     params
1532     `(let ((segments nil)
1533            ,@(when newline-segment-p
1534                '((newline-segment nil)
1535                  (extra-space 0)
1536                  (line-len 72))))
1537        (block nil
1538          ,@(when newline-segment-p
1539              `((setf newline-segment
1540                      (with-output-to-string (stream)
1541                        ,@(expand-directive-list (pop segments))))
1542                ,(expand-bind-defaults
1543                  ((extra 0)
1544                   (line-len '(or #-abcl(sb!impl::line-length stream) 72)))
1545                  (format-directive-params first-semi)
1546                  `(setf extra-space ,extra line-len ,line-len))))
1547          ,@(mapcar (lambda (segment)
1548                      `(push (with-output-to-string (stream)
1549                               ,@(expand-directive-list segment))
1550                             segments))
1551                    segments))
1552        (format-justification stream
1553                              ,@(if newline-segment-p
1554                                    '(newline-segment extra-space line-len)
1555                                    '(nil 0 0))
1556                              segments ,colonp ,atsignp
1557                              ,mincol ,colinc ,minpad ,padchar)))))
1558
1559;;;; format directive and support function for user-defined method
1560
1561(def-format-directive #\/ (string start end colonp atsignp params)
1562  (let ((symbol (extract-user-fun-name string start end)))
1563    (collect ((param-names) (bindings))
1564             (dolist (param-and-offset params)
1565               (let ((param (cdr param-and-offset)))
1566                 (let ((param-name (gensym)))
1567                   (param-names param-name)
1568                   (bindings `(,param-name
1569                               ,(case param
1570                                  (:arg (expand-next-arg))
1571                                  (:remaining '(length args))
1572                                  (t param)))))))
1573             `(let ,(bindings)
1574                (,symbol stream ,(expand-next-arg) ,colonp ,atsignp
1575                 ,@(param-names))))))
1576
1577(defun extract-user-fun-name (string start end)
1578  (let ((slash (position #\/ string :start start :end (1- end)
1579       :from-end t)))
1580    (unless slash
1581      (error 'format-error
1582       :complaint "malformed ~~/ directive"))
1583    (let* ((name (string-upcase (let ((foo string))
1584          ;; Hack alert: This is to keep the compiler
1585          ;; quiet about deleting code inside the
1586          ;; subseq expansion.
1587          (subseq foo (1+ slash) (1- end)))))
1588     (first-colon (position #\: name))
1589     (second-colon (if first-colon (position #\: name :start (1+ first-colon))))
1590     (package-name (if first-colon
1591           (subseq name 0 first-colon)
1592           "COMMON-LISP-USER"))
1593     (package (find-package package-name)))
1594      (unless package
1595  ;; FIXME: should be PACKAGE-ERROR? Could we just use
1596  ;; FIND-UNDELETED-PACKAGE-OR-LOSE?
1597  (error 'format-error
1598         :complaint "no package named ~S"
1599         :args (list package-name)))
1600      (intern (cond
1601               ((and second-colon (= second-colon (1+ first-colon)))
1602                (subseq name (1+ second-colon)))
1603               (first-colon
1604                (subseq name (1+ first-colon)))
1605               (t name))
1606        package))))
1607
1608;;; compile-time checking for argument mismatch.  This code is
1609;;; inspired by that of Gerd Moellmann, and comes decorated with
1610;;; FIXMEs:
1611(defun %compiler-walk-format-string (string args)
1612  (declare (type simple-string string))
1613  (let ((*default-format-error-control-string* string))
1614    (macrolet ((incf-both (&optional (increment 1))
1615                          `(progn
1616                             (incf min ,increment)
1617                             (incf max ,increment)))
1618         (walk-complex-directive (function)
1619                                       `(multiple-value-bind (min-inc max-inc remaining)
1620                                          (,function directive directives args)
1621                                          (incf min min-inc)
1622                                          (incf max max-inc)
1623                                          (setq directives remaining))))
1624      ;; FIXME: these functions take a list of arguments as well as
1625      ;; the directive stream.  This is to enable possibly some
1626      ;; limited type checking on FORMAT's arguments, as well as
1627      ;; simple argument count mismatch checking: when the minimum and
1628      ;; maximum argument counts are the same at a given point, we
1629      ;; know which argument is going to be used for a given
1630      ;; directive, and some (annotated below) require arguments of
1631      ;; particular types.
1632      (labels
1633        ((walk-justification (justification directives args)
1634                             (declare (ignore args))
1635                             (let ((*default-format-error-offset*
1636                                    (1- (format-directive-end justification))))
1637                               (multiple-value-bind (segments first-semi close remaining)
1638                                 (parse-format-justification directives)
1639                                 (declare (ignore segments first-semi))
1640                                 (cond
1641                                  ((not (format-directive-colonp close))
1642                                   (values 0 0 directives))
1643                                  ((format-directive-atsignp justification)
1644                                   (values 0 call-arguments-limit directives))
1645                                  ;; FIXME: here we could assert that the
1646                                  ;; corresponding argument was a list.
1647                                  (t (values 1 1 remaining))))))
1648         (walk-conditional (conditional directives args)
1649                           (let ((*default-format-error-offset*
1650                                  (1- (format-directive-end conditional))))
1651                             (multiple-value-bind (sublists last-semi-with-colon-p remaining)
1652                               (parse-conditional-directive directives)
1653                               (declare (ignore last-semi-with-colon-p))
1654                               (let ((sub-max
1655                                      (loop for s in sublists
1656                                        maximize (nth-value
1657                                                  1 (walk-directive-list s args)))))
1658                                 (cond
1659                                  ((format-directive-atsignp conditional)
1660                                   (values 1 (max 1 sub-max) remaining))
1661                                  ((loop for p in (format-directive-params conditional)
1662                                     thereis (or (integerp (cdr p))
1663                                                 (memq (cdr p) '(:remaining :arg))))
1664                                   (values 0 sub-max remaining))
1665                                  ;; FIXME: if not COLONP, then the next argument
1666                                  ;; must be a number.
1667                                  (t (values 1 (1+ sub-max) remaining)))))))
1668         (walk-iteration (iteration directives args)
1669                         (declare (ignore args))
1670                         (let ((*default-format-error-offset*
1671                                (1- (format-directive-end iteration))))
1672                           (let* ((close (find-directive directives #\} nil))
1673                                  (posn (or (position close directives)
1674                                            (error 'format-error
1675                                                   :complaint "no corresponding close brace")))
1676                                  (remaining (nthcdr (1+ posn) directives)))
1677                             ;; FIXME: if POSN is zero, the next argument must be
1678                             ;; a format control (either a function or a string).
1679                             (if (format-directive-atsignp iteration)
1680                                 (values (if (zerop posn) 1 0)
1681                                         call-arguments-limit
1682                                         remaining)
1683                                 ;; FIXME: the argument corresponding to this
1684                                 ;; directive must be a list.
1685                                 (let ((nreq (if (zerop posn) 2 1)))
1686                                   (values nreq nreq remaining))))))
1687         (walk-directive-list (directives args)
1688                              (let ((min 0) (max 0))
1689                                (loop
1690                                  (let ((directive (pop directives)))
1691                                    (when (null directive)
1692                                      (return (values min (min max call-arguments-limit))))
1693                                    (when (format-directive-p directive)
1694                                      (incf-both (count :arg (format-directive-params directive)
1695                                                        :key #'cdr))
1696                                      (let ((c (format-directive-character directive)))
1697                                        (cond
1698                                         ((find c "ABCDEFGORSWX$/")
1699                                          (incf-both))
1700                                         ((char= c #\P)
1701                                          (unless (format-directive-colonp directive)
1702                                            (incf-both)))
1703                                         ((or (find c "IT%&|_();>") (char= c #\Newline)))
1704                                         ;; FIXME: check correspondence of ~( and ~)
1705                                         ((char= c #\<)
1706                                          (walk-complex-directive walk-justification))
1707                                         ((char= c #\[)
1708                                          (walk-complex-directive walk-conditional))
1709                                         ((char= c #\{)
1710                                          (walk-complex-directive walk-iteration))
1711                                         ((char= c #\?)
1712                                          ;; FIXME: the argument corresponding to this
1713                                          ;; directive must be a format control.
1714                                          (cond
1715                                           ((format-directive-atsignp directive)
1716                                            (incf min)
1717                                            (setq max call-arguments-limit))
1718                                           (t (incf-both 2))))
1719                                         (t (throw 'give-up-format-string-walk nil))))))))))
1720  (catch 'give-up-format-string-walk
1721    (let ((directives (tokenize-control-string string)))
1722      (walk-directive-list directives args)))))))
1723
1724;;; From target-format.lisp.
1725
1726(in-package #:format)
1727
1728(defun format (destination control-string &rest format-arguments)
1729  (etypecase destination
1730    (null
1731     (with-output-to-string (stream)
1732       (%format stream control-string format-arguments)))
1733    (string
1734     (with-output-to-string (stream destination)
1735       (%format stream control-string format-arguments)))
1736    ((member t)
1737     (%format *standard-output* control-string format-arguments)
1738     nil)
1739    ((or stream xp::xp-structure)
1740     (%format destination control-string format-arguments)
1741     nil)))
1742
1743(defun %format (stream string-or-fun orig-args &optional (args orig-args))
1744  (if (functionp string-or-fun)
1745      (apply string-or-fun stream args)
1746      (catch 'up-and-out
1747  (let* ((string (etypecase string-or-fun
1748       (simple-string
1749        string-or-fun)
1750       (string
1751        (coerce string-or-fun 'simple-string))))
1752         (*default-format-error-control-string* string)
1753         (*logical-block-popper* nil))
1754    (interpret-directive-list stream (tokenize-control-string string)
1755            orig-args args)))))
1756
1757(defun interpret-directive-list (stream directives orig-args args)
1758  (if directives
1759      (let ((directive (car directives)))
1760  (etypecase directive
1761    (simple-string
1762     (write-string directive stream)
1763     (interpret-directive-list stream (cdr directives) orig-args args))
1764    (format-directive
1765     (multiple-value-bind (new-directives new-args)
1766             (let* ((character (format-directive-character directive))
1767                    (function
1768                     (svref *format-directive-interpreters*
1769                            (char-code character)))
1770                    (*default-format-error-offset*
1771                     (1- (format-directive-end directive))))
1772               (unless function
1773                 (error 'format-error
1774                        :complaint "unknown format directive ~@[(character: ~A)~]"
1775                        :args (list (char-name character))))
1776               (multiple-value-bind (new-directives new-args)
1777                 (funcall function stream directive
1778                          (cdr directives) orig-args args)
1779                 (values new-directives new-args)))
1780       (interpret-directive-list stream new-directives
1781               orig-args new-args)))))
1782      args))
1783
1784;;;; FORMAT directive definition macros and runtime support
1785
1786(eval-when (:compile-toplevel :execute)
1787
1788  ;;; This macro is used to extract the next argument from the current arg list.
1789  ;;; This is the version used by format directive interpreters.
1790  (defmacro next-arg (&optional offset)
1791    `(progn
1792       (when (null args)
1793         (error 'format-error
1794                :complaint "no more arguments"
1795                ,@(when offset
1796                    `(:offset ,offset))))
1797       (when *logical-block-popper*
1798         (funcall *logical-block-popper*))
1799       (pop args)))
1800
1801  (defmacro def-complex-format-interpreter (char lambda-list &body body)
1802    (let ((defun-name
1803            (intern (concatenate 'string
1804                                 (let ((name (char-name char)))
1805                                   (cond (name
1806                                          (string-capitalize name))
1807                                         (t
1808                                          (string char))))
1809                                 "-FORMAT-DIRECTIVE-INTERPRETER")))
1810          (directive (gensym))
1811          (directives (if lambda-list (car (last lambda-list)) (gensym))))
1812      `(progn
1813         (defun ,defun-name (stream ,directive ,directives orig-args args)
1814           (declare (ignorable stream orig-args args))
1815           ,@(if lambda-list
1816                 `((let ,(mapcar (lambda (var)
1817                                   `(,var
1818                                     (,(sys::symbolicate "FORMAT-DIRECTIVE-" var)
1819                                      ,directive)))
1820                                 (butlast lambda-list))
1821                     (values (progn ,@body) args)))
1822                 `((declare (ignore ,directive ,directives))
1823                   ,@body)))
1824         (%set-format-directive-interpreter ,char #',defun-name))))
1825
1826  (defmacro def-format-interpreter (char lambda-list &body body)
1827    (let ((directives (gensym)))
1828      `(def-complex-format-interpreter ,char (,@lambda-list ,directives)
1829         ,@body
1830         ,directives)))
1831
1832  (defmacro interpret-bind-defaults (specs params &body body)
1833    (sys::once-only ((params params))
1834                    (collect ((bindings))
1835                             (dolist (spec specs)
1836                               (destructuring-bind (var default) spec
1837                                                   (bindings `(,var (let* ((param-and-offset (pop ,params))
1838                                                                           (offset (car param-and-offset))
1839                                                                           (param (cdr param-and-offset)))
1840                                                                      (case param
1841                                                                        (:arg (or (next-arg offset) ,default))
1842                                                                        (:remaining (length args))
1843                                                                        ((nil) ,default)
1844                                                                        (t param)))))))
1845                             `(let* ,(bindings)
1846                                (when ,params
1847                                  (error 'format-error
1848                                         :complaint
1849                                         "too many parameters, expected no more than ~W"
1850                                         :args (list ,(length specs))
1851                                         :offset (caar ,params)))
1852                                ,@body))))
1853
1854  ) ; EVAL-WHEN
1855
1856;;;; format interpreters and support functions for simple output
1857
1858(defun format-write-field (stream string mincol colinc minpad padchar padleft)
1859  (unless padleft
1860    (write-string string stream))
1861  (dotimes (i minpad)
1862    (write-char padchar stream))
1863  ;; As of sbcl-0.6.12.34, we could end up here when someone tries to
1864  ;; print e.g. (FORMAT T "~F" "NOTFLOAT"), in which case ANSI says
1865  ;; we're supposed to soldier on bravely, and so we have to deal with
1866  ;; the unsupplied-MINCOL-and-COLINC case without blowing up.
1867  (when (and mincol colinc)
1868    (do ((chars (+ (length string) (max minpad 0)) (+ chars colinc)))
1869  ((>= chars mincol))
1870      (dotimes (i colinc)
1871  (write-char padchar stream))))
1872  (when padleft
1873    (write-string string stream)))
1874
1875(defun format-princ (stream arg colonp atsignp mincol colinc minpad padchar)
1876  (format-write-field stream
1877          (if (or arg (not colonp))
1878        (princ-to-string arg)
1879        "()")
1880          mincol colinc minpad padchar atsignp))
1881
1882(def-format-interpreter #\A (colonp atsignp params)
1883  (if params
1884      (interpret-bind-defaults ((mincol 0) (colinc 1) (minpad 0)
1885        (padchar #\space))
1886                               params
1887                               (format-princ stream (next-arg) colonp atsignp
1888                                             mincol colinc minpad padchar))
1889      (princ (if colonp (or (next-arg) "()") (next-arg)) stream)))
1890
1891(defun format-prin1 (stream arg colonp atsignp mincol colinc minpad padchar)
1892  (format-write-field stream
1893          (if (or arg (not colonp))
1894        (prin1-to-string arg)
1895        "()")
1896          mincol colinc minpad padchar atsignp))
1897
1898(def-format-interpreter #\S (colonp atsignp params)
1899  (cond (params
1900   (interpret-bind-defaults ((mincol 0) (colinc 1) (minpad 0)
1901           (padchar #\space))
1902                                  params
1903                                  (format-prin1 stream (next-arg) colonp atsignp
1904                                                mincol colinc minpad padchar)))
1905  (colonp
1906   (let ((arg (next-arg)))
1907     (if arg
1908         (prin1 arg stream)
1909         (princ "()" stream))))
1910  (t
1911   (prin1 (next-arg) stream))))
1912
1913(def-format-interpreter #\C (colonp atsignp params)
1914  (interpret-bind-defaults () params
1915                           (if colonp
1916                               (format-print-named-character (next-arg) stream)
1917                               (if atsignp
1918                                   (prin1 (next-arg) stream)
1919                                   (write-char (next-arg) stream)))))
1920
1921(defun format-print-named-character (char stream)
1922  (let* ((name (char-name char)))
1923    (cond (name
1924     (write-string (string-capitalize name) stream))
1925    (t
1926     (write-char char stream)))))
1927
1928(def-format-interpreter #\W (colonp atsignp params)
1929  (interpret-bind-defaults () params
1930                           (let ((*print-pretty* (or colonp *print-pretty*))
1931                                 (*print-level* (unless atsignp *print-level*))
1932                                 (*print-length* (unless atsignp *print-length*)))
1933                             (sys::output-object (next-arg) stream))))
1934
1935;;;; format interpreters and support functions for integer output
1936
1937;;; FORMAT-PRINT-NUMBER does most of the work for the numeric printing
1938;;; directives. The parameters are interpreted as defined for ~D.
1939(defun format-print-integer (stream number print-commas-p print-sign-p
1940                                    radix mincol padchar commachar commainterval)
1941  (let ((*print-base* radix)
1942  (*print-radix* nil))
1943    (if (integerp number)
1944  (let* ((text (princ-to-string (abs number)))
1945         (commaed (if print-commas-p
1946          (format-add-commas text commachar commainterval)
1947          text))
1948         (signed (cond ((minusp number)
1949            (concatenate 'string "-" commaed))
1950           (print-sign-p
1951            (concatenate 'string "+" commaed))
1952           (t commaed))))
1953    ;; colinc = 1, minpad = 0, padleft = t
1954    (format-write-field stream signed mincol 1 0 padchar t))
1955  (princ number stream))))
1956
1957(defun format-add-commas (string commachar commainterval)
1958  (let ((length (length string)))
1959    (multiple-value-bind (commas extra) (truncate (1- length) commainterval)
1960      (let ((new-string (make-string (+ length commas)))
1961      (first-comma (1+ extra)))
1962  (replace new-string string :end1 first-comma :end2 first-comma)
1963  (do ((src first-comma (+ src commainterval))
1964       (dst first-comma (+ dst commainterval 1)))
1965      ((= src length))
1966    (setf (schar new-string dst) commachar)
1967    (replace new-string string :start1 (1+ dst)
1968       :start2 src :end2 (+ src commainterval)))
1969  new-string))))
1970
1971;;; FIXME: This is only needed in this file, could be defined with
1972;;; SB!XC:DEFMACRO inside EVAL-WHEN
1973(defmacro interpret-format-integer (base)
1974  `(if (or colonp atsignp params)
1975       (interpret-bind-defaults
1976        ((mincol 0) (padchar #\space) (commachar #\,) (commainterval 3))
1977        params
1978        (format-print-integer stream (next-arg) colonp atsignp ,base mincol
1979                              padchar commachar commainterval))
1980       (write (next-arg) :stream stream :base ,base :radix nil :escape nil)))
1981
1982(def-format-interpreter #\D (colonp atsignp params)
1983  (interpret-format-integer 10))
1984
1985(def-format-interpreter #\B (colonp atsignp params)
1986  (interpret-format-integer 2))
1987
1988(def-format-interpreter #\O (colonp atsignp params)
1989  (interpret-format-integer 8))
1990
1991(def-format-interpreter #\X (colonp atsignp params)
1992  (interpret-format-integer 16))
1993
1994(def-format-interpreter #\R (colonp atsignp params)
1995  (interpret-bind-defaults
1996   ((base nil) (mincol 0) (padchar #\space) (commachar #\,)
1997    (commainterval 3))
1998   params
1999   (let ((arg (next-arg)))
2000     (if base
2001         (format-print-integer stream arg colonp atsignp base mincol
2002                               padchar commachar commainterval)
2003         (if atsignp
2004             (if colonp
2005                 (format-print-old-roman stream arg)
2006                 (format-print-roman stream arg))
2007             (if colonp
2008                 (format-print-ordinal stream arg)
2009                 (format-print-cardinal stream arg)))))))
2010
2011(defparameter *cardinal-ones*
2012  #(nil "one" "two" "three" "four" "five" "six" "seven" "eight" "nine"))
2013
2014(defparameter *cardinal-tens*
2015  #(nil nil "twenty" "thirty" "forty"
2016  "fifty" "sixty" "seventy" "eighty" "ninety"))
2017
2018(defparameter *cardinal-teens*
2019  #("ten" "eleven" "twelve" "thirteen" "fourteen"  ;;; RAD
2020          "fifteen" "sixteen" "seventeen" "eighteen" "nineteen"))
2021
2022(defparameter *cardinal-periods*
2023  #("" " thousand" " million" " billion" " trillion" " quadrillion"
2024       " quintillion" " sextillion" " septillion" " octillion" " nonillion"
2025       " decillion" " undecillion" " duodecillion" " tredecillion"
2026       " quattuordecillion" " quindecillion" " sexdecillion" " septendecillion"
2027       " octodecillion" " novemdecillion" " vigintillion"))
2028
2029(defparameter *ordinal-ones*
2030  #(nil "first" "second" "third" "fourth"
2031  "fifth" "sixth" "seventh" "eighth" "ninth"))
2032
2033(defparameter *ordinal-tens*
2034  #(nil "tenth" "twentieth" "thirtieth" "fortieth"
2035  "fiftieth" "sixtieth" "seventieth" "eightieth" "ninetieth"))
2036
2037(defun format-print-small-cardinal (stream n)
2038  (multiple-value-bind (hundreds rem) (truncate n 100)
2039    (when (plusp hundreds)
2040      (write-string (svref *cardinal-ones* hundreds) stream)
2041      (write-string " hundred" stream)
2042      (when (plusp rem)
2043  (write-char #\space stream)))
2044    (when (plusp rem)
2045      (multiple-value-bind (tens ones) (truncate rem 10)
2046  (cond ((< 1 tens)
2047               (write-string (svref *cardinal-tens* tens) stream)
2048               (when (plusp ones)
2049                 (write-char #\- stream)
2050                 (write-string (svref *cardinal-ones* ones) stream)))
2051              ((= tens 1)
2052               (write-string (svref *cardinal-teens* ones) stream))
2053              ((plusp ones)
2054               (write-string (svref *cardinal-ones* ones) stream)))))))
2055
2056(defun format-print-cardinal (stream n)
2057  (cond ((minusp n)
2058   (write-string "negative " stream)
2059   (format-print-cardinal-aux stream (- n) 0 n))
2060  ((zerop n)
2061   (write-string "zero" stream))
2062  (t
2063   (format-print-cardinal-aux stream n 0 n))))
2064
2065(defun format-print-cardinal-aux (stream n period err)
2066  (multiple-value-bind (beyond here) (truncate n 1000)
2067    (unless (<= period 20)
2068      (error "number too large to print in English: ~:D" err))
2069    (unless (zerop beyond)
2070      (format-print-cardinal-aux stream beyond (1+ period) err))
2071    (unless (zerop here)
2072      (unless (zerop beyond)
2073  (write-char #\space stream))
2074      (format-print-small-cardinal stream here)
2075      (write-string (svref *cardinal-periods* period) stream))))
2076
2077(defun format-print-ordinal (stream n)
2078  (when (minusp n)
2079    (write-string "negative " stream))
2080  (let ((number (abs n)))
2081    (multiple-value-bind (top bot) (truncate number 100)
2082      (unless (zerop top)
2083  (format-print-cardinal stream (- number bot)))
2084      (when (and (plusp top) (plusp bot))
2085  (write-char #\space stream))
2086      (multiple-value-bind (tens ones) (truncate bot 10)
2087  (cond ((= bot 12) (write-string "twelfth" stream))
2088        ((= tens 1)
2089         (write-string (svref *cardinal-teens* ones) stream);;;RAD
2090         (write-string "th" stream))
2091        ((and (zerop tens) (plusp ones))
2092         (write-string (svref *ordinal-ones* ones) stream))
2093        ((and (zerop ones)(plusp tens))
2094         (write-string (svref *ordinal-tens* tens) stream))
2095        ((plusp bot)
2096         (write-string (svref *cardinal-tens* tens) stream)
2097         (write-char #\- stream)
2098         (write-string (svref *ordinal-ones* ones) stream))
2099        ((plusp number)
2100         (write-string "th" stream))
2101        (t
2102         (write-string "zeroth" stream)))))))
2103
2104;;; Print Roman numerals
2105
2106(defun format-print-old-roman (stream n)
2107  (unless (< 0 n 5000)
2108    (error "Number too large to print in old Roman numerals: ~:D" n))
2109  (do ((char-list '(#\D #\C #\L #\X #\V #\I) (cdr char-list))
2110       (val-list '(500 100 50 10 5 1) (cdr val-list))
2111       (cur-char #\M (car char-list))
2112       (cur-val 1000 (car val-list))
2113       (start n (do ((i start (progn
2114        (write-char cur-char stream)
2115        (- i cur-val))))
2116        ((< i cur-val) i))))
2117      ((zerop start))))
2118
2119(defun format-print-roman (stream n)
2120  (unless (< 0 n 4000)
2121    (error "Number too large to print in Roman numerals: ~:D" n))
2122  (do ((char-list '(#\D #\C #\L #\X #\V #\I) (cdr char-list))
2123       (val-list '(500 100 50 10 5 1) (cdr val-list))
2124       (sub-chars '(#\C #\X #\X #\I #\I) (cdr sub-chars))
2125       (sub-val '(100 10 10 1 1 0) (cdr sub-val))
2126       (cur-char #\M (car char-list))
2127       (cur-val 1000 (car val-list))
2128       (cur-sub-char #\C (car sub-chars))
2129       (cur-sub-val 100 (car sub-val))
2130       (start n (do ((i start (progn
2131        (write-char cur-char stream)
2132        (- i cur-val))))
2133        ((< i cur-val)
2134         (cond ((<= (- cur-val cur-sub-val) i)
2135          (write-char cur-sub-char stream)
2136          (write-char cur-char stream)
2137          (- i (- cur-val cur-sub-val)))
2138         (t i))))))
2139      ((zerop start))))
2140
2141;;;; plural
2142
2143(def-format-interpreter #\P (colonp atsignp params)
2144  (interpret-bind-defaults () params
2145                           (let ((arg (if colonp
2146                                          (if (eq orig-args args)
2147                                              (error 'format-error
2148                                                     :complaint "no previous argument")
2149                                              (do ((arg-ptr orig-args (cdr arg-ptr)))
2150                                                  ((eq (cdr arg-ptr) args)
2151                                                   (car arg-ptr))))
2152                                          (next-arg))))
2153                             (if atsignp
2154                                 (write-string (if (eql arg 1) "y" "ies") stream)
2155                                 (unless (eql arg 1) (write-char #\s stream))))))
2156
2157;;;; format interpreters and support functions for floating point output
2158
2159(defun decimal-string (n)
2160  (write-to-string n :base 10 :radix nil :escape nil))
2161
2162(def-format-interpreter #\F (colonp atsignp params)
2163  (when colonp
2164    (error 'format-error
2165     :complaint
2166     "cannot specify the colon modifier with this directive"))
2167  (interpret-bind-defaults ((w nil) (d nil) (k nil) (ovf nil) (pad #\space))
2168         params
2169                           (format-fixed stream (next-arg) w d k ovf pad atsignp)))
2170
2171(defun format-fixed (stream number w d k ovf pad atsign)
2172  (if (numberp number)
2173      (if (floatp number)
2174    (format-fixed-aux stream number w d k ovf pad atsign)
2175    (if (rationalp number)
2176        (format-fixed-aux stream
2177        (coerce number 'single-float)
2178        w d k ovf pad atsign)
2179        (format-write-field stream
2180          (decimal-string number)
2181          w 1 0 #\space t)))
2182      (format-princ stream number nil nil w 1 0 pad)))
2183
2184;;; We return true if we overflowed, so that ~G can output the overflow char
2185;;; instead of spaces.
2186(defun format-fixed-aux (stream number w d k ovf pad atsign)
2187  (cond
2188   ((and (floatp number)
2189         (or (sys:float-infinity-p number)
2190             (sys:float-nan-p number)))
2191    (prin1 number stream)
2192    nil)
2193   (t
2194    (let ((spaceleft w))
2195      (when (and w (or atsign (minusp (float-sign number))))
2196        (decf spaceleft))
2197      (multiple-value-bind (str len lpoint tpoint)
2198        (sys::flonum-to-string (abs number) spaceleft d k)
2199  ;;if caller specifically requested no fraction digits, suppress the
2200  ;;optional trailing zero
2201  (when (and d (zerop d))
2202          (setf tpoint nil))
2203  (when w
2204    (decf spaceleft len)
2205    ;;optional leading zero
2206    (when lpoint
2207      (if (or (> spaceleft 0) tpoint) ;force at least one digit
2208    (decf spaceleft)
2209    (setq lpoint nil)))
2210    ;;optional trailing zero
2211    (when tpoint
2212      (if (> spaceleft 0)
2213    (decf spaceleft)
2214    (setq tpoint nil))))
2215  (cond ((and w (< spaceleft 0) ovf)
2216         ;;field width overflow
2217         (dotimes (i w) (write-char ovf stream))
2218         t)
2219        (t
2220         (when w (dotimes (i spaceleft) (write-char pad stream)))
2221         (cond ((minusp (float-sign number))
2222                      (write-char #\- stream))
2223                     (atsign
2224                      (write-char #\+ stream)))
2225         (when lpoint (write-char #\0 stream))
2226         (write-string str stream)
2227         (when tpoint (write-char #\0 stream))
2228         nil)))))))
2229
2230(def-format-interpreter #\E (colonp atsignp params)
2231  (when colonp
2232    (error 'format-error
2233     :complaint
2234     "cannot specify the colon modifier with this directive"))
2235  (interpret-bind-defaults
2236   ((w nil) (d nil) (e nil) (k 1) (ovf nil) (pad #\space) (mark nil))
2237   params
2238   (format-exponential stream (next-arg) w d e k ovf pad mark atsignp)))
2239
2240(defun format-exponential (stream number w d e k ovf pad marker atsign)
2241  (if (numberp number)
2242      (if (floatp number)
2243    (format-exp-aux stream number w d e k ovf pad marker atsign)
2244    (if (rationalp number)
2245        (format-exp-aux stream
2246            (coerce number 'single-float)
2247            w d e k ovf pad marker atsign)
2248        (format-write-field stream
2249          (decimal-string number)
2250          w 1 0 #\space t)))
2251      (format-princ stream number nil nil w 1 0 pad)))
2252
2253(defun format-exponent-marker (number)
2254  (if (typep number *read-default-float-format*)
2255      #\e
2256      (typecase number
2257  (single-float #\f)
2258  (double-float #\d)
2259  (short-float #\s)
2260  (long-float #\l))))
2261
2262;;; Here we prevent the scale factor from shifting all significance out of
2263;;; a number to the right. We allow insignificant zeroes to be shifted in
2264;;; to the left right, athough it is an error to specify k and d such that this
2265;;; occurs. Perhaps we should detect both these condtions and flag them as
2266;;; errors. As for now, we let the user get away with it, and merely guarantee
2267;;; that at least one significant digit will appear.
2268
2269;;; Raymond Toy writes: The Hyperspec seems to say that the exponent
2270;;; marker is always printed. Make it so. Also, the original version
2271;;; causes errors when printing infinities or NaN's. The Hyperspec is
2272;;; silent here, so let's just print out infinities and NaN's instead
2273;;; of causing an error.
2274(defun format-exp-aux (stream number w d e k ovf pad marker atsign)
2275  (if (and (floatp number)
2276     (or (sys::float-infinity-p number)
2277         (sys::float-nan-p number)))
2278      (prin1 number stream)
2279      (multiple-value-bind (num expt) (sys::scale-exponent (abs number))
2280  (let* ((expt (- expt k))
2281         (estr (decimal-string (abs expt)))
2282         (elen (if e (max (length estr) e) (length estr)))
2283         (fdig (if d (if (plusp k) (1+ (- d k)) d) nil))
2284         (fmin (if (minusp k) (- 1 k) nil))
2285         (spaceleft (if w
2286            (- w 2 elen
2287         (if (or atsign (minusp number))
2288             1 0))
2289            nil)))
2290    (if (and w ovf e (> elen e)) ;exponent overflow
2291        (dotimes (i w) (write-char ovf stream))
2292        (multiple-value-bind (fstr flen lpoint)
2293                (sys::flonum-to-string num spaceleft fdig k fmin)
2294    (when w
2295      (decf spaceleft flen)
2296      (when lpoint
2297        (if (> spaceleft 0)
2298      (decf spaceleft)
2299      (setq lpoint nil))))
2300    (cond ((and w (< spaceleft 0) ovf)
2301           ;;significand overflow
2302           (dotimes (i w) (write-char ovf stream)))
2303          (t (when w
2304         (dotimes (i spaceleft) (write-char pad stream)))
2305       (if (minusp number)
2306           (write-char #\- stream)
2307           (if atsign (write-char #\+ stream)))
2308       (when lpoint (write-char #\0 stream))
2309       (write-string fstr stream)
2310       (write-char (if marker
2311           marker
2312           (format-exponent-marker number))
2313             stream)
2314       (write-char (if (minusp expt) #\- #\+) stream)
2315       (when e
2316         ;;zero-fill before exponent if necessary
2317         (dotimes (i (- e (length estr)))
2318           (write-char #\0 stream)))
2319       (write-string estr stream)))))))))
2320
2321(def-format-interpreter #\G (colonp atsignp params)
2322  (when colonp
2323    (error 'format-error
2324     :complaint
2325     "cannot specify the colon modifier with this directive"))
2326  (interpret-bind-defaults
2327   ((w nil) (d nil) (e nil) (k nil) (ovf nil) (pad #\space) (mark nil))
2328   params
2329   (format-general stream (next-arg) w d e k ovf pad mark atsignp)))
2330
2331(defun format-general (stream number w d e k ovf pad marker atsign)
2332  (if (numberp number)
2333      (if (floatp number)
2334    (format-general-aux stream number w d e k ovf pad marker atsign)
2335    (if (rationalp number)
2336        (format-general-aux stream
2337          (coerce number 'single-float)
2338          w d e k ovf pad marker atsign)
2339        (format-write-field stream
2340          (decimal-string number)
2341          w 1 0 #\space t)))
2342      (format-princ stream number nil nil w 1 0 pad)))
2343
2344;;; Raymond Toy writes: same change as for format-exp-aux
2345(defun format-general-aux (stream number w d e k ovf pad marker atsign)
2346  (if (and (floatp number)
2347     (or (sys::float-infinity-p number)
2348         (sys::float-nan-p number)))
2349      (prin1 number stream)
2350      (multiple-value-bind (ignore n) (sys::scale-exponent (abs number))
2351  (declare (ignore ignore))
2352  ;; KLUDGE: Default d if omitted. The procedure is taken directly from
2353  ;; the definition given in the manual, and is not very efficient, since
2354  ;; we generate the digits twice. Future maintainers are encouraged to
2355  ;; improve on this. -- rtoy?? 1998??
2356  (unless d
2357    (multiple-value-bind (str len)
2358            (sys::flonum-to-string (abs number))
2359      (declare (ignore str))
2360      (let ((q (if (= len 1) 1 (1- len))))
2361        (setq d (max q (min n 7))))))
2362  (let* ((ee (if e (+ e 2) 4))
2363         (ww (if w (- w ee) nil))
2364         (dd (- d n)))
2365    (cond ((<= 0 dd d)
2366     (let ((char (if (format-fixed-aux stream number ww dd nil
2367               ovf pad atsign)
2368         ovf
2369         #\space)))
2370       (dotimes (i ee) (write-char char stream))))
2371    (t
2372     (format-exp-aux stream number w d e (or k 1)
2373         ovf pad marker atsign)))))))
2374
2375(def-format-interpreter #\$ (colonp atsignp params)
2376  (interpret-bind-defaults ((d 2) (n 1) (w 0) (pad #\space)) params
2377                           (format-dollars stream (next-arg) d n w pad colonp atsignp)))
2378
2379(defun format-dollars (stream number d n w pad colon atsign)
2380  (when (rationalp number)
2381    ;; This coercion to SINGLE-FLOAT seems as though it gratuitously
2382    ;; loses precision (why not LONG-FLOAT?) but it's the default
2383    ;; behavior in the ANSI spec, so in some sense it's the right
2384    ;; thing, and at least the user shouldn't be surprised.
2385    (setq number (coerce number 'single-float)))
2386  (if (floatp number)
2387      (let* ((signstr (if (minusp number) "-" (if atsign "+" "")))
2388       (signlen (length signstr)))
2389  (multiple-value-bind (str strlen ig2 ig3 pointplace)
2390          (sys::flonum-to-string number nil d nil)
2391    (declare (ignore ig2 ig3 strlen))
2392    (when colon
2393      (write-string signstr stream))
2394    (dotimes (i (- w signlen (max n pointplace) 1 d))
2395      (write-char pad stream))
2396    (unless colon
2397      (write-string signstr stream))
2398    (dotimes (i (- n pointplace))
2399      (write-char #\0 stream))
2400    (write-string str stream)))
2401      (format-write-field stream
2402        (decimal-string number)
2403        w 1 0 #\space t)))
2404
2405;;;; FORMAT interpreters and support functions for line/page breaks etc.
2406
2407(def-format-interpreter #\% (colonp atsignp params)
2408  (when (or colonp atsignp)
2409    (error 'format-error
2410     :complaint
2411     "cannot specify either colon or atsign for this directive"))
2412  (interpret-bind-defaults ((count 1)) params
2413                           (dotimes (i count)
2414                             (terpri stream))))
2415
2416(def-format-interpreter #\& (colonp atsignp params)
2417  (when (or colonp atsignp)
2418    (error 'format-error
2419     :complaint
2420     "cannot specify either colon or atsign for this directive"))
2421  (interpret-bind-defaults ((count 1)) params
2422                           (fresh-line stream)
2423                           (dotimes (i (1- count))
2424                             (terpri stream))))
2425
2426(def-format-interpreter #\| (colonp atsignp params)
2427  (when (or colonp atsignp)
2428    (error 'format-error
2429     :complaint
2430     "cannot specify either colon or atsign for this directive"))
2431  (interpret-bind-defaults ((count 1)) params
2432                           (dotimes (i count)
2433                             (write-char (code-char sys::form-feed-char-code) stream))))
2434
2435(def-format-interpreter #\~ (colonp atsignp params)
2436  (when (or colonp atsignp)
2437    (error 'format-error
2438     :complaint
2439     "cannot specify either colon or atsign for this directive"))
2440  (interpret-bind-defaults ((count 1)) params
2441                           (dotimes (i count)
2442                             (write-char #\~ stream))))
2443
2444(def-complex-format-interpreter #\newline (colonp atsignp params directives)
2445  (when (and colonp atsignp)
2446    (error 'format-error
2447     :complaint
2448     "cannot specify both colon and atsign for this directive"))
2449  (interpret-bind-defaults () params
2450                           (when atsignp
2451                             (write-char #\newline stream)))
2452  (if (and (not colonp)
2453     directives
2454     (simple-string-p (car directives)))
2455      (cons (string-left-trim *format-whitespace-chars*
2456            (car directives))
2457      (cdr directives))
2458      directives))
2459
2460;;;; format interpreters and support functions for tabs and simple pretty
2461;;;; printing
2462
2463(def-format-interpreter #\T (colonp atsignp params)
2464  (if colonp
2465      (interpret-bind-defaults ((n 1) (m 1)) params
2466                               (pprint-tab (if atsignp :section-relative :section) n m stream))
2467      (if atsignp
2468    (interpret-bind-defaults ((colrel 1) (colinc 1)) params
2469                                   (format-relative-tab stream colrel colinc))
2470    (interpret-bind-defaults ((colnum 1) (colinc 1)) params
2471                                   (format-absolute-tab stream colnum colinc)))))
2472
2473(defun output-spaces (stream n)
2474  (let ((spaces #.(make-string 100 :initial-element #\space)))
2475    (loop
2476      (when (< n (length spaces))
2477  (return))
2478      (write-string spaces stream)
2479      (decf n (length spaces)))
2480    (write-string spaces stream :end n)))
2481
2482(defun format-relative-tab (stream colrel colinc)
2483  (if (xp::xp-structure-p stream)
2484      (pprint-tab :line-relative colrel colinc stream)
2485      (let* ((cur (charpos stream))
2486       (spaces (if (and cur (plusp colinc))
2487       (- (* (ceiling (+ cur colrel) colinc) colinc) cur)
2488       colrel)))
2489  (output-spaces stream spaces))))
2490
2491(defun format-absolute-tab (stream colnum colinc)
2492  (if (xp::xp-structure-p stream)
2493      (pprint-tab :line colnum colinc stream)
2494      (let ((cur (charpos stream)))
2495  (cond ((null cur)
2496         (write-string "  " stream))
2497        ((< cur colnum)
2498         (output-spaces stream (- colnum cur)))
2499        (t
2500         (unless (zerop colinc)
2501     (output-spaces stream
2502        (- colinc (rem (- cur colnum) colinc)))))))))
2503
2504(def-format-interpreter #\_ (colonp atsignp params)
2505  (interpret-bind-defaults () params
2506                           (pprint-newline (if colonp
2507                                               (if atsignp
2508                                                   :mandatory
2509                                                   :fill)
2510                                               (if atsignp
2511                                                   :miser
2512                                                   :linear))
2513                                           stream)))
2514
2515(def-format-interpreter #\I (colonp atsignp params)
2516  (when atsignp
2517    (error 'format-error
2518     :complaint "cannot specify the at-sign modifier"))
2519  (interpret-bind-defaults ((n 0)) params
2520                           (pprint-indent (if colonp :current :block) n stream)))
2521
2522;;;; format interpreter for ~*
2523
2524(def-format-interpreter #\* (colonp atsignp params)
2525  (if atsignp
2526      (if colonp
2527    (error 'format-error
2528     :complaint "cannot specify both colon and at-sign")
2529    (interpret-bind-defaults ((posn 0)) params
2530                                   (if (<= 0 posn (length orig-args))
2531                                       (setf args (nthcdr posn orig-args))
2532                                       (error 'format-error
2533                                              :complaint "Index ~W is out of bounds. (It should ~
2534                                              have been between 0 and ~W.)"
2535                                              :args (list posn (length orig-args))))))
2536      (if colonp
2537    (interpret-bind-defaults ((n 1)) params
2538                                   (do ((cur-posn 0 (1+ cur-posn))
2539                                        (arg-ptr orig-args (cdr arg-ptr)))
2540                                       ((eq arg-ptr args)
2541                                        (let ((new-posn (- cur-posn n)))
2542                                          (if (<= 0 new-posn (length orig-args))
2543                                              (setf args (nthcdr new-posn orig-args))
2544                                              (error 'format-error
2545                                                     :complaint
2546                                                     "Index ~W is out of bounds. (It should
2547                                                      have been between 0 and ~W.)"
2548                                                     :args
2549                                                     (list new-posn (length orig-args))))))))
2550    (interpret-bind-defaults ((n 1)) params
2551                                   (dotimes (i n)
2552                                     (next-arg))))))
2553
2554;;;; format interpreter for indirection
2555
2556(def-format-interpreter #\? (colonp atsignp params string end)
2557  (when colonp
2558    (error 'format-error
2559     :complaint "cannot specify the colon modifier"))
2560  (interpret-bind-defaults () params
2561                           (handler-bind
2562                             ((format-error
2563                               (lambda (condition)
2564                                 (error 'format-error
2565                                        :complaint
2566                                        "~A~%while processing indirect format string:"
2567                                        :args (list condition)
2568                                        :print-banner nil
2569                                        :control-string string
2570                                        :offset (1- end)))))
2571                             (if atsignp
2572                                 (setf args (%format stream (next-arg) orig-args args))
2573                                 (%format stream (next-arg) (next-arg))))))
2574
2575;;;; format interpreters for capitalization
2576
2577(def-complex-format-interpreter #\( (colonp atsignp params directives)
2578  (let ((close (find-directive directives #\) nil)))
2579    (unless close
2580      (error 'format-error
2581       :complaint "no corresponding close paren"))
2582    (interpret-bind-defaults () params
2583                             (let* ((posn (position close directives))
2584                                    (before (subseq directives 0 posn))
2585                                    (after (nthcdr (1+ posn) directives))
2586                                    (stream (sys::make-case-frob-stream stream
2587                                                                        (if colonp
2588                                                                            (if atsignp
2589                                                                                :upcase
2590                                                                                :capitalize)
2591                                                                            (if atsignp
2592                                                                                :capitalize-first
2593                                                                                :downcase)))))
2594                               (setf args (interpret-directive-list stream before orig-args args))
2595                               after))))
2596
2597(def-complex-format-interpreter #\) ()
2598  (error 'format-error
2599   :complaint "no corresponding open paren"))
2600
2601;;;; format interpreters and support functions for conditionalization
2602
2603(def-complex-format-interpreter #\[ (colonp atsignp params directives)
2604  (multiple-value-bind (sublists last-semi-with-colon-p remaining)
2605    (parse-conditional-directive directives)
2606    (setf args
2607    (if atsignp
2608        (if colonp
2609      (error 'format-error
2610       :complaint
2611                         "cannot specify both the colon and at-sign modifiers")
2612      (if (cdr sublists)
2613          (error 'format-error
2614           :complaint
2615           "can only specify one section")
2616          (interpret-bind-defaults () params
2617                                               (let ((prev-args args)
2618                                                     (arg (next-arg)))
2619                                                 (if arg
2620                                                     (interpret-directive-list stream
2621                                                                               (car sublists)
2622                                                                               orig-args
2623                                                                               prev-args)
2624                                                     args)))))
2625        (if colonp
2626      (if (= (length sublists) 2)
2627          (interpret-bind-defaults () params
2628                                               (if (next-arg)
2629                                                   (interpret-directive-list stream (car sublists)
2630                                                                             orig-args args)
2631                                                   (interpret-directive-list stream (cadr sublists)
2632                                                                             orig-args args)))
2633          (error 'format-error
2634           :complaint
2635           "must specify exactly two sections"))
2636      (interpret-bind-defaults ((index (next-arg))) params
2637                                           (let* ((default (and last-semi-with-colon-p
2638                                                                (pop sublists)))
2639                                                  (last (1- (length sublists)))
2640                                                  (sublist
2641                                                   (if (<= 0 index last)
2642                                                       (nth (- last index) sublists)
2643                                                       default)))
2644                                             (interpret-directive-list stream sublist orig-args
2645                                                                       args))))))
2646    remaining))
2647
2648(def-complex-format-interpreter #\; ()
2649  (error 'format-error
2650   :complaint
2651   "~~; not contained within either ~~[...~~] or ~~<...~~>"))
2652
2653(def-complex-format-interpreter #\] ()
2654  (error 'format-error
2655   :complaint
2656   "no corresponding open bracket"))
2657
2658;;;; format interpreter for up-and-out
2659
2660(defvar *outside-args*)
2661
2662(def-format-interpreter #\^ (colonp atsignp params)
2663  (when atsignp
2664    (error 'format-error
2665     :complaint "cannot specify the at-sign modifier"))
2666  (when (and colonp (not *up-up-and-out-allowed*))
2667    (error 'format-error
2668     :complaint "attempt to use ~~:^ outside a ~~:{...~~} construct"))
2669  (when (interpret-bind-defaults ((arg1 nil) (arg2 nil) (arg3 nil)) params
2670          (cond (arg3 (<= arg1 arg2 arg3))
2671                (arg2 (eql arg1 arg2))
2672                (arg1 (eql arg1 0))
2673                (t (if colonp
2674                       (null *outside-args*)
2675                       (null args)))))
2676    (throw (if colonp 'up-up-and-out 'up-and-out)
2677     args)))
2678
2679;;;; format interpreters for iteration
2680
2681(def-complex-format-interpreter #\{
2682  (colonp atsignp params string end directives)
2683  (let ((close (find-directive directives #\} nil)))
2684    (unless close
2685      (error 'format-error
2686       :complaint
2687       "no corresponding close brace"))
2688    (interpret-bind-defaults ((max-count nil)) params
2689      (let* ((closed-with-colon (format-directive-colonp close))
2690             (posn (position close directives))
2691             (insides (if (zerop posn)
2692                          (next-arg)
2693                          (subseq directives 0 posn)))
2694             (*up-up-and-out-allowed* colonp))
2695        (labels
2696            ((do-guts (orig-args args)
2697                      (if (zerop posn)
2698                          (handler-bind
2699                            ((format-error
2700                              (lambda (condition)
2701                                (error
2702                                 'format-error
2703                                 :complaint
2704                                 "~A~%while processing indirect format string:"
2705                                 :args (list condition)
2706                                 :print-banner nil
2707                                 :control-string string
2708                                 :offset (1- end)))))
2709                            (%format stream insides orig-args args))
2710                          (interpret-directive-list stream insides
2711                                                    orig-args args)))
2712             (bind-args (orig-args args)
2713                        (if colonp
2714                            (let* ((arg (next-arg))
2715                                   (*logical-block-popper* nil)
2716                                   (*outside-args* args))
2717                              (catch 'up-and-out
2718                                (do-guts arg arg))
2719                              args)
2720                            (do-guts orig-args args)))
2721             (do-loop (orig-args args)
2722                      (catch (if colonp 'up-up-and-out 'up-and-out)
2723                        (loop
2724                          (when (and (not closed-with-colon) (null args))
2725                            (return))
2726                          (when (and max-count (minusp (decf max-count)))
2727                            (return))
2728                          (setf args (bind-args orig-args args))
2729                          (when (and closed-with-colon (null args))
2730                            (return)))
2731                        args)))
2732          (if atsignp
2733              (setf args (do-loop orig-args args))
2734              (let ((arg (next-arg))
2735                    (*logical-block-popper* nil))
2736                (do-loop arg arg)))
2737          (nthcdr (1+ posn) directives))))))
2738
2739(def-complex-format-interpreter #\} ()
2740  (error 'format-error
2741   :complaint "no corresponding open brace"))
2742
2743;;;; format interpreters and support functions for justification
2744
2745(def-complex-format-interpreter #\<
2746  (colonp atsignp params string end directives)
2747  (multiple-value-bind (segments first-semi close remaining)
2748    (parse-format-justification directives)
2749    (setf args
2750    (if (format-directive-colonp close)
2751        (multiple-value-bind (prefix per-line-p insides suffix)
2752                (parse-format-logical-block segments colonp first-semi
2753                                            close params string end)
2754    (interpret-format-logical-block stream orig-args args
2755            prefix per-line-p insides
2756            suffix atsignp))
2757        (let ((count (reduce #'+ (mapcar (lambda (x) (count-if #'illegal-inside-justification-p x)) segments))))
2758    (when (> count 0)
2759      ;; ANSI specifies that "an error is signalled" in this
2760      ;; situation.
2761      (error 'format-error
2762       :complaint "~D illegal directive~:P found inside justification block"
2763       :args (list count)))
2764    (interpret-format-justification stream orig-args args
2765            segments colonp atsignp
2766            first-semi params))))
2767    remaining))
2768
2769(defun interpret-format-justification
2770  (stream orig-args args segments colonp atsignp first-semi params)
2771  (interpret-bind-defaults
2772   ((mincol 0) (colinc 1) (minpad 0) (padchar #\space))
2773   params
2774   (let ((newline-string nil)
2775         (strings nil)
2776         (extra-space 0)
2777         (line-len 0))
2778     (setf args
2779           (catch 'up-and-out
2780             (when (and first-semi (format-directive-colonp first-semi))
2781               (interpret-bind-defaults
2782                ((extra 0)
2783                 (len (or #-abcl(sb!impl::line-length stream) 72)))
2784                (format-directive-params first-semi)
2785                (setf newline-string
2786                      (with-output-to-string (stream)
2787                        (setf args
2788                              (interpret-directive-list stream
2789                                                        (pop segments)
2790                                                        orig-args
2791                                                        args))))
2792                (setf extra-space extra)
2793                (setf line-len len)))
2794             (dolist (segment segments)
2795               (push (with-output-to-string (stream)
2796                       (setf args
2797                             (interpret-directive-list stream segment
2798                                                       orig-args args)))
2799                     strings))
2800             args))
2801     (format-justification stream newline-string extra-space line-len strings
2802                           colonp atsignp mincol colinc minpad padchar)))
2803  args)
2804
2805(defun format-justification (stream newline-prefix extra-space line-len strings
2806                                    pad-left pad-right mincol colinc minpad padchar)
2807  (setf strings (reverse strings))
2808  (let* ((num-gaps (+ (1- (length strings))
2809          (if pad-left 1 0)
2810          (if pad-right 1 0)))
2811   (chars (+ (* num-gaps minpad)
2812       (loop
2813         for string in strings
2814         summing (length string))))
2815   (length (if (> chars mincol)
2816         (+ mincol (* (ceiling (- chars mincol) colinc) colinc))
2817         mincol))
2818   (padding (+ (- length chars) (* num-gaps minpad))))
2819    (when (and newline-prefix
2820         (> (+ (or (charpos stream) 0)
2821         length extra-space)
2822      line-len))
2823      (write-string newline-prefix stream))
2824    (flet ((do-padding ()
2825                       (let ((pad-len (if (zerop num-gaps)
2826                                          padding
2827                                          (truncate padding num-gaps))))
2828                         (decf padding pad-len)
2829                         (decf num-gaps)
2830                         (dotimes (i pad-len) (write-char padchar stream)))))
2831      (when (or pad-left
2832    (and (not pad-right) (null (cdr strings))))
2833  (do-padding))
2834      (when strings
2835  (write-string (car strings) stream)
2836  (dolist (string (cdr strings))
2837    (do-padding)
2838    (write-string string stream)))
2839      (when pad-right
2840  (do-padding)))))
2841
2842(defun interpret-format-logical-block
2843  (stream orig-args args prefix per-line-p insides suffix atsignp)
2844  (let ((arg (if atsignp args (next-arg))))
2845    (if per-line-p
2846  (pprint-logical-block
2847         (stream arg :per-line-prefix prefix :suffix suffix)
2848         (let ((*logical-block-popper* (lambda () (pprint-pop))))
2849           (catch 'up-and-out
2850             (interpret-directive-list stream insides
2851                                       (if atsignp orig-args arg)
2852                                       arg))))
2853  (pprint-logical-block (stream arg :prefix prefix :suffix suffix)
2854                              (let ((*logical-block-popper* (lambda () (pprint-pop))))
2855                                (catch 'up-and-out
2856                                  (interpret-directive-list stream insides
2857                                                            (if atsignp orig-args arg)
2858                                                            arg))))))
2859  (if atsignp nil args))
2860
2861;;;; format interpreter and support functions for user-defined method
2862
2863(def-format-interpreter #\/ (string start end colonp atsignp params)
2864  (let ((symbol (extract-user-fun-name string start end)))
2865    (collect ((args))
2866             (dolist (param-and-offset params)
2867               (let ((param (cdr param-and-offset)))
2868                 (case param
2869                   (:arg (args (next-arg)))
2870                   (:remaining (args (length args)))
2871                   (t (args param)))))
2872             (apply (fdefinition symbol) stream (next-arg) colonp atsignp (args)))))
2873
2874(setf sys::*simple-format-function* #'format)
2875
2876(eval-when (:compile-toplevel :execute)
2877    ;; the code below needs to its floats to be read as long-floats
2878    (setf *read-default-float-format* *saved-default-float-format*))
2879
2880
2881(provide 'format)
Note: See TracBrowser for help on using the repository browser.