1 ;;; gnus-spec.el --- format spec functions for Gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002
3 ;; Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval-when-compile (require 'cl))
33 (defcustom gnus-use-correct-string-widths (featurep 'xemacs)
34 "*If non-nil, use correct functions for dealing with wide characters."
38 ;;; Internal variables.
40 (defvar gnus-summary-mark-positions nil)
41 (defvar gnus-group-mark-positions nil)
42 (defvar gnus-group-indentation "")
44 ;; Format specs. The chunks below are the machine-generated forms
45 ;; that are to be evaled as the result of the default format strings.
46 ;; We write them in here to get them byte-compiled. That way the
47 ;; default actions will be quite fast, while still retaining the full
48 ;; flexibility of the user-defined format specs.
50 ;; First we have lots of dummy defvars to let the compiler know these
51 ;; are really dynamic variables.
53 (defvar gnus-tmp-unread)
54 (defvar gnus-tmp-replied)
55 (defvar gnus-tmp-score-char)
56 (defvar gnus-tmp-indentation)
57 (defvar gnus-tmp-opening-bracket)
58 (defvar gnus-tmp-lines)
59 (defvar gnus-tmp-name)
60 (defvar gnus-tmp-closing-bracket)
61 (defvar gnus-tmp-subject-or-nil)
62 (defvar gnus-tmp-subject)
63 (defvar gnus-tmp-marked)
64 (defvar gnus-tmp-marked-mark)
65 (defvar gnus-tmp-subscribed)
66 (defvar gnus-tmp-process-marked)
67 (defvar gnus-tmp-number-of-unread)
68 (defvar gnus-tmp-group-name)
69 (defvar gnus-tmp-group)
70 (defvar gnus-tmp-article-number)
71 (defvar gnus-tmp-unread-and-unselected)
72 (defvar gnus-tmp-news-method)
73 (defvar gnus-tmp-news-server)
74 (defvar gnus-tmp-article-number)
75 (defvar gnus-mouse-face)
76 (defvar gnus-mouse-face-prop)
78 (defun gnus-summary-line-format-spec ()
79 (insert gnus-tmp-unread gnus-tmp-replied
80 gnus-tmp-score-char gnus-tmp-indentation)
81 (gnus-put-text-property
85 gnus-tmp-opening-bracket
88 (if (> (length gnus-tmp-name) 20)
89 (substring gnus-tmp-name 0 20)
91 gnus-tmp-closing-bracket)
93 gnus-mouse-face-prop gnus-mouse-face)
94 (insert " " gnus-tmp-subject-or-nil "\n"))
96 (defvar gnus-summary-line-format-spec
97 (gnus-byte-code 'gnus-summary-line-format-spec))
99 (defun gnus-summary-dummy-line-format-spec ()
101 (gnus-put-text-property
106 gnus-mouse-face-prop gnus-mouse-face)
107 (insert " " gnus-tmp-subject "\n"))
109 (defvar gnus-summary-dummy-line-format-spec
110 (gnus-byte-code 'gnus-summary-dummy-line-format-spec))
112 (defun gnus-group-line-format-spec ()
113 (insert gnus-tmp-marked-mark gnus-tmp-subscribed
114 gnus-tmp-process-marked
115 gnus-group-indentation
116 (format "%5s: " gnus-tmp-number-of-unread))
117 (gnus-put-text-property
120 (insert gnus-tmp-group "\n")
122 gnus-mouse-face-prop gnus-mouse-face))
123 (defvar gnus-group-line-format-spec
124 (gnus-byte-code 'gnus-group-line-format-spec))
126 (defvar gnus-format-specs
127 `((version . ,emacs-version)
128 (gnus-version . ,(gnus-continuum-version))
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-article-mode-line-format-spec nil)
137 (defvar gnus-summary-mode-line-format-spec nil)
138 (defvar gnus-group-mode-line-format-spec nil)
140 ;;; Phew. All that gruft is over with, fortunately.
143 (defun gnus-update-format (var)
144 "Update the format specification near point."
149 ;; Find the end of the current word.
150 (re-search-forward "[ \t\n]" nil t)
152 (when (re-search-backward "\\(gnus-[-a-z]+-line-format\\)" nil t)
154 (let* ((type (intern (progn (string-match "gnus-\\([-a-z]+\\)-line" var)
155 (match-string 1 var))))
156 (entry (assq type gnus-format-specs))
159 (setq gnus-format-specs (delq entry gnus-format-specs)))
161 (intern (format "%s-spec" var))
162 (gnus-parse-format (setq value (symbol-value (intern var)))
163 (symbol-value (intern (format "%s-alist" var)))
164 (not (string-match "mode" var))))
165 (setq spec (symbol-value (intern (format "%s-spec" var))))
166 (push (list type value spec) gnus-format-specs)
168 (pop-to-buffer "*Gnus Format*")
170 (lisp-interaction-mode)
171 (insert (pp-to-string spec))))
173 (defun gnus-update-format-specifications (&optional force &rest types)
174 "Update all (necessary) format specifications."
175 ;; Make the indentation array.
176 ;; See whether all the stored info needs to be flushed.
178 (not (equal (gnus-continuum-version)
179 (cdr (assq 'gnus-version gnus-format-specs))))
180 (not (equal emacs-version
181 (cdr (assq 'version gnus-format-specs)))))
182 (setq gnus-format-specs nil))
184 ;; Go through all the formats and see whether they need updating.
185 (let (new-format entry type val)
186 (while (setq type (pop types))
187 ;; Jump to the proper buffer to find out the value of the
188 ;; variable, if possible. (It may be buffer-local.)
190 (let ((buffer (intern (format "gnus-%s-buffer" type)))
192 (when (and (boundp buffer)
193 (setq val (symbol-value buffer))
194 (gnus-buffer-exists-p val))
196 (setq new-format (symbol-value
197 (intern (format "gnus-%s-line-format" type)))))
198 (setq entry (cdr (assq type gnus-format-specs)))
200 (equal (car entry) new-format))
201 ;; Use the old format.
202 (set (intern (format "gnus-%s-line-format-spec" type))
204 ;; This is a new format.
206 (if (not (stringp new-format))
207 ;; This is a function call or something.
209 ;; This is a "real" format.
213 (intern (format "gnus-%s-line-format-alist" type)))
214 (not (string-match "mode$" (symbol-name type))))))
215 ;; Enter the new format spec into the list.
218 (setcar (cdr entry) val)
219 (setcar entry new-format))
220 (push (list type new-format val) gnus-format-specs))
221 (set (intern (format "gnus-%s-line-format-spec" type)) val)))))
223 (unless (assq 'version gnus-format-specs)
224 (push (cons 'version emacs-version) gnus-format-specs)))
226 (defvar gnus-mouse-face-0 'highlight)
227 (defvar gnus-mouse-face-1 'highlight)
228 (defvar gnus-mouse-face-2 'highlight)
229 (defvar gnus-mouse-face-3 'highlight)
230 (defvar gnus-mouse-face-4 'highlight)
232 (defun gnus-mouse-face-function (form type)
233 `(gnus-put-text-property
234 (point) (progn ,@form (point))
238 `(quote ,(symbol-value (intern (format "gnus-mouse-face-%d" type)))))))
240 (defvar gnus-face-0 'bold)
241 (defvar gnus-face-1 'italic)
242 (defvar gnus-face-2 'bold-italic)
243 (defvar gnus-face-3 'bold)
244 (defvar gnus-face-4 'bold)
246 (defun gnus-face-face-function (form type)
247 `(gnus-add-text-properties
248 (point) (progn ,@form (point))
249 '(gnus-face t face ,(symbol-value (intern (format "gnus-face-%d" type))))))
251 (defun gnus-balloon-face-function (form type)
252 `(gnus-put-text-property
253 (point) (progn ,@form (point))
255 ,(intern (format "gnus-balloon-face-%d" type))))
257 (defun gnus-spec-tab (column)
259 `(insert (make-string (max (- ,column (current-column)) 0) ? ))
261 (if (> (current-column) ,(abs column))
262 (delete-region (point)
263 (- (point) (- (current-column) ,(abs column))))
264 (insert (make-string (max (- ,(abs column) (current-column)) 0)
267 (defun gnus-correct-length (string)
268 "Return the correct width of STRING."
270 (mapcar (lambda (char) (incf length (gnus-char-width char))) string)
273 (defun gnus-correct-substring (string start &optional end)
278 (length (length string))
279 (string (concat string "\0")))
280 ;; Find the start position.
281 (while (and (< seek length)
283 (incf wseek (gnus-char-width (aref string seek)))
286 ;; Find the end position.
287 (while (and (<= seek length)
290 (incf wseek (gnus-char-width (aref string seek)))
293 (substring string wstart (1- wend))))
295 (defun gnus-tilde-max-form (el max-width)
296 "Return a form that limits EL to MAX-WIDTH."
297 (let ((max (abs max-width))
298 (length-fun (if gnus-use-correct-string-widths
301 (substring-fun (if gnus-use-correct-string-widths
302 'gnus-correct-substring
305 `(if (> (,length-fun ,el) ,max)
307 `(,substring-fun ,el (- (,length-fun ,el) ,max))
308 `(,substring-fun ,el 0 ,max))
310 `(let ((val (eval ,el)))
311 (if (> (,length-fun val) ,max)
313 `(,substring-fun val (- (,length-fun val) ,max))
314 `(,substring-fun val 0 ,max))
317 (defun gnus-tilde-cut-form (el cut-width)
318 "Return a form that cuts CUT-WIDTH off of EL."
319 (let ((cut (abs cut-width))
320 (length-fun (if gnus-use-correct-string-widths
323 (substring-fun (if gnus-use-correct-string-widths
324 'gnus-correct-substring
327 `(if (> (,length-fun ,el) ,cut)
329 `(,substring-fun ,el 0 (- (,length-fun ,el) ,cut))
330 `(,substring-fun ,el ,cut))
332 `(let ((val (eval ,el)))
333 (if (> (,length-fun val) ,cut)
335 `(,substring-fun val 0 (- (,length-fun val) ,cut))
336 `(,substring-fun val ,cut))
339 (defun gnus-tilde-ignore-form (el ignore-value)
340 "Return a form that is blank when EL is IGNORE-VALUE."
342 `(if (equal ,el ,ignore-value)
344 `(let ((val (eval ,el)))
345 (if (equal val ,ignore-value)
348 (defun gnus-pad-form (el pad-width)
349 "Return a form that pads EL to PAD-WIDTH accounting for multi-column
350 characters correctly. This is because `format' may pad to columns or to
351 characters when given a pad value."
352 (let ((pad (abs pad-width))
353 (side (< 0 pad-width)))
355 `(let ((need (- ,pad (,(if gnus-use-correct-string-widths
360 (concat ,(when side '(make-string need ?\ ))
362 ,(when (not side) '(make-string need ?\ )))
364 `(let* ((val (eval ,el))
365 (need (- ,pad (,(if gnus-use-correct-string-widths
369 (concat ,(when side '(make-string need ?\ ))
371 ,(when (not side) '(make-string need ?\ )))
374 (defun gnus-parse-format (format spec-alist &optional insert)
375 ;; This function parses the FORMAT string with the help of the
376 ;; SPEC-ALIST and returns a list that can be eval'ed to return the
377 ;; string. If the FORMAT string contains the specifiers %( and %)
378 ;; the text between them will have the mouse-face text property.
379 ;; If the FORMAT string contains the specifiers %[ and %], the text between
380 ;; them will have the balloon-help text property.
381 (let ((case-fold-search nil))
383 "\\`\\(.*\\)%[0-9]?[{(«]\\(.*\\)%[0-9]?[»})]\\(.*\n?\\)\\'\\|%[-0-9]*="
385 (gnus-parse-complex-format format spec-alist)
386 ;; This is a simple format.
387 (gnus-parse-simple-format format spec-alist insert))))
389 (defun gnus-parse-complex-format (format spec-alist)
392 (gnus-set-work-buffer)
394 (goto-char (point-min))
395 (while (re-search-forward "\"" nil t)
396 (replace-match "\\\"" nil t))
397 (goto-char (point-min))
399 ;; Convert all font specs into font spec lists.
400 (while (re-search-forward "%\\([0-9]+\\)?\\([«»{}()]\\)" nil t)
401 (let ((number (if (match-beginning 1)
402 (match-string 1) "0"))
403 (delim (aref (match-string 2) 0)))
404 (if (or (= delim ?\()
407 (replace-match (concat "\"("
408 (cond ((= delim ?\() "mouse")
409 ((= delim ?\{) "face")
413 (replace-match "\")\""))))
414 (goto-char (point-max))
416 ;; Convert point position commands.
417 (goto-char (point-min))
418 (let ((case-fold-search nil))
419 (while (re-search-forward "%\\([-0-9]+\\)?C" nil t)
420 (replace-match "\"(point)\"" t t)
422 ;; Convert TAB commands.
423 (goto-char (point-min))
424 (while (re-search-forward "%\\([-0-9]+\\)=" nil t)
425 (replace-match (format "\"(tab %s)\"" (match-string 1)) t t))
426 ;; Convert the buffer into the spec.
427 (goto-char (point-min))
428 (let ((form (read (current-buffer))))
430 `(let (gnus-position)
431 ,@(gnus-complex-form-to-spec form spec-alist)
433 (gnus-put-text-property gnus-position (1+ gnus-position)
436 ,@(gnus-complex-form-to-spec form spec-alist)))))))
438 (defun gnus-complex-form-to-spec (form spec-alist)
444 (gnus-parse-simple-format sform spec-alist t))
445 ((eq (car sform) 'point)
446 '(setq gnus-position (point)))
447 ((eq (car sform) 'tab)
448 (gnus-spec-tab (cadr sform)))
450 (funcall (intern (format "gnus-%s-face-function" (car sform)))
451 (gnus-complex-form-to-spec (cddr sform) spec-alist)
455 (defun gnus-parse-simple-format (format spec-alist &optional insert)
456 ;; This function parses the FORMAT string with the help of the
457 ;; SPEC-ALIST and returns a list that can be eval'ed to return a
460 spec flist fstring elem result dontinsert user-defined
461 type value pad-width spec-beg cut-width ignore-value
462 tilde-form tilde elem-type extended-spec)
464 (gnus-set-work-buffer)
466 (goto-char (point-min))
467 (while (re-search-forward "%" nil t)
468 (setq user-defined nil
476 (setq spec-beg (1- (point)))
478 ;; Parse this spec fully.
481 ((looking-at "\\([-.0-9]+\\)\\(,[-0-9]+\\)?")
482 (setq pad-width (string-to-number (match-string 1)))
483 (when (match-beginning 2)
484 (setq max-width (string-to-number (buffer-substring
485 (1+ (match-beginning 2))
487 (goto-char (match-end 0)))
490 (setq tilde (read (current-buffer))
494 ((memq type '(pad pad-left))
495 (setq pad-width value))
496 ((eq type 'pad-right)
497 (setq pad-width (- value)))
498 ((memq type '(max-right max))
499 (setq max-width value))
501 (setq max-width (- value)))
502 ((memq type '(cut cut-left))
503 (setq cut-width value))
504 ((eq type 'cut-right)
505 (setq cut-width (- value)))
508 (if (stringp value) value (format "%s" value))))
510 (setq tilde-form value))
512 (error "Unknown tilde type: %s" tilde)))
517 ;; User-defined spec -- find the spec name.
518 ((eq (setq spec (char-after)) ?u)
520 (when (and (eq (setq user-defined (char-after)) ?&)
521 (looking-at "&\\([^;]+\\);"))
522 (setq user-defined (match-string 1))
523 (goto-char (match-end 1))))
525 ((and (eq spec ?&) (looking-at "&\\([^;]+\\);"))
526 (setq extended-spec (intern (match-string 1)))
527 (goto-char (match-end 1))))
529 (delete-region spec-beg (point))
531 ;; Now we have all the relevant data on this spec, so
532 ;; we start doing stuff.
535 ;; "%%" just results in a "%".
540 (setq elem (list tilde-form ?s)))
541 ;; Treat user defined format specifiers specially.
545 (list (intern (format
546 (if (stringp user-defined)
547 "gnus-user-format-function-%s"
548 "gnus-user-format-function-%c")
552 ;; Find the specification from `spec-alist'.
553 ((setq elem (cdr (assq (or extended-spec spec) spec-alist))))
555 (setq elem '("*" ?s))))
556 (setq elem-type (cadr elem))
557 ;; Insert the new format elements.
559 (not (and (featurep 'xemacs)
560 gnus-use-correct-string-widths)))
561 (insert (number-to-string pad-width)))
562 ;; Create the form to be evaled.
563 (if (or max-width cut-width ignore-value
564 (and (featurep 'xemacs)
565 gnus-use-correct-string-widths))
568 (let ((el (car elem)))
569 (cond ((= (cadr elem) ?c)
570 (setq el (list 'char-to-string el)))
572 (setq el (list 'int-to-string el))))
574 (setq el (gnus-tilde-ignore-form el ignore-value)))
576 (setq el (gnus-tilde-cut-form el cut-width)))
578 (setq el (gnus-tilde-max-form el max-width)))
580 (setq el (gnus-pad-form el pad-width)))
583 (push (car elem) flist))))
584 (setq fstring (buffer-substring-no-properties (point-min) (point-max))))
586 ;; Do some postprocessing to increase efficiency.
591 ((string= fstring "")
593 ;; Not a format string.
594 ((not (string-match "%" fstring))
596 ;; A format string with just a single string spec.
597 ((string= fstring "%s")
599 ;; A single character.
600 ((string= fstring "%c")
603 ((string= fstring "%d")
606 (list `(princ ,(car flist)))
607 (list `(int-to-string ,(car flist)))))
608 ;; Just lots of chars and strings.
609 ((string-match "\\`\\(%[cs]\\)+\\'" fstring)
611 ;; A single string spec at the beginning of the spec.
612 ((string-match "\\`%[sc][^%]+\\'" fstring)
613 (list (car flist) (substring fstring 2)))
614 ;; A single string spec in the middle of the spec.
615 ((string-match "\\`\\([^%]+\\)%[sc]\\([^%]+\\)\\'" fstring)
616 (list (match-string 1 fstring) (car flist) (match-string 2 fstring)))
617 ;; A single string spec in the end of the spec.
618 ((string-match "\\`\\([^%]+\\)%[sc]\\'" fstring)
619 (list (match-string 1 fstring) (car flist)))
620 ;; A more complex spec.
622 (list (cons 'format (cons fstring (nreverse flist)))))))
628 (cons 'insert result)))
629 (cond ((stringp result)
632 (cons 'concat result))
635 (defun gnus-eval-format (format &optional alist props)
636 "Eval the format variable FORMAT, using ALIST.
637 If PROPS, insert the result."
638 (let ((form (gnus-parse-format format alist props)))
640 (gnus-add-text-properties (point) (progn (eval form) (point)) props)
643 (defun gnus-compile ()
644 "Byte-compile the user-defined format specs."
647 (let ((entries gnus-format-specs)
648 (byte-compile-warnings '(unresolved callargs redefine))
651 (gnus-message 7 "Compiling format specs...")
654 (setq entry (pop entries))
655 (if (memq (car entry) '(gnus-version version))
656 (setq gnus-format-specs (delq entry gnus-format-specs))
657 (let ((form (caddr entry)))
658 (when (and (listp form)
659 ;; Under GNU Emacs, it's (byte-code ...)
660 (not (eq 'byte-code (car form)))
661 ;; Under XEmacs, it's (funcall #<compiled-function ...>)
662 (not (and (eq 'funcall (car form))
663 (byte-code-function-p (cadr form)))))
664 (defalias 'gnus-tmp-func `(lambda () ,form))
665 (byte-compile 'gnus-tmp-func)
666 (setcar (cddr entry) (gnus-byte-code 'gnus-tmp-func))))))
668 (push (cons 'version emacs-version) gnus-format-specs)
669 ;; Mark the .newsrc.eld file as "dirty".
671 (gnus-message 7 "Compiling user specs...done"))))
673 (defun gnus-set-format (type &optional insertable)
674 (set (intern (format "gnus-%s-line-format-spec" type))
676 (symbol-value (intern (format "gnus-%s-line-format" type)))
677 (symbol-value (intern (format "gnus-%s-line-format-alist" type)))
683 ;; coding: iso-8859-1
686 ;;; gnus-spec.el ends here