source: trunk/j/src/org/armedbear/lisp/format.lisp @ 8214

Last change on this file since 8214 was 8214, checked in by piso, 17 years ago

Incorporated recent SBCL updates.

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