[bpt/emacs.git] / lisp / gnus / gnus-spec.el

;;; gnus-spec.el --- format spec functions for Gnus

;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
;;   2005, 2006, 2007 Free Software Foundation, Inc.

;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: news

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;;; Code:

(eval-when-compile (require 'cl))
(defvar gnus-newsrc-file-version)

(require 'gnus)

(defcustom gnus-use-correct-string-widths (featurep 'xemacs)
  "*If non-nil, use correct functions for dealing with wide characters."
  :version "22.1"
  :group 'gnus-format
  :type 'boolean)

(defcustom gnus-make-format-preserve-properties (featurep 'xemacs)
  "*If non-nil, use a replacement `format' function which preserves
text properties. This is only needed on XEmacs, as FSF Emacs does this anyway."
  :version "22.1"
  :group 'gnus-format
  :type 'boolean)

;;; Internal variables.

(defvar gnus-summary-mark-positions nil)
(defvar gnus-group-mark-positions nil)
(defvar gnus-group-indentation "")

;; Format specs.  The chunks below are the machine-generated forms
;; that are to be evaled as the result of the default format strings.
;; We write them in here to get them byte-compiled.  That way the
;; default actions will be quite fast, while still retaining the full
;; flexibility of the user-defined format specs.

;; First we have lots of dummy defvars to let the compiler know these
;; are really dynamic variables.

(defvar gnus-tmp-unread)
(defvar gnus-tmp-replied)
(defvar gnus-tmp-score-char)
(defvar gnus-tmp-indentation)
(defvar gnus-tmp-opening-bracket)
(defvar gnus-tmp-lines)
(defvar gnus-tmp-name)
(defvar gnus-tmp-closing-bracket)
(defvar gnus-tmp-subject-or-nil)
(defvar gnus-tmp-subject)
(defvar gnus-tmp-marked)
(defvar gnus-tmp-marked-mark)
(defvar gnus-tmp-subscribed)
(defvar gnus-tmp-process-marked)
(defvar gnus-tmp-number-of-unread)
(defvar gnus-tmp-group-name)
(defvar gnus-tmp-group)
(defvar gnus-tmp-article-number)
(defvar gnus-tmp-unread-and-unselected)
(defvar gnus-tmp-news-method)
(defvar gnus-tmp-news-server)
(defvar gnus-tmp-article-number)
(defvar gnus-mouse-face)
(defvar gnus-mouse-face-prop)
(defvar gnus-tmp-header)
(defvar gnus-tmp-from)

(defun gnus-summary-line-format-spec ()
  (insert gnus-tmp-unread gnus-tmp-replied
	  gnus-tmp-score-char gnus-tmp-indentation)
  (gnus-put-text-property
   (point)
   (progn
     (insert
      (format "%c%4s: %-23s%c" gnus-tmp-opening-bracket gnus-tmp-lines
	      (let ((val
		     (inline
		       (gnus-summary-from-or-to-or-newsgroups
			gnus-tmp-header gnus-tmp-from))))
		(if (> (length val) 23)
		    (substring val 0 23)
		  val))
	      gnus-tmp-closing-bracket))
     (point))
   gnus-mouse-face-prop gnus-mouse-face)
  (insert " " gnus-tmp-subject-or-nil "\n"))

(defvar gnus-summary-line-format-spec
  (gnus-byte-code 'gnus-summary-line-format-spec))

(defun gnus-summary-dummy-line-format-spec ()
  (insert "*  ")
  (gnus-put-text-property
   (point)
   (progn
     (insert ":				 :")
     (point))
   gnus-mouse-face-prop gnus-mouse-face)
  (insert " " gnus-tmp-subject "\n"))

(defvar gnus-summary-dummy-line-format-spec
  (gnus-byte-code 'gnus-summary-dummy-line-format-spec))

(defun gnus-group-line-format-spec ()
  (insert gnus-tmp-marked-mark gnus-tmp-subscribed
	  gnus-tmp-process-marked
	  gnus-group-indentation
	  (format "%5s: " gnus-tmp-number-of-unread))
  (gnus-put-text-property
   (point)
   (progn
     (insert gnus-tmp-group "\n")
     (1- (point)))
   gnus-mouse-face-prop gnus-mouse-face))
(defvar gnus-group-line-format-spec
  (gnus-byte-code 'gnus-group-line-format-spec))

(defvar gnus-format-specs
  `((version . ,emacs-version)
    (gnus-version . ,(gnus-continuum-version))
    (group "%M\%S\%p\%P\%5y: %(%g%)\n" ,gnus-group-line-format-spec)
    (summary-dummy "*  %(:                          :%) %S\n"
		   ,gnus-summary-dummy-line-format-spec)
    (summary "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
	     ,gnus-summary-line-format-spec))
  "Alist of format specs.")

(defvar gnus-default-format-specs gnus-format-specs)

(defvar gnus-article-mode-line-format-spec nil)
(defvar gnus-summary-mode-line-format-spec nil)
(defvar gnus-group-mode-line-format-spec nil)

;;; Phew.  All that gruft is over with, fortunately.

;;;###autoload
(defun gnus-update-format (var)
  "Update the format specification near point."
  (interactive
   (list
    (save-excursion
      (eval-defun nil)
      ;; Find the end of the current word.
      (re-search-forward "[ \t\n]" nil t)
      ;; Search backward.
      (when (re-search-backward "\\(gnus-[-a-z]+-line-format\\)" nil t)
	(match-string 1)))))
  (let* ((type (intern (progn (string-match "gnus-\\([-a-z]+\\)-line" var)
			      (match-string 1 var))))
	 (entry (assq type gnus-format-specs))
	 value spec)
    (when entry
      (setq gnus-format-specs (delq entry gnus-format-specs)))
    (set
     (intern (format "%s-spec" var))
     (gnus-parse-format (setq value (symbol-value (intern var)))
			(symbol-value (intern (format "%s-alist" var)))
			(not (string-match "mode" var))))
    (setq spec (symbol-value (intern (format "%s-spec" var))))
    (push (list type value spec) gnus-format-specs)

    (pop-to-buffer "*Gnus Format*")
    (erase-buffer)
    (lisp-interaction-mode)
    (insert (gnus-pp-to-string spec))))

(defun gnus-update-format-specifications (&optional force &rest types)
  "Update all (necessary) format specifications.
Return a list of updated types."
  ;; Make the indentation array.
  ;; See whether all the stored info needs to be flushed.
  (when (or force
	    (not gnus-newsrc-file-version)
	    (not (equal (gnus-continuum-version)
			(gnus-continuum-version gnus-newsrc-file-version)))
	    (not (equal emacs-version
			(cdr (assq 'version gnus-format-specs)))))
    (setq gnus-format-specs nil))
  ;; Flush the group format spec cache if there's the grouplens stuff
  ;; or it doesn't support decoded group names.
  (when (memq 'group types)
    (let* ((spec (assq 'group gnus-format-specs))
	   (sspec (gnus-prin1-to-string (nth 2 spec))))
      (when (or (string-match " gnus-tmp-grouplens[ )]" sspec)
		(not (string-match " gnus-tmp-decoded-group[ )]" sspec)))
	(setq gnus-format-specs (delq spec gnus-format-specs)))))

  ;; Go through all the formats and see whether they need updating.
  (let (new-format entry type val updated)
    (while (setq type (pop types))
      ;; Jump to the proper buffer to find out the value of the
      ;; variable, if possible.  (It may be buffer-local.)
      (save-excursion
	(let ((buffer (intern (format "gnus-%s-buffer" type))))
	  (when (and (boundp buffer)
		     (setq val (symbol-value buffer))
		     (gnus-buffer-exists-p val))
	    (set-buffer val))
	  (setq new-format (symbol-value
			    (intern (format "gnus-%s-line-format" type)))))
	(setq entry (cdr (assq type gnus-format-specs)))
	(if (and (car entry)
		 (equal (car entry) new-format))
	    ;; Use the old format.
	    (set (intern (format "gnus-%s-line-format-spec" type))
		 (cadr entry))
	  ;; This is a new format.
	  (setq val
		(if (not (stringp new-format))
		    ;; This is a function call or something.
		    new-format
		  ;; This is a "real" format.
		  (gnus-parse-format
		   new-format
		   (symbol-value
		    (intern (format "gnus-%s-line-format-alist" type)))
		   (not (string-match "mode$" (symbol-name type))))))
	  ;; Enter the new format spec into the list.
	  (if entry
	      (progn
		(setcar (cdr entry) val)
		(setcar entry new-format))
	    (push (list type new-format val) gnus-format-specs))
	  (set (intern (format "gnus-%s-line-format-spec" type)) val)
	  (push type updated))))

    (unless (assq 'version gnus-format-specs)
      (push (cons 'version emacs-version) gnus-format-specs))
    updated))

(defvar gnus-mouse-face-0 'highlight)
(defvar gnus-mouse-face-1 'highlight)
(defvar gnus-mouse-face-2 'highlight)
(defvar gnus-mouse-face-3 'highlight)
(defvar gnus-mouse-face-4 'highlight)

(defun gnus-mouse-face-function (form type)
  `(gnus-put-text-property
    (point) (progn ,@form (point))
    gnus-mouse-face-prop
    ,(if (equal type 0)
	 'gnus-mouse-face
       `(quote ,(symbol-value (intern (format "gnus-mouse-face-%d" type)))))))

(defvar gnus-face-0 'bold)
(defvar gnus-face-1 'italic)
(defvar gnus-face-2 'bold-italic)
(defvar gnus-face-3 'bold)
(defvar gnus-face-4 'bold)

(defun gnus-face-face-function (form type)
  `(gnus-add-text-properties
    (point) (progn ,@form (point))
    '(gnus-face t face ,(symbol-value (intern (format "gnus-face-%d" type))))))

(defun gnus-balloon-face-function (form type)
  `(gnus-put-text-property
    (point) (progn ,@form (point))
    ,(if (fboundp 'balloon-help-mode)
	 ''balloon-help
       ''help-echo)
    ,(intern (format "gnus-balloon-face-%d" type))))

(defun gnus-spec-tab (column)
  (if (> column 0)
      `(insert-char ?  (max (- ,column (current-column)) 0))
    (let ((column (abs column)))
      `(if (> (current-column) ,column)
	   (let ((end (point)))
	     (if (= (move-to-column ,column) ,column)
		 (delete-region (point) end)
	       (delete-region (1- (point)) end)
	       (insert " ")))
	 (insert-char ?  (max (- ,column (current-column)) 0))))))

(defun gnus-correct-length (string)
  "Return the correct width of STRING."
  (apply #'+ (mapcar #'char-width string)))

(defun gnus-correct-substring (string start &optional end)
  (let ((wstart 0)
	(wend 0)
	(wseek 0)
	(seek 0)
	(length (length string))
	(string (concat string "\0")))
    ;; Find the start position.
    (while (and (< seek length)
		(< wseek start))
      (incf wseek (char-width (aref string seek)))
      (incf seek))
    (setq wstart seek)
    ;; Find the end position.
    (while (and (<= seek length)
		(or (not end)
		    (<= wseek end)))
      (incf wseek (char-width (aref string seek)))
      (incf seek))
    (setq wend seek)
    (substring string wstart (1- wend))))

(defun gnus-string-width-function ()
  (cond
   (gnus-use-correct-string-widths
    'gnus-correct-length)
   ((fboundp 'string-width)
    'string-width)
   (t
    'length)))

(defun gnus-substring-function ()
  (cond
   (gnus-use-correct-string-widths
    'gnus-correct-substring)
   ((fboundp 'string-width)
    'gnus-correct-substring)
   (t
    'substring)))

(defun gnus-tilde-max-form (el max-width)
  "Return a form that limits EL to MAX-WIDTH."
  (let ((max (abs max-width))
	(length-fun (gnus-string-width-function))
	(substring-fun (gnus-substring-function)))
    (if (symbolp el)
	`(if (> (,length-fun ,el) ,max)
	     ,(if (< max-width 0)
		  `(,substring-fun ,el (- (,length-fun ,el) ,max))
		`(,substring-fun ,el 0 ,max))
	   ,el)
      `(let ((val (eval ,el)))
	 (if (> (,length-fun val) ,max)
	     ,(if (< max-width 0)
		  `(,substring-fun val (- (,length-fun val) ,max))
		`(,substring-fun val 0 ,max))
	   val)))))

(defun gnus-tilde-cut-form (el cut-width)
  "Return a form that cuts CUT-WIDTH off of EL."
  (let ((cut (abs cut-width))
	(length-fun (gnus-string-width-function))
	(substring-fun (gnus-substring-function)))
    (if (symbolp el)
	`(if (> (,length-fun ,el) ,cut)
	     ,(if (< cut-width 0)
		  `(,substring-fun ,el 0 (- (,length-fun ,el) ,cut))
		`(,substring-fun ,el ,cut))
	   ,el)
      `(let ((val (eval ,el)))
	 (if (> (,length-fun val) ,cut)
	     ,(if (< cut-width 0)
		  `(,substring-fun val 0 (- (,length-fun val) ,cut))
		`(,substring-fun val ,cut))
	   val)))))

(defun gnus-tilde-ignore-form (el ignore-value)
  "Return a form that is blank when EL is IGNORE-VALUE."
  (if (symbolp el)
      `(if (equal ,el ,ignore-value)
	   "" ,el)
    `(let ((val (eval ,el)))
       (if (equal val ,ignore-value)
	   "" val))))

(defun gnus-pad-form (el pad-width)
  "Return a form that pads EL to PAD-WIDTH accounting for multi-column
characters correctly. This is because `format' may pad to columns or to
characters when given a pad value."
  (let ((pad (abs pad-width))
	(side (< 0 pad-width))
	(length-fun (gnus-string-width-function)))
    (if (symbolp el)
	`(let ((need (- ,pad (,length-fun ,el))))
	   (if (> need 0)
	       (concat ,(when side '(make-string need ?\ ))
		       ,el
		       ,(when (not side) '(make-string need ?\ )))
	     ,el))
      `(let* ((val (eval ,el))
	      (need (- ,pad (,length-fun val))))
	 (if (> need 0)
	     (concat ,(when side '(make-string need ?\ ))
		     val
		     ,(when (not side) '(make-string need ?\ )))
	   val)))))

(defun gnus-parse-format (format spec-alist &optional insert)
  ;; This function parses the FORMAT string with the help of the
  ;; SPEC-ALIST and returns a list that can be eval'ed to return the
  ;; string.  If the FORMAT string contains the specifiers %( and %)
  ;; the text between them will have the mouse-face text property.
  ;; If the FORMAT string contains the specifiers %[ and %], the text between
  ;; them will have the balloon-help text property.
  (let ((case-fold-search nil))
    (if (string-match
Commit	Line	Data
23f87bed	1	;;; gnus-spec.el --- format spec functions for Gnus
e84b4b86 TTN	2
e84b4b86 TTN	3	;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
d7a0267c	4	;; 2005, 2006, 2007 Free Software Foundation, Inc.
eec82323	5
6748645f	6	;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
eec82323 LMI	7	;; Keywords: news
	8
	9	;; This file is part of GNU Emacs.
	10
	11	;; GNU Emacs is free software; you can redistribute it and/or modify
	12	;; it under the terms of the GNU General Public License as published by
5a9dffec	13	;; the Free Software Foundation; either version 3, or (at your option)
eec82323 LMI	14	;; any later version.
	15
	16	;; GNU Emacs is distributed in the hope that it will be useful,
	17	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	;; GNU General Public License for more details.
	20
	21	;; You should have received a copy of the GNU General Public License
	22	;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56 LK	23	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
3a35cf56 LK	24	;; Boston, MA 02110-1301, USA.
eec82323 LMI	25
	26	;;; Commentary:
	27
	28	;;; Code:
	29
5ab7173c	30	(eval-when-compile (require 'cl))
139bbb9c	31	(defvar gnus-newsrc-file-version)
5ab7173c	32
eec82323 LMI	33	(require 'gnus)
eec82323 LMI	34
23f87bed MB	35	(defcustom gnus-use-correct-string-widths (featurep 'xemacs)
23f87bed MB	36	"*If non-nil, use correct functions for dealing with wide characters."
bf247b6e	37	:version "22.1"
23f87bed MB	38	:group 'gnus-format
	39	:type 'boolean)
	40
	41	(defcustom gnus-make-format-preserve-properties (featurep 'xemacs)
	42	"*If non-nil, use a replacement `format' function which preserves
	43	text properties. This is only needed on XEmacs, as FSF Emacs does this anyway."
bf247b6e	44	:version "22.1"
23f87bed MB	45	:group 'gnus-format
	46	:type 'boolean)
	47
eec82323 LMI	48	;;; Internal variables.
	49
	50	(defvar gnus-summary-mark-positions nil)
	51	(defvar gnus-group-mark-positions nil)
	52	(defvar gnus-group-indentation "")
	53
	54	;; Format specs. The chunks below are the machine-generated forms
	55	;; that are to be evaled as the result of the default format strings.
	56	;; We write them in here to get them byte-compiled. That way the
	57	;; default actions will be quite fast, while still retaining the full
	58	;; flexibility of the user-defined format specs.
	59
	60	;; First we have lots of dummy defvars to let the compiler know these
	61	;; are really dynamic variables.
	62
	63	(defvar gnus-tmp-unread)
	64	(defvar gnus-tmp-replied)
	65	(defvar gnus-tmp-score-char)
	66	(defvar gnus-tmp-indentation)
	67	(defvar gnus-tmp-opening-bracket)
	68	(defvar gnus-tmp-lines)
	69	(defvar gnus-tmp-name)
	70	(defvar gnus-tmp-closing-bracket)
	71	(defvar gnus-tmp-subject-or-nil)
	72	(defvar gnus-tmp-subject)
	73	(defvar gnus-tmp-marked)
	74	(defvar gnus-tmp-marked-mark)
	75	(defvar gnus-tmp-subscribed)
	76	(defvar gnus-tmp-process-marked)
	77	(defvar gnus-tmp-number-of-unread)
	78	(defvar gnus-tmp-group-name)
	79	(defvar gnus-tmp-group)
	80	(defvar gnus-tmp-article-number)
	81	(defvar gnus-tmp-unread-and-unselected)
	82	(defvar gnus-tmp-news-method)
	83	(defvar gnus-tmp-news-server)
	84	(defvar gnus-tmp-article-number)
	85	(defvar gnus-mouse-face)
	86	(defvar gnus-mouse-face-prop)
23f87bed MB	87	(defvar gnus-tmp-header)
23f87bed MB	88	(defvar gnus-tmp-from)
eec82323 LMI	89
	90	(defun gnus-summary-line-format-spec ()
	91	(insert gnus-tmp-unread gnus-tmp-replied
	92	gnus-tmp-score-char gnus-tmp-indentation)
	93	(gnus-put-text-property
	94	(point)
	95	(progn
	96	(insert
23f87bed MB	97	(format "%c%4s: %-23s%c" gnus-tmp-opening-bracket gnus-tmp-lines
	98	(let ((val
	99	(inline
	100	(gnus-summary-from-or-to-or-newsgroups
	101	gnus-tmp-header gnus-tmp-from))))
	102	(if (> (length val) 23)
	103	(substring val 0 23)
	104	val))
	105	gnus-tmp-closing-bracket))
eec82323 LMI	106	(point))
	107	gnus-mouse-face-prop gnus-mouse-face)
	108	(insert " " gnus-tmp-subject-or-nil "\n"))
	109
	110	(defvar gnus-summary-line-format-spec
	111	(gnus-byte-code 'gnus-summary-line-format-spec))
	112
	113	(defun gnus-summary-dummy-line-format-spec ()
	114	(insert "* ")
	115	(gnus-put-text-property
	116	(point)
	117	(progn
	118	(insert ": :")
	119	(point))
	120	gnus-mouse-face-prop gnus-mouse-face)
	121	(insert " " gnus-tmp-subject "\n"))
	122
	123	(defvar gnus-summary-dummy-line-format-spec
	124	(gnus-byte-code 'gnus-summary-dummy-line-format-spec))
	125
	126	(defun gnus-group-line-format-spec ()
	127	(insert gnus-tmp-marked-mark gnus-tmp-subscribed
	128	gnus-tmp-process-marked
	129	gnus-group-indentation
	130	(format "%5s: " gnus-tmp-number-of-unread))
	131	(gnus-put-text-property
	132	(point)
	133	(progn
	134	(insert gnus-tmp-group "\n")
	135	(1- (point)))
	136	gnus-mouse-face-prop gnus-mouse-face))
	137	(defvar gnus-group-line-format-spec
	138	(gnus-byte-code 'gnus-group-line-format-spec))
	139
	140	(defvar gnus-format-specs
	141	`((version . ,emacs-version)
23f87bed	142	(gnus-version . ,(gnus-continuum-version))
01c52d31	143	(group "%M\%S\%p\%P\%5y: %(%g%)\n" ,gnus-group-line-format-spec)
eec82323 LMI	144	(summary-dummy "* %(: :%) %S\n"
eec82323 LMI	145	,gnus-summary-dummy-line-format-spec)
23f87bed	146	(summary "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
eec82323 LMI	147	,gnus-summary-line-format-spec))
	148	"Alist of format specs.")
	149
23f87bed MB	150	(defvar gnus-default-format-specs gnus-format-specs)
23f87bed MB	151
eec82323 LMI	152	(defvar gnus-article-mode-line-format-spec nil)
	153	(defvar gnus-summary-mode-line-format-spec nil)
	154	(defvar gnus-group-mode-line-format-spec nil)
	155
23f87bed	156	;;; Phew. All that gruft is over with, fortunately.
eec82323 LMI	157
	158	;;;###autoload
	159	(defun gnus-update-format (var)
	160	"Update the format specification near point."
	161	(interactive
	162	(list
	163	(save-excursion
	164	(eval-defun nil)
	165	;; Find the end of the current word.
	166	(re-search-forward "[ \t\n]" nil t)
	167	;; Search backward.
	168	(when (re-search-backward "\\(gnus-[-a-z]+-line-format\\)" nil t)
	169	(match-string 1)))))
	170	(let* ((type (intern (progn (string-match "gnus-\\([-a-z]+\\)-line" var)
	171	(match-string 1 var))))
	172	(entry (assq type gnus-format-specs))
	173	value spec)
	174	(when entry
	175	(setq gnus-format-specs (delq entry gnus-format-specs)))
	176	(set
	177	(intern (format "%s-spec" var))
	178	(gnus-parse-format (setq value (symbol-value (intern var)))
	179	(symbol-value (intern (format "%s-alist" var)))
	180	(not (string-match "mode" var))))
	181	(setq spec (symbol-value (intern (format "%s-spec" var))))
	182	(push (list type value spec) gnus-format-specs)
	183
	184	(pop-to-buffer "Gnus Format")
	185	(erase-buffer)
	186	(lisp-interaction-mode)
23f87bed	187	(insert (gnus-pp-to-string spec))))
eec82323 LMI	188
eec82323 LMI	189	(defun gnus-update-format-specifications (&optional force &rest types)
5153a47a MB	190	"Update all (necessary) format specifications.
5153a47a MB	191	Return a list of updated types."
eec82323 LMI	192	;; Make the indentation array.
	193	;; See whether all the stored info needs to be flushed.
	194	(when (or force
23f87bed MB	195	(not gnus-newsrc-file-version)
	196	(not (equal (gnus-continuum-version)
	197	(gnus-continuum-version gnus-newsrc-file-version)))
eec82323 LMI	198	(not (equal emacs-version
	199	(cdr (assq 'version gnus-format-specs)))))
	200	(setq gnus-format-specs nil))
01c52d31 MB	201	;; Flush the group format spec cache if there's the grouplens stuff
01c52d31 MB	202	;; or it doesn't support decoded group names.
91472578	203	(when (memq 'group types)
01c52d31 MB	204	(let* ((spec (assq 'group gnus-format-specs))
	205	(sspec (gnus-prin1-to-string (nth 2 spec))))
	206	(when (or (string-match " gnus-tmp-grouplens[ )]" sspec)
	207	(not (string-match " gnus-tmp-decoded-group[ )]" sspec)))
91472578	208	(setq gnus-format-specs (delq spec gnus-format-specs)))))
eec82323 LMI	209
eec82323 LMI	210	;; Go through all the formats and see whether they need updating.
5153a47a	211	(let (new-format entry type val updated)
eec82323	212	(while (setq type (pop types))
23f87bed MB	213	;; Jump to the proper buffer to find out the value of the
23f87bed MB	214	;; variable, if possible. (It may be buffer-local.)
eec82323	215	(save-excursion
5153a47a	216	(let ((buffer (intern (format "gnus-%s-buffer" type))))
eec82323 LMI	217	(when (and (boundp buffer)
eec82323 LMI	218	(setq val (symbol-value buffer))
6748645f LMI	219	(gnus-buffer-exists-p val))
6748645f LMI	220	(set-buffer val))
eec82323 LMI	221	(setq new-format (symbol-value
	222	(intern (format "gnus-%s-line-format" type)))))
	223	(setq entry (cdr (assq type gnus-format-specs)))
	224	(if (and (car entry)
	225	(equal (car entry) new-format))
	226	;; Use the old format.
	227	(set (intern (format "gnus-%s-line-format-spec" type))
	228	(cadr entry))
	229	;; This is a new format.
	230	(setq val
	231	(if (not (stringp new-format))
	232	;; This is a function call or something.
	233	new-format
	234	;; This is a "real" format.
	235	(gnus-parse-format
	236	new-format
	237	(symbol-value
16409b0b	238	(intern (format "gnus-%s-line-format-alist" type)))
eec82323 LMI	239	(not (string-match "mode$" (symbol-name type))))))
	240	;; Enter the new format spec into the list.
	241	(if entry
	242	(progn
	243	(setcar (cdr entry) val)
	244	(setcar entry new-format))
	245	(push (list type new-format val) gnus-format-specs))
5153a47a MB	246	(set (intern (format "gnus-%s-line-format-spec" type)) val)
5153a47a MB	247	(push type updated))))
eec82323	248
5153a47a MB	249	(unless (assq 'version gnus-format-specs)
	250	(push (cons 'version emacs-version) gnus-format-specs))
	251	updated))
eec82323 LMI	252
	253	(defvar gnus-mouse-face-0 'highlight)
	254	(defvar gnus-mouse-face-1 'highlight)
	255	(defvar gnus-mouse-face-2 'highlight)
	256	(defvar gnus-mouse-face-3 'highlight)
	257	(defvar gnus-mouse-face-4 'highlight)
	258
	259	(defun gnus-mouse-face-function (form type)
	260	`(gnus-put-text-property
	261	(point) (progn ,@form (point))
	262	gnus-mouse-face-prop
	263	,(if (equal type 0)
	264	'gnus-mouse-face
	265	`(quote ,(symbol-value (intern (format "gnus-mouse-face-%d" type)))))))
	266
	267	(defvar gnus-face-0 'bold)
	268	(defvar gnus-face-1 'italic)
	269	(defvar gnus-face-2 'bold-italic)
	270	(defvar gnus-face-3 'bold)
	271	(defvar gnus-face-4 'bold)
	272
	273	(defun gnus-face-face-function (form type)
6748645f	274	`(gnus-add-text-properties
eec82323	275	(point) (progn ,@form (point))
6748645f	276	'(gnus-face t face ,(symbol-value (intern (format "gnus-face-%d" type))))))
eec82323	277
16409b0b GM	278	(defun gnus-balloon-face-function (form type)
	279	`(gnus-put-text-property
	280	(point) (progn ,@form (point))
23f87bed MB	281	,(if (fboundp 'balloon-help-mode)
	282	''balloon-help
	283	''help-echo)
16409b0b GM	284	,(intern (format "gnus-balloon-face-%d" type))))
16409b0b GM	285
23f87bed MB	286	(defun gnus-spec-tab (column)
23f87bed MB	287	(if (> column 0)
aa0a8561	288	`(insert-char ? (max (- ,column (current-column)) 0))
23f87bed	289	(let ((column (abs column)))
aa0a8561 MB	290	`(if (> (current-column) ,column)
	291	(let ((end (point)))
	292	(if (= (move-to-column ,column) ,column)
	293	(delete-region (point) end)
	294	(delete-region (1- (point)) end)
	295	(insert " ")))
	296	(insert-char ? (max (- ,column (current-column)) 0))))))
23f87bed MB	297
	298	(defun gnus-correct-length (string)
	299	"Return the correct width of STRING."
01c52d31	300	(apply #'+ (mapcar #'char-width string)))
23f87bed MB	301
	302	(defun gnus-correct-substring (string start &optional end)
	303	(let ((wstart 0)
	304	(wend 0)
	305	(wseek 0)
	306	(seek 0)
	307	(length (length string))
	308	(string (concat string "\0")))
	309	;; Find the start position.
	310	(while (and (< seek length)
	311	(< wseek start))
01c52d31	312	(incf wseek (char-width (aref string seek)))
23f87bed MB	313	(incf seek))
	314	(setq wstart seek)
	315	;; Find the end position.
	316	(while (and (<= seek length)
	317	(or (not end)
	318	(<= wseek end)))
01c52d31	319	(incf wseek (char-width (aref string seek)))
23f87bed MB	320	(incf seek))
	321	(setq wend seek)
	322	(substring string wstart (1- wend))))
	323
	324	(defun gnus-string-width-function ()
	325	(cond
	326	(gnus-use-correct-string-widths
	327	'gnus-correct-length)
	328	((fboundp 'string-width)
	329	'string-width)
	330	(t
	331	'length)))
	332
	333	(defun gnus-substring-function ()
	334	(cond
	335	(gnus-use-correct-string-widths
	336	'gnus-correct-substring)
	337	((fboundp 'string-width)
	338	'gnus-correct-substring)
	339	(t
	340	'substring)))
	341
eec82323 LMI	342	(defun gnus-tilde-max-form (el max-width)
eec82323 LMI	343	"Return a form that limits EL to MAX-WIDTH."
23f87bed MB	344	(let ((max (abs max-width))
	345	(length-fun (gnus-string-width-function))
	346	(substring-fun (gnus-substring-function)))
eec82323	347	(if (symbolp el)
23f87bed	348	`(if (> (,length-fun ,el) ,max)
eec82323	349	,(if (< max-width 0)
23f87bed MB	350	`(,substring-fun ,el (- (,length-fun ,el) ,max))
23f87bed MB	351	`(,substring-fun ,el 0 ,max))
eec82323 LMI	352	,el)
eec82323 LMI	353	`(let ((val (eval ,el)))
23f87bed	354	(if (> (,length-fun val) ,max)
eec82323	355	,(if (< max-width 0)
23f87bed MB	356	`(,substring-fun val (- (,length-fun val) ,max))
23f87bed MB	357	`(,substring-fun val 0 ,max))
eec82323 LMI	358	val)))))
	359
	360	(defun gnus-tilde-cut-form (el cut-width)
	361	"Return a form that cuts CUT-WIDTH off of EL."
23f87bed MB	362	(let ((cut (abs cut-width))
	363	(length-fun (gnus-string-width-function))
	364	(substring-fun (gnus-substring-function)))
eec82323	365	(if (symbolp el)
23f87bed	366	`(if (> (,length-fun ,el) ,cut)
eec82323	367	,(if (< cut-width 0)
23f87bed MB	368	`(,substring-fun ,el 0 (- (,length-fun ,el) ,cut))
23f87bed MB	369	`(,substring-fun ,el ,cut))
eec82323 LMI	370	,el)
eec82323 LMI	371	`(let ((val (eval ,el)))
23f87bed	372	(if (> (,length-fun val) ,cut)
eec82323	373	,(if (< cut-width 0)
23f87bed MB	374	`(,substring-fun val 0 (- (,length-fun val) ,cut))
23f87bed MB	375	`(,substring-fun val ,cut))
eec82323 LMI	376	val)))))
	377
	378	(defun gnus-tilde-ignore-form (el ignore-value)
	379	"Return a form that is blank when EL is IGNORE-VALUE."
	380	(if (symbolp el)
	381	`(if (equal ,el ,ignore-value)
	382	"" ,el)
	383	`(let ((val (eval ,el)))
	384	(if (equal val ,ignore-value)
	385	"" val))))
	386
23f87bed MB	387	(defun gnus-pad-form (el pad-width)
	388	"Return a form that pads EL to PAD-WIDTH accounting for multi-column
	389	characters correctly. This is because `format' may pad to columns or to
	390	characters when given a pad value."
	391	(let ((pad (abs pad-width))
	392	(side (< 0 pad-width))
	393	(length-fun (gnus-string-width-function)))
	394	(if (symbolp el)
	395	`(let ((need (- ,pad (,length-fun ,el))))
	396	(if (> need 0)
	397	(concat ,(when side '(make-string need ?\ ))
	398	,el
	399	,(when (not side) '(make-string need ?\ )))
	400	,el))
	401	`(let* ((val (eval ,el))
	402	(need (- ,pad (,length-fun val))))
	403	(if (> need 0)
	404	(concat ,(when side '(make-string need ?\ ))
	405	val
	406	,(when (not side) '(make-string need ?\ )))
	407	val)))))
	408
eec82323 LMI	409	(defun gnus-parse-format (format spec-alist &optional insert)
	410	;; This function parses the FORMAT string with the help of the
	411	;; SPEC-ALIST and returns a list that can be eval'ed to return the
	412	;; string. If the FORMAT string contains the specifiers %( and %)
	413	;; the text between them will have the mouse-face text property.
16409b0b GM	414	;; If the FORMAT string contains the specifiers %[ and %], the text between
16409b0b GM	415	;; them will have the balloon-help text property.
23f87bed MB	416	(let ((case-fold-search nil))
	417	(if (string-match
	418