1 ;;; gnus-spec.el --- format spec functions for Gnus -*- coding: iso-latin-1 -*-
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001
3 ;; Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Katsumi Yamaoka <yamaoka@jpl.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
30 (eval-when-compile (require 'cl))
35 (defcustom gnus-use-correct-string-widths t
36 "*If non-nil, use correct functions for dealing with wide characters."
40 ;;; Internal variables.
42 (defvar gnus-summary-mark-positions nil)
43 (defvar gnus-group-mark-positions nil)
44 (defvar gnus-group-indentation "")
46 ;; Format specs. The chunks below are the machine-generated forms
47 ;; that are to be evaled as the result of the default format strings.
48 ;; We write them in here to get them byte-compiled. That way the
49 ;; default actions will be quite fast, while still retaining the full
50 ;; flexibility of the user-defined format specs.
52 ;; First we have lots of dummy defvars to let the compiler know these
53 ;; are really dynamic variables.
55 (defvar gnus-tmp-unread)
56 (defvar gnus-tmp-replied)
57 (defvar gnus-tmp-score-char)
58 (defvar gnus-tmp-indentation)
59 (defvar gnus-tmp-opening-bracket)
60 (defvar gnus-tmp-lines)
61 (defvar gnus-tmp-name)
62 (defvar gnus-tmp-closing-bracket)
63 (defvar gnus-tmp-subject-or-nil)
64 (defvar gnus-tmp-subject)
65 (defvar gnus-tmp-marked)
66 (defvar gnus-tmp-marked-mark)
67 (defvar gnus-tmp-subscribed)
68 (defvar gnus-tmp-process-marked)
69 (defvar gnus-tmp-number-of-unread)
70 (defvar gnus-tmp-group-name)
71 (defvar gnus-tmp-group)
72 (defvar gnus-tmp-article-number)
73 (defvar gnus-tmp-unread-and-unselected)
74 (defvar gnus-tmp-news-method)
75 (defvar gnus-tmp-news-server)
76 (defvar gnus-tmp-article-number)
77 (defvar gnus-mouse-face)
78 (defvar gnus-mouse-face-prop)
80 (defun gnus-summary-line-format-spec ()
81 (insert gnus-tmp-unread gnus-tmp-replied
82 gnus-tmp-score-char gnus-tmp-indentation)
83 (gnus-put-text-property
87 gnus-tmp-opening-bracket
90 (if (> (length gnus-tmp-name) 20)
91 (substring gnus-tmp-name 0 20)
93 gnus-tmp-closing-bracket)
95 gnus-mouse-face-prop gnus-mouse-face)
96 (insert " " gnus-tmp-subject-or-nil "\n"))
98 (defvar gnus-summary-line-format-spec
99 (gnus-byte-code 'gnus-summary-line-format-spec))
101 (defun gnus-summary-dummy-line-format-spec ()
103 (gnus-put-text-property
108 gnus-mouse-face-prop gnus-mouse-face)
109 (insert " " gnus-tmp-subject "\n"))
111 (defvar gnus-summary-dummy-line-format-spec
112 (gnus-byte-code 'gnus-summary-dummy-line-format-spec))
114 (defun gnus-group-line-format-spec ()
115 (insert gnus-tmp-marked-mark gnus-tmp-subscribed
116 gnus-tmp-process-marked
117 gnus-group-indentation
118 (format "%5s: " gnus-tmp-number-of-unread))
119 (gnus-put-text-property
122 (insert gnus-tmp-group "\n")
124 gnus-mouse-face-prop gnus-mouse-face))
125 (defvar gnus-group-line-format-spec
126 (gnus-byte-code 'gnus-group-line-format-spec))
128 (defvar gnus-format-specs
129 `((group ("%M\%S\%p\%P\%5y: %(%g%)%l\n" ,gnus-group-line-format-spec))
130 (summary-dummy ("* %(: :%) %S\n"
131 ,gnus-summary-dummy-line-format-spec))
132 (summary ("%U\%R\%z\%I\%(%[%4L: %-23,23n%]%) %s\n"
133 ,gnus-summary-line-format-spec)))
134 "Alist of format specs.")
136 (defvar gnus-format-specs-compiled nil
137 "Alist of compiled format specs. Each element should be the form:
138 \(TYPE (FORMAT-STRING-1 . COMPILED-FUNCTION-1)
140 (FORMAT-STRING-n . COMPILED-FUNCTION-n)).")
142 (defvar gnus-article-mode-line-format-spec nil)
143 (defvar gnus-summary-mode-line-format-spec nil)
144 (defvar gnus-group-mode-line-format-spec nil)
146 ;;; Phew. All that gruft is over with, fortunately.
149 (defun gnus-update-format (var)
150 "Update the format specification near point."
155 ;; Find the end of the current word.
156 (re-search-forward "[ \t\n]" nil t)
158 (when (re-search-backward "\\(gnus-[-a-z]+-line-format\\)" nil t)
160 (let* ((type (intern (progn (string-match "gnus-\\([-a-z]+\\)-line" var)
161 (match-string 1 var))))
162 (value (symbol-value (intern var)))
164 (intern (format "%s-spec" var))
166 value (symbol-value (intern (format "%s-alist" var)))
167 (not (string-match "mode" var)))))
168 (entry (assq type gnus-format-specs)))
170 (let ((elem (assoc value entry)))
173 (setcdr entry (cons (cons value elem) (cdr entry)))))
174 (push (list type (cons value spec)) gnus-format-specs))
175 (gnus-product-variable-touch 'gnus-format-specs)
177 (pop-to-buffer "*Gnus Format*")
179 (lisp-interaction-mode)
180 (insert (pp-to-string spec))))
182 (put 'gnus-search-or-regist-spec 'lisp-indent-function 1)
183 (defmacro gnus-search-or-regist-spec (mspec &rest body)
184 (let ((specs (nth 0 mspec)) (type (nth 1 mspec)) (format (nth 2 mspec))
185 (spec (nth 3 mspec)) (entry (nth 4 mspec)) (elem (nth 5 mspec)))
186 `(let* ((,entry (assq ,type ,specs))
187 (,elem (assoc ,format (cdr ,entry))))
193 (setcdr ,entry (cons (cons ,format ,spec) (cdr ,entry))))
194 (push (list ,type (cons ,format ,spec)) ,specs))
195 (gnus-product-variable-touch (quote ,specs)))
198 (defun gnus-update-format-specification-1 (type format val)
199 (set (intern (format "gnus-%s-line-format-spec" type))
200 (gnus-search-or-regist-spec (gnus-format-specs-compiled
201 type format val entry elem)
202 (when (and gnus-compile-user-specs val)
205 (fset 'gnus-tmp-func `(lambda () ,val))
207 (let (byte-compile-warnings)
208 (byte-compile 'gnus-tmp-func))
209 (gnus-byte-code 'gnus-tmp-func))
210 (when (get-buffer "*Compile-Log*")
211 (bury-buffer "*Compile-Log*"))
212 (when (get-buffer "*Compile-Log-Show*")
213 (bury-buffer "*Compile-Log-Show*"))))))))
215 (defun gnus-update-format-specifications (&optional force &rest types)
216 "Update all (necessary) format specifications."
217 ;; Make the indentation array.
218 ;; See whether all the stored info needs to be flushed.
220 (message "%s" "Force update format specs.")
221 (setq gnus-format-specs nil
222 gnus-format-specs-compiled nil)
223 (gnus-product-variable-touch 'gnus-format-specs
224 'gnus-format-specs-compiled))
226 ;; Go through all the formats and see whether they need updating.
229 (while (setq type (pop types))
230 ;; Jump to the proper buffer to find out the value of the
231 ;; variable, if possible. (It may be buffer-local.)
233 (let ((buffer (intern (format "gnus-%s-buffer" type))))
234 (when (and (boundp buffer)
235 (setq val (symbol-value buffer))
236 (gnus-buffer-exists-p val))
239 (intern (format "gnus-%s-line-format" type))))))
240 (or (gnus-update-format-specification-1 type new-format nil)
241 ;; This is a new format.
242 (gnus-update-format-specification-1
244 (gnus-search-or-regist-spec (gnus-format-specs
245 type new-format val entry elem)
246 (setq val (if (stringp new-format)
247 ;; This is a "real" format.
251 (intern (format "gnus-%s-line-format-alist"
253 (not (string-match "mode$"
254 (symbol-name type))))
255 ;; This is a function call or something.
258 (defvar gnus-mouse-face-0 'highlight)
259 (defvar gnus-mouse-face-1 'highlight)
260 (defvar gnus-mouse-face-2 'highlight)
261 (defvar gnus-mouse-face-3 'highlight)
262 (defvar gnus-mouse-face-4 'highlight)
264 (defun gnus-mouse-face-function (form type)
265 `(gnus-put-text-property
266 (point) (progn ,@form (point))
270 `(quote ,(symbol-value (intern (format "gnus-mouse-face-%d" type)))))))
272 (defvar gnus-face-0 'bold)
273 (defvar gnus-face-1 'italic)
274 (defvar gnus-face-2 'bold-italic)
275 (defvar gnus-face-3 'bold)
276 (defvar gnus-face-4 'bold)
278 (defun gnus-face-face-function (form type)
279 `(gnus-add-text-properties
280 (point) (progn ,@form (point))
281 '(gnus-face t face ,(symbol-value (intern (format "gnus-face-%d" type))))))
283 (defun gnus-balloon-face-function (form type)
284 `(gnus-put-text-property
285 (point) (progn ,@form (point))
287 ,(intern (format "gnus-balloon-face-%d" type))))
289 (defun gnus-spec-tab (column)
291 `(insert (make-string (max (- ,column (current-column)) 0) ? ))
293 (if (> (current-column) ,(abs column))
294 (delete-region (point)
295 (- (point) (- (current-column) ,(abs column))))
296 (insert (make-string (max (- ,(abs column) (current-column)) 0)
299 (defun gnus-correct-length (string)
300 "Return the correct width of STRING."
302 (mapcar (lambda (char) (incf length (gnus-char-width char))) string)
305 (defun gnus-correct-substring (string start &optional end)
310 (length (length string))
311 (string (concat string "\0")))
312 ;; Find the start position.
313 (while (and (< seek length)
315 (incf wseek (gnus-char-width (aref string seek)))
318 ;; Find the end position.
319 (while (and (<= seek length)
322 (incf wseek (gnus-char-width (aref string seek)))
325 (substring string wstart (1- wend))))
327 (defun gnus-tilde-max-form (el max-width)
328 "Return a form that limits EL to MAX-WIDTH."
329 (let ((max (abs max-width))
330 (length-fun (if gnus-use-correct-string-widths
333 (substring-fun (if gnus-use-correct-string-widths
334 'gnus-correct-substring
337 `(if (> (,length-fun ,el) ,max)
339 `(,substring-fun ,el (- (,length-fun ,el) ,max))
340 `(,substring-fun ,el 0 ,max))
342 `(let ((val (eval ,el)))
343 (if (> (,length-fun val) ,max)
345 `(,substring-fun val (- (,length-fun val) ,max))
346 `(,substring-fun val 0 ,max))
349 (defun gnus-tilde-cut-form (el cut-width)
350 "Return a form that cuts CUT-WIDTH off of EL."
351 (let ((cut (abs cut-width))
352 (length-fun (if gnus-use-correct-string-widths
355 (substring-fun (if gnus-use-correct-string-widths
356 'gnus-correct-substring
359 `(if (> (,length-fun ,el) ,cut)
361 `(,substring-fun ,el 0 (- (,length-fun ,el) ,cut))
362 `(,substring-fun ,el ,cut))
364 `(let ((val (eval ,el)))
365 (if (> (,length-fun val) ,cut)
367 `(,substring-fun val 0 (- (,length-fun val) ,cut))
368 `(,substring-fun val ,cut))
371 (defun gnus-tilde-ignore-form (el ignore-value)
372 "Return a form that is blank when EL is IGNORE-VALUE."
374 `(if (equal ,el ,ignore-value)
376 `(let ((val (eval ,el)))
377 (if (equal val ,ignore-value)
380 (defun gnus-correct-pad-form (el pad-width)
381 "Return a form that pads EL to PAD-WIDTH accounting for multi-column
382 characters correctly. This is because `format' may pad to columns or to
383 characters when given a pad value."
384 (let ((pad (abs pad-width))
385 (side (< 0 pad-width)))
387 `(let ((need (- ,pad (gnus-correct-length ,el))))
389 (concat ,(when side '(make-string need ?\ ))
391 ,(when (not side) '(make-string need ?\ )))
393 `(let* ((val (eval ,el))
394 (need (- ,pad (gnus-correct-length ,el))))
396 (concat ,(when side '(make-string need ?\ ))
398 ,(when (not side) '(make-string need ?\ )))
401 (defun gnus-parse-format (format spec-alist &optional insert)
402 ;; This function parses the FORMAT string with the help of the
403 ;; SPEC-ALIST and returns a list that can be eval'ed to return the
404 ;; string. If the FORMAT string contains the specifiers %( and %)
405 ;; the text between them will have the mouse-face text property.
406 ;; If the FORMAT string contains the specifiers %[ and %], the text between
407 ;; them will have the balloon-help text property.
408 (let ((case-fold-search nil))
410 "\\`\\(.*\\)%[0-9]?[{(«]\\(.*\\)%[0-9]?[»})]\\(.*\n?\\)\\'"
412 (gnus-parse-complex-format format spec-alist)
413 ;; This is a simple format.
414 (gnus-parse-simple-format format spec-alist insert))))
416 (defun gnus-parse-complex-format (format spec-alist)
419 (gnus-set-work-buffer)
421 (goto-char (point-min))
422 (while (re-search-forward "\"" nil t)
423 (replace-match "\\\"" nil t))
424 (goto-char (point-min))
426 ;; Convert all font specs into font spec lists.
427 (while (re-search-forward "%\\([0-9]+\\)?\\([«»{}()]\\)" nil t)
428 (let ((number (if (match-beginning 1)
429 (match-string 1) "0"))
430 (delim (aref (match-string 2) 0)))
431 (if (or (= delim ?\()
434 (replace-match (concat "\"("
435 (cond ((= delim ?\() "mouse")
436 ((= delim ?\{) "face")
440 (replace-match "\")\""))))
441 (goto-char (point-max))
443 ;; Convert point position commands.
444 (goto-char (point-min))
445 (let ((case-fold-search nil))
446 (while (re-search-forward "%\\([-0-9]+\\)?C" nil t)
447 (replace-match "\"(point)\"" t t)
449 ;; Convert TAB commands.
450 (goto-char (point-min))
451 (while (re-search-forward "%\\([-0-9]+\\)=" nil t)
452 (replace-match (format "\"(tab %s)\"" (match-string 1)) t t))
453 ;; Convert the buffer into the spec.
454 (goto-char (point-min))
455 (let ((form (read (current-buffer))))
457 `(let (gnus-position)
458 ,@(gnus-complex-form-to-spec form spec-alist)
460 (gnus-put-text-property gnus-position (1+ gnus-position)
463 ,@(gnus-complex-form-to-spec form spec-alist)))))))
465 (defun gnus-complex-form-to-spec (form spec-alist)
471 (gnus-parse-simple-format sform spec-alist t))
472 ((eq (car sform) 'point)
473 '(setq gnus-position (point)))
474 ((eq (car sform) 'tab)
475 (gnus-spec-tab (cadr sform)))
477 (funcall (intern (format "gnus-%s-face-function" (car sform)))
478 (gnus-complex-form-to-spec (cddr sform) spec-alist)
482 (defun gnus-parse-simple-format (format spec-alist &optional insert)
483 ;; This function parses the FORMAT string with the help of the
484 ;; SPEC-ALIST and returns a list that can be eval'ed to return a
487 spec flist fstring elem result dontinsert user-defined
488 type value pad-width spec-beg cut-width ignore-value
489 tilde-form tilde elem-type extended-spec)
491 (gnus-set-work-buffer)
493 (goto-char (point-min))
494 (while (search-forward "%" nil t)
495 (setq user-defined nil
503 (setq spec-beg (1- (point)))
505 ;; Parse this spec fully.
508 ((looking-at "\\([-.0-9]+\\)\\(,[-0-9]+\\)?")
509 (setq pad-width (string-to-number (match-string 1)))
510 (when (match-beginning 2)
511 (setq max-width (string-to-number (buffer-substring
512 (1+ (match-beginning 2))
514 (goto-char (match-end 0)))
517 (setq tilde (read (current-buffer))
521 ((memq type '(pad pad-left))
522 (setq pad-width value))
523 ((eq type 'pad-right)
524 (setq pad-width (- value)))
525 ((memq type '(max-right max))
526 (setq max-width value))
528 (setq max-width (- value)))
529 ((memq type '(cut cut-left))
530 (setq cut-width value))
531 ((eq type 'cut-right)
532 (setq cut-width (- value)))
535 (if (stringp value) value (format "%s" value))))
537 (setq tilde-form value))
539 (error "Unknown tilde type: %s" tilde)))
544 ;; User-defined spec -- find the spec name.
545 ((eq (setq spec (char-after)) ?u)
547 (when (and (eq (setq user-defined (char-after)) ?&)
548 (looking-at "&\\([^;]+\\);"))
549 (setq user-defined (match-string 1))
550 (goto-char (match-end 1))))
552 ((and (eq spec ?&) (looking-at "&\\([^;]+\\);"))
553 (setq extended-spec (intern (match-string 1)))
554 (goto-char (match-end 1))))
556 (delete-region spec-beg (point))
558 ;; Now we have all the relevant data on this spec, so
559 ;; we start doing stuff.
562 ;; "%%" just results in a "%".
567 (setq elem (list tilde-form ?s)))
568 ;; Treat user defined format specifiers specially.
572 (list (intern (format
573 (if (stringp user-defined)
574 "gnus-user-format-function-%s"
575 "gnus-user-format-function-%c")
579 ;; Find the specification from `spec-alist'.
580 ((setq elem (cdr (assq (or extended-spec spec) spec-alist))))
582 (setq elem '("*" ?s))))
583 (setq elem-type (cadr elem))
584 ;; Insert the new format elements.
586 (not (and (featurep 'xemacs)
587 gnus-use-correct-string-widths)))
588 (insert (number-to-string pad-width)))
589 ;; Create the form to be evaled.
590 (if (or max-width cut-width ignore-value
591 (and (featurep 'xemacs)
592 gnus-use-correct-string-widths))
595 (let ((el (car elem)))
596 (cond ((= (cadr elem) ?c)
597 (setq el (list 'char-to-string el)))
599 (setq el (list 'int-to-string el))))
601 (setq el (gnus-tilde-ignore-form el ignore-value)))
603 (setq el (gnus-tilde-cut-form el cut-width)))
605 (setq el (gnus-tilde-max-form el max-width)))
607 (setq el (gnus-correct-pad-form el pad-width)))
610 (push (car elem) flist))))
611 (setq fstring (buffer-substring-no-properties (point-min) (point-max))))
613 ;; Do some postprocessing to increase efficiency.
618 ((string= fstring "")
620 ;; Not a format string.
621 ((not (string-match "%" fstring))
623 ;; A format string with just a single string spec.
624 ((string= fstring "%s")
626 ;; A single character.
627 ((string= fstring "%c")
630 ((string= fstring "%d")
633 (list `(princ ,(car flist)))
634 (list `(int-to-string ,(car flist)))))
635 ;; Just lots of chars and strings.
636 ((string-match "\\`\\(%[cs]\\)+\\'" fstring)
638 ;; A single string spec at the beginning of the spec.
639 ((string-match "\\`%[sc][^%]+\\'" fstring)
640 (list (car flist) (substring fstring 2)))
641 ;; A single string spec in the middle of the spec.
642 ((string-match "\\`\\([^%]+\\)%[sc]\\([^%]+\\)\\'" fstring)
643 (list (match-string 1 fstring) (car flist) (match-string 2 fstring)))
644 ;; A single string spec in the end of the spec.
645 ((string-match "\\`\\([^%]+\\)%[sc]\\'" fstring)
646 (list (match-string 1 fstring) (car flist)))
647 ;; A more complex spec.
649 (list (cons 'format (cons fstring (nreverse flist)))))))
655 (cons 'insert result)))
656 (cond ((stringp result)
659 (cons 'concat result))
662 (defun gnus-eval-format (format &optional alist props)
663 "Eval the format variable FORMAT, using ALIST.
664 If PROPS, insert the result."
665 (let ((form (gnus-parse-format format alist props)))
667 (gnus-add-text-properties (point) (progn (eval form) (point)) props)
670 (defun gnus-compile ()
671 "Byte-compile the user-defined format specs."
674 (let ((entries gnus-format-specs)
675 (byte-compile-warnings '(unresolved callargs redefine))
676 entry type compiled-function)
678 (gnus-message 7 "Compiling format specs...")
681 (setq entry (pop entries)
683 (if (memq type '(gnus-version version))
684 (setq gnus-format-specs (delq entry gnus-format-specs))
685 (let ((form (caddr entry)))
686 (when (and (listp form)
687 ;; Under GNU Emacs, it's (byte-code ...)
688 (not (eq 'byte-code (car form)))
689 ;; Under XEmacs, it's (funcall #<compiled-function ...>)
690 (not (and (eq 'funcall (car form))
691 (byte-code-function-p (cadr form)))))
692 (defalias 'gnus-tmp-func `(lambda () ,form))
693 (byte-compile 'gnus-tmp-func)
694 (setq compiled-function (gnus-byte-code 'gnus-tmp-func))
695 (set (intern (format "gnus-%s-line-format-spec" type))
697 (let ((elem (cdr (assq type gnus-format-specs-compiled))))
699 (set-alist 'elem (cadr entry) compiled-function)
700 (setq elem (list (cadr entry) compiled-function)))
701 (set-alist 'gnus-format-specs-compiled type elem))))))
703 (push (cons 'version emacs-version) gnus-format-specs)
704 (gnus-message 7 "Compiling user specs...done"))))
706 (defun gnus-set-format (type &optional insertable)
707 (set (intern (format "gnus-%s-line-format-spec" type))
709 (symbol-value (intern (format "gnus-%s-line-format" type)))
710 (symbol-value (intern (format "gnus-%s-line-format-alist" type)))
718 ;; coding: iso-8859-1
721 ;;; gnus-spec.el ends here