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)
77 (defvar gnus-tmp-header)
78 (defvar gnus-tmp-from)
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 (format "%c%4s: %-23s%c" gnus-tmp-opening-bracket gnus-tmp-lines
90 (gnus-summary-from-or-to-or-newsgroups
91 gnus-tmp-header gnus-tmp-from))))
92 (if (> (length val) 23)
95 gnus-tmp-closing-bracket))
97 gnus-mouse-face-prop gnus-mouse-face)
98 (insert " " gnus-tmp-subject-or-nil "\n"))
100 (defvar gnus-summary-line-format-spec
101 (gnus-byte-code 'gnus-summary-line-format-spec))
103 (defun gnus-summary-dummy-line-format-spec ()
105 (gnus-put-text-property
110 gnus-mouse-face-prop gnus-mouse-face)
111 (insert " " gnus-tmp-subject "\n"))
113 (defvar gnus-summary-dummy-line-format-spec
114 (gnus-byte-code 'gnus-summary-dummy-line-format-spec))
116 (defun gnus-group-line-format-spec ()
117 (insert gnus-tmp-marked-mark gnus-tmp-subscribed
118 gnus-tmp-process-marked
119 gnus-group-indentation
120 (format "%5s: " gnus-tmp-number-of-unread))
121 (gnus-put-text-property
124 (insert gnus-tmp-group "\n")
126 gnus-mouse-face-prop gnus-mouse-face))
127 (defvar gnus-group-line-format-spec
128 (gnus-byte-code 'gnus-group-line-format-spec))
130 (defvar gnus-format-specs
131 `((version . ,emacs-version)
132 (gnus-version . ,(gnus-continuum-version))
133 (group "%M\%S\%p\%P\%5y: %(%g%)%l\n" ,gnus-group-line-format-spec)
134 (summary-dummy "* %(: :%) %S\n"
135 ,gnus-summary-dummy-line-format-spec)
136 (summary "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
137 ,gnus-summary-line-format-spec))
138 "Alist of format specs.")
140 (defvar gnus-default-format-specs gnus-format-specs)
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 (entry (assq type gnus-format-specs))
165 (setq gnus-format-specs (delq entry gnus-format-specs)))
167 (intern (format "%s-spec" var))
168 (gnus-parse-format (setq value (symbol-value (intern var)))
169 (symbol-value (intern (format "%s-alist" var)))
170 (not (string-match "mode" var))))
171 (setq spec (symbol-value (intern (format "%s-spec" var))))
172 (push (list type value spec) gnus-format-specs)
174 (pop-to-buffer "*Gnus Format*")
176 (lisp-interaction-mode)
177 (insert (pp-to-string spec))))
179 (defun gnus-update-format-specifications (&optional force &rest types)
180 "Update all (necessary) format specifications."
181 ;; Make the indentation array.
182 ;; See whether all the stored info needs to be flushed.
184 (not gnus-newsrc-file-version)
185 (not (equal (gnus-continuum-version)
186 (gnus-continuum-version gnus-newsrc-file-version)))
187 (not (equal emacs-version
188 (cdr (assq 'version gnus-format-specs)))))
189 (setq gnus-format-specs nil))
191 ;; Go through all the formats and see whether they need updating.
192 (let (new-format entry type val)
193 (while (setq type (pop types))
194 ;; Jump to the proper buffer to find out the value of the
195 ;; variable, if possible. (It may be buffer-local.)
197 (let ((buffer (intern (format "gnus-%s-buffer" type)))
199 (when (and (boundp buffer)
200 (setq val (symbol-value buffer))
201 (gnus-buffer-exists-p val))
203 (setq new-format (symbol-value
204 (intern (format "gnus-%s-line-format" type)))))
205 (setq entry (cdr (assq type gnus-format-specs)))
207 (equal (car entry) new-format))
208 ;; Use the old format.
209 (set (intern (format "gnus-%s-line-format-spec" type))
211 ;; This is a new format.
213 (if (not (stringp new-format))
214 ;; This is a function call or something.
216 ;; This is a "real" format.
220 (intern (format "gnus-%s-line-format-alist" type)))
221 (not (string-match "mode$" (symbol-name type))))))
222 ;; Enter the new format spec into the list.
225 (setcar (cdr entry) val)
226 (setcar entry new-format))
227 (push (list type new-format val) gnus-format-specs))
228 (set (intern (format "gnus-%s-line-format-spec" type)) val)))))
230 (unless (assq 'version gnus-format-specs)
231 (push (cons 'version emacs-version) gnus-format-specs)))
233 (defvar gnus-mouse-face-0 'highlight)
234 (defvar gnus-mouse-face-1 'highlight)
235 (defvar gnus-mouse-face-2 'highlight)
236 (defvar gnus-mouse-face-3 'highlight)
237 (defvar gnus-mouse-face-4 'highlight)
239 (defun gnus-mouse-face-function (form type)
240 `(gnus-put-text-property
241 (point) (progn ,@form (point))
245 `(quote ,(symbol-value (intern (format "gnus-mouse-face-%d" type)))))))
247 (defvar gnus-face-0 'bold)
248 (defvar gnus-face-1 'italic)
249 (defvar gnus-face-2 'bold-italic)
250 (defvar gnus-face-3 'bold)
251 (defvar gnus-face-4 'bold)
253 (defun gnus-face-face-function (form type)
254 `(gnus-add-text-properties
255 (point) (progn ,@form (point))
256 '(gnus-face t face ,(symbol-value (intern (format "gnus-face-%d" type))))))
258 (defun gnus-balloon-face-function (form type)
259 `(gnus-put-text-property
260 (point) (progn ,@form (point))
261 ,(if (fboundp 'balloon-help-mode)
264 ,(intern (format "gnus-balloon-face-%d" type))))
266 (defun gnus-spec-tab (column)
268 `(insert (make-string (max (- ,column (current-column)) 0) ? ))
269 (let ((column (abs column)))
270 (if gnus-use-correct-string-widths
272 (if (> (current-column) ,column)
274 (delete-backward-char 1)
275 (> (current-column) ,column))))
276 (insert (make-string (max (- ,column (current-column)) 0) ? )))
278 (if (> (current-column) ,column)
279 (delete-region (point)
280 (- (point) (- (current-column) ,column)))
281 (insert (make-string (max (- ,column (current-column)) 0)
284 (defun gnus-correct-length (string)
285 "Return the correct width of STRING."
287 (mapcar (lambda (char) (incf length (gnus-char-width char))) string)
290 (defun gnus-correct-substring (string start &optional end)
295 (length (length string))
296 (string (concat string "\0")))
297 ;; Find the start position.
298 (while (and (< seek length)
300 (incf wseek (gnus-char-width (aref string seek)))
303 ;; Find the end position.
304 (while (and (<= seek length)
307 (incf wseek (gnus-char-width (aref string seek)))
310 (substring string wstart (1- wend))))
312 (defun gnus-string-width-function ()
314 (gnus-use-correct-string-widths
315 'gnus-correct-length)
316 ((fboundp 'string-width)
321 (defun gnus-substring-function ()
323 (gnus-use-correct-string-widths
324 'gnus-correct-substring)
325 ((fboundp 'string-width)
326 'gnus-correct-substring)
330 (defun gnus-tilde-max-form (el max-width)
331 "Return a form that limits EL to MAX-WIDTH."
332 (let ((max (abs max-width))
333 (length-fun (gnus-string-width-function))
334 (substring-fun (gnus-substring-function)))
336 `(if (> (,length-fun ,el) ,max)
338 `(,substring-fun ,el (- (,length-fun ,el) ,max))
339 `(,substring-fun ,el 0 ,max))
341 `(let ((val (eval ,el)))
342 (if (> (,length-fun val) ,max)
344 `(,substring-fun val (- (,length-fun val) ,max))
345 `(,substring-fun val 0 ,max))
348 (defun gnus-tilde-cut-form (el cut-width)
349 "Return a form that cuts CUT-WIDTH off of EL."
350 (let ((cut (abs cut-width))
351 (length-fun (gnus-string-width-function))
352 (substring-fun (gnus-substring-function)))
354 `(if (> (,length-fun ,el) ,cut)
356 `(,substring-fun ,el 0 (- (,length-fun ,el) ,cut))
357 `(,substring-fun ,el ,cut))
359 `(let ((val (eval ,el)))
360 (if (> (,length-fun val) ,cut)
362 `(,substring-fun val 0 (- (,length-fun val) ,cut))
363 `(,substring-fun val ,cut))
366 (defun gnus-tilde-ignore-form (el ignore-value)
367 "Return a form that is blank when EL is IGNORE-VALUE."
369 `(if (equal ,el ,ignore-value)
371 `(let ((val (eval ,el)))
372 (if (equal val ,ignore-value)
375 (defun gnus-pad-form (el pad-width)
376 "Return a form that pads EL to PAD-WIDTH accounting for multi-column
377 characters correctly. This is because `format' may pad to columns or to
378 characters when given a pad value."
379 (let ((pad (abs pad-width))
380 (side (< 0 pad-width)))
382 `(let ((need (- ,pad (,(if gnus-use-correct-string-widths
387 (concat ,(when side '(make-string need ?\ ))
389 ,(when (not side) '(make-string need ?\ )))
391 `(let* ((val (eval ,el))
392 (need (- ,pad (,(if gnus-use-correct-string-widths
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?\\)\\'\\|%[-0-9]*="
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 (re-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-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))
678 (gnus-message 7 "Compiling format specs...")
681 (setq entry (pop entries))
682 (if (memq (car entry) '(gnus-version version))
683 (setq gnus-format-specs (delq entry gnus-format-specs))
684 (let ((form (caddr entry)))
685 (when (and (listp form)
686 ;; Under GNU Emacs, it's (byte-code ...)
687 (not (eq 'byte-code (car form)))
688 ;; Under XEmacs, it's (funcall #<compiled-function ...>)
689 (not (and (eq 'funcall (car form))
690 (byte-code-function-p (cadr form)))))
691 (defalias 'gnus-tmp-func `(lambda () ,form))
692 (byte-compile 'gnus-tmp-func)
693 (setcar (cddr entry) (gnus-byte-code 'gnus-tmp-func))))))
695 (push (cons 'version emacs-version) gnus-format-specs)
696 ;; Mark the .newsrc.eld file as "dirty".
698 (gnus-message 7 "Compiling user specs...done"))))
700 (defun gnus-set-format (type &optional insertable)
701 (set (intern (format "gnus-%s-line-format-spec" type))
703 (symbol-value (intern (format "gnus-%s-line-format" type)))
704 (symbol-value (intern (format "gnus-%s-line-format-alist" type)))
710 ;; coding: iso-8859-1
713 ;;; gnus-spec.el ends here