1 ;;; gnus-spec.el --- format spec functions for Gnus
2 ;; Copyright (C) 1996 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
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.
31 ;;; Internal variables.
33 (defvar gnus-summary-mark-positions nil)
34 (defvar gnus-group-mark-positions nil)
35 (defvar gnus-group-indentation "")
37 ;; Format specs. The chunks below are the machine-generated forms
38 ;; that are to be evaled as the result of the default format strings.
39 ;; We write them in here to get them byte-compiled. That way the
40 ;; default actions will be quite fast, while still retaining the full
41 ;; flexibility of the user-defined format specs.
43 ;; First we have lots of dummy defvars to let the compiler know these
44 ;; are really dynamic variables.
46 (defvar gnus-tmp-unread)
47 (defvar gnus-tmp-replied)
48 (defvar gnus-tmp-score-char)
49 (defvar gnus-tmp-indentation)
50 (defvar gnus-tmp-opening-bracket)
51 (defvar gnus-tmp-lines)
52 (defvar gnus-tmp-name)
53 (defvar gnus-tmp-closing-bracket)
54 (defvar gnus-tmp-subject-or-nil)
55 (defvar gnus-tmp-subject)
56 (defvar gnus-tmp-marked)
57 (defvar gnus-tmp-marked-mark)
58 (defvar gnus-tmp-subscribed)
59 (defvar gnus-tmp-process-marked)
60 (defvar gnus-tmp-number-of-unread)
61 (defvar gnus-tmp-group-name)
62 (defvar gnus-tmp-group)
63 (defvar gnus-tmp-article-number)
64 (defvar gnus-tmp-unread-and-unselected)
65 (defvar gnus-tmp-news-method)
66 (defvar gnus-tmp-news-server)
67 (defvar gnus-tmp-article-number)
68 (defvar gnus-mouse-face)
69 (defvar gnus-mouse-face-prop)
71 (defun gnus-summary-line-format-spec ()
72 (insert gnus-tmp-unread gnus-tmp-replied
73 gnus-tmp-score-char gnus-tmp-indentation)
74 (gnus-put-text-property
78 gnus-tmp-opening-bracket
81 (if (> (length gnus-tmp-name) 20)
82 (substring gnus-tmp-name 0 20)
84 gnus-tmp-closing-bracket)
86 gnus-mouse-face-prop gnus-mouse-face)
87 (insert " " gnus-tmp-subject-or-nil "\n"))
89 (defvar gnus-summary-line-format-spec
90 (gnus-byte-code 'gnus-summary-line-format-spec))
92 (defun gnus-summary-dummy-line-format-spec ()
94 (gnus-put-text-property
99 gnus-mouse-face-prop gnus-mouse-face)
100 (insert " " gnus-tmp-subject "\n"))
102 (defvar gnus-summary-dummy-line-format-spec
103 (gnus-byte-code 'gnus-summary-dummy-line-format-spec))
105 (defun gnus-group-line-format-spec ()
106 (insert gnus-tmp-marked-mark gnus-tmp-subscribed
107 gnus-tmp-process-marked
108 gnus-group-indentation
109 (format "%5s: " gnus-tmp-number-of-unread))
110 (gnus-put-text-property
113 (insert gnus-tmp-group "\n")
115 gnus-mouse-face-prop gnus-mouse-face))
116 (defvar gnus-group-line-format-spec
117 (gnus-byte-code 'gnus-group-line-format-spec))
119 (defvar gnus-format-specs
120 `((version . ,emacs-version)
121 (group "%M\%S\%p\%P\%5y: %(%g%)%l\n" ,gnus-group-line-format-spec)
122 (summary-dummy "* %(: :%) %S\n"
123 ,gnus-summary-dummy-line-format-spec)
124 (summary "%U\%R\%z\%I\%(%[%4L: %-20,20n%]%) %s\n"
125 ,gnus-summary-line-format-spec))
126 "Alist of format specs.")
128 (defvar gnus-article-mode-line-format-spec nil)
129 (defvar gnus-summary-mode-line-format-spec nil)
130 (defvar gnus-group-mode-line-format-spec nil)
132 ;;; Phew. All that gruft is over, fortunately.
135 (defun gnus-update-format (var)
136 "Update the format specification near point."
141 ;; Find the end of the current word.
142 (re-search-forward "[ \t\n]" nil t)
144 (when (re-search-backward "\\(gnus-[-a-z]+-line-format\\)" nil t)
146 (let* ((type (intern (progn (string-match "gnus-\\([-a-z]+\\)-line" var)
147 (match-string 1 var))))
148 (entry (assq type gnus-format-specs))
151 (setq gnus-format-specs (delq entry gnus-format-specs)))
153 (intern (format "%s-spec" var))
154 (gnus-parse-format (setq value (symbol-value (intern var)))
155 (symbol-value (intern (format "%s-alist" var)))
156 (not (string-match "mode" var))))
157 (setq spec (symbol-value (intern (format "%s-spec" var))))
158 (push (list type value spec) gnus-format-specs)
160 (pop-to-buffer "*Gnus Format*")
162 (lisp-interaction-mode)
163 (insert (pp-to-string spec))))
165 (defun gnus-update-format-specifications (&optional force &rest types)
166 "Update all (necessary) format specifications."
167 ;; 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))
186 (buffer-name (get-buffer val)))
187 (set-buffer (get-buffer val)))
188 (setq new-format (symbol-value
189 (intern (format "gnus-%s-line-format" type))))))
190 (setq entry (cdr (assq type gnus-format-specs)))
192 (equal (car entry) new-format))
193 ;; Use the old format.
194 (set (intern (format "gnus-%s-line-format-spec" type))
196 ;; This is a new format.
198 (if (not (stringp new-format))
199 ;; This is a function call or something.
201 ;; This is a "real" format.
205 (intern (format "gnus-%s-line-format-alist"
206 (if (eq type 'article-mode)
207 'summary-mode type))))
208 (not (string-match "mode$" (symbol-name type))))))
209 ;; Enter the new format spec into the list.
212 (setcar (cdr entry) val)
213 (setcar entry new-format))
214 (push (list type new-format val) gnus-format-specs))
215 (set (intern (format "gnus-%s-line-format-spec" type)) val))))
217 (unless (assq 'version gnus-format-specs)
218 (push (cons 'version emacs-version) gnus-format-specs)))
220 (defvar gnus-mouse-face-0 'highlight)
221 (defvar gnus-mouse-face-1 'highlight)
222 (defvar gnus-mouse-face-2 'highlight)
223 (defvar gnus-mouse-face-3 'highlight)
224 (defvar gnus-mouse-face-4 'highlight)
226 (defun gnus-mouse-face-function (form type)
227 `(gnus-put-text-property
228 (point) (progn ,@form (point))
232 `(quote ,(symbol-value (intern (format "gnus-mouse-face-%d" type)))))))
234 (defvar gnus-face-0 'bold)
235 (defvar gnus-face-1 'italic)
236 (defvar gnus-face-2 'bold-italic)
237 (defvar gnus-face-3 'bold)
238 (defvar gnus-face-4 'bold)
240 (defun gnus-face-face-function (form type)
241 `(gnus-put-text-property
242 (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 ?\() (= delim ?\{))
312 (replace-match (concat "\"(" (if (= delim ?\() "mouse" "face")
314 (replace-match "\")\""))))
315 (goto-char (point-max))
317 (goto-char (point-min))
318 (let ((form (read (current-buffer))))
319 (cons 'progn (gnus-complex-form-to-spec form spec-alist)))))
321 (defun gnus-complex-form-to-spec (form spec-alist)
326 (gnus-parse-simple-format sform spec-alist t)
327 (funcall (intern (format "gnus-%s-face-function" (car sform)))
328 (gnus-complex-form-to-spec (cddr sform) spec-alist)
332 (defun gnus-parse-simple-format (format spec-alist &optional insert)
333 ;; This function parses the FORMAT string with the help of the
334 ;; SPEC-ALIST and returns a list that can be eval'ed to return a
337 spec flist fstring elem result dontinsert user-defined
338 type value pad-width spec-beg cut-width ignore-value
339 tilde-form tilde elem-type)
341 (gnus-set-work-buffer)
343 (goto-char (point-min))
344 (while (re-search-forward "%" nil t)
345 (setq user-defined nil
352 (setq spec-beg (1- (point)))
354 ;; Parse this spec fully.
357 ((looking-at "\\([-.0-9]+\\)\\(,[-0-9]+\\)?")
358 (setq pad-width (string-to-number (match-string 1)))
359 (when (match-beginning 2)
360 (setq max-width (string-to-number (buffer-substring
361 (1+ (match-beginning 2))
363 (goto-char (match-end 0)))
366 (setq tilde (read (current-buffer))
370 ((memq type '(pad pad-left))
371 (setq pad-width value))
372 ((eq type 'pad-right)
373 (setq pad-width (- value)))
374 ((memq type '(max-right max))
375 (setq max-width value))
377 (setq max-width (- value)))
378 ((memq type '(cut cut-left))
379 (setq cut-width value))
380 ((eq type 'cut-right)
381 (setq cut-width (- value)))
384 (if (stringp value) value (format "%s" value))))
386 (setq tilde-form value))
388 (error "Unknown tilde type: %s" tilde)))
392 ;; User-defined spec -- find the spec name.
393 (when (= (setq spec (following-char)) ?u)
395 (setq user-defined (following-char)))
397 (delete-region spec-beg (point))
399 ;; Now we have all the relevant data on this spec, so
400 ;; we start doing stuff.
403 ;; "%%" just results in a "%".
408 (setq elem (list tilde-form ?s)))
409 ;; Treat user defined format specifiers specially.
413 (list (intern (format "gnus-user-format-function-%c"
415 'gnus-tmp-header) ?s)))
416 ;; Find the specification from `spec-alist'.
417 ((setq elem (cdr (assq spec spec-alist))))
419 (setq elem '("*" ?s))))
420 (setq elem-type (cadr elem))
421 ;; Insert the new format elements.
423 (insert (number-to-string pad-width)))
424 ;; Create the form to be evaled.
425 (if (or max-width cut-width ignore-value)
428 (let ((el (car elem)))
429 (cond ((= (cadr elem) ?c)
430 (setq el (list 'char-to-string el)))
432 (setq el (list 'int-to-string el))))
434 (setq el (gnus-tilde-ignore-form el ignore-value)))
436 (setq el (gnus-tilde-cut-form el cut-width)))
438 (setq el (gnus-tilde-max-form el max-width)))
441 (push (car elem) flist))))
442 (setq fstring (buffer-string)))
444 ;; Do some postprocessing to increase efficiency.
449 ((string= fstring "")
451 ;; Not a format string.
452 ((not (string-match "%" fstring))
454 ;; A format string with just a single string spec.
455 ((string= fstring "%s")
457 ;; A single character.
458 ((string= fstring "%c")
461 ((string= fstring "%d")
464 (list `(princ ,(car flist)))
465 (list `(int-to-string ,(car flist)))))
466 ;; Just lots of chars and strings.
467 ((string-match "\\`\\(%[cs]\\)+\\'" fstring)
469 ;; A single string spec at the beginning of the spec.
470 ((string-match "\\`%[sc][^%]+\\'" fstring)
471 (list (car flist) (substring fstring 2)))
472 ;; A single string spec in the middle of the spec.
473 ((string-match "\\`\\([^%]+\\)%[sc]\\([^%]+\\)\\'" fstring)
474 (list (match-string 1 fstring) (car flist) (match-string 2 fstring)))
475 ;; A single string spec in the end of the spec.
476 ((string-match "\\`\\([^%]+\\)%[sc]\\'" fstring)
477 (list (match-string 1 fstring) (car flist)))
478 ;; A more complex spec.
480 (list (cons 'format (cons fstring (nreverse flist)))))))
486 (cons 'insert result)))
487 (cond ((stringp result)
490 (cons 'concat result))
493 (defun gnus-eval-format (format &optional alist props)
494 "Eval the format variable FORMAT, using ALIST.
495 If PROPS, insert the result."
496 (let ((form (gnus-parse-format format alist props)))
498 (gnus-add-text-properties (point) (progn (eval form) (point)) props)
501 (defun gnus-compile ()
502 "Byte-compile the user-defined format specs."
504 (let ((entries gnus-format-specs)
505 (byte-compile-warnings '(unresolved callargs redefine))
508 (gnus-message 7 "Compiling format specs...")
511 (setq entry (pop entries))
512 (if (eq (car entry) 'version)
513 (setq gnus-format-specs (delq entry gnus-format-specs))
514 (when (and (listp (caddr entry))
515 (not (eq 'byte-code (caaddr entry))))
516 (fset 'gnus-tmp-func `(lambda () ,(caddr entry)))
517 (byte-compile 'gnus-tmp-func)
518 (setcar (cddr entry) (gnus-byte-code 'gnus-tmp-func)))))
520 (push (cons 'version emacs-version) gnus-format-specs)
521 ;; Mark the .newsrc.eld file as "dirty".
522 (gnus-dribble-enter " ")
523 (gnus-message 7 "Compiling user specs...done"))))
527 ;;; gnus-spec.el ends here