1 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; This software is derived from the CMU CL system, which was
5 ;;;; written at Carnegie Mellon University and released into the
6 ;;;; public domain. The software is in the public domain and is
7 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
8 ;;;; files for more information.
10 (in-package "SB!FORMAT")
12 (define-condition format-error
(error reference-condition
)
13 ((complaint :reader format-error-complaint
:initarg
:complaint
)
14 (args :reader format-error-args
:initarg
:args
:initform nil
)
15 (control-string :reader format-error-control-string
16 :initarg
:control-string
17 :initform
*default-format-error-control-string
*)
18 (offset :reader format-error-offset
:initarg
:offset
19 :initform
*default-format-error-offset
*)
20 (second-relative :reader format-error-second-relative
21 :initarg
:second-relative
:initform nil
)
22 (print-banner :reader format-error-print-banner
:initarg
:print-banner
24 (:report %print-format-error
)
25 (:default-initargs
:references nil
))
27 (defun %print-format-error
(condition stream
)
29 "~:[~*~;error in ~S: ~]~?~@[~% ~A~% ~V@T^~@[~V@T^~]~]"
30 (format-error-print-banner condition
)
32 (format-error-complaint condition
)
33 (format-error-args condition
)
34 (format-error-control-string condition
)
35 (format-error-offset condition
)
36 (format-error-second-relative condition
)))
38 (def!struct format-directive
39 (string (missing-arg) :type simple-string
)
40 (start (missing-arg) :type
(and unsigned-byte fixnum
))
41 (end (missing-arg) :type
(and unsigned-byte fixnum
))
42 (character (missing-arg) :type character
)
43 (colonp nil
:type
(member t nil
))
44 (atsignp nil
:type
(member t nil
))
45 (params nil
:type list
))
46 (def!method print-object
((x format-directive
) stream
)
47 (print-unreadable-object (x stream
)
48 (write-string (format-directive-string x
)
50 :start
(format-directive-start x
)
51 :end
(format-directive-end x
))))
53 ;;;; TOKENIZE-CONTROL-STRING
55 (defun tokenize-control-string (string)
56 (declare (simple-string string
))
60 ;; FIXME: consider rewriting this 22.3.5.2-related processing
61 ;; using specials to maintain state and doing the logic inside
62 ;; the directive expanders themselves.
66 (justification-semicolon))
68 (let ((next-directive (or (position #\~ string
:start index
) end
)))
69 (when (> next-directive index
)
70 (push (subseq string index next-directive
) result
))
71 (when (= next-directive end
)
73 (let* ((directive (parse-directive string next-directive
))
74 (char (format-directive-character directive
)))
75 ;; this processing is required by CLHS 22.3.5.2
77 ((char= char
#\
<) (push directive block
))
78 ((and block
(char= char
#\
;) (format-directive-colonp directive))
79 (setf semicolon directive
))
83 :complaint
"~~> without a matching ~~<"
84 :control-string string
85 :offset next-directive
))
87 ((format-directive-colonp directive
)
89 (setf pprint
(car block
)))
92 (unless justification-semicolon
93 (setf justification-semicolon semicolon
))))
95 ;; block cases are handled by the #\< expander/interpreter
98 ((#\W
#\I
#\_
) (unless pprint
(setf pprint directive
)))
99 (#\T
(when (and (format-directive-colonp directive
)
101 (setf pprint directive
))))))
102 (push directive result
)
103 (setf index
(format-directive-end directive
)))))
104 (when (and pprint justification-semicolon
)
105 (let ((pprint-offset (1- (format-directive-end pprint
)))
106 (justification-offset
107 (1- (format-directive-end justification-semicolon
))))
109 :complaint
"misuse of justification and pprint directives"
110 :control-string string
111 :offset
(min pprint-offset justification-offset
)
112 :second-relative
(- (max pprint-offset justification-offset
)
113 (min pprint-offset justification-offset
)
115 :references
(list '(:ansi-cl
:section
(22 3 5 2))))))
118 (defun parse-directive (string start
)
119 (let ((posn (1+ start
)) (params nil
) (colonp nil
) (atsignp nil
)
120 (end (length string
)))
124 :complaint
"string ended before directive was found"
125 :control-string string
127 (schar string posn
)))
129 (when (or colonp atsignp
)
131 :complaint
"parameters found after #\\: or #\\@ modifier"
132 :control-string string
134 :references
(list '(:ansi-cl
:section
(22 3)))))))
136 (let ((char (get-char)))
137 (cond ((or (char<= #\
0 char
#\
9) (char= char
#\
+) (char= char
#\-
))
139 (multiple-value-bind (param new-posn
)
140 (parse-integer string
:start posn
:junk-allowed t
)
141 (push (cons posn param
) params
)
149 ((or (char= char
#\v)
152 (push (cons posn
:arg
) params
)
162 (push (cons posn
:remaining
) params
)
173 (push (cons posn
(get-char)) params
)
175 (unless (char= (get-char) #\
,)
179 (push (cons posn nil
) params
))
183 :complaint
"too many colons supplied"
184 :control-string string
186 :references
(list '(:ansi-cl
:section
(22 3))))
191 :complaint
"too many #\\@ characters supplied"
192 :control-string string
194 :references
(list '(:ansi-cl
:section
(22 3))))
197 (when (and (char= (schar string
(1- posn
)) #\
,)
199 (char/= (schar string
(- posn
2)) #\')))
201 (push (cons (1- posn
) nil
) params
))
204 (let ((char (get-char)))
205 (when (char= char
#\
/)
206 (let ((closing-slash (position #\
/ string
:start
(1+ posn
))))
208 (setf posn closing-slash
)
210 :complaint
"no matching closing slash"
211 :control-string string
213 (make-format-directive
214 :string string
:start start
:end
(1+ posn
)
215 :character
(char-upcase char
)
216 :colonp colonp
:atsignp atsignp
217 :params
(nreverse params
))))))
221 (sb!xc
:defmacro formatter
(control-string)
222 `#',(%formatter control-string
))
224 (defun %formatter
(control-string)
226 (catch 'need-orig-args
227 (let* ((*simple-args
* nil
)
228 (*only-simple-args
* t
)
229 (guts (expand-control-string control-string
))
231 (dolist (arg *simple-args
*)
235 :complaint
"required argument missing"
236 :control-string
,control-string
239 (return `(lambda (stream &optional
,@args
&rest args
)
240 (declare (ignorable stream
))
243 (let ((*orig-args-available
* t
)
244 (*only-simple-args
* nil
))
245 `(lambda (stream &rest orig-args
)
246 (declare (ignorable stream
))
247 (let ((args orig-args
))
248 ,(expand-control-string control-string
)
251 (defun expand-control-string (string)
252 (let* ((string (etypecase string
256 (coerce string
'simple-string
))))
257 (*default-format-error-control-string
* string
)
258 (directives (tokenize-control-string string
)))
260 ,@(expand-directive-list directives
))))
262 (defun expand-directive-list (directives)
264 (remaining-directives directives
))
266 (unless remaining-directives
268 (multiple-value-bind (form new-directives
)
269 (expand-directive (car remaining-directives
)
270 (cdr remaining-directives
))
272 (setf remaining-directives new-directives
)))
275 (defun expand-directive (directive more-directives
)
279 (let ((char (format-directive-character directive
)))
282 (aref *format-directive-expanders
* (char-code char
)))
284 (*default-format-error-offset
*
285 (1- (format-directive-end directive
))))
286 (declare (type (or null function
) expander
))
288 (funcall expander directive more-directives
)
290 :complaint
"unknown directive ~@[(character: ~A)~]"
291 :args
(list (char-name (format-directive-character directive
)))))))
293 (values `(write-string ,directive stream
)
296 (defmacro-mundanely expander-next-arg
(string offset
)
300 :complaint
"no more arguments"
301 :control-string
,string
304 (defun expand-next-arg (&optional offset
)
305 (if (or *orig-args-available
* (not *only-simple-args
*))
306 `(,*expander-next-arg-macro
*
307 ,*default-format-error-control-string
*
308 ,(or offset
*default-format-error-offset
*))
309 (let ((symbol (gensym "FORMAT-ARG-")))
310 (push (cons symbol
(or offset
*default-format-error-offset
*))
314 (defmacro expand-bind-defaults
(specs params
&body body
)
315 (once-only ((params params
))
317 (collect ((expander-bindings) (runtime-bindings))
319 (destructuring-bind (var default
) spec
320 (let ((symbol (gensym)))
325 (let* ((param-and-offset (pop ,params
))
326 (offset (car param-and-offset
))
327 (param (cdr param-and-offset
)))
329 (:arg
`(or ,(expand-next-arg offset
)
332 (setf *only-simple-args
* nil
)
336 `(let ,(expander-bindings)
337 `(let ,(list ,@(runtime-bindings))
342 "too many parameters, expected no more than ~W"
343 :args
(list ,(length specs
))
344 :offset
(caar ,params
)))
349 :complaint
"too many parameters, expected none"
350 :offset
(caar ,params
)))
353 ;;;; format directive machinery
355 ;;; FIXME: only used in this file, could be SB!XC:DEFMACRO in EVAL-WHEN
356 (defmacro def-complex-format-directive
(char lambda-list
&body body
)
357 (let ((defun-name (intern (format nil
358 "~:@(~:C~)-FORMAT-DIRECTIVE-EXPANDER"
361 (directives (if lambda-list
(car (last lambda-list
)) (gensym))))
363 (defun ,defun-name
(,directive
,directives
)
365 `((let ,(mapcar (lambda (var)
367 (,(symbolicate "FORMAT-DIRECTIVE-" var
)
369 (butlast lambda-list
))
371 `((declare (ignore ,directive
,directives
))
373 (%set-format-directive-expander
,char
#',defun-name
))))
375 ;;; FIXME: only used in this file, could be SB!XC:DEFMACRO in EVAL-WHEN
376 (defmacro def-format-directive
(char lambda-list
&body body
)
377 (let ((directives (gensym))
379 (body-without-decls body
))
381 (let ((form (car body-without-decls
)))
382 (unless (and (consp form
) (eq (car form
) 'declare
))
384 (push (pop body-without-decls
) declarations
)))
385 (setf declarations
(reverse declarations
))
386 `(def-complex-format-directive ,char
(,@lambda-list
,directives
)
388 (values (progn ,@body-without-decls
)
391 (eval-when (#-sb-xc
:compile-toplevel
:load-toplevel
:execute
)
393 (defun %set-format-directive-expander
(char fn
)
394 (setf (aref *format-directive-expanders
* (char-code (char-upcase char
))) fn
)
397 (defun %set-format-directive-interpreter
(char fn
)
398 (setf (aref *format-directive-interpreters
*
399 (char-code (char-upcase char
)))
403 (defun find-directive (directives kind stop-at-semi
)
405 (let ((next (car directives
)))
406 (if (format-directive-p next
)
407 (let ((char (format-directive-character next
)))
408 (if (or (char= kind char
)
409 (and stop-at-semi
(char= char
#\
;)))
412 (cdr (flet ((after (char)
413 (member (find-directive (cdr directives
)
424 (find-directive (cdr directives
) kind stop-at-semi
)))))
428 ;;;; format directives for simple output
430 (def-format-directive #\A
(colonp atsignp params
)
432 (expand-bind-defaults ((mincol 0) (colinc 1) (minpad 0)
435 `(format-princ stream
,(expand-next-arg) ',colonp
',atsignp
436 ,mincol
,colinc
,minpad
,padchar
))
438 `(or ,(expand-next-arg) "()")
442 (def-format-directive #\S
(colonp atsignp params
)
444 (expand-bind-defaults ((mincol 0) (colinc 1) (minpad 0)
447 `(format-prin1 stream
,(expand-next-arg) ,colonp
,atsignp
448 ,mincol
,colinc
,minpad
,padchar
)))
450 `(let ((arg ,(expand-next-arg)))
453 (princ "()" stream
))))
455 `(prin1 ,(expand-next-arg) stream
))))
457 (def-format-directive #\C
(colonp atsignp params
)
458 (expand-bind-defaults () params
460 `(format-print-named-character ,(expand-next-arg) stream
)
462 `(prin1 ,(expand-next-arg) stream
)
463 `(write-char ,(expand-next-arg) stream
)))))
465 (def-format-directive #\W
(colonp atsignp params
)
466 (expand-bind-defaults () params
467 (if (or colonp atsignp
)
468 `(let (,@(when colonp
469 '((*print-pretty
* t
)))
471 '((*print-level
* nil
)
472 (*print-length
* nil
))))
473 (output-object ,(expand-next-arg) stream
))
474 `(output-object ,(expand-next-arg) stream
))))
476 ;;;; format directives for integer output
478 (defun expand-format-integer (base colonp atsignp params
)
479 (if (or colonp atsignp params
)
480 (expand-bind-defaults
481 ((mincol 0) (padchar #\space
) (commachar #\
,) (commainterval 3))
483 `(format-print-integer stream
,(expand-next-arg) ,colonp
,atsignp
484 ,base
,mincol
,padchar
,commachar
486 `(let ((*print-base
* ,base
)
488 (*print-escape
* nil
))
489 (output-object ,(expand-next-arg) stream
))))
491 (def-format-directive #\D
(colonp atsignp params
)
492 (expand-format-integer 10 colonp atsignp params
))
494 (def-format-directive #\B
(colonp atsignp params
)
495 (expand-format-integer 2 colonp atsignp params
))
497 (def-format-directive #\O
(colonp atsignp params
)
498 (expand-format-integer 8 colonp atsignp params
))
500 (def-format-directive #\X
(colonp atsignp params
)
501 (expand-format-integer 16 colonp atsignp params
))
503 (def-format-directive #\R
(colonp atsignp params
)
504 (expand-bind-defaults
505 ((base nil
) (mincol 0) (padchar #\space
) (commachar #\
,)
508 (let ((n-arg (gensym)))
509 `(let ((,n-arg
,(expand-next-arg)))
511 (format-print-integer stream
,n-arg
,colonp
,atsignp
513 ,padchar
,commachar
,commainterval
)
516 `(format-print-old-roman stream
,n-arg
)
517 `(format-print-roman stream
,n-arg
))
519 `(format-print-ordinal stream
,n-arg
)
520 `(format-print-cardinal stream
,n-arg
))))))))
522 ;;;; format directive for pluralization
524 (def-format-directive #\P
(colonp atsignp params end
)
525 (expand-bind-defaults () params
529 (*orig-args-available
*
530 `(if (eq orig-args args
)
532 :complaint
"no previous argument"
534 (do ((arg-ptr orig-args
(cdr arg-ptr
)))
535 ((eq (cdr arg-ptr
) args
)
538 (unless *simple-args
*
540 :complaint
"no previous argument"))
541 (caar *simple-args
*))
543 (/show0
"THROWing NEED-ORIG-ARGS from tilde-P")
544 (throw 'need-orig-args nil
)))))
546 `(write-string (if (eql ,arg
1) "y" "ies") stream
)
547 `(unless (eql ,arg
1) (write-char #\s stream
))))))
549 ;;;; format directives for floating point output
551 (def-format-directive #\F
(colonp atsignp params
)
555 "The colon modifier cannot be used with this directive."))
556 (expand-bind-defaults ((w nil
) (d nil
) (k nil
) (ovf nil
) (pad #\space
)) params
557 `(format-fixed stream
,(expand-next-arg) ,w
,d
,k
,ovf
,pad
,atsignp
)))
559 (def-format-directive #\E
(colonp atsignp params
)
563 "The colon modifier cannot be used with this directive."))
564 (expand-bind-defaults
565 ((w nil
) (d nil
) (e nil
) (k 1) (ovf nil
) (pad #\space
) (mark nil
))
567 `(format-exponential stream
,(expand-next-arg) ,w
,d
,e
,k
,ovf
,pad
,mark
570 (def-format-directive #\G
(colonp atsignp params
)
574 "The colon modifier cannot be used with this directive."))
575 (expand-bind-defaults
576 ((w nil
) (d nil
) (e nil
) (k nil
) (ovf nil
) (pad #\space
) (mark nil
))
578 `(format-general stream
,(expand-next-arg) ,w
,d
,e
,k
,ovf
,pad
,mark
,atsignp
)))
580 (def-format-directive #\$
(colonp atsignp params
)
581 (expand-bind-defaults ((d 2) (n 1) (w 0) (pad #\space
)) params
582 `(format-dollars stream
,(expand-next-arg) ,d
,n
,w
,pad
,colonp
585 ;;;; format directives for line/page breaks etc.
587 (def-format-directive #\%
(colonp atsignp params
)
588 (when (or colonp atsignp
)
591 "The colon and atsign modifiers cannot be used with this directive."
594 (expand-bind-defaults ((count 1)) params
599 (def-format-directive #\
& (colonp atsignp params
)
600 (when (or colonp atsignp
)
603 "The colon and atsign modifiers cannot be used with this directive."
606 (expand-bind-defaults ((count 1)) params
609 (dotimes (i (1- ,count
))
611 '(fresh-line stream
)))
613 (def-format-directive #\|
(colonp atsignp params
)
614 (when (or colonp atsignp
)
617 "The colon and atsign modifiers cannot be used with this directive."
620 (expand-bind-defaults ((count 1)) params
622 (write-char (code-char form-feed-char-code
) stream
)))
623 '(write-char (code-char form-feed-char-code
) stream
)))
625 (def-format-directive #\~
(colonp atsignp params
)
626 (when (or colonp atsignp
)
629 "The colon and atsign modifiers cannot be used with this directive."
632 (expand-bind-defaults ((count 1)) params
634 (write-char #\~ stream
)))
635 '(write-char #\~ stream
)))
637 (def-complex-format-directive #\newline
(colonp atsignp params directives
)
638 (when (and colonp atsignp
)
640 :complaint
"both colon and atsign modifiers used simultaneously"))
641 (values (expand-bind-defaults () params
643 '(write-char #\newline stream
)
645 (if (and (not colonp
)
647 (simple-string-p (car directives
)))
648 (cons (string-left-trim *format-whitespace-chars
*
653 ;;;; format directives for tabs and simple pretty printing
655 (def-format-directive #\T
(colonp atsignp params
)
657 (expand-bind-defaults ((n 1) (m 1)) params
658 `(pprint-tab ,(if atsignp
:section-relative
:section
)
661 (expand-bind-defaults ((colrel 1) (colinc 1)) params
662 `(format-relative-tab stream
,colrel
,colinc
))
663 (expand-bind-defaults ((colnum 1) (colinc 1)) params
664 `(format-absolute-tab stream
,colnum
,colinc
)))))
666 (def-format-directive #\_
(colonp atsignp params
)
667 (expand-bind-defaults () params
668 `(pprint-newline ,(if colonp
677 (def-format-directive #\I
(colonp atsignp params
)
681 "cannot use the at-sign modifier with this directive"))
682 (expand-bind-defaults ((n 0)) params
683 `(pprint-indent ,(if colonp
:current
:block
) ,n stream
)))
685 ;;;; format directive for ~*
687 (def-format-directive #\
* (colonp atsignp params end
)
692 "both colon and atsign modifiers used simultaneously")
693 (expand-bind-defaults ((posn 0)) params
694 (unless *orig-args-available
*
695 (/show0
"THROWing NEED-ORIG-ARGS from tilde-@*")
696 (throw 'need-orig-args nil
))
697 `(if (<= 0 ,posn
(length orig-args
))
698 (setf args
(nthcdr ,posn orig-args
))
700 :complaint
"Index ~W out of bounds. Should have been ~
702 :args
(list ,posn
(length orig-args
))
703 :offset
,(1- end
)))))
705 (expand-bind-defaults ((n 1)) params
706 (unless *orig-args-available
*
707 (/show0
"THROWing NEED-ORIG-ARGS from tilde-:*")
708 (throw 'need-orig-args nil
))
709 `(do ((cur-posn 0 (1+ cur-posn
))
710 (arg-ptr orig-args
(cdr arg-ptr
)))
712 (let ((new-posn (- cur-posn
,n
)))
713 (if (<= 0 new-posn
(length orig-args
))
714 (setf args
(nthcdr new-posn orig-args
))
717 "Index ~W is out of bounds; should have been ~
719 :args
(list new-posn
(length orig-args
))
720 :offset
,(1- end
)))))))
722 (expand-bind-defaults ((n 1)) params
723 (setf *only-simple-args
* nil
)
726 (expand-next-arg)))))
728 ;;;; format directive for indirection
730 (def-format-directive #\? (colonp atsignp params string end
)
733 :complaint
"cannot use the colon modifier with this directive"))
734 (expand-bind-defaults () params
740 "~A~%while processing indirect format string:"
741 :args
(list condition
)
743 :control-string
,string
744 :offset
,(1- end
)))))
746 (if *orig-args-available
*
747 `(setf args
(%format stream
,(expand-next-arg) orig-args args
))
748 (throw 'need-orig-args nil
))
749 `(%format stream
,(expand-next-arg) ,(expand-next-arg))))))
751 ;;;; format directives for capitalization
753 (def-complex-format-directive #\
( (colonp atsignp params directives
)
754 (let ((close (find-directive directives
#\
) nil
)))
757 :complaint
"no corresponding close parenthesis"))
758 (let* ((posn (position close directives
))
759 (before (subseq directives
0 posn
))
760 (after (nthcdr (1+ posn
) directives
)))
762 (expand-bind-defaults () params
763 `(let ((stream (make-case-frob-stream stream
771 ,@(expand-directive-list before
)))
774 (def-complex-format-directive #\
) ()
776 :complaint
"no corresponding open parenthesis"))
778 ;;;; format directives and support functions for conditionalization
780 (def-complex-format-directive #\
[ (colonp atsignp params directives
)
781 (multiple-value-bind (sublists last-semi-with-colon-p remaining
)
782 (parse-conditional-directive directives
)
788 "both colon and atsign modifiers used simultaneously")
792 "Can only specify one section")
793 (expand-bind-defaults () params
794 (expand-maybe-conditional (car sublists
)))))
796 (if (= (length sublists
) 2)
797 (expand-bind-defaults () params
798 (expand-true-false-conditional (car sublists
)
802 "must specify exactly two sections"))
803 (expand-bind-defaults ((index nil
)) params
804 (setf *only-simple-args
* nil
)
806 (case `(or ,index
,(expand-next-arg))))
807 (when last-semi-with-colon-p
808 (push `(t ,@(expand-directive-list (pop sublists
)))
810 (let ((count (length sublists
)))
811 (dolist (sublist sublists
)
812 (push `(,(decf count
)
813 ,@(expand-directive-list sublist
))
815 `(case ,case
,@clauses
)))))
818 (defun parse-conditional-directive (directives)
820 (last-semi-with-colon-p nil
)
821 (remaining directives
))
823 (let ((close-or-semi (find-directive remaining
#\
] t
)))
824 (unless close-or-semi
826 :complaint
"no corresponding close bracket"))
827 (let ((posn (position close-or-semi remaining
)))
828 (push (subseq remaining
0 posn
) sublists
)
829 (setf remaining
(nthcdr (1+ posn
) remaining
))
830 (when (char= (format-directive-character close-or-semi
) #\
])
832 (setf last-semi-with-colon-p
833 (format-directive-colonp close-or-semi
)))))
834 (values sublists last-semi-with-colon-p remaining
)))
836 (defun expand-maybe-conditional (sublist)
838 `(let ((prev-args args
)
839 (arg ,(expand-next-arg)))
841 (setf args prev-args
)
842 ,@(expand-directive-list sublist
)))))
843 (if *only-simple-args
*
844 (multiple-value-bind (guts new-args
)
845 (let ((*simple-args
* *simple-args
*))
846 (values (expand-directive-list sublist
)
848 (cond ((and new-args
(eq *simple-args
* (cdr new-args
)))
849 (setf *simple-args
* new-args
)
850 `(when ,(caar new-args
)
853 (setf *only-simple-args
* nil
)
857 (defun expand-true-false-conditional (true false
)
858 (let ((arg (expand-next-arg)))
862 ,@(expand-directive-list true
))
864 ,@(expand-directive-list false
)))))
865 (if *only-simple-args
*
866 (multiple-value-bind (true-guts true-args true-simple
)
867 (let ((*simple-args
* *simple-args
*)
868 (*only-simple-args
* t
))
869 (values (expand-directive-list true
)
872 (multiple-value-bind (false-guts false-args false-simple
)
873 (let ((*simple-args
* *simple-args
*)
874 (*only-simple-args
* t
))
875 (values (expand-directive-list false
)
878 (if (= (length true-args
) (length false-args
))
882 ,(do ((false false-args
(cdr false
))
883 (true true-args
(cdr true
))
884 (bindings nil
(cons `(,(caar false
) ,(caar true
))
886 ((eq true
*simple-args
*)
887 (setf *simple-args
* true-args
)
888 (setf *only-simple-args
*
889 (and true-simple false-simple
))
896 (setf *only-simple-args
* nil
)
900 (def-complex-format-directive #\
; ()
903 "~~; directive not contained within either ~~[...~~] or ~~<...~~>"))
905 (def-complex-format-directive #\
] ()
908 "no corresponding open bracket"))
910 ;;;; format directive for up-and-out
912 (def-format-directive #\^
(colonp atsignp params
)
915 :complaint
"cannot use the at-sign modifier with this directive"))
916 (when (and colonp
(not *up-up-and-out-allowed
*))
918 :complaint
"attempt to use ~~:^ outside a ~~:{...~~} construct"))
919 `(when ,(expand-bind-defaults ((arg1 nil
) (arg2 nil
) (arg3 nil
)) params
920 `(cond (,arg3
(<= ,arg1
,arg2
,arg3
))
921 (,arg2
(eql ,arg1
,arg2
))
922 (,arg1
(eql ,arg1
0))
926 (setf *only-simple-args
* nil
)
929 '(return-from outside-loop nil
)
932 ;;;; format directives for iteration
934 (def-complex-format-directive #\
{ (colonp atsignp params string end directives
)
935 (let ((close (find-directive directives
#\
} nil
)))
938 :complaint
"no corresponding close brace"))
939 (let* ((closed-with-colon (format-directive-colonp close
))
940 (posn (position close directives
)))
944 (if *orig-args-available
*
950 "~A~%while processing indirect format string:"
951 :args
(list condition
)
953 :control-string
,string
954 :offset
,(1- end
)))))
956 (%format stream inside-string orig-args args
))))
957 (throw 'need-orig-args nil
))
958 (let ((*up-up-and-out-allowed
* colonp
))
959 (expand-directive-list (subseq directives
0 posn
)))))
960 (compute-loop (count)
962 (setf *only-simple-args
* nil
))
964 ,@(unless closed-with-colon
968 `((when (and ,count
(minusp (decf ,count
)))
971 (let ((*expander-next-arg-macro
* 'expander-next-arg
)
972 (*only-simple-args
* nil
)
973 (*orig-args-available
* t
))
974 `((let* ((orig-args ,(expand-next-arg))
977 (declare (ignorable orig-args outside-args args
))
979 ,@(compute-insides)))))
981 ,@(when closed-with-colon
984 (compute-block (count)
987 ,(compute-loop count
))
988 (compute-loop count
)))
989 (compute-bindings (count)
991 (compute-block count
)
992 `(let* ((orig-args ,(expand-next-arg))
994 (declare (ignorable orig-args args
))
995 ,(let ((*expander-next-arg-macro
* 'expander-next-arg
)
996 (*only-simple-args
* nil
)
997 (*orig-args-available
* t
))
998 (compute-block count
))))))
1000 (expand-bind-defaults ((count nil
)) params
1002 `(let ((inside-string ,(expand-next-arg)))
1003 ,(compute-bindings count
))
1004 (compute-bindings count
)))
1006 `(let ((inside-string ,(expand-next-arg)))
1007 ,(compute-bindings nil
))
1008 (compute-bindings nil
)))
1009 (nthcdr (1+ posn
) directives
))))))
1011 (def-complex-format-directive #\
} ()
1012 (error 'format-error
1013 :complaint
"no corresponding open brace"))
1015 ;;;; format directives and support functions for justification
1017 (defparameter *illegal-inside-justification
*
1018 (mapcar (lambda (x) (parse-directive x
0))
1019 '("~W" "~:W" "~@W" "~:@W"
1020 "~_" "~:_" "~@_" "~:@_"
1022 "~I" "~:I" "~@I" "~:@I"
1025 (defun illegal-inside-justification-p (directive)
1026 (member directive
*illegal-inside-justification
*
1028 (and (format-directive-p x
)
1029 (format-directive-p y
)
1030 (eql (format-directive-character x
) (format-directive-character y
))
1031 (eql (format-directive-colonp x
) (format-directive-colonp y
))
1032 (eql (format-directive-atsignp x
) (format-directive-atsignp y
))))))
1034 (def-complex-format-directive #\
< (colonp atsignp params string end directives
)
1035 (multiple-value-bind (segments first-semi close remaining
)
1036 (parse-format-justification directives
)
1038 (if (format-directive-colonp close
)
1039 (multiple-value-bind (prefix per-line-p insides suffix
)
1040 (parse-format-logical-block segments colonp first-semi
1041 close params string end
)
1042 (expand-format-logical-block prefix per-line-p insides
1044 (let ((count (reduce #'+ (mapcar (lambda (x) (count-if #'illegal-inside-justification-p x
)) segments
))))
1046 ;; ANSI specifies that "an error is signalled" in this
1048 (error 'format-error
1049 :complaint
"~D illegal directive~:P found inside justification block"
1051 :references
(list '(:ansi-cl
:section
(22 3 5 2)))))
1052 (expand-format-justification segments colonp atsignp
1053 first-semi params
)))
1056 (def-complex-format-directive #\
> ()
1057 (error 'format-error
1058 :complaint
"no corresponding open bracket"))
1060 (defun parse-format-logical-block
1061 (segments colonp first-semi close params string end
)
1063 (error 'format-error
1064 :complaint
"No parameters can be supplied with ~~<...~~:>."
1065 :offset
(caar params
)))
1066 (multiple-value-bind (prefix insides suffix
)
1067 (multiple-value-bind (prefix-default suffix-default
)
1068 (if colonp
(values "(" ")") (values "" ""))
1069 (flet ((extract-string (list prefix-p
)
1070 (let ((directive (find-if #'format-directive-p list
)))
1072 (error 'format-error
1074 "cannot include format directives inside the ~
1075 ~:[suffix~;prefix~] segment of ~~<...~~:>"
1076 :args
(list prefix-p
)
1077 :offset
(1- (format-directive-end directive
))
1079 (list '(:ansi-cl
:section
(22 3 5 2))))
1080 (apply #'concatenate
'string list
)))))
1081 (case (length segments
)
1082 (0 (values prefix-default nil suffix-default
))
1083 (1 (values prefix-default
(car segments
) suffix-default
))
1084 (2 (values (extract-string (car segments
) t
)
1085 (cadr segments
) suffix-default
))
1086 (3 (values (extract-string (car segments
) t
)
1088 (extract-string (caddr segments
) nil
)))
1090 (error 'format-error
1091 :complaint
"too many segments for ~~<...~~:>")))))
1092 (when (format-directive-atsignp close
)
1094 (add-fill-style-newlines insides
1097 (format-directive-end first-semi
)
1100 (and first-semi
(format-directive-atsignp first-semi
))
1104 (defun add-fill-style-newlines (list string offset
&optional last-directive
)
1107 (let ((directive (car list
)))
1109 ((simple-string-p directive
)
1110 (let* ((non-space (position #\Space directive
:test
#'char
/=))
1111 (newlinep (and last-directive
1113 (format-directive-character last-directive
)
1116 ((and newlinep non-space
)
1118 (list (subseq directive
0 non-space
))
1119 (add-fill-style-newlines-aux
1120 (subseq directive non-space
) string
(+ offset non-space
))
1121 (add-fill-style-newlines
1122 (cdr list
) string
(+ offset
(length directive
)))))
1125 (add-fill-style-newlines
1126 (cdr list
) string
(+ offset
(length directive
)))))
1128 (nconc (add-fill-style-newlines-aux directive string offset
)
1129 (add-fill-style-newlines
1130 (cdr list
) string
(+ offset
(length directive
))))))))
1133 (add-fill-style-newlines
1135 (format-directive-end directive
) directive
))))))
1138 (defun add-fill-style-newlines-aux (literal string offset
)
1139 (let ((end (length literal
))
1141 (collect ((results))
1143 (let ((blank (position #\space literal
:start posn
)))
1145 (results (subseq literal posn
))
1147 (let ((non-blank (or (position #\space literal
:start blank
1150 (results (subseq literal posn non-blank
))
1151 (results (make-format-directive
1152 :string string
:character
#\_
1153 :start
(+ offset non-blank
) :end
(+ offset non-blank
)
1154 :colonp t
:atsignp nil
:params nil
))
1155 (setf posn non-blank
))
1160 (defun parse-format-justification (directives)
1161 (let ((first-semi nil
)
1163 (remaining directives
))
1164 (collect ((segments))
1166 (let ((close-or-semi (find-directive remaining
#\
> t
)))
1167 (unless close-or-semi
1168 (error 'format-error
1169 :complaint
"no corresponding close bracket"))
1170 (let ((posn (position close-or-semi remaining
)))
1171 (segments (subseq remaining
0 posn
))
1172 (setf remaining
(nthcdr (1+ posn
) remaining
)))
1173 (when (char= (format-directive-character close-or-semi
)
1175 (setf close close-or-semi
)
1178 (setf first-semi close-or-semi
))))
1179 (values (segments) first-semi close remaining
))))
1181 (sb!xc
:defmacro expander-pprint-next-arg
(string offset
)
1184 (error 'format-error
1185 :complaint
"no more arguments"
1186 :control-string
,string
1191 (defun expand-format-logical-block (prefix per-line-p insides suffix atsignp
)
1192 `(let ((arg ,(if atsignp
'args
(expand-next-arg))))
1194 (setf *only-simple-args
* nil
)
1196 (pprint-logical-block
1198 ,(if per-line-p
:per-line-prefix
:prefix
) ,prefix
1202 `((orig-args arg
))))
1203 (declare (ignorable args
,@(unless atsignp
'(orig-args))))
1205 ,@(let ((*expander-next-arg-macro
* 'expander-pprint-next-arg
)
1206 (*only-simple-args
* nil
)
1207 (*orig-args-available
*
1208 (if atsignp
*orig-args-available
* t
)))
1209 (expand-directive-list insides
)))))))
1211 (defun expand-format-justification (segments colonp atsignp first-semi params
)
1212 (let ((newline-segment-p
1214 (format-directive-colonp first-semi
))))
1215 (expand-bind-defaults
1216 ((mincol 0) (colinc 1) (minpad 0) (padchar #\space
))
1218 `(let ((segments nil
)
1219 ,@(when newline-segment-p
1220 '((newline-segment nil
)
1224 ,@(when newline-segment-p
1225 `((setf newline-segment
1226 (with-output-to-string (stream)
1227 ,@(expand-directive-list (pop segments
))))
1228 ,(expand-bind-defaults
1230 (line-len '(or (sb!impl
::line-length stream
) 72)))
1231 (format-directive-params first-semi
)
1232 `(setf extra-space
,extra line-len
,line-len
))))
1233 ,@(mapcar (lambda (segment)
1234 `(push (with-output-to-string (stream)
1235 ,@(expand-directive-list segment
))
1238 (format-justification stream
1239 ,@(if newline-segment-p
1240 '(newline-segment extra-space line-len
)
1242 segments
,colonp
,atsignp
1243 ,mincol
,colinc
,minpad
,padchar
)))))
1245 ;;;; format directive and support function for user-defined method
1247 (def-format-directive #\
/ (string start end colonp atsignp params
)
1248 (let ((symbol (extract-user-fun-name string start end
)))
1249 (collect ((param-names) (bindings))
1250 (dolist (param-and-offset params
)
1251 (let ((param (cdr param-and-offset
)))
1252 (let ((param-name (gensym)))
1253 (param-names param-name
)
1254 (bindings `(,param-name
1256 (:arg
(expand-next-arg))
1257 (:remaining
'(length args
))
1260 (,symbol stream
,(expand-next-arg) ,colonp
,atsignp
1261 ,@(param-names))))))
1263 (defun extract-user-fun-name (string start end
)
1264 (let ((slash (position #\
/ string
:start start
:end
(1- end
)
1267 (error 'format-error
1268 :complaint
"malformed ~~/ directive"))
1269 (let* ((name (string-upcase (let ((foo string
))
1270 ;; Hack alert: This is to keep the compiler
1271 ;; quiet about deleting code inside the
1272 ;; subseq expansion.
1273 (subseq foo
(1+ slash
) (1- end
)))))
1274 (first-colon (position #\
: name
))
1275 (second-colon (if first-colon
(position #\
: name
:start
(1+ first-colon
))))
1276 (package-name (if first-colon
1277 (subseq name
0 first-colon
)
1278 "COMMON-LISP-USER"))
1279 (package (find-package package-name
)))
1281 ;; FIXME: should be PACKAGE-ERROR? Could we just use
1282 ;; FIND-UNDELETED-PACKAGE-OR-LOSE?
1283 (error 'format-error
1284 :complaint
"no package named ~S"
1285 :args
(list package-name
)))
1287 ((and second-colon
(= second-colon
(1+ first-colon
)))
1288 (subseq name
(1+ second-colon
)))
1290 (subseq name
(1+ first-colon
)))
1294 ;;; compile-time checking for argument mismatch. This code is
1295 ;;; inspired by that of Gerd Moellmann, and comes decorated with
1297 (defun %compiler-walk-format-string
(string args
)
1298 (declare (type simple-string string
))
1299 (let ((*default-format-error-control-string
* string
))
1300 (macrolet ((incf-both (&optional
(increment 1))
1302 (incf min
,increment
)
1303 (incf max
,increment
)))
1304 (walk-complex-directive (function)
1305 `(multiple-value-bind (min-inc max-inc remaining
)
1306 (,function directive directives args
)
1309 (setq directives remaining
))))
1310 ;; FIXME: these functions take a list of arguments as well as
1311 ;; the directive stream. This is to enable possibly some
1312 ;; limited type checking on FORMAT's arguments, as well as
1313 ;; simple argument count mismatch checking: when the minimum and
1314 ;; maximum argument counts are the same at a given point, we
1315 ;; know which argument is going to be used for a given
1316 ;; directive, and some (annotated below) require arguments of
1317 ;; particular types.
1319 ((walk-justification (justification directives args
)
1320 (declare (ignore args
))
1321 (let ((*default-format-error-offset
*
1322 (1- (format-directive-end justification
))))
1323 (multiple-value-bind (segments first-semi close remaining
)
1324 (parse-format-justification directives
)
1325 (declare (ignore segments first-semi
))
1327 ((not (format-directive-colonp close
))
1328 (values 0 0 directives
))
1329 ((format-directive-atsignp justification
)
1330 (values 0 sb
!xc
:call-arguments-limit directives
))
1331 ;; FIXME: here we could assert that the
1332 ;; corresponding argument was a list.
1333 (t (values 1 1 remaining
))))))
1334 (walk-conditional (conditional directives args
)
1335 (let ((*default-format-error-offset
*
1336 (1- (format-directive-end conditional
))))
1337 (multiple-value-bind (sublists last-semi-with-colon-p remaining
)
1338 (parse-conditional-directive directives
)
1339 (declare (ignore last-semi-with-colon-p
))
1341 (loop for s in sublists
1343 1 (walk-directive-list s args
)))))
1345 ((format-directive-atsignp conditional
)
1346 (values 1 (max 1 sub-max
) remaining
))
1347 ((loop for p in
(format-directive-params conditional
)
1348 thereis
(or (integerp (cdr p
))
1349 (memq (cdr p
) '(:remaining
:arg
))))
1350 (values 0 sub-max remaining
))
1351 ;; FIXME: if not COLONP, then the next argument
1352 ;; must be a number.
1353 (t (values 1 (1+ sub-max
) remaining
)))))))
1354 (walk-iteration (iteration directives args
)
1355 (declare (ignore args
))
1356 (let ((*default-format-error-offset
*
1357 (1- (format-directive-end iteration
))))
1358 (let* ((close (find-directive directives
#\
} nil
))
1359 (posn (or (position close directives
)
1360 (error 'format-error
1361 :complaint
"no corresponding close brace")))
1362 (remaining (nthcdr (1+ posn
) directives
)))
1363 ;; FIXME: if POSN is zero, the next argument must be
1364 ;; a format control (either a function or a string).
1365 (if (format-directive-atsignp iteration
)
1366 (values (if (zerop posn
) 1 0)
1367 sb
!xc
:call-arguments-limit
1369 ;; FIXME: the argument corresponding to this
1370 ;; directive must be a list.
1371 (let ((nreq (if (zerop posn
) 2 1)))
1372 (values nreq nreq remaining
))))))
1373 (walk-directive-list (directives args
)
1374 (let ((min 0) (max 0))
1376 (let ((directive (pop directives
)))
1377 (when (null directive
)
1378 (return (values min
(min max sb
!xc
:call-arguments-limit
))))
1379 (when (format-directive-p directive
)
1380 (incf-both (count :arg
(format-directive-params directive
)
1382 (let ((c (format-directive-character directive
)))
1384 ((find c
"ABCDEFGORSWX$/")
1387 (unless (format-directive-colonp directive
)
1389 ((or (find c
"IT%&|_();>~") (char= c
#\Newline
)))
1390 ;; FIXME: check correspondence of ~( and ~)
1392 (walk-complex-directive walk-justification
))
1394 (walk-complex-directive walk-conditional
))
1396 (walk-complex-directive walk-iteration
))
1398 ;; FIXME: the argument corresponding to this
1399 ;; directive must be a format control.
1401 ((format-directive-atsignp directive
)
1403 (setq max sb
!xc
:call-arguments-limit
))
1405 (t (throw 'give-up-format-string-walk nil
))))))))))
1406 (catch 'give-up-format-string-walk
1407 (let ((directives (tokenize-control-string string
)))
1408 (walk-directive-list directives args
)))))))