(gnus-balloon-face-function): Use the help-echo text property in Emacs.
[gnus] / lisp / gnus-spec.el
1 ;;; gnus-spec.el --- format spec functions for Gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news
7
8 ;; This file is part of GNU Emacs.
9
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)
13 ;; any later version.
14
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.
19
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.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile (require 'cl))
30
31 (require 'gnus)
32
33 (defcustom gnus-use-correct-string-widths (featurep 'xemacs)
34   "*If non-nil, use correct functions for dealing with wide characters."
35   :group 'gnus-format
36   :type 'boolean)
37
38 ;;; Internal variables.
39
40 (defvar gnus-summary-mark-positions nil)
41 (defvar gnus-group-mark-positions nil)
42 (defvar gnus-group-indentation "")
43
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.
49
50 ;; First we have lots of dummy defvars to let the compiler know these
51 ;; are really dynamic variables.
52
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)
79
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
84    (point)
85    (progn
86      (insert
87       (format "%c%4s: %-23s%c" gnus-tmp-opening-bracket gnus-tmp-lines
88               (let ((val
89                      (inline
90                        (gnus-summary-from-or-to-or-newsgroups
91                         gnus-tmp-header gnus-tmp-from))))
92                 (if (> (length val) 23)
93                     (substring val 0 23)
94                   val))
95               gnus-tmp-closing-bracket))
96      (point))
97    gnus-mouse-face-prop gnus-mouse-face)
98   (insert " " gnus-tmp-subject-or-nil "\n"))
99
100 (defvar gnus-summary-line-format-spec
101   (gnus-byte-code 'gnus-summary-line-format-spec))
102
103 (defun gnus-summary-dummy-line-format-spec ()
104   (insert "*  ")
105   (gnus-put-text-property
106    (point)
107    (progn
108      (insert ":                          :")
109      (point))
110    gnus-mouse-face-prop gnus-mouse-face)
111   (insert " " gnus-tmp-subject "\n"))
112
113 (defvar gnus-summary-dummy-line-format-spec
114   (gnus-byte-code 'gnus-summary-dummy-line-format-spec))
115
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
122    (point)
123    (progn
124      (insert gnus-tmp-group "\n")
125      (1- (point)))
126    gnus-mouse-face-prop gnus-mouse-face))
127 (defvar gnus-group-line-format-spec
128   (gnus-byte-code 'gnus-group-line-format-spec))
129
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.")
139
140 (defvar gnus-default-format-specs gnus-format-specs)
141
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)
145
146 ;;; Phew.  All that gruft is over with, fortunately.
147
148 ;;;###autoload
149 (defun gnus-update-format (var)
150   "Update the format specification near point."
151   (interactive
152    (list
153     (save-excursion
154       (eval-defun nil)
155       ;; Find the end of the current word.
156       (re-search-forward "[ \t\n]" nil t)
157       ;; Search backward.
158       (when (re-search-backward "\\(gnus-[-a-z]+-line-format\\)" nil t)
159         (match-string 1)))))
160   (let* ((type (intern (progn (string-match "gnus-\\([-a-z]+\\)-line" var)
161                               (match-string 1 var))))
162          (entry (assq type gnus-format-specs))
163          value spec)
164     (when entry
165       (setq gnus-format-specs (delq entry gnus-format-specs)))
166     (set
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)
173
174     (pop-to-buffer "*Gnus Format*")
175     (erase-buffer)
176     (lisp-interaction-mode)
177     (insert (pp-to-string spec))))
178
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.
183   (when (or force
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))
190
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.)
196       (save-excursion
197         (let ((buffer (intern (format "gnus-%s-buffer" type)))
198               val)
199           (when (and (boundp buffer)
200                      (setq val (symbol-value buffer))
201                      (gnus-buffer-exists-p val))
202             (set-buffer val))
203           (setq new-format (symbol-value
204                             (intern (format "gnus-%s-line-format" type)))))
205         (setq entry (cdr (assq type gnus-format-specs)))
206         (if (and (car entry)
207                  (equal (car entry) new-format))
208             ;; Use the old format.
209             (set (intern (format "gnus-%s-line-format-spec" type))
210                  (cadr entry))
211           ;; This is a new format.
212           (setq val
213                 (if (not (stringp new-format))
214                     ;; This is a function call or something.
215                     new-format
216                   ;; This is a "real" format.
217                   (gnus-parse-format
218                    new-format
219                    (symbol-value
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.
223           (if entry
224               (progn
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)))))
229
230   (unless (assq 'version gnus-format-specs)
231     (push (cons 'version emacs-version) gnus-format-specs)))
232
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)
238
239 (defun gnus-mouse-face-function (form type)
240   `(gnus-put-text-property
241     (point) (progn ,@form (point))
242     gnus-mouse-face-prop
243     ,(if (equal type 0)
244          'gnus-mouse-face
245        `(quote ,(symbol-value (intern (format "gnus-mouse-face-%d" type)))))))
246
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)
252
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))))))
257
258 (defun gnus-balloon-face-function (form type)
259   `(gnus-put-text-property
260     (point) (progn ,@form (point))
261     ,(if (fboundp 'balloon-help-mode)
262          ''balloon-help
263        ''help-echo)
264     ,(intern (format "gnus-balloon-face-%d" type))))
265
266 (defun gnus-spec-tab (column)
267   (if (> column 0)
268       `(insert (make-string (max (- ,column (current-column)) 0) ? ))
269     (let ((column (abs column)))
270       (if gnus-use-correct-string-widths
271           `(progn
272              (if (> (current-column) ,column)
273                  (while (progn
274                           (delete-backward-char 1)
275                           (> (current-column) ,column))))
276              (insert (make-string (max (- ,column (current-column)) 0) ? )))
277         `(progn
278            (if (> (current-column) ,column)
279                (delete-region (point)
280                               (- (point) (- (current-column) ,column)))
281              (insert (make-string (max (- ,column (current-column)) 0)
282                                   ? ))))))))
283
284 (defun gnus-correct-length (string)
285   "Return the correct width of STRING."
286   (let ((length 0))
287     (mapcar (lambda (char) (incf length (gnus-char-width char))) string)
288     length))
289
290 (defun gnus-correct-substring (string start &optional end)
291   (let ((wstart 0)
292         (wend 0)
293         (wseek 0)
294         (seek 0)
295         (length (length string))
296         (string (concat string "\0")))
297     ;; Find the start position.
298     (while (and (< seek length)
299                 (< wseek start))
300       (incf wseek (gnus-char-width (aref string seek)))
301       (incf seek))
302     (setq wstart seek)
303     ;; Find the end position.
304     (while (and (<= seek length)
305                 (or (not end)
306                     (<= wseek end)))
307       (incf wseek (gnus-char-width (aref string seek)))
308       (incf seek))
309     (setq wend seek)
310     (substring string wstart (1- wend))))
311
312 (defun gnus-string-width-function ()
313   (cond
314    (gnus-use-correct-string-widths
315     'gnus-correct-length)
316    ((fboundp 'string-width)
317     'string-width)
318    (t
319     'length)))
320
321 (defun gnus-substring-function ()
322   (cond
323    (gnus-use-correct-string-widths
324     'gnus-correct-substring)
325    ((fboundp 'string-width)
326     'gnus-correct-substring)
327    (t
328     'substring)))
329
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)))
335     (if (symbolp el)
336         `(if (> (,length-fun ,el) ,max)
337              ,(if (< max-width 0)
338                   `(,substring-fun ,el (- (,length-fun ,el) ,max))
339                 `(,substring-fun ,el 0 ,max))
340            ,el)
341       `(let ((val (eval ,el)))
342          (if (> (,length-fun val) ,max)
343              ,(if (< max-width 0)
344                   `(,substring-fun val (- (,length-fun val) ,max))
345                 `(,substring-fun val 0 ,max))
346            val)))))
347
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)))
353     (if (symbolp el)
354         `(if (> (,length-fun ,el) ,cut)
355              ,(if (< cut-width 0)
356                   `(,substring-fun ,el 0 (- (,length-fun ,el) ,cut))
357                 `(,substring-fun ,el ,cut))
358            ,el)
359       `(let ((val (eval ,el)))
360          (if (> (,length-fun val) ,cut)
361              ,(if (< cut-width 0)
362                   `(,substring-fun val 0 (- (,length-fun val) ,cut))
363                 `(,substring-fun val ,cut))
364            val)))))
365
366 (defun gnus-tilde-ignore-form (el ignore-value)
367   "Return a form that is blank when EL is IGNORE-VALUE."
368   (if (symbolp el)
369       `(if (equal ,el ,ignore-value)
370            "" ,el)
371     `(let ((val (eval ,el)))
372        (if (equal val ,ignore-value)
373            "" val))))
374
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)))
381     (if (symbolp el)
382         `(let ((need (- ,pad (,(if gnus-use-correct-string-widths
383                                    'gnus-correct-length
384                                  'length)
385                               ,el))))
386            (if (> need 0)
387                (concat ,(when side '(make-string need ?\ ))
388                        ,el
389                        ,(when (not side) '(make-string need ?\ )))
390              ,el))
391       `(let* ((val (eval ,el))
392               (need (- ,pad (,(if gnus-use-correct-string-widths
393                                   'gnus-correct-length
394                                 'length) val))))
395          (if (> need 0)
396              (concat ,(when side '(make-string need ?\ ))
397                      val
398                      ,(when (not side) '(make-string need ?\ )))
399            val)))))
400
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))
409     (if (string-match
410          "\\`\\(.*\\)%[0-9]?[{(«]\\(.*\\)%[0-9]?[»})]\\(.*\n?\\)\\'\\|%[-0-9]*="
411          format)
412         (gnus-parse-complex-format format spec-alist)
413       ;; This is a simple format.
414       (gnus-parse-simple-format format spec-alist insert))))
415
416 (defun gnus-parse-complex-format (format spec-alist)
417   (let (found-C)
418     (save-excursion
419       (gnus-set-work-buffer)
420       (insert format)
421       (goto-char (point-min))
422       (while (re-search-forward "\"" nil t)
423         (replace-match "\\\"" nil t))
424       (goto-char (point-min))
425       (insert "(\"")
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 ?\()
432                   (= delim ?\{)
433                   (= delim ?\«))
434               (replace-match (concat "\"("
435                                      (cond ((= delim ?\() "mouse")
436                                            ((= delim ?\{) "face")
437                                            (t "balloon"))
438                                      " " number " \"")
439                              t t)
440             (replace-match "\")\""))))
441       (goto-char (point-max))
442       (insert "\")")
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)
448           (setq found-C 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))))
456         (if found-C
457             `(let (gnus-position)
458                ,@(gnus-complex-form-to-spec form spec-alist)
459                (if gnus-position
460                    (gnus-put-text-property gnus-position (1+ gnus-position)
461                                            'gnus-position t)))
462           `(progn
463              ,@(gnus-complex-form-to-spec form spec-alist)))))))
464
465 (defun gnus-complex-form-to-spec (form spec-alist)
466   (delq nil
467         (mapcar
468          (lambda (sform)
469            (cond
470             ((stringp sform)
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)))
476             (t
477              (funcall (intern (format "gnus-%s-face-function" (car sform)))
478                       (gnus-complex-form-to-spec (cddr sform) spec-alist)
479                       (nth 1 sform)))))
480          form)))
481
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
485   ;; string.
486   (let ((max-width 0)
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)
490     (save-excursion
491       (gnus-set-work-buffer)
492       (insert format)
493       (goto-char (point-min))
494       (while (re-search-forward "%" nil t)
495         (setq user-defined nil
496               spec-beg nil
497               pad-width nil
498               max-width nil
499               cut-width nil
500               ignore-value nil
501               tilde-form nil
502               extended-spec nil)
503         (setq spec-beg (1- (point)))
504
505         ;; Parse this spec fully.
506         (while
507             (cond
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))
513                                                    (match-end 2)))))
514               (goto-char (match-end 0)))
515              ((looking-at "~")
516               (forward-char 1)
517               (setq tilde (read (current-buffer))
518                     type (car tilde)
519                     value (cadr tilde))
520               (cond
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))
527                ((eq type 'max-left)
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)))
533                ((eq type 'ignore)
534                 (setq ignore-value
535                       (if (stringp value) value (format "%s" value))))
536                ((eq type 'form)
537                 (setq tilde-form value))
538                (t
539                 (error "Unknown tilde type: %s" tilde)))
540               t)
541              (t
542               nil)))
543         (cond
544          ;; User-defined spec -- find the spec name.
545          ((eq (setq spec (char-after)) ?u)
546           (forward-char 1)
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))))
551          ;; extended spec
552          ((and (eq spec ?&) (looking-at "&\\([^;]+\\);"))
553           (setq extended-spec (intern (match-string 1)))
554           (goto-char (match-end 1))))
555         (forward-char 1)
556         (delete-region spec-beg (point))
557
558         ;; Now we have all the relevant data on this spec, so
559         ;; we start doing stuff.
560         (insert "%")
561         (if (eq spec ?%)
562             ;; "%%" just results in a "%".
563             (insert "%")
564           (cond
565            ;; Do tilde forms.
566            ((eq spec ?@)
567             (setq elem (list tilde-form ?s)))
568            ;; Treat user defined format specifiers specially.
569            (user-defined
570             (setq elem
571                   (list
572                    (list (intern (format
573                                   (if (stringp user-defined)
574                                       "gnus-user-format-function-%s"
575                                     "gnus-user-format-function-%c")
576                                   user-defined))
577                          'gnus-tmp-header)
578                    ?s)))
579            ;; Find the specification from `spec-alist'.
580            ((setq elem (cdr (assq (or extended-spec spec) spec-alist))))
581            (t
582             (setq elem '("*" ?s))))
583           (setq elem-type (cadr elem))
584           ;; Insert the new format elements.
585           (when (and pad-width
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))
593               (progn
594                 (insert ?s)
595                 (let ((el (car elem)))
596                   (cond ((= (cadr elem) ?c)
597                          (setq el (list 'char-to-string el)))
598                         ((= (cadr elem) ?d)
599                          (setq el (list 'int-to-string el))))
600                   (when ignore-value
601                     (setq el (gnus-tilde-ignore-form el ignore-value)))
602                   (when cut-width
603                     (setq el (gnus-tilde-cut-form el cut-width)))
604                   (when max-width
605                     (setq el (gnus-tilde-max-form el max-width)))
606                   (when pad-width
607                     (setq el (gnus-pad-form el pad-width)))
608                   (push el flist)))
609             (insert elem-type)
610             (push (car elem) flist))))
611       (setq fstring (buffer-substring-no-properties (point-min) (point-max))))
612
613     ;; Do some postprocessing to increase efficiency.
614     (setq
615      result
616      (cond
617       ;; Emptiness.
618       ((string= fstring "")
619        nil)
620       ;; Not a format string.
621       ((not (string-match "%" fstring))
622        (list fstring))
623       ;; A format string with just a single string spec.
624       ((string= fstring "%s")
625        (list (car flist)))
626       ;; A single character.
627       ((string= fstring "%c")
628        (list (car flist)))
629       ;; A single number.
630       ((string= fstring "%d")
631        (setq dontinsert)
632        (if insert
633            (list `(princ ,(car flist)))
634          (list `(int-to-string ,(car flist)))))
635       ;; Just lots of chars and strings.
636       ((string-match "\\`\\(%[cs]\\)+\\'" fstring)
637        (nreverse flist))
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.
648       (t
649        (list (cons 'format (cons fstring (nreverse flist)))))))
650
651     (if insert
652         (when result
653           (if dontinsert
654               result
655             (cons 'insert result)))
656       (cond ((stringp result)
657              result)
658             ((consp result)
659              (cons 'concat result))
660             (t "")))))
661
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)))
666     (if props
667         (gnus-add-text-properties (point) (progn (eval form) (point)) props)
668       (eval form))))
669
670 (defun gnus-compile ()
671   "Byte-compile the user-defined format specs."
672   (interactive)
673   (require 'bytecomp)
674   (let ((entries gnus-format-specs)
675         (byte-compile-warnings '(unresolved callargs redefine))
676         entry gnus-tmp-func)
677     (save-excursion
678       (gnus-message 7 "Compiling format specs...")
679
680       (while entries
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))))))
694
695       (push (cons 'version emacs-version) gnus-format-specs)
696       ;; Mark the .newsrc.eld file as "dirty".
697       (gnus-dribble-touch)
698       (gnus-message 7 "Compiling user specs...done"))))
699
700 (defun gnus-set-format (type &optional insertable)
701   (set (intern (format "gnus-%s-line-format-spec" type))
702        (gnus-parse-format
703         (symbol-value (intern (format "gnus-%s-line-format" type)))
704         (symbol-value (intern (format "gnus-%s-line-format-alist" type)))
705         insertable)))
706
707 (provide 'gnus-spec)
708
709 ;; Local Variables:
710 ;; coding: iso-8859-1
711 ;; End:
712
713 ;;; gnus-spec.el ends here