1 ;;; gnus-spec.el --- format spec functions for Gnus
2 ;; Copyright (C) 1996,97,98 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
28 (eval-when-compile (require 'cl))
32 ;;; Internal variables.
34 (defvar gnus-summary-mark-positions nil)
35 (defvar gnus-group-mark-positions nil)
36 (defvar gnus-group-indentation "")
38 ;; Format specs. The chunks below are the machine-generated forms
39 ;; that are to be evaled as the result of the default format strings.
40 ;; We write them in here to get them byte-compiled. That way the
41 ;; default actions will be quite fast, while still retaining the full
42 ;; flexibility of the user-defined format specs.
44 ;; First we have lots of dummy defvars to let the compiler know these
45 ;; are really dynamic variables.
47 (defvar gnus-tmp-unread)
48 (defvar gnus-tmp-replied)
49 (defvar gnus-tmp-score-char)
50 (defvar gnus-tmp-indentation)
51 (defvar gnus-tmp-opening-bracket)
52 (defvar gnus-tmp-lines)
53 (defvar gnus-tmp-name)
54 (defvar gnus-tmp-closing-bracket)
55 (defvar gnus-tmp-subject-or-nil)
56 (defvar gnus-tmp-subject)
57 (defvar gnus-tmp-marked)
58 (defvar gnus-tmp-marked-mark)
59 (defvar gnus-tmp-subscribed)
60 (defvar gnus-tmp-process-marked)
61 (defvar gnus-tmp-number-of-unread)
62 (defvar gnus-tmp-group-name)
63 (defvar gnus-tmp-group)
64 (defvar gnus-tmp-article-number)
65 (defvar gnus-tmp-unread-and-unselected)
66 (defvar gnus-tmp-news-method)
67 (defvar gnus-tmp-news-server)
68 (defvar gnus-tmp-article-number)
69 (defvar gnus-mouse-face)
70 (defvar gnus-mouse-face-prop)
72 (defun gnus-summary-line-format-spec ()
73 (insert gnus-tmp-unread gnus-tmp-replied
74 gnus-tmp-score-char gnus-tmp-indentation)
75 (gnus-put-text-property
79 gnus-tmp-opening-bracket
82 (if (> (length gnus-tmp-name) 20)
83 (substring gnus-tmp-name 0 20)
85 gnus-tmp-closing-bracket)
87 gnus-mouse-face-prop gnus-mouse-face)
88 (insert " " gnus-tmp-subject-or-nil "\n"))
90 (defvar gnus-summary-line-format-spec
91 (gnus-byte-code 'gnus-summary-line-format-spec))
93 (defun gnus-summary-dummy-line-format-spec ()
95 (gnus-put-text-property
100 gnus-mouse-face-prop gnus-mouse-face)
101 (insert " " gnus-tmp-subject "\n"))
103 (defvar gnus-summary-dummy-line-format-spec
104 (gnus-byte-code 'gnus-summary-dummy-line-format-spec))
106 (defun gnus-group-line-format-spec ()
107 (insert gnus-tmp-marked-mark gnus-tmp-subscribed
108 gnus-tmp-process-marked
109 gnus-group-indentation
110 (format "%5s: " gnus-tmp-number-of-unread))
111 (gnus-put-text-property
114 (insert gnus-tmp-group "\n")
116 gnus-mouse-face-prop gnus-mouse-face))
117 (defvar gnus-group-line-format-spec
118 (gnus-byte-code 'gnus-group-line-format-spec))
120 (defvar gnus-format-specs
121 `((version . ,emacs-version)
122 (group "%M\%S\%p\%P\%5y: %(%g%)%l\n" ,gnus-group-line-format-spec)
123 (summary-dummy "* %(: :%) %S\n"
124 ,gnus-summary-dummy-line-format-spec)
125 (summary "%U\%R\%z\%I\%(%[%4L: %-20,20n%]%) %s\n"
126 ,gnus-summary-line-format-spec))
127 "Alist of format specs.")
129 (defvar gnus-article-mode-line-format-spec nil)
130 (defvar gnus-summary-mode-line-format-spec nil)
131 (defvar gnus-group-mode-line-format-spec nil)
133 ;;; Phew. All that gruft is over, fortunately.
136 (defun gnus-update-format (var)
137 "Update the format specification near point."
142 ;; Find the end of the current word.
143 (re-search-forward "[ \t\n]" nil t)
145 (when (re-search-backward "\\(gnus-[-a-z]+-line-format\\)" nil t)
147 (let* ((type (intern (progn (string-match "gnus-\\([-a-z]+\\)-line" var)
148 (match-string 1 var))))
149 (entry (assq type gnus-format-specs))
152 (setq gnus-format-specs (delq entry gnus-format-specs)))
154 (intern (format "%s-spec" var))
155 (gnus-parse-format (setq value (symbol-value (intern var)))
156 (symbol-value (intern (format "%s-alist" var)))
157 (not (string-match "mode" var))))
158 (setq spec (symbol-value (intern (format "%s-spec" var))))
159 (push (list type value spec) gnus-format-specs)
161 (pop-to-buffer "*Gnus Format*")
163 (lisp-interaction-mode)
164 (insert (pp-to-string spec))))
166 (defun gnus-update-format-specifications (&optional force &rest types)
167 "Update all (necessary) format specifications."
168 ;; Make the indentation array.
169 ;; See whether all the stored info needs to be flushed.
171 (not (equal emacs-version
172 (cdr (assq 'version gnus-format-specs)))))
173 (setq gnus-format-specs nil))
175 ;; Go through all the formats and see whether they need updating.
176 (let (new-format entry type val)
177 (while (setq type (pop types))
178 ;; Jump to the proper buffer to find out the value of
179 ;; the variable, if possible. (It may be buffer-local.)
181 (let ((buffer (intern (format "gnus-%s-buffer" type)))
183 (when (and (boundp buffer)
184 (setq val (symbol-value buffer))
185 (gnus-buffer-exists-p val))
187 (setq new-format (symbol-value
188 (intern (format "gnus-%s-line-format" type)))))
189 (setq entry (cdr (assq type gnus-format-specs)))
191 (equal (car entry) new-format))
192 ;; Use the old format.
193 (set (intern (format "gnus-%s-line-format-spec" type))
195 ;; This is a new format.
197 (if (not (stringp new-format))
198 ;; This is a function call or something.
200 ;; This is a "real" format.
204 (intern (format "gnus-%s-line-format-alist"
205 (if (eq type 'article-mode)
206 'summary-mode type))))
207 (not (string-match "mode$" (symbol-name type))))))
208 ;; Enter the new format spec into the list.
211 (setcar (cdr entry) val)
212 (setcar entry new-format))
213 (push (list type new-format val) gnus-format-specs))
214 (set (intern (format "gnus-%s-line-format-spec" type)) val)))))
216 (unless (assq 'version gnus-format-specs)
217 (push (cons 'version emacs-version) gnus-format-specs)))
219 (defvar gnus-mouse-face-0 'highlight)
220 (defvar gnus-mouse-face-1 'highlight)
221 (defvar gnus-mouse-face-2 'highlight)
222 (defvar gnus-mouse-face-3 'highlight)
223 (defvar gnus-mouse-face-4 'highlight)
225 (defun gnus-mouse-face-function (form type)
226 `(gnus-put-text-property
227 (point) (progn ,@form (point))
231 `(quote ,(symbol-value (intern (format "gnus-mouse-face-%d" type)))))))
233 (defvar gnus-face-0 'bold)
234 (defvar gnus-face-1 'italic)
235 (defvar gnus-face-2 'bold-italic)
236 (defvar gnus-face-3 'bold)
237 (defvar gnus-face-4 'bold)
239 (defun gnus-face-face-function (form type)
240 `(gnus-add-text-properties
241 (point) (progn ,@form (point))
243 'face ',(symbol-value (intern (format "gnus-face-%d" type))))))
245 (defun gnus-tilde-max-form (el max-width)
246 "Return a form that limits EL to MAX-WIDTH."
247 (let ((max (abs max-width)))
249 `(if (> (length ,el) ,max)
251 `(substring ,el (- (length el) ,max))
252 `(substring ,el 0 ,max))
254 `(let ((val (eval ,el)))
255 (if (> (length val) ,max)
257 `(substring val (- (length val) ,max))
258 `(substring val 0 ,max))
261 (defun gnus-tilde-cut-form (el cut-width)
262 "Return a form that cuts CUT-WIDTH off of EL."
263 (let ((cut (abs cut-width)))
265 `(if (> (length ,el) ,cut)
267 `(substring ,el 0 (- (length el) ,cut))
268 `(substring ,el ,cut))
270 `(let ((val (eval ,el)))
271 (if (> (length val) ,cut)
273 `(substring val 0 (- (length val) ,cut))
274 `(substring val ,cut))
277 (defun gnus-tilde-ignore-form (el ignore-value)
278 "Return a form that is blank when EL is IGNORE-VALUE."
280 `(if (equal ,el ,ignore-value)
282 `(let ((val (eval ,el)))
283 (if (equal val ,ignore-value)
286 (defun gnus-parse-format (format spec-alist &optional insert)
287 ;; This function parses the FORMAT string with the help of the
288 ;; SPEC-ALIST and returns a list that can be eval'ed to return the
289 ;; string. If the FORMAT string contains the specifiers %( and %)
290 ;; the text between them will have the mouse-face text property.
292 "\\`\\(.*\\)%[0-9]?[{(]\\(.*\\)%[0-9]?[})]\\(.*\n?\\)\\'"
294 (gnus-parse-complex-format format spec-alist)
295 ;; This is a simple format.
296 (gnus-parse-simple-format format spec-alist insert)))
298 (defun gnus-parse-complex-format (format spec-alist)
300 (gnus-set-work-buffer)
302 (goto-char (point-min))
303 (while (re-search-forward "\"" nil t)
304 (replace-match "\\\"" nil t))
305 (goto-char (point-min))
307 (while (re-search-forward "%\\([0-9]+\\)?\\([{}()]\\)" nil t)
308 (let ((number (if (match-beginning 1)
309 (match-string 1) "0"))
310 (delim (aref (match-string 2) 0)))
311 (if (or (= delim ?\()
313 (replace-match (concat "\"(" (if (= delim ?\() "mouse" "face")
315 (replace-match "\")\""))))
316 (goto-char (point-max))
318 (goto-char (point-min))
319 (let ((form (read (current-buffer))))
320 (cons 'progn (gnus-complex-form-to-spec form spec-alist)))))
322 (defun gnus-complex-form-to-spec (form spec-alist)
327 (gnus-parse-simple-format sform spec-alist t)
328 (funcall (intern (format "gnus-%s-face-function" (car sform)))
329 (gnus-complex-form-to-spec (cddr sform) spec-alist)
333 (defun gnus-parse-simple-format (format spec-alist &optional insert)
334 ;; This function parses the FORMAT string with the help of the
335 ;; SPEC-ALIST and returns a list that can be eval'ed to return a
338 spec flist fstring elem result dontinsert user-defined
339 type value pad-width spec-beg cut-width ignore-value
340 tilde-form tilde elem-type)
342 (gnus-set-work-buffer)
344 (goto-char (point-min))
345 (while (re-search-forward "%" nil t)
346 (setq user-defined nil
353 (setq spec-beg (1- (point)))
355 ;; Parse this spec fully.
358 ((looking-at "\\([-.0-9]+\\)\\(,[-0-9]+\\)?")
359 (setq pad-width (string-to-number (match-string 1)))
360 (when (match-beginning 2)
361 (setq max-width (string-to-number (buffer-substring
362 (1+ (match-beginning 2))
364 (goto-char (match-end 0)))
367 (setq tilde (read (current-buffer))
371 ((memq type '(pad pad-left))
372 (setq pad-width value))
373 ((eq type 'pad-right)
374 (setq pad-width (- value)))
375 ((memq type '(max-right max))
376 (setq max-width value))
378 (setq max-width (- value)))
379 ((memq type '(cut cut-left))
380 (setq cut-width value))
381 ((eq type 'cut-right)
382 (setq cut-width (- value)))
385 (if (stringp value) value (format "%s" value))))
387 (setq tilde-form value))
389 (error "Unknown tilde type: %s" tilde)))
393 ;; User-defined spec -- find the spec name.
394 (when (= (setq spec (following-char)) ?u)
396 (setq user-defined (following-char)))
398 (delete-region spec-beg (point))
400 ;; Now we have all the relevant data on this spec, so
401 ;; we start doing stuff.
404 ;; "%%" just results in a "%".
409 (setq elem (list tilde-form ?s)))
410 ;; Treat user defined format specifiers specially.
414 (list (intern (format "gnus-user-format-function-%c"
418 ;; Find the specification from `spec-alist'.
419 ((setq elem (cdr (assq spec spec-alist))))
421 (setq elem '("*" ?s))))
422 (setq elem-type (cadr elem))
423 ;; Insert the new format elements.
425 (insert (number-to-string pad-width)))
426 ;; Create the form to be evaled.
427 (if (or max-width cut-width ignore-value)
430 (let ((el (car elem)))
431 (cond ((= (cadr elem) ?c)
432 (setq el (list 'char-to-string el)))
434 (setq el (list 'int-to-string el))))
436 (setq el (gnus-tilde-ignore-form el ignore-value)))
438 (setq el (gnus-tilde-cut-form el cut-width)))
440 (setq el (gnus-tilde-max-form el max-width)))
443 (push (car elem) flist))))
444 (setq fstring (buffer-string)))
446 ;; Do some postprocessing to increase efficiency.
451 ((string= fstring "")
453 ;; Not a format string.
454 ((not (string-match "%" fstring))
456 ;; A format string with just a single string spec.
457 ((string= fstring "%s")
459 ;; A single character.
460 ((string= fstring "%c")
463 ((string= fstring "%d")
466 (list `(princ ,(car flist)))
467 (list `(int-to-string ,(car flist)))))
468 ;; Just lots of chars and strings.
469 ((string-match "\\`\\(%[cs]\\)+\\'" fstring)
471 ;; A single string spec at the beginning of the spec.
472 ((string-match "\\`%[sc][^%]+\\'" fstring)
473 (list (car flist) (substring fstring 2)))
474 ;; A single string spec in the middle of the spec.
475 ((string-match "\\`\\([^%]+\\)%[sc]\\([^%]+\\)\\'" fstring)
476 (list (match-string 1 fstring) (car flist) (match-string 2 fstring)))
477 ;; A single string spec in the end of the spec.
478 ((string-match "\\`\\([^%]+\\)%[sc]\\'" fstring)
479 (list (match-string 1 fstring) (car flist)))
480 ;; A more complex spec.
482 (list (cons 'format (cons fstring (nreverse flist)))))))
488 (cons 'insert result)))
489 (cond ((stringp result)
492 (cons 'concat result))
495 (defun gnus-eval-format (format &optional alist props)
496 "Eval the format variable FORMAT, using ALIST.
497 If PROPS, insert the result."
498 (let ((form (gnus-parse-format format alist props)))
500 (gnus-add-text-properties (point) (progn (eval form) (point)) props)
503 (defun gnus-compile ()
504 "Byte-compile the user-defined format specs."
507 (let ((entries gnus-format-specs)
508 (byte-compile-warnings '(unresolved callargs redefine))
511 (gnus-message 7 "Compiling format specs...")
514 (setq entry (pop entries))
515 (if (eq (car entry) 'version)
516 (setq gnus-format-specs (delq entry gnus-format-specs))
517 (let ((form (caddr entry)))
518 (when (and (listp form)
519 ;; Under GNU Emacs, it's (byte-code ...)
520 (not (eq 'byte-code (car form)))
521 ;; Under XEmacs, it's (funcall #<compiled-function ...>)
522 (not (and (eq 'funcall (car form))
523 (compiled-function-p (cadr form)))))
524 (fset 'gnus-tmp-func `(lambda () ,form))
525 (byte-compile 'gnus-tmp-func)
526 (setcar (cddr entry) (gnus-byte-code 'gnus-tmp-func))))))
528 (push (cons 'version emacs-version) gnus-format-specs)
529 ;; Mark the .newsrc.eld file as "dirty".
530 (gnus-dribble-enter " ")
531 (gnus-message 7 "Compiling user specs...done"))))
533 (defun gnus-set-format (type &optional insertable)
534 (set (intern (format "gnus-%s-line-format-spec" type))
536 (symbol-value (intern (format "gnus-%s-line-format" type)))
537 (symbol-value (intern (format "gnus-%s-line-format-alist" type)))
543 ;;; gnus-spec.el ends here