0f0e9675c71f460f25214c2dcaf9b583d6414f53
[gnus] / lisp / gnus-util.el
1 ;;; gnus-util.el --- utility functions for Gnus
2
3 ;; Copyright (C) 1996-2013 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 3 of the License, or
13 ;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;; Nothing in this file depends on any other parts of Gnus -- all
26 ;; functions and macros in this file are utility functions that are
27 ;; used by Gnus and may be used by any other package without loading
28 ;; Gnus first.
29
30 ;; [Unfortunately, it does depend on other parts of Gnus, e.g. the
31 ;; autoloads and defvars below...]
32
33 ;;; Code:
34
35 ;; For Emacs <22.2 and XEmacs.
36 (eval-and-compile
37   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
38 (eval-when-compile
39   (require 'cl))
40
41 (require 'time-date)
42
43 (defcustom gnus-completing-read-function 'gnus-emacs-completing-read
44   "Function use to do completing read."
45   :version "24.1"
46   :group 'gnus-meta
47   :type `(radio (function-item
48                  :doc "Use Emacs standard `completing-read' function."
49                  gnus-emacs-completing-read)
50                 ;; iswitchb.el is very old and ido.el is unavailable
51                 ;; in XEmacs, so we exclude those function items.
52                 ,@(unless (featurep 'xemacs)
53                     '((function-item
54                        :doc "Use `ido-completing-read' function."
55                        gnus-ido-completing-read)
56                       (function-item
57                        :doc "Use iswitchb based completing-read function."
58                        gnus-iswitchb-completing-read)))))
59
60 (defcustom gnus-completion-styles
61   (if (and (boundp 'completion-styles-alist)
62            (boundp 'completion-styles))
63       (append (when (and (assq 'substring completion-styles-alist)
64                          (not (memq 'substring completion-styles)))
65                 (list 'substring))
66               completion-styles)
67     nil)
68   "Value of `completion-styles' to use when completing."
69   :version "24.1"
70   :group 'gnus-meta
71   :type '(repeat symbol))
72
73 ;; Fixme: this should be a gnus variable, not nnmail-.
74 (defvar nnmail-pathname-coding-system)
75 (defvar nnmail-active-file-coding-system)
76
77 ;; Inappropriate references to other parts of Gnus.
78 (defvar gnus-emphasize-whitespace-regexp)
79 (defvar gnus-original-article-buffer)
80 (defvar gnus-user-agent)
81
82 (autoload 'gnus-get-buffer-window "gnus-win")
83 (autoload 'nnheader-narrow-to-headers "nnheader")
84 (autoload 'nnheader-replace-chars-in-string "nnheader")
85 (autoload 'mail-header-remove-comments "mail-parse")
86
87 (eval-and-compile
88   (cond
89    ;; Prefer `replace-regexp-in-string' (present in Emacs, XEmacs 21.5,
90    ;; SXEmacs 22.1.4) over `replace-in-string'.  The latter leads to inf-loops
91    ;; on empty matches:
92    ;;   (replace-in-string "foo" "/*$" "/")
93    ;;   (replace-in-string "xe" "\\(x\\)?" "")
94    ((fboundp 'replace-regexp-in-string)
95     (defun gnus-replace-in-string  (string regexp newtext &optional literal)
96       "Replace all matches for REGEXP with NEWTEXT in STRING.
97 If LITERAL is non-nil, insert NEWTEXT literally.  Return a new
98 string containing the replacements.
99
100 This is a compatibility function for different Emacsen."
101       (replace-regexp-in-string regexp newtext string nil literal)))
102    ((fboundp 'replace-in-string)
103     (defalias 'gnus-replace-in-string 'replace-in-string))))
104
105 (defun gnus-boundp (variable)
106   "Return non-nil if VARIABLE is bound and non-nil."
107   (and (boundp variable)
108        (symbol-value variable)))
109
110 (defmacro gnus-eval-in-buffer-window (buffer &rest forms)
111   "Pop to BUFFER, evaluate FORMS, and then return to the original window."
112   (let ((tempvar (make-symbol "GnusStartBufferWindow"))
113         (w (make-symbol "w"))
114         (buf (make-symbol "buf")))
115     `(let* ((,tempvar (selected-window))
116             (,buf ,buffer)
117             (,w (gnus-get-buffer-window ,buf 'visible)))
118        (unwind-protect
119            (progn
120              (if ,w
121                  (progn
122                    (select-window ,w)
123                    (set-buffer (window-buffer ,w)))
124                (pop-to-buffer ,buf))
125              ,@forms)
126          (select-window ,tempvar)))))
127
128 (put 'gnus-eval-in-buffer-window 'lisp-indent-function 1)
129 (put 'gnus-eval-in-buffer-window 'edebug-form-spec '(form body))
130
131 (defmacro gnus-intern-safe (string hashtable)
132   "Get hash value.  Arguments are STRING and HASHTABLE."
133   `(let ((symbol (intern ,string ,hashtable)))
134      (or (boundp symbol)
135          (set symbol nil))
136      symbol))
137
138 (defsubst gnus-goto-char (point)
139   (and point (goto-char point)))
140
141 (defmacro gnus-buffer-exists-p (buffer)
142   `(let ((buffer ,buffer))
143      (when buffer
144        (funcall (if (stringp buffer) 'get-buffer 'buffer-name)
145                 buffer))))
146
147 ;; The LOCAL arg to `add-hook' is interpreted differently in Emacs and
148 ;; XEmacs.  In Emacs we don't need to call `make-local-hook' first.
149 ;; It's harmless, though, so the main purpose of this alias is to shut
150 ;; up the byte compiler.
151 (defalias 'gnus-make-local-hook (if (featurep 'xemacs)
152                                     'make-local-hook
153                                   'ignore))
154
155 (defun gnus-delete-first (elt list)
156   "Delete by side effect the first occurrence of ELT as a member of LIST."
157   (if (equal (car list) elt)
158       (cdr list)
159     (let ((total list))
160       (while (and (cdr list)
161                   (not (equal (cadr list) elt)))
162         (setq list (cdr list)))
163       (when (cdr list)
164         (setcdr list (cddr list)))
165       total)))
166
167 ;; Delete the current line (and the next N lines).
168 (defmacro gnus-delete-line (&optional n)
169   `(delete-region (point-at-bol)
170                   (progn (forward-line ,(or n 1)) (point))))
171
172 (defun gnus-extract-address-components (from)
173   "Extract address components from a From header.
174 Given an RFC-822 address FROM, extract full name and canonical address.
175 Returns a list of the form (FULL-NAME CANONICAL-ADDRESS).  Much more simple
176 solution than `mail-extract-address-components', which works much better, but
177 is slower."
178   (let (name address)
179     ;; First find the address - the thing with the @ in it.  This may
180     ;; not be accurate in mail addresses, but does the trick most of
181     ;; the time in news messages.
182     (cond (;; Check ``<foo@bar>'' first in order to handle the quite common
183            ;; form ``"abc@xyz" <foo@bar>'' (i.e. ``@'' as part of a comment)
184            ;; correctly.
185            (string-match "<\\([^@ \t<>]+[!@][^@ \t<>]+\\)>" from)
186            (setq address (substring from (match-beginning 1) (match-end 1))))
187           ((string-match "\\b[^@ \t<>]+[!@][^@ \t<>]+\\b" from)
188            (setq address (substring from (match-beginning 0) (match-end 0)))))
189     ;; Then we check whether the "name <address>" format is used.
190     (and address
191          ;; Linear white space is not required.
192          (string-match (concat "[ \t]*<" (regexp-quote address) ">") from)
193          (and (setq name (substring from 0 (match-beginning 0)))
194               ;; Strip any quotes from the name.
195               (string-match "^\".*\"$" name)
196               (setq name (substring name 1 (1- (match-end 0))))))
197     ;; If not, then "address (name)" is used.
198     (or name
199         (and (string-match "(.+)" from)
200              (setq name (substring from (1+ (match-beginning 0))
201                                    (1- (match-end 0)))))
202         (and (string-match "()" from)
203              (setq name address))
204         ;; XOVER might not support folded From headers.
205         (and (string-match "(.*" from)
206              (setq name (substring from (1+ (match-beginning 0))
207                                    (match-end 0)))))
208     (list (if (string= name "") nil name) (or address from))))
209
210 (declare-function message-fetch-field "message" (header &optional not-all))
211
212 (defun gnus-fetch-field (field)
213   "Return the value of the header FIELD of current article."
214   (require 'message)
215   (save-excursion
216     (save-restriction
217       (let ((inhibit-point-motion-hooks t))
218         (nnheader-narrow-to-headers)
219         (message-fetch-field field)))))
220
221 (defun gnus-fetch-original-field (field)
222   "Fetch FIELD from the original version of the current article."
223   (with-current-buffer gnus-original-article-buffer
224     (gnus-fetch-field field)))
225
226
227 (defun gnus-goto-colon ()
228   (move-beginning-of-line 1)
229   (let ((eol (point-at-eol)))
230     (goto-char (or (text-property-any (point) eol 'gnus-position t)
231                    (search-forward ":" eol t)
232                    (point)))))
233
234 (declare-function gnus-find-method-for-group "gnus" (group &optional info))
235 (declare-function gnus-group-name-decode "gnus-group" (string charset))
236 (declare-function gnus-group-name-charset "gnus-group" (method group))
237 ;; gnus-group requires gnus-int which requires message.
238 (declare-function message-tokenize-header "message"
239                   (header &optional separator))
240
241 (defun gnus-decode-newsgroups (newsgroups group &optional method)
242   (require 'gnus-group)
243   (let ((method (or method (gnus-find-method-for-group group))))
244     (mapconcat (lambda (group)
245                  (gnus-group-name-decode group (gnus-group-name-charset
246                                                 method group)))
247                (message-tokenize-header newsgroups)
248                ",")))
249
250 (defun gnus-remove-text-with-property (prop)
251   "Delete all text in the current buffer with text property PROP."
252   (let ((start (point-min))
253         end)
254     (unless (get-text-property start prop)
255       (setq start (next-single-property-change start prop)))
256     (while start
257       (setq end (text-property-any start (point-max) prop nil))
258       (delete-region start (or end (point-max)))
259       (setq start (when end
260                     (next-single-property-change start prop))))))
261
262 (defun gnus-find-text-property-region (start end prop)
263   "Return a list of text property regions that has property PROP."
264   (let (regions value)
265     (unless (get-text-property start prop)
266       (setq start (next-single-property-change start prop)))
267     (while start
268       (setq value (get-text-property start prop)
269             end (text-property-not-all start (point-max) prop value))
270       (if (not end)
271           (setq start nil)
272         (when value
273           (push (list (set-marker (make-marker) start)
274                       (set-marker (make-marker) end)
275                       value)
276                 regions))
277         (setq start (next-single-property-change start prop))))
278     (nreverse regions)))
279
280 (defun gnus-newsgroup-directory-form (newsgroup)
281   "Make hierarchical directory name from NEWSGROUP name."
282   (let* ((newsgroup (gnus-newsgroup-savable-name newsgroup))
283          (idx (string-match ":" newsgroup)))
284     (concat
285      (if idx (substring newsgroup 0 idx))
286      (if idx "/")
287      (nnheader-replace-chars-in-string
288       (if idx (substring newsgroup (1+ idx)) newsgroup)
289       ?. ?/))))
290
291 (defun gnus-newsgroup-savable-name (group)
292   ;; Replace any slashes in a group name (eg. an ange-ftp nndoc group)
293   ;; with dots.
294   (nnheader-replace-chars-in-string group ?/ ?.))
295
296 (defun gnus-string> (s1 s2)
297   (not (or (string< s1 s2)
298            (string= s1 s2))))
299
300 (defun gnus-string< (s1 s2)
301   "Return t if first arg string is less than second in lexicographic order.
302 Case is significant if and only if `case-fold-search' is nil.
303 Symbols are also allowed; their print names are used instead."
304   (if case-fold-search
305       (string-lessp (downcase (if (symbolp s1) (symbol-name s1) s1))
306                     (downcase (if (symbolp s2) (symbol-name s2) s2)))
307     (string-lessp s1 s2)))
308
309 ;;; Time functions.
310
311 (defun gnus-file-newer-than (file date)
312   (let ((fdate (nth 5 (file-attributes file))))
313     (or (> (car fdate) (car date))
314         (and (= (car fdate) (car date))
315              (> (nth 1 fdate) (nth 1 date))))))
316
317 ;; Every version of Emacs Gnus supports has built-in float-time.
318 ;; The featurep test silences an irritating compiler warning.
319 (eval-and-compile
320   (if (or (featurep 'emacs)
321           (fboundp 'float-time))
322       (defalias 'gnus-float-time 'float-time)
323     (defun gnus-float-time (&optional time)
324       "Convert time value TIME to a floating point number.
325 TIME defaults to the current time."
326       (time-to-seconds (or time (current-time))))))
327
328 ;;; Keymap macros.
329
330 (defmacro gnus-local-set-keys (&rest plist)
331   "Set the keys in PLIST in the current keymap."
332   `(gnus-define-keys-1 (current-local-map) ',plist))
333
334 (defmacro gnus-define-keys (keymap &rest plist)
335   "Define all keys in PLIST in KEYMAP."
336   ;; Convert the key [?\S-\ ] to [(shift space)] for XEmacs.
337   (when (featurep 'xemacs)
338     (let ((bindings plist))
339       (while bindings
340         (when (equal (car bindings) [?\S-\ ])
341           (setcar bindings [(shift space)]))
342         (setq bindings (cddr bindings)))))
343   `(gnus-define-keys-1 (quote ,keymap) (quote ,plist)))
344
345 (defmacro gnus-define-keys-safe (keymap &rest plist)
346   "Define all keys in PLIST in KEYMAP without overwriting previous definitions."
347   `(gnus-define-keys-1 (quote ,keymap) (quote ,plist) t))
348
349 (put 'gnus-define-keys 'lisp-indent-function 1)
350 (put 'gnus-define-keys-safe 'lisp-indent-function 1)
351 (put 'gnus-local-set-keys 'lisp-indent-function 1)
352
353 (defmacro gnus-define-keymap (keymap &rest plist)
354   "Define all keys in PLIST in KEYMAP."
355   `(gnus-define-keys-1 ,keymap (quote ,plist)))
356
357 (put 'gnus-define-keymap 'lisp-indent-function 1)
358
359 (defun gnus-define-keys-1 (keymap plist &optional safe)
360   (when (null keymap)
361     (error "Can't set keys in a null keymap"))
362   (cond ((symbolp keymap)
363          (setq keymap (symbol-value keymap)))
364         ((keymapp keymap))
365         ((listp keymap)
366          (set (car keymap) nil)
367          (define-prefix-command (car keymap))
368          (define-key (symbol-value (caddr keymap)) (cadr keymap) (car keymap))
369          (setq keymap (symbol-value (car keymap)))))
370   (let (key)
371     (while plist
372       (when (symbolp (setq key (pop plist)))
373         (setq key (symbol-value key)))
374       (if (or (not safe)
375               (eq (lookup-key keymap key) 'undefined))
376           (define-key keymap key (pop plist))
377         (pop plist)))))
378
379 (defun gnus-y-or-n-p (prompt)
380   (prog1
381       (y-or-n-p prompt)
382     (message "")))
383 (defun gnus-yes-or-no-p (prompt)
384   (prog1
385       (yes-or-no-p prompt)
386     (message "")))
387
388 ;; By Frank Schmitt <ich@Frank-Schmitt.net>. Allows to have
389 ;; age-depending date representations. (e.g. just the time if it's
390 ;; from today, the day of the week if it's within the last 7 days and
391 ;; the full date if it's older)
392
393 (defun gnus-seconds-today ()
394   "Return the number of seconds passed today."
395   (let ((now (decode-time (current-time))))
396     (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600))))
397
398 (defun gnus-seconds-month ()
399   "Return the number of seconds passed this month."
400   (let ((now (decode-time (current-time))))
401     (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600)
402        (* (- (car (nthcdr 3 now)) 1) 3600 24))))
403
404 (defun gnus-seconds-year ()
405   "Return the number of seconds passed this year."
406   (let ((now (decode-time (current-time)))
407         (days (format-time-string "%j" (current-time))))
408     (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600)
409        (* (- (string-to-number days) 1) 3600 24))))
410
411 (defmacro gnus-date-get-time (date)
412   "Convert DATE string to Emacs time.
413 Cache the result as a text property stored in DATE."
414   ;; Either return the cached value...
415   `(let ((d ,date))
416      (if (equal "" d)
417          '(0 0)
418        (or (get-text-property 0 'gnus-time d)
419            ;; or compute the value...
420            (let ((time (safe-date-to-time d)))
421              ;; and store it back in the string.
422              (put-text-property 0 1 'gnus-time time d)
423              time)))))
424
425 (defun gnus-dd-mmm (messy-date)
426   "Return a string like DD-MMM from a big messy string."
427   (condition-case ()
428       (format-time-string "%d-%b" (gnus-date-get-time messy-date))
429     (error "  -   ")))
430
431 (defsubst gnus-time-iso8601 (time)
432   "Return a string of TIME in YYYYMMDDTHHMMSS format."
433   (format-time-string "%Y%m%dT%H%M%S" time))
434
435 (defun gnus-date-iso8601 (date)
436   "Convert the DATE to YYYYMMDDTHHMMSS."
437   (condition-case ()
438       (gnus-time-iso8601 (gnus-date-get-time date))
439     (error "")))
440
441 (defun gnus-mode-string-quote (string)
442   "Quote all \"%\"'s in STRING."
443   (gnus-replace-in-string string "%" "%%"))
444
445 ;; Make a hash table (default and minimum size is 256).
446 ;; Optional argument HASHSIZE specifies the table size.
447 (defun gnus-make-hashtable (&optional hashsize)
448   (make-vector (if hashsize (max (gnus-create-hash-size hashsize) 256) 256) 0))
449
450 ;; Make a number that is suitable for hashing; bigger than MIN and
451 ;; equal to some 2^x.  Many machines (such as sparcs) do not have a
452 ;; hardware modulo operation, so they implement it in software.  On
453 ;; many sparcs over 50% of the time to intern is spent in the modulo.
454 ;; Yes, it's slower than actually computing the hash from the string!
455 ;; So we use powers of 2 so people can optimize the modulo to a mask.
456 (defun gnus-create-hash-size (min)
457   (let ((i 1))
458     (while (< i min)
459       (setq i (* 2 i)))
460     i))
461
462 (defcustom gnus-verbose 6
463   "*Integer that says how verbose Gnus should be.
464 The higher the number, the more messages Gnus will flash to say what
465 it's doing.  At zero, Gnus will be totally mute; at five, Gnus will
466 display most important messages; and at ten, Gnus will keep on
467 jabbering all the time."
468   :version "24.1"
469   :group 'gnus-start
470   :type 'integer)
471
472 (defcustom gnus-add-timestamp-to-message nil
473   "Non-nil means add timestamps to messages that Gnus issues.
474 If it is `log', add timestamps to only the messages that go into the
475 \"*Messages*\" buffer (in XEmacs, it is the \" *Message-Log*\" buffer).
476 If it is neither nil nor `log', add timestamps not only to log messages
477 but also to the ones displayed in the echo area."
478   :version "23.1" ;; No Gnus
479   :group  'gnus-various
480   :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
481                  (const :tag "Logged messages only" log)
482                  (sexp :tag "All messages"
483                        :match (lambda (widget value) value)
484                        :value t)
485                  (const :tag "No timestamp" nil)))
486
487 (eval-when-compile
488   (defmacro gnus-message-with-timestamp-1 (format-string args)
489     (let ((timestamp '(format-time-string "%Y%m%dT%H%M%S.%3N> " time)))
490       (if (featurep 'xemacs)
491           `(let (str time)
492              (if (or (and (null ,format-string) (null ,args))
493                      (progn
494                        (setq str (apply 'format ,format-string ,args))
495                        (zerop (length str))))
496                  (prog1
497                      (and ,format-string str)
498                    (clear-message nil))
499                (cond ((eq gnus-add-timestamp-to-message 'log)
500                       (setq time (current-time))
501                       (display-message 'no-log str)
502                       (log-message 'message (concat ,timestamp str)))
503                      (gnus-add-timestamp-to-message
504                       (setq time (current-time))
505                       (display-message 'message (concat ,timestamp str)))
506                      (t
507                       (display-message 'message str))))
508              str)
509         `(let (str time)
510            (cond ((eq gnus-add-timestamp-to-message 'log)
511                   (setq str (let (message-log-max)
512                               (apply 'message ,format-string ,args)))
513                   (when (and message-log-max
514                              (> message-log-max 0)
515                              (/= (length str) 0))
516                     (setq time (current-time))
517                     (with-current-buffer (get-buffer-create "*Messages*")
518                       (goto-char (point-max))
519                       (insert ,timestamp str "\n")
520                       (forward-line (- message-log-max))
521                       (delete-region (point-min) (point))
522                       (goto-char (point-max))))
523                   str)
524                  (gnus-add-timestamp-to-message
525                   (if (or (and (null ,format-string) (null ,args))
526                           (progn
527                             (setq str (apply 'format ,format-string ,args))
528                             (zerop (length str))))
529                       (prog1
530                           (and ,format-string str)
531                         (message nil))
532                     (setq time (current-time))
533                     (message "%s" (concat ,timestamp str))
534                     str))
535                  (t
536                   (apply 'message ,format-string ,args))))))))
537
538 (defvar gnus-action-message-log nil)
539
540 (defun gnus-message-with-timestamp (format-string &rest args)
541   "Display message with timestamp.  Arguments are the same as `message'.
542 The `gnus-add-timestamp-to-message' variable controls how to add
543 timestamp to message."
544   (gnus-message-with-timestamp-1 format-string args))
545
546 (defun gnus-message (level &rest args)
547   "If LEVEL is lower than `gnus-verbose' print ARGS using `message'.
548
549 Guideline for numbers:
550 1 - error messages, 3 - non-serious error messages, 5 - messages for things
551 that take a long time, 7 - not very important messages on stuff, 9 - messages
552 inside loops."
553   (if (<= level gnus-verbose)
554       (let ((message
555              (if gnus-add-timestamp-to-message
556                  (apply 'gnus-message-with-timestamp args)
557                (apply 'message args))))
558         (when (and (consp gnus-action-message-log)
559                    (<= level 3))
560           (push message gnus-action-message-log))
561         message)
562     ;; We have to do this format thingy here even if the result isn't
563     ;; shown - the return value has to be the same as the return value
564     ;; from `message'.
565     (apply 'format args)))
566
567 (defun gnus-final-warning ()
568   (when (and (consp gnus-action-message-log)
569              (setq gnus-action-message-log
570                    (delete nil gnus-action-message-log)))
571     (message "Warning: %s"
572              (mapconcat #'identity gnus-action-message-log "; "))))
573
574 (defun gnus-error (level &rest args)
575   "Beep an error if LEVEL is equal to or less than `gnus-verbose'.
576 ARGS are passed to `message'."
577   (when (<= (floor level) gnus-verbose)
578     (apply 'message args)
579     (ding)
580     (let (duration)
581       (when (and (floatp level)
582                  (not (zerop (setq duration (* 10 (- level (floor level)))))))
583         (sit-for duration))))
584   nil)
585
586 (defun gnus-split-references (references)
587   "Return a list of Message-IDs in REFERENCES."
588   (let ((beg 0)
589         (references (mail-header-remove-comments (or references "")))
590         ids)
591     (while (string-match "<[^<]+[^< \t]" references beg)
592       (push (substring references (match-beginning 0) (setq beg (match-end 0)))
593             ids))
594     (nreverse ids)))
595
596 (defun gnus-extract-references (references)
597   "Return a list of Message-IDs in REFERENCES (in In-Reply-To
598   format), trimmed to only contain the Message-IDs."
599   (let ((ids (gnus-split-references references))
600         refs)
601     (dolist (id ids)
602       (when (string-match "<[^<>]+>" id)
603         (push (match-string 0 id) refs)))
604     refs))
605
606 (defsubst gnus-parent-id (references &optional n)
607   "Return the last Message-ID in REFERENCES.
608 If N, return the Nth ancestor instead."
609   (when (and references
610              (not (zerop (length references))))
611     (if n
612         (let ((ids (inline (gnus-split-references references))))
613           (while (nthcdr n ids)
614             (setq ids (cdr ids)))
615           (car ids))
616       (let ((references (mail-header-remove-comments references)))
617         (when (string-match "\\(<[^<]+>\\)[ \t]*\\'" references)
618           (match-string 1 references))))))
619
620 (defsubst gnus-buffer-live-p (buffer)
621   "Say whether BUFFER is alive or not."
622   (and buffer (buffer-live-p (get-buffer buffer))))
623
624 (defun gnus-horizontal-recenter ()
625   "Recenter the current buffer horizontally."
626   (if (< (current-column) (/ (window-width) 2))
627       (set-window-hscroll (gnus-get-buffer-window (current-buffer) t) 0)
628     (let* ((orig (point))
629            (end (window-end (gnus-get-buffer-window (current-buffer) t)))
630            (max 0))
631       (when end
632         ;; Find the longest line currently displayed in the window.
633         (goto-char (window-start))
634         (while (and (not (eobp))
635                     (< (point) end))
636           (end-of-line)
637           (setq max (max max (current-column)))
638           (forward-line 1))
639         (goto-char orig)
640         ;; Scroll horizontally to center (sort of) the point.
641         (if (> max (window-width))
642             (set-window-hscroll
643              (gnus-get-buffer-window (current-buffer) t)
644              (min (- (current-column) (/ (window-width) 3))
645                   (+ 2 (- max (window-width)))))
646           (set-window-hscroll (gnus-get-buffer-window (current-buffer) t) 0))
647         max))))
648
649 (defun gnus-read-event-char (&optional prompt)
650   "Get the next event."
651   (let ((event (read-event prompt)))
652     ;; should be gnus-characterp, but this can't be called in XEmacs anyway
653     (cons (and (numberp event) event) event)))
654
655 (defun gnus-copy-file (file &optional to)
656   "Copy FILE to TO."
657   (interactive
658    (list (read-file-name "Copy file: " default-directory)
659          (read-file-name "Copy file to: " default-directory)))
660   (unless to
661     (setq to (read-file-name "Copy file to: " default-directory)))
662   (when (file-directory-p to)
663     (setq to (concat (file-name-as-directory to)
664                      (file-name-nondirectory file))))
665   (copy-file file to))
666
667 (defvar gnus-work-buffer " *gnus work*")
668
669 (declare-function gnus-get-buffer-create "gnus" (name))
670 ;; gnus.el requires mm-util.
671 (declare-function mm-enable-multibyte "mm-util")
672
673 (defun gnus-set-work-buffer ()
674   "Put point in the empty Gnus work buffer."
675   (if (get-buffer gnus-work-buffer)
676       (progn
677         (set-buffer gnus-work-buffer)
678         (erase-buffer))
679     (set-buffer (gnus-get-buffer-create gnus-work-buffer))
680     (kill-all-local-variables)
681     (mm-enable-multibyte)))
682
683 (defmacro gnus-group-real-name (group)
684   "Find the real name of a foreign newsgroup."
685   `(let ((gname ,group))
686      (if (string-match "^[^:]+:" gname)
687          (substring gname (match-end 0))
688        gname)))
689
690 (defmacro gnus-group-server (group)
691   "Find the server name of a foreign newsgroup.
692 For example, (gnus-group-server \"nnimap+yxa:INBOX.foo\") would
693 yield \"nnimap:yxa\"."
694   `(let ((gname ,group))
695      (if (string-match "^\\([^:+]+\\)\\(?:\\+\\([^:]*\\)\\)?:" gname)
696          (format "%s:%s" (match-string 1 gname) (or
697                                                  (match-string 2 gname)
698                                                  ""))
699        (format "%s:%s" (car gnus-select-method) (cadr gnus-select-method)))))
700
701 (defun gnus-make-sort-function (funs)
702   "Return a composite sort condition based on the functions in FUNS."
703   (cond
704    ;; Just a simple function.
705    ((functionp funs) funs)
706    ;; No functions at all.
707    ((null funs) funs)
708    ;; A list of functions.
709    ((or (cdr funs)
710         (listp (car funs)))
711     (gnus-byte-compile
712      `(lambda (t1 t2)
713         ,(gnus-make-sort-function-1 (reverse funs)))))
714    ;; A list containing just one function.
715    (t
716     (car funs))))
717
718 (defun gnus-make-sort-function-1 (funs)
719   "Return a composite sort condition based on the functions in FUNS."
720   (let ((function (car funs))
721         (first 't1)
722         (last 't2))
723     (when (consp function)
724       (cond
725        ;; Reversed spec.
726        ((eq (car function) 'not)
727         (setq function (cadr function)
728               first 't2
729               last 't1))
730        ((functionp function)
731         ;; Do nothing.
732         )
733        (t
734         (error "Invalid sort spec: %s" function))))
735     (if (cdr funs)
736         `(or (,function ,first ,last)
737              (and (not (,function ,last ,first))
738                   ,(gnus-make-sort-function-1 (cdr funs))))
739       `(,function ,first ,last))))
740
741 (defun gnus-turn-off-edit-menu (type)
742   "Turn off edit menu in `gnus-TYPE-mode-map'."
743   (define-key (symbol-value (intern (format "gnus-%s-mode-map" type)))
744     [menu-bar edit] 'undefined))
745
746 (defmacro gnus-bind-print-variables (&rest forms)
747   "Bind print-* variables and evaluate FORMS.
748 This macro is used with `prin1', `pp', etc. in order to ensure printed
749 Lisp objects are loadable.  Bind `print-quoted' and `print-readably'
750 to t, and `print-escape-multibyte', `print-escape-newlines',
751 `print-escape-nonascii', `print-length', `print-level' and
752 `print-string-length' to nil."
753   `(let ((print-quoted t)
754          (print-readably t)
755          ;;print-circle
756          ;;print-continuous-numbering
757          print-escape-multibyte
758          print-escape-newlines
759          print-escape-nonascii
760          ;;print-gensym
761          print-length
762          print-level
763          print-string-length)
764      ,@forms))
765
766 (defun gnus-prin1 (form)
767   "Use `prin1' on FORM in the current buffer.
768 Bind `print-quoted' and `print-readably' to t, and `print-length' and
769 `print-level' to nil.  See also `gnus-bind-print-variables'."
770   (gnus-bind-print-variables (prin1 form (current-buffer))))
771
772 (defun gnus-prin1-to-string (form)
773   "The same as `prin1'.
774 Bind `print-quoted' and `print-readably' to t, and `print-length' and
775 `print-level' to nil.  See also `gnus-bind-print-variables'."
776   (gnus-bind-print-variables (prin1-to-string form)))
777
778 (defun gnus-pp (form &optional stream)
779   "Use `pp' on FORM in the current buffer.
780 Bind `print-quoted' and `print-readably' to t, and `print-length' and
781 `print-level' to nil.  See also `gnus-bind-print-variables'."
782   (gnus-bind-print-variables (pp form (or stream (current-buffer)))))
783
784 (defun gnus-pp-to-string (form)
785   "The same as `pp-to-string'.
786 Bind `print-quoted' and `print-readably' to t, and `print-length' and
787 `print-level' to nil.  See also `gnus-bind-print-variables'."
788   (gnus-bind-print-variables (pp-to-string form)))
789
790 (defun gnus-make-directory (directory)
791   "Make DIRECTORY (and all its parents) if it doesn't exist."
792   (require 'nnmail)
793   (let ((file-name-coding-system nnmail-pathname-coding-system))
794     (when (and directory
795                (not (file-exists-p directory)))
796       (make-directory directory t)))
797   t)
798
799 (defun gnus-write-buffer (file)
800   "Write the current buffer's contents to FILE."
801   (require 'nnmail)
802   (let ((file-name-coding-system nnmail-pathname-coding-system))
803     ;; Make sure the directory exists.
804     (gnus-make-directory (file-name-directory file))
805     ;; Write the buffer.
806     (write-region (point-min) (point-max) file nil 'quietly)))
807
808 (defun gnus-delete-file (file)
809   "Delete FILE if it exists."
810   (when (file-exists-p file)
811     (delete-file file)))
812
813 (defun gnus-delete-duplicates (list)
814   "Remove duplicate entries from LIST."
815   (let ((result nil))
816     (while list
817       (unless (member (car list) result)
818         (push (car list) result))
819       (pop list))
820     (nreverse result)))
821
822 (defun gnus-delete-directory (directory)
823   "Delete files in DIRECTORY.  Subdirectories remain.
824 If there's no subdirectory, delete DIRECTORY as well."
825   (when (file-directory-p directory)
826     (let ((files (directory-files
827                   directory t "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))
828           file dir)
829       (while files
830         (setq file (pop files))
831         (if (eq t (car (file-attributes file)))
832             ;; `file' is a subdirectory.
833             (setq dir t)
834           ;; `file' is a file or a symlink.
835           (delete-file file)))
836       (unless dir
837         (delete-directory directory)))))
838
839 (defun gnus-strip-whitespace (string)
840   "Return STRING stripped of all whitespace."
841   (while (string-match "[\r\n\t ]+" string)
842     (setq string (replace-match "" t t string)))
843   string)
844
845 (declare-function gnus-put-text-property "gnus"
846                   (start end property value &optional object))
847
848 (defsubst gnus-put-text-property-excluding-newlines (beg end prop val)
849   "The same as `put-text-property', but don't put this prop on any newlines in the region."
850   (save-match-data
851     (save-excursion
852       (save-restriction
853         (goto-char beg)
854         (while (re-search-forward gnus-emphasize-whitespace-regexp end 'move)
855           (gnus-put-text-property beg (match-beginning 0) prop val)
856           (setq beg (point)))
857         (gnus-put-text-property beg (point) prop val)))))
858
859 (declare-function gnus-overlay-put  "gnus" (overlay prop value))
860 (declare-function gnus-make-overlay "gnus"
861                   (beg end &optional buffer front-advance rear-advance))
862
863 (defsubst gnus-put-overlay-excluding-newlines (beg end prop val)
864   "The same as `put-text-property', but don't put this prop on any newlines in the region."
865   (save-match-data
866     (save-excursion
867       (save-restriction
868         (goto-char beg)
869         (while (re-search-forward gnus-emphasize-whitespace-regexp end 'move)
870           (gnus-overlay-put
871            (gnus-make-overlay beg (match-beginning 0))
872            prop val)
873           (setq beg (point)))
874         (gnus-overlay-put (gnus-make-overlay beg (point)) prop val)))))
875
876 (defun gnus-put-text-property-excluding-characters-with-faces (beg end prop val)
877   "The same as `put-text-property', except where `gnus-face' is set.
878 If so, and PROP is `face', set the second element of its value to VAL.
879 Otherwise, do nothing."
880   (while (< beg end)
881     ;; Property values are compared with `eq'.
882     (let ((stop (next-single-property-change beg 'face nil end)))
883       (if (get-text-property beg 'gnus-face)
884           (when (eq prop 'face)
885             (setcar (cdr (get-text-property beg 'face)) (or val 'default)))
886         (inline
887           (gnus-put-text-property beg stop prop val)))
888       (setq beg stop))))
889
890 (defun gnus-get-text-property-excluding-characters-with-faces (pos prop)
891   "The same as `get-text-property', except where `gnus-face' is set.
892 If so, and PROP is `face', return the second element of its value.
893 Otherwise, return the value."
894   (let ((val (get-text-property pos prop)))
895     (if (and (get-text-property pos 'gnus-face)
896              (eq prop 'face))
897         (cadr val)
898       (get-text-property pos prop))))
899
900 (defmacro gnus-faces-at (position)
901   "Return a list of faces at POSITION."
902   (if (featurep 'xemacs)
903       `(let ((pos ,position))
904          (mapcar-extents 'extent-face
905                          nil (current-buffer) pos pos nil 'face))
906     `(let ((pos ,position))
907        (delq nil (cons (get-text-property pos 'face)
908                        (mapcar
909                         (lambda (overlay)
910                           (overlay-get overlay 'face))
911                         (overlays-at pos)))))))
912
913 (if (fboundp 'invisible-p)
914     (defalias 'gnus-invisible-p 'invisible-p)
915   ;; for Emacs < 22.2, and XEmacs.
916   (defun gnus-invisible-p (pos)
917     "Return non-nil if the character after POS is currently invisible."
918     (let ((prop (get-char-property pos 'invisible)))
919       (if (eq buffer-invisibility-spec t)
920           prop
921         (or (memq prop buffer-invisibility-spec)
922             (assq prop buffer-invisibility-spec))))))
923
924 ;; Note: the optional 2nd argument has a different meaning between
925 ;; Emacs and XEmacs.
926 ;; (next-char-property-change POSITION &optional LIMIT)
927 ;; (next-extent-change        POS      &optional OBJECT)
928 (defalias 'gnus-next-char-property-change
929   (if (fboundp 'next-extent-change)
930       'next-extent-change 'next-char-property-change))
931
932 (defalias 'gnus-previous-char-property-change
933   (if (fboundp 'previous-extent-change)
934       'previous-extent-change 'previous-char-property-change))
935
936 ;;; Protected and atomic operations.  dmoore@ucsd.edu 21.11.1996
937 ;; The primary idea here is to try to protect internal datastructures
938 ;; from becoming corrupted when the user hits C-g, or if a hook or
939 ;; similar blows up.  Often in Gnus multiple tables/lists need to be
940 ;; updated at the same time, or information can be lost.
941
942 (defvar gnus-atomic-be-safe t
943   "If t, certain operations will be protected from interruption by C-g.")
944
945 (defmacro gnus-atomic-progn (&rest forms)
946   "Evaluate FORMS atomically, which means to protect the evaluation
947 from being interrupted by the user.  An error from the forms themselves
948 will return without finishing the operation.  Since interrupts from
949 the user are disabled, it is recommended that only the most minimal
950 operations are performed by FORMS.  If you wish to assign many
951 complicated values atomically, compute the results into temporary
952 variables and then do only the assignment atomically."
953   `(let ((inhibit-quit gnus-atomic-be-safe))
954      ,@forms))
955
956 (put 'gnus-atomic-progn 'lisp-indent-function 0)
957
958 (defmacro gnus-atomic-progn-assign (protect &rest forms)
959   "Evaluate FORMS, but ensure that the variables listed in PROTECT
960 are not changed if anything in FORMS signals an error or otherwise
961 non-locally exits.  The variables listed in PROTECT are updated atomically.
962 It is safe to use gnus-atomic-progn-assign with long computations.
963
964 Note that if any of the symbols in PROTECT were unbound, they will be
965 set to nil on a successful assignment.  In case of an error or other
966 non-local exit, it will still be unbound."
967   (let* ((temp-sym-map (mapcar (lambda (x) (list (make-symbol
968                                                   (concat (symbol-name x)
969                                                           "-tmp"))
970                                                  x))
971                                protect))
972          (sym-temp-map (mapcar (lambda (x) (list (cadr x) (car x)))
973                                temp-sym-map))
974          (temp-sym-let (mapcar (lambda (x) (list (car x)
975                                                  `(and (boundp ',(cadr x))
976                                                        ,(cadr x))))
977                                temp-sym-map))
978          (sym-temp-let sym-temp-map)
979          (temp-sym-assign (apply 'append temp-sym-map))
980          (sym-temp-assign (apply 'append sym-temp-map))
981          (result (make-symbol "result-tmp")))
982     `(let (,@temp-sym-let
983            ,result)
984        (let ,sym-temp-let
985          (setq ,result (progn ,@forms))
986          (setq ,@temp-sym-assign))
987        (let ((inhibit-quit gnus-atomic-be-safe))
988          (setq ,@sym-temp-assign))
989        ,result)))
990
991 (put 'gnus-atomic-progn-assign 'lisp-indent-function 1)
992 ;(put 'gnus-atomic-progn-assign 'edebug-form-spec '(sexp body))
993
994 (defmacro gnus-atomic-setq (&rest pairs)
995   "Similar to setq, except that the real symbols are only assigned when
996 there are no errors.  And when the real symbols are assigned, they are
997 done so atomically.  If other variables might be changed via side-effect,
998 see gnus-atomic-progn-assign.  It is safe to use gnus-atomic-setq
999 with potentially long computations."
1000   (let ((tpairs pairs)
1001         syms)
1002     (while tpairs
1003       (push (car tpairs) syms)
1004       (setq tpairs (cddr tpairs)))
1005     `(gnus-atomic-progn-assign ,syms
1006        (setq ,@pairs))))
1007
1008 ;(put 'gnus-atomic-setq 'edebug-form-spec '(body))
1009
1010
1011 ;;; Functions for saving to babyl/mail files.
1012
1013 (eval-when-compile
1014   (if (featurep 'xemacs)
1015       ;; Don't load tm and apel XEmacs packages that provide some
1016       ;; Emacs emulating functions and variables.
1017       (let ((features features))
1018         (provide 'tm-view)
1019         (unless (fboundp 'set-alist) (defalias 'set-alist 'ignore))
1020         (require 'rmail)) ;; It requires tm-view that loads apel.
1021     (require 'rmail))
1022   (autoload 'rmail-update-summary "rmailsum"))
1023
1024 (defvar mm-text-coding-system)
1025
1026 (declare-function mm-append-to-file "mm-util"
1027                   (start end filename &optional codesys inhibit))
1028 (declare-function rmail-swap-buffers-maybe "rmail" ())
1029 (declare-function rmail-maybe-set-message-counters "rmail" ())
1030 (declare-function rmail-count-new-messages "rmail" (&optional nomsg))
1031 (declare-function rmail-summary-exists "rmail" ())
1032 (declare-function rmail-show-message "rmail" (&optional n no-summary))
1033 ;; Macroexpansion of rmail-select-summary:
1034 (declare-function rmail-summary-displayed "rmail" ())
1035 (declare-function rmail-pop-to-buffer "rmail" (&rest args))
1036 (declare-function rmail-maybe-display-summary "rmail" ())
1037
1038 (defun gnus-output-to-rmail (filename &optional ask)
1039   "Append the current article to an Rmail file named FILENAME.
1040 In Emacs 22 this writes Babyl format; in Emacs 23 it writes mbox unless
1041 FILENAME exists and is Babyl format."
1042   (require 'rmail)
1043   (require 'mm-util)
1044   (require 'nnmail)
1045   ;; Some of this codes is borrowed from rmailout.el.
1046   (setq filename (expand-file-name filename))
1047   ;; FIXME should we really be messing with this defcustom?
1048   ;; It is not needed for the operation of this function.
1049   (if (boundp 'rmail-default-rmail-file)
1050       (setq rmail-default-rmail-file filename) ; 22
1051     (setq rmail-default-file filename))        ; 23
1052   (let ((artbuf (current-buffer))
1053         (tmpbuf (get-buffer-create " *Gnus-output*"))
1054         ;; Babyl rmail.el defines this, mbox does not.
1055         (babyl (fboundp 'rmail-insert-rmail-file-header)))
1056     (save-excursion
1057       ;; Note that we ignore the possibility of visiting a Babyl
1058       ;; format buffer in Emacs 23, since Rmail no longer supports that.
1059      (or (get-file-buffer filename)
1060          (progn
1061            ;; In case someone wants to write to a Babyl file from Emacs 23.
1062            (when (file-exists-p filename)
1063              (setq babyl (mail-file-babyl-p filename))
1064              t))
1065           (if (or (not ask)
1066                   (gnus-yes-or-no-p
1067                    (concat "\"" filename "\" does not exist, create it? ")))
1068               (let ((file-buffer (create-file-buffer filename)))
1069                 (with-current-buffer file-buffer
1070                   (if (fboundp 'rmail-insert-rmail-file-header)
1071                       (rmail-insert-rmail-file-header))
1072                   (let ((require-final-newline nil)
1073                         (coding-system-for-write mm-text-coding-system))
1074                     (gnus-write-buffer filename)))
1075                 (kill-buffer file-buffer))
1076             (error "Output file does not exist")))
1077       (set-buffer tmpbuf)
1078       (erase-buffer)
1079       (insert-buffer-substring artbuf)
1080       (if babyl
1081           (gnus-convert-article-to-rmail)
1082         ;; Non-Babyl case copied from gnus-output-to-mail.
1083         (goto-char (point-min))
1084         (if (looking-at "From ")
1085             (forward-line 1)
1086           (insert "From nobody " (current-time-string) "\n"))
1087         (let (case-fold-search)
1088           (while (re-search-forward "^From " nil t)
1089             (beginning-of-line)
1090             (insert ">"))))
1091       ;; Decide whether to append to a file or to an Emacs buffer.
1092       (let ((outbuf (get-file-buffer filename)))
1093         (if (not outbuf)
1094             (progn
1095               (unless babyl             ; from gnus-output-to-mail
1096                 (let ((buffer-read-only nil))
1097                   (goto-char (point-max))
1098                   (forward-char -2)
1099                   (unless (looking-at "\n\n")
1100                     (goto-char (point-max))
1101                     (unless (bolp)
1102                       (insert "\n"))
1103                     (insert "\n"))))
1104               (let ((file-name-coding-system nnmail-pathname-coding-system))
1105                 (mm-append-to-file (point-min) (point-max) filename)))
1106           ;; File has been visited, in buffer OUTBUF.
1107           (set-buffer outbuf)
1108           (let ((buffer-read-only nil)
1109                 (msg (and (boundp 'rmail-current-message)
1110                           (symbol-value 'rmail-current-message))))
1111             ;; If MSG is non-nil, buffer is in RMAIL mode.
1112             ;; Compare this with rmail-output-to-rmail-buffer in Emacs 23.
1113             (when msg
1114               (unless babyl
1115                 (rmail-swap-buffers-maybe)
1116                 (rmail-maybe-set-message-counters))
1117               (widen)
1118               (narrow-to-region (point-max) (point-max)))
1119             (insert-buffer-substring tmpbuf)
1120             (when msg
1121               (when babyl
1122                 (goto-char (point-min))
1123                 (widen)
1124                 (search-backward "\n\^_")
1125                 (narrow-to-region (point) (point-max)))
1126               (rmail-count-new-messages t)
1127               (when (rmail-summary-exists)
1128                 (rmail-select-summary
1129                  (rmail-update-summary)))
1130               (rmail-show-message msg))
1131             (save-buffer)))))
1132     (kill-buffer tmpbuf)))
1133
1134 (defun gnus-output-to-mail (filename &optional ask)
1135   "Append the current article to a mail file named FILENAME."
1136   (require 'nnmail)
1137   (setq filename (expand-file-name filename))
1138   (let ((artbuf (current-buffer))
1139         (tmpbuf (get-buffer-create " *Gnus-output*")))
1140     (save-excursion
1141       ;; Create the file, if it doesn't exist.
1142       (when (and (not (get-file-buffer filename))
1143                  (not (file-exists-p filename)))
1144         (if (or (not ask)
1145                 (gnus-y-or-n-p
1146                  (concat "\"" filename "\" does not exist, create it? ")))
1147             (let ((file-buffer (create-file-buffer filename)))
1148               (with-current-buffer file-buffer
1149                 (let ((require-final-newline nil)
1150                       (coding-system-for-write mm-text-coding-system))
1151                   (gnus-write-buffer filename)))
1152               (kill-buffer file-buffer))
1153           (error "Output file does not exist")))
1154       (set-buffer tmpbuf)
1155       (erase-buffer)
1156       (insert-buffer-substring artbuf)
1157       (goto-char (point-min))
1158       (if (looking-at "From ")
1159           (forward-line 1)
1160         (insert "From nobody " (current-time-string) "\n"))
1161       (let (case-fold-search)
1162         (while (re-search-forward "^From " nil t)
1163           (beginning-of-line)
1164           (insert ">")))
1165       ;; Decide whether to append to a file or to an Emacs buffer.
1166       (let ((outbuf (get-file-buffer filename)))
1167         (if (not outbuf)
1168             (let ((buffer-read-only nil))
1169               (save-excursion
1170                 (goto-char (point-max))
1171                 (forward-char -2)
1172                 (unless (looking-at "\n\n")
1173                   (goto-char (point-max))
1174                   (unless (bolp)
1175                     (insert "\n"))
1176                   (insert "\n"))
1177                 (goto-char (point-max))
1178                 (let ((file-name-coding-system nnmail-pathname-coding-system))
1179                   (mm-append-to-file (point-min) (point-max) filename))))
1180           ;; File has been visited, in buffer OUTBUF.
1181           (set-buffer outbuf)
1182           (let ((buffer-read-only nil))
1183             (goto-char (point-max))
1184             (unless (eobp)
1185               (insert "\n"))
1186             (insert "\n")
1187             (insert-buffer-substring tmpbuf)))))
1188     (kill-buffer tmpbuf)))
1189
1190 (defun gnus-convert-article-to-rmail ()
1191   "Convert article in current buffer to Rmail message format."
1192   (let ((buffer-read-only nil))
1193     ;; Convert article directly into Babyl format.
1194     (goto-char (point-min))
1195     (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
1196     (while (search-forward "\n\^_" nil t) ;single char
1197       (replace-match "\n^_" t t))       ;2 chars: "^" and "_"
1198     (goto-char (point-max))
1199     (insert "\^_")))
1200
1201 (defun gnus-map-function (funs arg)
1202   "Apply the result of the first function in FUNS to the second, and so on.
1203 ARG is passed to the first function."
1204   (while funs
1205     (setq arg (funcall (pop funs) arg)))
1206   arg)
1207
1208 (defun gnus-run-hooks (&rest funcs)
1209   "Does the same as `run-hooks', but saves the current buffer."
1210   (save-current-buffer
1211     (apply 'run-hooks funcs)))
1212
1213 (defun gnus-run-hook-with-args (hook &rest args)
1214   "Does the same as `run-hook-with-args', but saves the current buffer."
1215   (save-current-buffer
1216     (apply 'run-hook-with-args hook args)))
1217
1218 (defun gnus-run-mode-hooks (&rest funcs)
1219   "Run `run-mode-hooks' if it is available, otherwise `run-hooks'.
1220 This function saves the current buffer."
1221   (if (fboundp 'run-mode-hooks)
1222       (save-current-buffer (apply 'run-mode-hooks funcs))
1223     (save-current-buffer (apply 'run-hooks funcs))))
1224
1225 ;;; Various
1226
1227 (defvar gnus-group-buffer)              ; Compiler directive
1228 (defun gnus-alive-p ()
1229   "Say whether Gnus is running or not."
1230   (and (boundp 'gnus-group-buffer)
1231        (get-buffer gnus-group-buffer)
1232        (with-current-buffer gnus-group-buffer
1233          (eq major-mode 'gnus-group-mode))))
1234
1235 (defun gnus-remove-if (predicate sequence &optional hash-table-p)
1236   "Return a copy of SEQUENCE with all items satisfying PREDICATE removed.
1237 SEQUENCE should be a list, a vector, or a string.  Returns always a list.
1238 If HASH-TABLE-P is non-nil, regards SEQUENCE as a hash table."
1239   (let (out)
1240     (if hash-table-p
1241         (mapatoms (lambda (symbol)
1242                     (unless (funcall predicate symbol)
1243                       (push symbol out)))
1244                   sequence)
1245       (unless (listp sequence)
1246         (setq sequence (append sequence nil)))
1247       (while sequence
1248         (unless (funcall predicate (car sequence))
1249           (push (car sequence) out))
1250         (setq sequence (cdr sequence))))
1251     (nreverse out)))
1252
1253 (defun gnus-remove-if-not (predicate sequence &optional hash-table-p)
1254   "Return a copy of SEQUENCE with all items not satisfying PREDICATE removed.
1255 SEQUENCE should be a list, a vector, or a string.  Returns always a list.
1256 If HASH-TABLE-P is non-nil, regards SEQUENCE as a hash table."
1257   (let (out)
1258     (if hash-table-p
1259         (mapatoms (lambda (symbol)
1260                     (when (funcall predicate symbol)
1261                       (push symbol out)))
1262                   sequence)
1263       (unless (listp sequence)
1264         (setq sequence (append sequence nil)))
1265       (while sequence
1266         (when (funcall predicate (car sequence))
1267           (push (car sequence) out))
1268         (setq sequence (cdr sequence))))
1269     (nreverse out)))
1270
1271 (if (fboundp 'assq-delete-all)
1272     (defalias 'gnus-delete-alist 'assq-delete-all)
1273   (defun gnus-delete-alist (key alist)
1274     "Delete from ALIST all elements whose car is KEY.
1275 Return the modified alist."
1276     (let (entry)
1277       (while (setq entry (assq key alist))
1278         (setq alist (delq entry alist)))
1279       alist)))
1280
1281 (defun gnus-grep-in-list (word list)
1282   "Find if a WORD matches any regular expression in the given LIST."
1283   (when (and word list)
1284     (catch 'found
1285       (dolist (r list)
1286         (when (string-match r word)
1287           (throw 'found r))))))
1288
1289 (defmacro gnus-alist-pull (key alist &optional assoc-p)
1290   "Modify ALIST to be without KEY."
1291   (unless (symbolp alist)
1292     (error "Not a symbol: %s" alist))
1293   (let ((fun (if assoc-p 'assoc 'assq)))
1294     `(setq ,alist (delq (,fun ,key ,alist) ,alist))))
1295
1296 (defun gnus-globalify-regexp (re)
1297   "Return a regexp that matches a whole line, if RE matches a part of it."
1298   (concat (unless (string-match "^\\^" re) "^.*")
1299           re
1300           (unless (string-match "\\$$" re) ".*$")))
1301
1302 (defun gnus-set-window-start (&optional point)
1303   "Set the window start to POINT, or (point) if nil."
1304   (let ((win (gnus-get-buffer-window (current-buffer) t)))
1305     (when win
1306       (set-window-start win (or point (point))))))
1307
1308 (defun gnus-annotation-in-region-p (b e)
1309   (if (= b e)
1310       (eq (cadr (memq 'gnus-undeletable (text-properties-at b))) t)
1311     (text-property-any b e 'gnus-undeletable t)))
1312
1313 (defun gnus-or (&rest elems)
1314   "Return non-nil if any of the elements are non-nil."
1315   (catch 'found
1316     (while elems
1317       (when (pop elems)
1318         (throw 'found t)))))
1319
1320 (defun gnus-and (&rest elems)
1321   "Return non-nil if all of the elements are non-nil."
1322   (catch 'found
1323     (while elems
1324       (unless (pop elems)
1325         (throw 'found nil)))
1326     t))
1327
1328 ;; gnus.el requires mm-util.
1329 (declare-function mm-disable-multibyte "mm-util")
1330
1331 (defun gnus-write-active-file (file hashtb &optional full-names)
1332   ;; `coding-system-for-write' should be `raw-text' or equivalent.
1333   (let ((coding-system-for-write nnmail-active-file-coding-system))
1334     (with-temp-file file
1335       ;; The buffer should be in the unibyte mode because group names
1336       ;; are ASCII text or encoded non-ASCII text (i.e., unibyte).
1337       (mm-disable-multibyte)
1338       (mapatoms
1339        (lambda (sym)
1340          (when (and sym
1341                     (boundp sym)
1342                     (symbol-value sym))
1343            (insert (format "%S %d %d y\n"
1344                            (if full-names
1345                                sym
1346                              (intern (gnus-group-real-name (symbol-name sym))))
1347                            (or (cdr (symbol-value sym))
1348                                (car (symbol-value sym)))
1349                            (car (symbol-value sym))))))
1350        hashtb)
1351       (goto-char (point-max))
1352       (while (search-backward "\\." nil t)
1353         (delete-char 1)))))
1354
1355 ;; Fixme: Why not use `with-output-to-temp-buffer'?
1356 (defmacro gnus-with-output-to-file (file &rest body)
1357   (let ((buffer (make-symbol "output-buffer"))
1358         (size (make-symbol "output-buffer-size"))
1359         (leng (make-symbol "output-buffer-length"))
1360         (append (make-symbol "output-buffer-append")))
1361     `(let* ((,size 131072)
1362             (,buffer (make-string ,size 0))
1363             (,leng 0)
1364             (,append nil)
1365             (standard-output
1366              (lambda (c)
1367                (aset ,buffer ,leng c)
1368
1369                (if (= ,size (setq ,leng (1+ ,leng)))
1370                    (progn (write-region ,buffer nil ,file ,append 'no-msg)
1371                           (setq ,leng 0
1372                                 ,append t))))))
1373        ,@body
1374        (when (> ,leng 0)
1375          (let ((coding-system-for-write 'no-conversion))
1376          (write-region (substring ,buffer 0 ,leng) nil ,file
1377                        ,append 'no-msg))))))
1378
1379 (put 'gnus-with-output-to-file 'lisp-indent-function 1)
1380 (put 'gnus-with-output-to-file 'edebug-form-spec '(form body))
1381
1382 (if (fboundp 'union)
1383     (defalias 'gnus-union 'union)
1384   (defun gnus-union (l1 l2)
1385     "Set union of lists L1 and L2."
1386     (cond ((null l1) l2)
1387           ((null l2) l1)
1388           ((equal l1 l2) l1)
1389           (t
1390            (or (>= (length l1) (length l2))
1391                (setq l1 (prog1 l2 (setq l2 l1))))
1392            (while l2
1393              (or (member (car l2) l1)
1394                  (push (car l2) l1))
1395              (pop l2))
1396            l1))))
1397
1398 (declare-function gnus-add-text-properties "gnus"
1399                   (start end properties &optional object))
1400
1401 (defun gnus-add-text-properties-when
1402   (property value start end properties &optional object)
1403   "Like `gnus-add-text-properties', only applied on where PROPERTY is VALUE."
1404   (let (point)
1405     (while (and start
1406                 (< start end) ;; XEmacs will loop for every when start=end.
1407                 (setq point (text-property-not-all start end property value)))
1408       (gnus-add-text-properties start point properties object)
1409       (setq start (text-property-any point end property value)))
1410     (if start
1411         (gnus-add-text-properties start end properties object))))
1412
1413 (defun gnus-remove-text-properties-when
1414   (property value start end properties &optional object)
1415   "Like `remove-text-properties', only applied on where PROPERTY is VALUE."
1416   (let (point)
1417     (while (and start
1418                 (< start end)
1419                 (setq point (text-property-not-all start end property value)))
1420       (remove-text-properties start point properties object)
1421       (setq start (text-property-any point end property value)))
1422     (if start
1423         (remove-text-properties start end properties object))
1424     t))
1425
1426 (defun gnus-string-remove-all-properties (string)
1427   (condition-case ()
1428       (let ((s string))
1429         (set-text-properties 0 (length string) nil string)
1430         s)
1431     (error string)))
1432
1433 ;; This might use `compare-strings' to reduce consing in the
1434 ;; case-insensitive case, but it has to cope with null args.
1435 ;; (`string-equal' uses symbol print names.)
1436 (defun gnus-string-equal (x y)
1437   "Like `string-equal', except it compares case-insensitively."
1438   (and (= (length x) (length y))
1439        (or (string-equal x y)
1440            (string-equal (downcase x) (downcase y)))))
1441
1442 (defcustom gnus-use-byte-compile t
1443   "If non-nil, byte-compile crucial run-time code.
1444 Setting it to nil has no effect after the first time `gnus-byte-compile'
1445 is run."
1446   :type 'boolean
1447   :version "22.1"
1448   :group 'gnus-various)
1449
1450 (defun gnus-byte-compile (form)
1451   "Byte-compile FORM if `gnus-use-byte-compile' is non-nil."
1452   (if gnus-use-byte-compile
1453       (progn
1454         (condition-case nil
1455             ;; Work around a bug in XEmacs 21.4
1456             (require 'byte-optimize)
1457           (error))
1458         (require 'bytecomp)
1459         (defalias 'gnus-byte-compile
1460           (lambda (form)
1461             (let ((byte-compile-warnings '(unresolved callargs redefine)))
1462               (byte-compile form))))
1463         (gnus-byte-compile form))
1464     form))
1465
1466 (defun gnus-remassoc (key alist)
1467   "Delete by side effect any elements of LIST whose car is `equal' to KEY.
1468 The modified LIST is returned.  If the first member
1469 of LIST has a car that is `equal' to KEY, there is no way to remove it
1470 by side effect; therefore, write `(setq foo (gnus-remassoc key foo))' to be
1471 sure of changing the value of `foo'."
1472   (when alist
1473     (if (equal key (caar alist))
1474         (cdr alist)
1475       (setcdr alist (gnus-remassoc key (cdr alist)))
1476       alist)))
1477
1478 (defun gnus-update-alist-soft (key value alist)
1479   (if value
1480       (cons (cons key value) (gnus-remassoc key alist))
1481     (gnus-remassoc key alist)))
1482
1483 (defun gnus-create-info-command (node)
1484   "Create a command that will go to info NODE."
1485   `(lambda ()
1486      (interactive)
1487      ,(concat "Enter the info system at node " node)
1488      (Info-goto-node ,node)
1489      (setq gnus-info-buffer (current-buffer))
1490      (gnus-configure-windows 'info)))
1491
1492 (defun gnus-not-ignore (&rest args)
1493   t)
1494
1495 (defvar gnus-directory-sep-char-regexp "/"
1496   "The regexp of directory separator character.
1497 If you find some problem with the directory separator character, try
1498 \"[/\\\\\]\" for some systems.")
1499
1500 (defun gnus-url-unhex (x)
1501   (if (> x ?9)
1502       (if (>= x ?a)
1503           (+ 10 (- x ?a))
1504         (+ 10 (- x ?A)))
1505     (- x ?0)))
1506
1507 ;; Fixme: Do it like QP.
1508 (defun gnus-url-unhex-string (str &optional allow-newlines)
1509   "Remove %XX, embedded spaces, etc in a url.
1510 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
1511 decoding of carriage returns and line feeds in the string, which is normally
1512 forbidden in URL encoding."
1513   (let ((tmp "")
1514         (case-fold-search t))
1515     (while (string-match "%[0-9a-f][0-9a-f]" str)
1516       (let* ((start (match-beginning 0))
1517              (ch1 (gnus-url-unhex (elt str (+ start 1))))
1518              (code (+ (* 16 ch1)
1519                       (gnus-url-unhex (elt str (+ start 2))))))
1520         (setq tmp (concat
1521                    tmp (substring str 0 start)
1522                    (cond
1523                     (allow-newlines
1524                      (char-to-string code))
1525                     ((or (= code ?\n) (= code ?\r))
1526                      " ")
1527                     (t (char-to-string code))))
1528               str (substring str (match-end 0)))))
1529     (setq tmp (concat tmp str))
1530     tmp))
1531
1532 (defun gnus-make-predicate (spec)
1533   "Transform SPEC into a function that can be called.
1534 SPEC is a predicate specifier that contains stuff like `or', `and',
1535 `not', lists and functions.  The functions all take one parameter."
1536   `(lambda (elem) ,(gnus-make-predicate-1 spec)))
1537
1538 (defun gnus-make-predicate-1 (spec)
1539   (cond
1540    ((symbolp spec)
1541     `(,spec elem))
1542    ((listp spec)
1543     (if (memq (car spec) '(or and not))
1544         `(,(car spec) ,@(mapcar 'gnus-make-predicate-1 (cdr spec)))
1545       (error "Invalid predicate specifier: %s" spec)))))
1546
1547 (defun gnus-completing-read (prompt collection &optional require-match
1548                                     initial-input history def)
1549   "Call `gnus-completing-read-function'."
1550   (funcall gnus-completing-read-function
1551            (concat prompt (when def
1552                             (concat " (default " def ")"))
1553                    ": ")
1554            collection require-match initial-input history def))
1555
1556 (defun gnus-emacs-completing-read (prompt collection &optional require-match
1557                                           initial-input history def)
1558   "Call standard `completing-read-function'."
1559   (let ((completion-styles gnus-completion-styles))
1560     (completing-read prompt
1561                      ;; Old XEmacs (at least 21.4) expect an alist,
1562                      ;; in which the car of each element is a string,
1563                      ;; for collection.
1564                      (mapcar (lambda (elem)
1565                                (list (format "%s" (or (car-safe elem) elem))))
1566                              collection)
1567                      nil require-match initial-input history def)))
1568
1569 (autoload 'ido-completing-read "ido")
1570 (defun gnus-ido-completing-read (prompt collection &optional require-match
1571                                         initial-input history def)
1572   "Call `ido-completing-read-function'."
1573   (ido-completing-read prompt collection nil require-match
1574                        initial-input history def))
1575
1576
1577 (declare-function iswitchb-read-buffer "iswitchb"
1578                   (prompt &optional default require-match start matches-set))
1579 (defvar iswitchb-temp-buflist)
1580
1581 (defun gnus-iswitchb-completing-read (prompt collection &optional require-match
1582                                             initial-input history def)
1583   "`iswitchb' based completing-read function."
1584   ;; Make sure iswitchb is loaded before we let-bind its variables.
1585   ;; If it is loaded inside the let, variables can become unbound afterwards.
1586   (require 'iswitchb)
1587   (let ((iswitchb-make-buflist-hook
1588          (lambda ()
1589            (setq iswitchb-temp-buflist
1590                  (let ((choices (append
1591                                  (when initial-input (list initial-input))
1592                                  (symbol-value history) collection))
1593                        filtered-choices)
1594                    (dolist (x choices)
1595                      (setq filtered-choices (adjoin x filtered-choices)))
1596                    (nreverse filtered-choices))))))
1597     (unwind-protect
1598         (progn
1599           (or iswitchb-mode
1600               (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup))
1601           (iswitchb-read-buffer prompt def require-match))
1602       (or iswitchb-mode
1603           (remove-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)))))
1604
1605 (defun gnus-graphic-display-p ()
1606   (if (featurep 'xemacs)
1607       (device-on-window-system-p)
1608     (display-graphic-p)))
1609
1610 (put 'gnus-parse-without-error 'lisp-indent-function 0)
1611 (put 'gnus-parse-without-error 'edebug-form-spec '(body))
1612
1613 (defmacro gnus-parse-without-error (&rest body)
1614   "Allow continuing onto the next line even if an error occurs."
1615   `(while (not (eobp))
1616      (condition-case ()
1617          (progn
1618            ,@body
1619            (goto-char (point-max)))
1620        (error
1621         (gnus-error 4 "Invalid data on line %d"
1622                     (count-lines (point-min) (point)))
1623         (forward-line 1)))))
1624
1625 (defun gnus-cache-file-contents (file variable function)
1626   "Cache the contents of FILE in VARIABLE.  The contents come from FUNCTION."
1627   (let ((time (nth 5 (file-attributes file)))
1628         contents value)
1629     (if (or (null (setq value (symbol-value variable)))
1630             (not (equal (car value) file))
1631             (not (equal (nth 1 value) time)))
1632         (progn
1633           (setq contents (funcall function file))
1634           (set variable (list file time contents))
1635           contents)
1636       (nth 2 value))))
1637
1638 (defun gnus-multiple-choice (prompt choice &optional idx)
1639   "Ask user a multiple choice question.
1640 CHOICE is a list of the choice char and help message at IDX."
1641   (let (tchar buf)
1642     (save-window-excursion
1643       (save-excursion
1644         (while (not tchar)
1645           (message "%s (%s): "
1646                    prompt
1647                    (concat
1648                     (mapconcat (lambda (s) (char-to-string (car s)))
1649                                choice ", ") ", ?"))
1650           (setq tchar (read-char))
1651           (when (not (assq tchar choice))
1652             (setq tchar nil)
1653             (setq buf (get-buffer-create "*Gnus Help*"))
1654             (pop-to-buffer buf)
1655             (fundamental-mode)          ; for Emacs 20.4+
1656             (buffer-disable-undo)
1657             (erase-buffer)
1658             (insert prompt ":\n\n")
1659             (let ((max -1)
1660                   (list choice)
1661                   (alist choice)
1662                   (idx (or idx 1))
1663                   (i 0)
1664                   n width pad format)
1665               ;; find the longest string to display
1666               (while list
1667                 (setq n (length (nth idx (car list))))
1668                 (unless (> max n)
1669                   (setq max n))
1670                 (setq list (cdr list)))
1671               (setq max (+ max 4))      ; %c, `:', SPACE, a SPACE at end
1672               (setq n (/ (1- (window-width)) max)) ; items per line
1673               (setq width (/ (1- (window-width)) n)) ; width of each item
1674               ;; insert `n' items, each in a field of width `width'
1675               (while alist
1676                 (if (< i n)
1677                     ()
1678                   (setq i 0)
1679                   (delete-char -1)              ; the `\n' takes a char
1680                   (insert "\n"))
1681                 (setq pad (- width 3))
1682                 (setq format (concat "%c: %-" (int-to-string pad) "s"))
1683                 (insert (format format (caar alist) (nth idx (car alist))))
1684                 (setq alist (cdr alist))
1685                 (setq i (1+ i))))))))
1686     (if (buffer-live-p buf)
1687         (kill-buffer buf))
1688     tchar))
1689
1690 (if (featurep 'emacs)
1691     (defalias 'gnus-select-frame-set-input-focus 'select-frame-set-input-focus)
1692   (if (fboundp 'select-frame-set-input-focus)
1693       (defalias 'gnus-select-frame-set-input-focus 'select-frame-set-input-focus)
1694     ;; XEmacs 21.4, SXEmacs
1695     (defun gnus-select-frame-set-input-focus (frame)
1696       "Select FRAME, raise it, and set input focus, if possible."
1697       (raise-frame frame)
1698       (select-frame frame)
1699       (focus-frame frame))))
1700
1701 (defun gnus-frame-or-window-display-name (object)
1702   "Given a frame or window, return the associated display name.
1703 Return nil otherwise."
1704   (if (featurep 'xemacs)
1705       (device-connection (dfw-device object))
1706     (if (or (framep object)
1707             (and (windowp object)
1708                  (setq object (window-frame object))))
1709         (let ((display (frame-parameter object 'display)))
1710           (if (and (stringp display)
1711                    ;; Exclude invalid display names.
1712                    (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'"
1713                                  display))
1714               display)))))
1715
1716 (defvar tool-bar-mode)
1717
1718 (defun gnus-tool-bar-update (&rest ignore)
1719   "Update the tool bar."
1720   (when (and (boundp 'tool-bar-mode)
1721              tool-bar-mode)
1722     (let* ((args nil)
1723            (func (cond ((featurep 'xemacs)
1724                         'ignore)
1725                        ((fboundp 'tool-bar-update)
1726                         'tool-bar-update)
1727                        ((fboundp 'force-window-update)
1728                         'force-window-update)
1729                        ((fboundp 'redraw-frame)
1730                         (setq args (list (selected-frame)))
1731                         'redraw-frame)
1732                        (t 'ignore))))
1733       (apply func args))))
1734
1735 ;; Fixme: This has only one use (in gnus-agent), which isn't worthwhile.
1736 (defmacro gnus-mapcar (function seq1 &rest seqs2_n)
1737   "Apply FUNCTION to each element of the sequences, and make a list of the results.
1738 If there are several sequences, FUNCTION is called with that many arguments,
1739 and mapping stops as soon as the shortest sequence runs out.  With just one
1740 sequence, this is like `mapcar'.  With several, it is like the Common Lisp
1741 `mapcar' function extended to arbitrary sequence types."
1742
1743   (if seqs2_n
1744       (let* ((seqs (cons seq1 seqs2_n))
1745              (cnt 0)
1746              (heads (mapcar (lambda (seq)
1747                               (make-symbol (concat "head"
1748                                                    (int-to-string
1749                                                     (setq cnt (1+ cnt))))))
1750                             seqs))
1751              (result (make-symbol "result"))
1752              (result-tail (make-symbol "result-tail")))
1753         `(let* ,(let* ((bindings (cons nil nil))
1754                        (heads heads))
1755                   (nconc bindings (list (list result '(cons nil nil))))
1756                   (nconc bindings (list (list result-tail result)))
1757                   (while heads
1758                     (nconc bindings (list (list (pop heads) (pop seqs)))))
1759                   (cdr bindings))
1760            (while (and ,@heads)
1761              (setcdr ,result-tail (cons (funcall ,function
1762                                                  ,@(mapcar (lambda (h) (list 'car h))
1763                                                            heads))
1764                                         nil))
1765              (setq ,result-tail (cdr ,result-tail)
1766                    ,@(apply 'nconc (mapcar (lambda (h) (list h (list 'cdr h))) heads))))
1767            (cdr ,result)))
1768     `(mapcar ,function ,seq1)))
1769
1770 (if (fboundp 'merge)
1771     (defalias 'gnus-merge 'merge)
1772   ;; Adapted from cl-seq.el
1773   (defun gnus-merge (type list1 list2 pred)
1774     "Destructively merge lists LIST1 and LIST2 to produce a new list.
1775 Argument TYPE is for compatibility and ignored.
1776 Ordering of the elements is preserved according to PRED, a `less-than'
1777 predicate on the elements."
1778     (let ((res nil))
1779       (while (and list1 list2)
1780         (if (funcall pred (car list2) (car list1))
1781             (push (pop list2) res)
1782           (push (pop list1) res)))
1783       (nconc (nreverse res) list1 list2))))
1784
1785 (defvar xemacs-codename)
1786 (defvar sxemacs-codename)
1787 (defvar emacs-program-version)
1788
1789 (defun gnus-emacs-version ()
1790   "Stringified Emacs version."
1791   (let* ((lst (if (listp gnus-user-agent)
1792                   gnus-user-agent
1793                 '(gnus emacs type)))
1794          (system-v (cond ((memq 'config lst)
1795                           system-configuration)
1796                          ((memq 'type lst)
1797                           (symbol-name system-type))
1798                          (t nil)))
1799          codename emacsname)
1800     (cond ((featurep 'sxemacs)
1801            (setq emacsname "SXEmacs"
1802                  codename sxemacs-codename))
1803           ((featurep 'xemacs)
1804            (setq emacsname "XEmacs"
1805                  codename xemacs-codename))
1806           (t
1807            (setq emacsname "Emacs")))
1808     (cond
1809      ((not (memq 'emacs lst))
1810       nil)
1811      ((string-match "^\\(\\([.0-9]+\\)*\\)\\.[0-9]+$" emacs-version)
1812       ;; Emacs:
1813       (concat "Emacs/" (match-string 1 emacs-version)
1814               (if system-v
1815                   (concat " (" system-v ")")
1816                 "")))
1817      ((or (featurep 'sxemacs) (featurep 'xemacs))
1818       ;; XEmacs or SXEmacs:
1819       (concat emacsname "/" emacs-program-version
1820               (let (plst)
1821                 (when (memq 'codename lst)
1822                   (push codename plst))
1823                 (when system-v
1824                   (push system-v plst))
1825                 (unless (featurep 'mule)
1826                   (push "no MULE" plst))
1827                 (when (> (length plst) 0)
1828                   (concat
1829                    " (" (mapconcat 'identity (reverse plst) ", ") ")")))))
1830      (t emacs-version))))
1831
1832 (defun gnus-rename-file (old-path new-path &optional trim)
1833   "Rename OLD-PATH as NEW-PATH.  If TRIM, recursively delete
1834 empty directories from OLD-PATH."
1835   (when (file-exists-p old-path)
1836     (let* ((old-dir (file-name-directory old-path))
1837            (old-name (file-name-nondirectory old-path))
1838            (new-dir (file-name-directory new-path))
1839            (new-name (file-name-nondirectory new-path))
1840            temp)
1841       (gnus-make-directory new-dir)
1842       (rename-file old-path new-path t)
1843       (when trim
1844         (while (progn (setq temp (directory-files old-dir))
1845                       (while (member (car temp) '("." ".."))
1846                         (setq temp (cdr temp)))
1847                       (= (length temp) 0))
1848           (delete-directory old-dir)
1849           (setq old-dir (file-name-as-directory
1850                          (file-truename
1851                           (concat old-dir "..")))))))))
1852
1853 (defun gnus-set-file-modes (filename mode)
1854   "Wrapper for set-file-modes."
1855   (ignore-errors
1856     (set-file-modes filename mode)))
1857
1858 (if (fboundp 'set-process-query-on-exit-flag)
1859     (defalias 'gnus-set-process-query-on-exit-flag
1860       'set-process-query-on-exit-flag)
1861   (defalias 'gnus-set-process-query-on-exit-flag
1862     'process-kill-without-query))
1863
1864 (defalias 'gnus-read-shell-command
1865   (if (fboundp 'read-shell-command) 'read-shell-command 'read-string))
1866
1867 (defmacro gnus-put-display-table (range value display-table)
1868   "Set the value for char RANGE to VALUE in DISPLAY-TABLE.  "
1869   (if (featurep 'xemacs)
1870       (progn
1871         `(if (fboundp 'put-display-table)
1872           (put-display-table ,range ,value ,display-table)
1873           (if (sequencep ,display-table)
1874               (aset ,display-table ,range ,value)
1875             (put-char-table ,range ,value ,display-table))))
1876     `(aset ,display-table ,range ,value)))
1877
1878 (defmacro gnus-get-display-table (character display-table)
1879   "Find value for CHARACTER in DISPLAY-TABLE.  "
1880   (if (featurep 'xemacs)
1881       `(if (fboundp 'get-display-table)
1882           (get-display-table ,character ,display-table)
1883           (if (sequencep ,display-table)
1884               (aref ,display-table ,character)
1885             (get-char-table ,character ,display-table)))
1886     `(aref ,display-table ,character)))
1887
1888 (defun gnus-rescale-image (image size)
1889   "Rescale IMAGE to SIZE if possible.
1890 SIZE is in format (WIDTH . HEIGHT). Return a new image.
1891 Sizes are in pixels."
1892   (if (or (not (fboundp 'imagemagick-types))
1893           (not (get-buffer-window (current-buffer))))
1894       image
1895     (let ((new-width (car size))
1896           (new-height (cdr size)))
1897       (when (> (cdr (image-size image t)) new-height)
1898         (setq image (or (create-image (plist-get (cdr image) :data) 'imagemagick t
1899                                       :height new-height)
1900                         image)))
1901       (when (> (car (image-size image t)) new-width)
1902         (setq image (or
1903                    (create-image (plist-get (cdr image) :data) 'imagemagick t
1904                                  :width new-width)
1905                    image)))
1906       image)))
1907
1908 (defun gnus-recursive-directory-files (dir)
1909   "Return all regular files below DIR."
1910   (let (files)
1911     (dolist (file (directory-files dir t))
1912       (when (and (not (member (file-name-nondirectory file) '("." "..")))
1913                  (file-readable-p file))
1914         (cond
1915          ((file-regular-p file)
1916           (push file files))
1917          ((file-directory-p file)
1918           (setq files (append (gnus-recursive-directory-files file) files))))))
1919     files))
1920
1921 (defun gnus-list-memq-of-list (elements list)
1922   "Return non-nil if any of the members of ELEMENTS are in LIST."
1923   (let ((found nil))
1924     (dolist (elem elements)
1925       (setq found (or found
1926                       (memq elem list))))
1927     found))
1928
1929 (eval-and-compile
1930   (cond
1931    ((fboundp 'match-substitute-replacement)
1932     (defalias 'gnus-match-substitute-replacement 'match-substitute-replacement))
1933    (t
1934     (defun gnus-match-substitute-replacement (replacement &optional fixedcase literal string subexp)
1935       "Return REPLACEMENT as it will be inserted by `replace-match'.
1936 In other words, all back-references in the form `\\&' and `\\N'
1937 are substituted with actual strings matched by the last search.
1938 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
1939 meaning as for `replace-match'.
1940
1941 This is the definition of match-substitute-replacement in subr.el from GNU Emacs."
1942       (let ((match (match-string 0 string)))
1943         (save-match-data
1944           (set-match-data (mapcar (lambda (x)
1945                                     (if (numberp x)
1946                                         (- x (match-beginning 0))
1947                                       x))
1948                                   (match-data t)))
1949           (replace-match replacement fixedcase literal match subexp)))))))
1950
1951 (if (fboundp 'string-match-p)
1952     (defalias 'gnus-string-match-p 'string-match-p)
1953   (defsubst gnus-string-match-p (regexp string &optional start)
1954     "\
1955 Same as `string-match' except this function does not change the match data."
1956     (save-match-data
1957       (string-match regexp string start))))
1958
1959 (if (fboundp 'string-prefix-p)
1960     (defalias 'gnus-string-prefix-p 'string-prefix-p)
1961   (defun gnus-string-prefix-p (str1 str2 &optional ignore-case)
1962     "Return non-nil if STR1 is a prefix of STR2.
1963 If IGNORE-CASE is non-nil, the comparison is done without paying attention
1964 to case differences."
1965     (and (<= (length str1) (length str2))
1966          (let ((prefix (substring str2 0 (length str1))))
1967            (if ignore-case
1968                (string-equal (downcase str1) (downcase prefix))
1969              (string-equal str1 prefix))))))
1970
1971 ;; Simple check: can be a macro but this way, although slow, it's really clear.
1972 ;; We don't use `bound-and-true-p' because it's not in XEmacs.
1973 (defun gnus-bound-and-true-p (sym)
1974   (and (boundp sym) (symbol-value sym)))
1975
1976 (if (fboundp 'timer--function)
1977     (defalias 'gnus-timer--function 'timer--function)
1978   (defun gnus-timer--function (timer)
1979     (elt timer 5)))
1980
1981 (provide 'gnus-util)
1982
1983 ;;; gnus-util.el ends here