6bbcc7020051155faf1cfa6e70647b84088168c2
[elisp/gnus.git-] / lisp / gnus-util.el
1 ;;; gnus-util.el --- utility functions for Semi-gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;;      Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
7 ;; Keywords: mail, news, MIME
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
13 ;; the Free Software Foundation; either version 2, or (at your option)
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
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;; Nothing in this file depends on any other parts of Gnus -- all
29 ;; functions and macros in this file are utility functions that are
30 ;; used by Gnus and may be used by any other package without loading
31 ;; Gnus first.
32
33 ;; [Unfortunately, it does depend on other parts of Gnus, e.g. the
34 ;; autoloads below...]
35
36 ;;; Code:
37
38 (eval-when-compile
39   (require 'cl)
40   ;; Fixme: this should be a gnus variable, not nnmail-.
41   (defvar nnmail-pathname-coding-system))
42 (eval-when-compile (require 'static))
43
44 (require 'custom)
45 (require 'time-date)
46 (require 'netrc)
47
48 (eval-and-compile
49   (autoload 'message-fetch-field "message")
50   (autoload 'gnus-get-buffer-window "gnus-win")
51   (autoload 'rmail-insert-rmail-file-header "rmail")
52   (autoload 'rmail-count-new-messages "rmail")
53   (autoload 'rmail-show-message "rmail")
54   (autoload 'nnheader-narrow-to-headers "nnheader")
55   (autoload 'nnheader-replace-chars-in-string "nnheader"))
56
57 (eval-and-compile
58   (cond
59    ((fboundp 'replace-in-string)
60     (defalias 'gnus-replace-in-string 'replace-in-string))
61    ((fboundp 'replace-regexp-in-string)
62     (defun gnus-replace-in-string  (string regexp newtext &optional literal)
63       (replace-regexp-in-string regexp newtext string nil literal)))))
64
65 ;;; bring in the netrc functions as aliases
66 (defalias 'gnus-netrc-get 'netrc-get)
67 (defalias 'gnus-netrc-machine 'netrc-machine)
68 (defalias 'gnus-parse-netrc 'netrc-parse)
69
70 (defun gnus-boundp (variable)
71   "Return non-nil if VARIABLE is bound and non-nil."
72   (and (boundp variable)
73        (symbol-value variable)))
74
75 (defmacro gnus-eval-in-buffer-window (buffer &rest forms)
76   "Pop to BUFFER, evaluate FORMS, and then return to the original window."
77   (let ((tempvar (make-symbol "GnusStartBufferWindow"))
78         (w (make-symbol "w"))
79         (buf (make-symbol "buf"))
80         (frame (make-symbol "frame")))
81     `(let* ((,tempvar (selected-window))
82             (,buf ,buffer)
83             (,w (gnus-get-buffer-window ,buf 'visible))
84             ,frame)
85        (unwind-protect
86            (progn
87              (if ,w
88                  (progn
89                    (select-window ,w)
90                    (set-buffer (window-buffer ,w)))
91                (pop-to-buffer ,buf))
92              ,@forms)
93          (setq ,frame (selected-frame))
94          (select-window ,tempvar)
95          (select-frame ,frame)))))
96
97 (put 'gnus-eval-in-buffer-window 'lisp-indent-function 1)
98 (put 'gnus-eval-in-buffer-window 'edebug-form-spec '(form body))
99
100 (defmacro gnus-intern-safe (string hashtable)
101   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
102   `(let ((symbol (intern ,string ,hashtable)))
103      (or (boundp symbol)
104          (set symbol nil))
105      symbol))
106
107 ;; Added by Geoffrey T. Dairiki <dairiki@u.washington.edu>.  A safe way
108 ;; to limit the length of a string.  This function is necessary since
109 ;; `(substr "abc" 0 30)' pukes with "Args out of range".
110 ;; Fixme: Why not `truncate-string-to-width'?
111 (defsubst gnus-limit-string (str width)
112   (if (> (length str) width)
113       (substring str 0 width)
114     str))
115
116 (defsubst gnus-goto-char (point)
117   (and point (goto-char point)))
118
119 (defmacro gnus-buffer-exists-p (buffer)
120   `(let ((buffer ,buffer))
121      (when buffer
122        (funcall (if (stringp buffer) 'get-buffer 'buffer-name)
123                 buffer))))
124
125 ;; The LOCAL arg to `add-hook' is interpreted differently in Emacs and
126 ;; XEmacs.  In Emacs we don't need to call `make-local-hook' first.
127 ;; It's harmless, though, so the main purpose of this alias is to shut
128 ;; up the byte compiler.
129 (defalias 'gnus-make-local-hook
130   (if (eq (get 'make-local-hook 'byte-compile)
131           'byte-compile-obsolete)
132       'ignore                           ; Emacs
133     'make-local-hook))                  ; XEmacs
134
135 (defun gnus-delete-first (elt list)
136   "Delete by side effect the first occurrence of ELT as a member of LIST."
137   (if (equal (car list) elt)
138       (cdr list)
139     (let ((total list))
140       (while (and (cdr list)
141                   (not (equal (cadr list) elt)))
142         (setq list (cdr list)))
143       (when (cdr list)
144         (setcdr list (cddr list)))
145       total)))
146
147 ;; Delete the current line (and the next N lines).
148 (defmacro gnus-delete-line (&optional n)
149   `(delete-region (point-at-bol)
150                   (progn (forward-line ,(or n 1)) (point))))
151
152 (defun gnus-byte-code (func)
153   "Return a form that can be `eval'ed based on FUNC."
154   (let ((fval (indirect-function func)))
155     (if (byte-code-function-p fval)
156         (let ((flist (append fval nil)))
157           (setcar flist 'byte-code)
158           flist)
159       (cons 'progn (cddr fval)))))
160
161 (defun gnus-extract-address-components (from)
162   "Extract address components from a From header.
163 Given an RFC-822 address FROM, extract full name and canonical address.
164 Returns a list of the form (FULL-NAME CANONICAL-ADDRESS).  Much more simple
165 solution than `mail-extract-address-components', which works much better, but
166 is slower."
167   (let (name address)
168     ;; First find the address - the thing with the @ in it.  This may
169     ;; not be accurate in mail addresses, but does the trick most of
170     ;; the time in news messages.
171     (when (string-match "\\b[^@ \t<>]+[!@][^@ \t<>]+\\b" from)
172       (setq address (substring from (match-beginning 0) (match-end 0))))
173     ;; Then we check whether the "name <address>" format is used.
174     (and address
175          ;; Linear white space is not required.
176          (string-match (concat "[ \t]*<" (regexp-quote address) ">") from)
177          (and (setq name (substring from 0 (match-beginning 0)))
178               ;; Strip any quotes from the name.
179               (string-match "^\".*\"$" name)
180               (setq name (substring name 1 (1- (match-end 0))))))
181     ;; If not, then "address (name)" is used.
182     (or name
183         (and (string-match "(.+)" from)
184              (setq name (substring from (1+ (match-beginning 0))
185                                    (1- (match-end 0)))))
186         (and (string-match "()" from)
187              (setq name address))
188         ;; XOVER might not support folded From headers.
189         (and (string-match "(.*" from)
190              (setq name (substring from (1+ (match-beginning 0))
191                                    (match-end 0)))))
192     (list (if (string= name "") nil name) (or address from))))
193
194
195 (defun gnus-fetch-field (field)
196   "Return the value of the header FIELD of current article."
197   (save-excursion
198     (save-restriction
199       (let ((case-fold-search t)
200             (inhibit-point-motion-hooks t))
201         (nnheader-narrow-to-headers)
202         (message-fetch-field field)))))
203
204 (defun gnus-fetch-original-field (field)
205   "Fetch FIELD from the original version of the current article."
206   (with-current-buffer gnus-original-article-buffer
207     (gnus-fetch-field field)))
208
209
210 (defun gnus-goto-colon ()
211   (beginning-of-line)
212   (let ((eol (point-at-eol)))
213     (goto-char (or (text-property-any (point) eol 'gnus-position t)
214                    (search-forward ":" eol t)
215                    (point)))))
216
217 (defun gnus-decode-newsgroups (newsgroups group &optional method)
218   (let ((method (or method (gnus-find-method-for-group group))))
219     (mapconcat (lambda (group)
220                  (gnus-group-name-decode group (gnus-group-name-charset
221                                                 method group)))
222                (message-tokenize-header newsgroups)
223                ",")))
224
225 (defun gnus-remove-text-with-property (prop)
226   "Delete all text in the current buffer with text property PROP."
227   (save-excursion
228     (goto-char (point-min))
229     (while (not (eobp))
230       (while (get-text-property (point) prop)
231         (delete-char 1))
232       (goto-char (next-single-property-change (point) prop nil (point-max))))))
233
234 (defun gnus-newsgroup-directory-form (newsgroup)
235   "Make hierarchical directory name from NEWSGROUP name."
236   (let* ((newsgroup (gnus-newsgroup-savable-name newsgroup))
237          (idx (string-match ":" newsgroup)))
238     (concat
239      (if idx (substring newsgroup 0 idx))
240      (if idx "/")
241      (nnheader-replace-chars-in-string
242       (if idx (substring newsgroup (1+ idx)) newsgroup)
243       ?. ?/))))
244
245 (defun gnus-newsgroup-savable-name (group)
246   ;; Replace any slashes in a group name (eg. an ange-ftp nndoc group)
247   ;; with dots.
248   (nnheader-replace-chars-in-string group ?/ ?.))
249
250 (defun gnus-string> (s1 s2)
251   (not (or (string< s1 s2)
252            (string= s1 s2))))
253
254 ;;; Time functions.
255
256 (defun gnus-file-newer-than (file date)
257   (let ((fdate (nth 5 (file-attributes file))))
258     (or (> (car fdate) (car date))
259         (and (= (car fdate) (car date))
260              (> (nth 1 fdate) (nth 1 date))))))
261
262 ;;; Keymap macros.
263
264 (defmacro gnus-local-set-keys (&rest plist)
265   "Set the keys in PLIST in the current keymap."
266   `(gnus-define-keys-1 (current-local-map) ',plist))
267
268 (defmacro gnus-define-keys (keymap &rest plist)
269   "Define all keys in PLIST in KEYMAP."
270   `(gnus-define-keys-1 (quote ,keymap) (quote ,plist)))
271
272 (defmacro gnus-define-keys-safe (keymap &rest plist)
273   "Define all keys in PLIST in KEYMAP without overwriting previous definitions."
274   `(gnus-define-keys-1 (quote ,keymap) (quote ,plist) t))
275
276 (put 'gnus-define-keys 'lisp-indent-function 1)
277 (put 'gnus-define-keys-safe 'lisp-indent-function 1)
278 (put 'gnus-local-set-keys 'lisp-indent-function 1)
279
280 (defmacro gnus-define-keymap (keymap &rest plist)
281   "Define all keys in PLIST in KEYMAP."
282   `(gnus-define-keys-1 ,keymap (quote ,plist)))
283
284 (put 'gnus-define-keymap 'lisp-indent-function 1)
285
286 (defun gnus-define-keys-1 (keymap plist &optional safe)
287   (when (null keymap)
288     (error "Can't set keys in a null keymap"))
289   (cond ((symbolp keymap)
290          (setq keymap (symbol-value keymap)))
291         ((keymapp keymap))
292         ((listp keymap)
293          (set (car keymap) nil)
294          (define-prefix-command (car keymap))
295          (define-key (symbol-value (caddr keymap)) (cadr keymap) (car keymap))
296          (setq keymap (symbol-value (car keymap)))))
297   (let (key)
298     (while plist
299       (when (symbolp (setq key (pop plist)))
300         (setq key (symbol-value key)))
301       (if (or (not safe)
302               (eq (lookup-key keymap key) 'undefined))
303           (define-key keymap key (pop plist))
304         (pop plist)))))
305
306 (defun gnus-completing-read-with-default (default prompt &rest args)
307   ;; Like `completing-read', except that DEFAULT is the default argument.
308   (let* ((prompt (if default
309                      (concat prompt " (default " default ") ")
310                    (concat prompt " ")))
311          (answer (apply 'completing-read prompt args)))
312     (if (or (null answer) (zerop (length answer)))
313         default
314       answer)))
315
316 ;; Two silly functions to ensure that all `y-or-n-p' questions clear
317 ;; the echo area.
318 (defun gnus-y-or-n-p (prompt)
319   (prog1
320       (y-or-n-p prompt)
321     (message "")))
322
323 (defun gnus-yes-or-no-p (prompt)
324   (prog1
325       (yes-or-no-p prompt)
326     (message "")))
327
328 ;; By Frank Schmitt <ich@Frank-Schmitt.net>. Allows to have
329 ;; age-depending date representations. (e.g. just the time if it's
330 ;; from today, the day of the week if it's within the last 7 days and
331 ;; the full date if it's older)
332
333 (defun gnus-seconds-today ()
334   "Return the number of seconds passed today."
335   (let ((now (decode-time (current-time))))
336     (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600))))
337
338 (defun gnus-seconds-month ()
339   "Return the number of seconds passed this month."
340   (let ((now (decode-time (current-time))))
341     (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600)
342        (* (- (car (nthcdr 3 now)) 1) 3600 24))))
343
344 (defun gnus-seconds-year ()
345   "Return the number of seconds passed this year."
346   (let ((now (decode-time (current-time)))
347         (days (format-time-string "%j" (current-time))))
348     (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600)
349        (* (- (string-to-number days) 1) 3600 24))))
350
351 (defvar gnus-user-date-format-alist
352   '(((gnus-seconds-today) . "%k:%M")
353     (604800 . "%a %k:%M")                   ;;that's one week
354     ((gnus-seconds-month) . "%a %d")
355     ((gnus-seconds-year) . "%b %d")
356     (t . "%b %d '%y"))                      ;;this one is used when no
357                                             ;;other does match
358   "Specifies date format depending on age of article.
359 This is an alist of items (AGE . FORMAT).  AGE can be a number (of
360 seconds) or a Lisp expression evaluating to a number.  When the age of
361 the article is less than this number, then use `format-time-string'
362 with the corresponding FORMAT for displaying the date of the article.
363 If AGE is not a number or a Lisp expression evaluating to a
364 non-number, then the corresponding FORMAT is used as a default value.
365
366 Note that the list is processed from the beginning, so it should be
367 sorted by ascending AGE.  Also note that items following the first
368 non-number AGE will be ignored.
369
370 You can use the functions `gnus-seconds-today', `gnus-seconds-month'
371 and `gnus-seconds-year' in the AGE spec.  They return the number of
372 seconds passed since the start of today, of this month, of this year,
373 respectively.")
374
375 (defun gnus-user-date (messy-date)
376   "Format the messy-date according to gnus-user-date-format-alist.
377 Returns \"  ?  \" if there's bad input or if an other error occurs.
378 Input should look like this: \"Sun, 14 Oct 2001 13:34:39 +0200\"."
379   (condition-case ()
380       (let* ((messy-date (time-to-seconds (safe-date-to-time messy-date)))
381              (now (time-to-seconds (current-time)))
382              ;;If we don't find something suitable we'll use this one
383              (my-format "%b %d '%y"))
384         (let* ((difference (- now messy-date))
385                (templist gnus-user-date-format-alist)
386                (top (eval (caar templist))))
387           (while (if (numberp top) (< top difference) (not top))
388             (progn
389               (setq templist (cdr templist))
390               (setq top (eval (caar templist)))))
391           (if (stringp (cdr (car templist)))
392               (setq my-format (cdr (car templist)))))
393         (format-time-string (eval my-format) (seconds-to-time messy-date)))
394     (error "  ?   ")))
395
396 (defun gnus-dd-mmm (messy-date)
397   "Return a string like DD-MMM from a big messy string."
398   (condition-case ()
399       (format-time-string "%d-%b" (safe-date-to-time messy-date))
400     (error "  -   ")))
401
402 (defmacro gnus-date-get-time (date)
403   "Convert DATE string to Emacs time.
404 Cache the result as a text property stored in DATE."
405   ;; Either return the cached value...
406   `(let ((d ,date))
407      (if (equal "" d)
408          '(0 0)
409        (or (get-text-property 0 'gnus-time d)
410            ;; or compute the value...
411            (let ((time (safe-date-to-time d)))
412              ;; and store it back in the string.
413              (put-text-property 0 1 'gnus-time time d)
414              time)))))
415
416 (defsubst gnus-time-iso8601 (time)
417   "Return a string of TIME in YYYYMMDDTHHMMSS format."
418   (format-time-string "%Y%m%dT%H%M%S" time))
419
420 (defun gnus-date-iso8601 (date)
421   "Convert the DATE to YYYYMMDDTHHMMSS."
422   (condition-case ()
423       (gnus-time-iso8601 (gnus-date-get-time date))
424     (error "")))
425
426 (defun gnus-mode-string-quote (string)
427   "Quote all \"%\"'s in STRING."
428   (gnus-replace-in-string string "%" "%%"))
429
430 ;; Make a hash table (default and minimum size is 256).
431 ;; Optional argument HASHSIZE specifies the table size.
432 (defun gnus-make-hashtable (&optional hashsize)
433   (make-vector (if hashsize (max (gnus-create-hash-size hashsize) 256) 256) 0))
434
435 ;; Make a number that is suitable for hashing; bigger than MIN and
436 ;; equal to some 2^x.  Many machines (such as sparcs) do not have a
437 ;; hardware modulo operation, so they implement it in software.  On
438 ;; many sparcs over 50% of the time to intern is spent in the modulo.
439 ;; Yes, it's slower than actually computing the hash from the string!
440 ;; So we use powers of 2 so people can optimize the modulo to a mask.
441 (defun gnus-create-hash-size (min)
442   (let ((i 1))
443     (while (< i min)
444       (setq i (* 2 i)))
445     i))
446
447 (defcustom gnus-verbose 7
448   "*Integer that says how verbose Gnus should be.
449 The higher the number, the more messages Gnus will flash to say what
450 it's doing.  At zero, Gnus will be totally mute; at five, Gnus will
451 display most important messages; and at ten, Gnus will keep on
452 jabbering all the time."
453   :group 'gnus-start
454   :type 'integer)
455
456 (defun gnus-message (level &rest args)
457   "If LEVEL is lower than `gnus-verbose' print ARGS using `message'.
458
459 Guideline for numbers:
460 1 - error messages, 3 - non-serious error messages, 5 - messages for things
461 that take a long time, 7 - not very important messages on stuff, 9 - messages
462 inside loops."
463   (if (<= level gnus-verbose)
464       (apply 'message args)
465     ;; We have to do this format thingy here even if the result isn't
466     ;; shown - the return value has to be the same as the return value
467     ;; from `message'.
468     (apply 'format args)))
469
470 (defun gnus-error (level &rest args)
471   "Beep an error if LEVEL is equal to or less than `gnus-verbose'."
472   (when (<= (floor level) gnus-verbose)
473     (apply 'message args)
474     (ding)
475     (let (duration)
476       (when (and (floatp level)
477                  (not (zerop (setq duration (* 10 (- level (floor level)))))))
478         (sit-for duration))))
479   nil)
480
481 (defun gnus-split-references (references)
482   "Return a list of Message-IDs in REFERENCES."
483   (let ((beg 0)
484         ids)
485     (while (string-match "<[^<]+[^< \t]" references beg)
486       (push (substring references (match-beginning 0) (setq beg (match-end 0)))
487             ids))
488     (nreverse ids)))
489
490 (defsubst gnus-parent-id (references &optional n)
491   "Return the last Message-ID in REFERENCES.
492 If N, return the Nth ancestor instead."
493   (when (and references
494              (not (zerop (length references))))
495     (if n
496         (let ((ids (inline (gnus-split-references references))))
497           (while (nthcdr n ids)
498             (setq ids (cdr ids)))
499           (car ids))
500       (when (string-match "\\(<[^<]+>\\)[ \t]*\\'" references)
501         (match-string 1 references)))))
502
503 (defun gnus-buffer-live-p (buffer)
504   "Say whether BUFFER is alive or not."
505   (and buffer
506        (get-buffer buffer)
507        (buffer-name (get-buffer buffer))))
508
509 (defun gnus-horizontal-recenter ()
510   "Recenter the current buffer horizontally."
511   (if (< (current-column) (/ (window-width) 2))
512       (set-window-hscroll (gnus-get-buffer-window (current-buffer) t) 0)
513     (let* ((orig (point))
514            (end (window-end (gnus-get-buffer-window (current-buffer) t)))
515            (max 0))
516       (when end
517         ;; Find the longest line currently displayed in the window.
518         (goto-char (window-start))
519         (while (and (not (eobp))
520                     (< (point) end))
521           (end-of-line)
522           (setq max (max max (current-column)))
523           (forward-line 1))
524         (goto-char orig)
525         ;; Scroll horizontally to center (sort of) the point.
526         (if (> max (window-width))
527             (set-window-hscroll
528              (gnus-get-buffer-window (current-buffer) t)
529              (min (- (current-column) (/ (window-width) 3))
530                   (+ 2 (- max (window-width)))))
531           (set-window-hscroll (gnus-get-buffer-window (current-buffer) t) 0))
532         max))))
533
534 (defun gnus-read-event-char (&optional prompt)
535   "Get the next event."
536   (let ((event (condition-case nil
537                    (read-event prompt)
538                  ;; `read-event' doesn't allow arguments in Mule 2.3
539                  (wrong-number-of-arguments
540                   (when prompt
541                     (message "%s" prompt))
542                   (read-event)))))
543     ;; should be gnus-characterp, but this can't be called in XEmacs anyway
544     (cons (and (numberp event) event) event)))
545
546 (defun gnus-sortable-date (date)
547   "Make string suitable for sorting from DATE."
548   (gnus-time-iso8601 (date-to-time date)))
549
550 (defun gnus-copy-file (file &optional to)
551   "Copy FILE to TO."
552   (interactive
553    (list (read-file-name "Copy file: " default-directory)
554          (read-file-name "Copy file to: " default-directory)))
555   (unless to
556     (setq to (read-file-name "Copy file to: " default-directory)))
557   (when (file-directory-p to)
558     (setq to (concat (file-name-as-directory to)
559                      (file-name-nondirectory file))))
560   (copy-file file to))
561
562 (defvar gnus-work-buffer " *gnus work*")
563
564 (defun gnus-set-work-buffer ()
565   "Put point in the empty Gnus work buffer."
566   (if (get-buffer gnus-work-buffer)
567       (progn
568         (set-buffer gnus-work-buffer)
569         (erase-buffer))
570     (set-buffer (gnus-get-buffer-create gnus-work-buffer))
571     (kill-all-local-variables)))
572
573 (defmacro gnus-group-real-name (group)
574   "Find the real name of a foreign newsgroup."
575   `(let ((gname ,group))
576      (if (string-match "^[^:]+:" gname)
577          (substring gname (match-end 0))
578        gname)))
579
580 (defun gnus-make-sort-function (funs)
581   "Return a composite sort condition based on the functions in FUNS."
582   (cond
583    ;; Just a simple function.
584    ((functionp funs) funs)
585    ;; No functions at all.
586    ((null funs) funs)
587    ;; A list of functions.
588    ((or (cdr funs)
589         (listp (car funs)))
590     (gnus-byte-compile
591      `(lambda (t1 t2)
592         ,(gnus-make-sort-function-1 (reverse funs)))))
593    ;; A list containing just one function.
594    (t
595     (car funs))))
596
597 (defun gnus-make-sort-function-1 (funs)
598   "Return a composite sort condition based on the functions in FUNS."
599   (let ((function (car funs))
600         (first 't1)
601         (last 't2))
602     (when (consp function)
603       (cond
604        ;; Reversed spec.
605        ((eq (car function) 'not)
606         (setq function (cadr function)
607               first 't2
608               last 't1))
609        ((functionp function)
610         ;; Do nothing.
611         )
612        (t
613         (error "Invalid sort spec: %s" function))))
614     (if (cdr funs)
615         `(or (,function ,first ,last)
616              (and (not (,function ,last ,first))
617                   ,(gnus-make-sort-function-1 (cdr funs))))
618       `(,function ,first ,last))))
619
620 (defun gnus-turn-off-edit-menu (type)
621   "Turn off edit menu in `gnus-TYPE-mode-map'."
622   (define-key (symbol-value (intern (format "gnus-%s-mode-map" type)))
623     [menu-bar edit] 'undefined))
624
625 (defun gnus-prin1 (form)
626   "Use `prin1' on FORM in the current buffer.
627 Bind `print-quoted' and `print-readably' to t while printing."
628   (let ((print-quoted t)
629         (print-readably t)
630         (print-escape-multibyte nil)
631         print-level print-length)
632     (prin1 form (current-buffer))))
633
634 (defun gnus-prin1-to-string (form)
635   "The same as `prin1'.
636 Bind `print-quoted' and `print-readably' to t, and `print-length'
637 and `print-level' to nil."
638   (let ((print-quoted t)
639         (print-readably t)
640         (print-length nil)
641         (print-level nil))
642     (prin1-to-string form)))
643
644 (defun gnus-make-directory (directory)
645   "Make DIRECTORY (and all its parents) if it doesn't exist."
646   (require 'nnmail)
647   (let ((file-name-coding-system nnmail-pathname-coding-system))
648     (when (and directory
649                (not (file-exists-p directory)))
650       (make-directory directory t)))
651   t)
652
653 (defun gnus-write-buffer (file)
654   "Write the current buffer's contents to FILE."
655   ;; Make sure the directory exists.
656   (gnus-make-directory (file-name-directory file))
657   (let ((file-name-coding-system nnmail-pathname-coding-system))
658     ;; Write the buffer.
659     (write-region (point-min) (point-max) file nil 'quietly)))
660
661 (defun gnus-write-buffer-as-binary (file)
662   "Write the current buffer's contents to FILE without code conversion."
663   ;; Make sure the directory exists.
664   (gnus-make-directory (file-name-directory file))
665   ;; Write the buffer.
666   (write-region-as-binary (point-min) (point-max) file nil 'quietly))
667
668 (defun gnus-write-buffer-as-coding-system (coding-system file)
669   "Write the current buffer's contents to FILE with code conversion."
670   ;; Make sure the directory exists.
671   (gnus-make-directory (file-name-directory file))
672   ;; Write the buffer.
673   (write-region-as-coding-system
674    coding-system (point-min) (point-max) file nil 'quietly))
675
676 (defun gnus-delete-file (file)
677   "Delete FILE if it exists."
678   (when (file-exists-p file)
679     (delete-file file)))
680
681 (defun gnus-strip-whitespace (string)
682   "Return STRING stripped of all whitespace."
683   (while (string-match "[\r\n\t ]+" string)
684     (setq string (replace-match "" t t string)))
685   string)
686
687 (defsubst gnus-put-text-property-excluding-newlines (beg end prop val)
688   "The same as `put-text-property', but don't put this prop on any newlines in the region."
689   (save-match-data
690     (save-excursion
691       (save-restriction
692         (goto-char beg)
693         (while (re-search-forward gnus-emphasize-whitespace-regexp end 'move)
694           (gnus-put-text-property beg (match-beginning 0) prop val)
695           (setq beg (point)))
696         (gnus-put-text-property beg (point) prop val)))))
697
698 (defsubst gnus-put-overlay-excluding-newlines (beg end prop val)
699   "The same as `put-text-property', but don't put this prop on any newlines in the region."
700   (save-match-data
701     (save-excursion
702       (save-restriction
703         (goto-char beg)
704         (while (re-search-forward gnus-emphasize-whitespace-regexp end 'move)
705           (gnus-overlay-put
706            (gnus-make-overlay beg (match-beginning 0))
707            prop val)
708           (setq beg (point)))
709         (gnus-overlay-put (gnus-make-overlay beg (point)) prop val)))))
710
711 (defun gnus-put-text-property-excluding-characters-with-faces (beg end
712                                                                    prop val)
713   "The same as `put-text-property', but don't put props on characters with the `gnus-face' property."
714   (let ((b beg))
715     (while (/= b end)
716       (when (get-text-property b 'gnus-face)
717         (setq b (next-single-property-change b 'gnus-face nil end)))
718       (when (/= b end)
719         (inline
720           (gnus-put-text-property
721            b (setq b (next-single-property-change b 'gnus-face nil end))
722            prop val))))))
723
724 (defmacro gnus-faces-at (position)
725   "Return a list of faces at POSITION."
726   (if (featurep 'xemacs)
727       `(let ((pos ,position))
728          (mapcar-extents 'extent-face
729                          nil (current-buffer) pos pos nil 'face))
730     `(let ((pos ,position))
731        (delq nil (cons (get-text-property pos 'face)
732                        (mapcar
733                         (lambda (overlay)
734                           (overlay-get overlay 'face))
735                         (overlays-at pos)))))))
736
737 ;;; Protected and atomic operations.  dmoore@ucsd.edu 21.11.1996
738 ;;; The primary idea here is to try to protect internal datastructures
739 ;;; from becoming corrupted when the user hits C-g, or if a hook or
740 ;;; similar blows up.  Often in Gnus multiple tables/lists need to be
741 ;;; updated at the same time, or information can be lost.
742
743 (defvar gnus-atomic-be-safe t
744   "If t, certain operations will be protected from interruption by C-g.")
745
746 (defmacro gnus-atomic-progn (&rest forms)
747   "Evaluate FORMS atomically, which means to protect the evaluation
748 from being interrupted by the user.  An error from the forms themselves
749 will return without finishing the operation.  Since interrupts from
750 the user are disabled, it is recommended that only the most minimal
751 operations are performed by FORMS.  If you wish to assign many
752 complicated values atomically, compute the results into temporary
753 variables and then do only the assignment atomically."
754   `(let ((inhibit-quit gnus-atomic-be-safe))
755      ,@forms))
756
757 (put 'gnus-atomic-progn 'lisp-indent-function 0)
758
759 (defmacro gnus-atomic-progn-assign (protect &rest forms)
760   "Evaluate FORMS, but insure that the variables listed in PROTECT
761 are not changed if anything in FORMS signals an error or otherwise
762 non-locally exits.  The variables listed in PROTECT are updated atomically.
763 It is safe to use gnus-atomic-progn-assign with long computations.
764
765 Note that if any of the symbols in PROTECT were unbound, they will be
766 set to nil on a successful assignment.  In case of an error or other
767 non-local exit, it will still be unbound."
768   (let* ((temp-sym-map (mapcar (lambda (x) (list (make-symbol
769                                                   (concat (symbol-name x)
770                                                           "-tmp"))
771                                                  x))
772                                protect))
773          (sym-temp-map (mapcar (lambda (x) (list (cadr x) (car x)))
774                                temp-sym-map))
775          (temp-sym-let (mapcar (lambda (x) (list (car x)
776                                                  `(and (boundp ',(cadr x))
777                                                        ,(cadr x))))
778                                temp-sym-map))
779          (sym-temp-let sym-temp-map)
780          (temp-sym-assign (apply 'append temp-sym-map))
781          (sym-temp-assign (apply 'append sym-temp-map))
782          (result (make-symbol "result-tmp")))
783     `(let (,@temp-sym-let
784            ,result)
785        (let ,sym-temp-let
786          (setq ,result (progn ,@forms))
787          (setq ,@temp-sym-assign))
788        (let ((inhibit-quit gnus-atomic-be-safe))
789          (setq ,@sym-temp-assign))
790        ,result)))
791
792 (put 'gnus-atomic-progn-assign 'lisp-indent-function 1)
793 ;(put 'gnus-atomic-progn-assign 'edebug-form-spec '(sexp body))
794
795 (defmacro gnus-atomic-setq (&rest pairs)
796   "Similar to setq, except that the real symbols are only assigned when
797 there are no errors.  And when the real symbols are assigned, they are
798 done so atomically.  If other variables might be changed via side-effect,
799 see gnus-atomic-progn-assign.  It is safe to use gnus-atomic-setq
800 with potentially long computations."
801   (let ((tpairs pairs)
802         syms)
803     (while tpairs
804       (push (car tpairs) syms)
805       (setq tpairs (cddr tpairs)))
806     `(gnus-atomic-progn-assign ,syms
807        (setq ,@pairs))))
808
809 ;(put 'gnus-atomic-setq 'edebug-form-spec '(body))
810
811
812 ;;; Functions for saving to babyl/mail files.
813
814 (eval-when-compile
815   (condition-case nil
816       (progn
817         (require 'rmail)
818         (autoload 'rmail-update-summary "rmailsum"))
819     (error
820      (define-compiler-macro rmail-select-summary (&rest body)
821        ;; Rmail of the XEmacs version is supplied by the package, and
822        ;; requires tm and apel packages.  However, there may be those
823        ;; who haven't installed those packages.  This macro helps such
824        ;; people even if they install those packages later.
825        `(eval '(rmail-select-summary ,@body)))
826      ;; If there's rmail but there's no tm (or there's apel of the
827      ;; mainstream, not the XEmacs version), loading rmail of the XEmacs
828      ;; version fails halfway, however it provides the rmail-select-summary
829      ;; macro which uses the following functions:
830      (autoload 'rmail-summary-displayed "rmail")
831      (autoload 'rmail-maybe-display-summary "rmail")))
832   (defvar rmail-default-rmail-file)
833   (defvar mm-text-coding-system))
834
835 (defun gnus-output-to-rmail (filename &optional ask)
836   "Append the current article to an Rmail file named FILENAME."
837   (require 'rmail)
838   (require 'mm-util)
839   ;; Most of these codes are borrowed from rmailout.el.
840   (setq filename (expand-file-name filename))
841   (setq rmail-default-rmail-file filename)
842   (let ((artbuf (current-buffer))
843         (tmpbuf (get-buffer-create " *Gnus-output*")))
844     (save-excursion
845       (or (get-file-buffer filename)
846           (file-exists-p filename)
847           (if (or (not ask)
848                   (gnus-yes-or-no-p
849                    (concat "\"" filename "\" does not exist, create it? ")))
850               (let ((file-buffer (create-file-buffer filename)))
851                 (save-excursion
852                   (set-buffer file-buffer)
853                   (rmail-insert-rmail-file-header)
854                   (let ((require-final-newline nil))
855                     (gnus-write-buffer-as-coding-system
856                      nnheader-text-coding-system filename)))
857                 (kill-buffer file-buffer))
858             (error "Output file does not exist")))
859       (set-buffer tmpbuf)
860       (erase-buffer)
861       (insert-buffer-substring artbuf)
862       (gnus-convert-article-to-rmail)
863       ;; Decide whether to append to a file or to an Emacs buffer.
864       (let ((outbuf (get-file-buffer filename)))
865         (if (not outbuf)
866             (let ((file-name-coding-system nnmail-pathname-coding-system))
867               (write-region-as-binary (point-min) (point-max)
868                                       filename 'append))
869           ;; File has been visited, in buffer OUTBUF.
870           (set-buffer outbuf)
871           (let ((buffer-read-only nil)
872                 (msg (and (boundp 'rmail-current-message)
873                           (symbol-value 'rmail-current-message))))
874             ;; If MSG is non-nil, buffer is in RMAIL mode.
875             (when msg
876               (widen)
877               (narrow-to-region (point-max) (point-max)))
878             (insert-buffer-substring tmpbuf)
879             (when msg
880               (goto-char (point-min))
881               (widen)
882               (search-backward "\n\^_")
883               (narrow-to-region (point) (point-max))
884               (rmail-count-new-messages t)
885               (when (rmail-summary-exists)
886                 (rmail-select-summary
887                  (rmail-update-summary)))
888               (rmail-count-new-messages t)
889               (rmail-show-message msg))
890             (save-buffer)))))
891     (kill-buffer tmpbuf)))
892
893 (defun gnus-output-to-mail (filename &optional ask)
894   "Append the current article to a mail file named FILENAME."
895   (setq filename (expand-file-name filename))
896   (let ((artbuf (current-buffer))
897         (tmpbuf (get-buffer-create " *Gnus-output*")))
898     (save-excursion
899       ;; Create the file, if it doesn't exist.
900       (when (and (not (get-file-buffer filename))
901                  (not (file-exists-p filename)))
902         (if (or (not ask)
903                 (gnus-y-or-n-p
904                  (concat "\"" filename "\" does not exist, create it? ")))
905             (let ((file-buffer (create-file-buffer filename)))
906               (save-excursion
907                 (set-buffer file-buffer)
908                 (let ((require-final-newline nil))
909                   (gnus-write-buffer-as-coding-system
910                    nnheader-text-coding-system filename)))
911               (kill-buffer file-buffer))
912           (error "Output file does not exist")))
913       (set-buffer tmpbuf)
914       (erase-buffer)
915       (insert-buffer-substring artbuf)
916       (goto-char (point-min))
917       (if (looking-at "From ")
918           (forward-line 1)
919         (insert "From nobody " (current-time-string) "\n"))
920       (let (case-fold-search)
921         (while (re-search-forward "^From " nil t)
922           (beginning-of-line)
923           (insert ">")))
924       ;; Decide whether to append to a file or to an Emacs buffer.
925       (let ((outbuf (get-file-buffer filename)))
926         (if (not outbuf)
927             (let ((buffer-read-only nil))
928               (save-excursion
929                 (goto-char (point-max))
930                 (forward-char -2)
931                 (unless (looking-at "\n\n")
932                   (goto-char (point-max))
933                   (unless (bolp)
934                     (insert "\n"))
935                   (insert "\n"))
936                 (goto-char (point-max))
937                 (let ((file-name-coding-system nnmail-pathname-coding-system))
938                   (write-region-as-binary (point-min) (point-max)
939                                           filename 'append))))
940           ;; File has been visited, in buffer OUTBUF.
941           (set-buffer outbuf)
942           (let ((buffer-read-only nil))
943             (goto-char (point-max))
944             (unless (eobp)
945               (insert "\n"))
946             (insert "\n")
947             (insert-buffer-substring tmpbuf)))))
948     (kill-buffer tmpbuf)))
949
950 (defun gnus-convert-article-to-rmail ()
951   "Convert article in current buffer to Rmail message format."
952   (let ((buffer-read-only nil))
953     ;; Convert article directly into Babyl format.
954     (goto-char (point-min))
955     (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
956     (while (search-forward "\n\^_" nil t) ;single char
957       (replace-match "\n^_" t t))       ;2 chars: "^" and "_"
958     (goto-char (point-max))
959     (insert "\^_")))
960
961 (defun gnus-map-function (funs arg)
962   "Apply the result of the first function in FUNS to the second, and so on.
963 ARG is passed to the first function."
964   (while funs
965     (setq arg (funcall (pop funs) arg)))
966   arg)
967
968 (defun gnus-run-hooks (&rest funcs)
969   "Does the same as `run-hooks', but saves the current buffer."
970   (save-current-buffer
971     (apply 'run-hooks funcs)))
972
973 ;;; Various
974
975 (defvar gnus-group-buffer)              ; Compiler directive
976 (defun gnus-alive-p ()
977   "Say whether Gnus is running or not."
978   (and (boundp 'gnus-group-buffer)
979        (get-buffer gnus-group-buffer)
980        (save-excursion
981          (set-buffer gnus-group-buffer)
982          (eq major-mode 'gnus-group-mode))))
983
984 (defun gnus-remove-duplicates (list)
985   (let (new)
986     (while list
987       (or (member (car list) new)
988           (setq new (cons (car list) new)))
989       (setq list (cdr list)))
990     (nreverse new)))
991
992 (defun gnus-remove-if (predicate list)
993   "Return a copy of LIST with all items satisfying PREDICATE removed."
994   (let (out)
995     (while list
996       (unless (funcall predicate (car list))
997         (push (car list) out))
998       (setq list (cdr list)))
999     (nreverse out)))
1000
1001 (if (fboundp 'assq-delete-all)
1002     (defalias 'gnus-delete-alist 'assq-delete-all)
1003   (defun gnus-delete-alist (key alist)
1004     "Delete from ALIST all elements whose car is KEY.
1005 Return the modified alist."
1006     (let (entry)
1007       (while (setq entry (assq key alist))
1008         (setq alist (delq entry alist)))
1009       alist)))
1010
1011 (defmacro gnus-pull (key alist &optional assoc-p)
1012   "Modify ALIST to be without KEY."
1013   (unless (symbolp alist)
1014     (error "Not a symbol: %s" alist))
1015   (let ((fun (if assoc-p 'assoc 'assq)))
1016     `(setq ,alist (delq (,fun ,key ,alist) ,alist))))
1017
1018 (defun gnus-globalify-regexp (re)
1019   "Return a regexp that matches a whole line, iff RE matches a part of it."
1020   (concat (unless (string-match "^\\^" re) "^.*")
1021           re
1022           (unless (string-match "\\$$" re) ".*$")))
1023
1024 (defun gnus-set-window-start (&optional point)
1025   "Set the window start to POINT, or (point) if nil."
1026   (let ((win (gnus-get-buffer-window (current-buffer) t)))
1027     (when win
1028       (set-window-start win (or point (point))))))
1029
1030 (defun gnus-annotation-in-region-p (b e)
1031   (if (= b e)
1032       (eq (cadr (memq 'gnus-undeletable (text-properties-at b))) t)
1033     (text-property-any b e 'gnus-undeletable t)))
1034
1035 (defun gnus-or (&rest elems)
1036   "Return non-nil if any of the elements are non-nil."
1037   (catch 'found
1038     (while elems
1039       (when (pop elems)
1040         (throw 'found t)))))
1041
1042 (defun gnus-and (&rest elems)
1043   "Return non-nil if all of the elements are non-nil."
1044   (catch 'found
1045     (while elems
1046       (unless (pop elems)
1047         (throw 'found nil)))
1048     t))
1049
1050 (defun gnus-write-active-file (file hashtb &optional full-names)
1051   (let ((coding-system-for-write nnmail-active-file-coding-system))
1052     (with-temp-file file
1053       (mapatoms
1054        (lambda (sym)
1055          (when (and sym
1056                     (boundp sym)
1057                     (symbol-value sym))
1058            (insert (format "%S %d %d y\n"
1059                            (if full-names
1060                                sym
1061                              (intern (gnus-group-real-name (symbol-name sym))))
1062                            (or (cdr (symbol-value sym))
1063                                (car (symbol-value sym)))
1064                            (car (symbol-value sym))))))
1065        hashtb)
1066       (goto-char (point-max))
1067       (while (search-backward "\\." nil t)
1068         (delete-char 1)))))
1069
1070 ;; Fixme: Why not use `with-output-to-temp-buffer'?
1071 (defmacro gnus-with-output-to-file (file &rest body)
1072   (let ((buffer (make-symbol "output-buffer"))
1073         (size (make-symbol "output-buffer-size"))
1074         (leng (make-symbol "output-buffer-length"))
1075         (append (make-symbol "output-buffer-append")))
1076     `(let* ((,size 131072)
1077             (,buffer (make-string ,size 0))
1078             (,leng 0)
1079             (,append nil)
1080             (standard-output
1081              (lambda (c)
1082                (aset ,buffer ,leng c)
1083                    
1084                (if (= ,size (setq ,leng (1+ ,leng)))
1085                    (progn (write-region ,buffer nil ,file ,append 'no-msg)
1086                           (setq ,leng 0
1087                                 ,append t))))))
1088        ,@body
1089        (when (> ,leng 0)
1090          (let ((coding-system-for-write 'no-conversion))
1091          (write-region (substring ,buffer 0 ,leng) nil ,file
1092                        ,append 'no-msg))))))
1093
1094 (put 'gnus-with-output-to-file 'lisp-indent-function 1)
1095 (put 'gnus-with-output-to-file 'edebug-form-spec '(form body))
1096
1097 (if (fboundp 'union)
1098     (defalias 'gnus-union 'union)
1099   (defun gnus-union (l1 l2)
1100     "Set union of lists L1 and L2."
1101     (cond ((null l1) l2)
1102           ((null l2) l1)
1103           ((equal l1 l2) l1)
1104           (t
1105            (or (>= (length l1) (length l2))
1106                (setq l1 (prog1 l2 (setq l2 l1))))
1107            (while l2
1108              (or (member (car l2) l1)
1109                  (push (car l2) l1))
1110              (pop l2))
1111            l1))))
1112
1113 (defun gnus-add-text-properties-when
1114   (property value start end properties &optional object)
1115   "Like `gnus-add-text-properties', only applied on where PROPERTY is VALUE."
1116   (let (point)
1117     (while (and start
1118                 (< start end) ;; XEmacs will loop for every when start=end.
1119                 (setq point (text-property-not-all start end property value)))
1120       (gnus-add-text-properties start point properties object)
1121       (setq start (text-property-any point end property value)))
1122     (if start
1123         (gnus-add-text-properties start end properties object))))
1124
1125 (defun gnus-remove-text-properties-when
1126   (property value start end properties &optional object)
1127   "Like `remove-text-properties', only applied on where PROPERTY is VALUE."
1128   (let (point)
1129     (while (and start
1130                 (< start end)
1131                 (setq point (text-property-not-all start end property value)))
1132       (remove-text-properties start point properties object)
1133       (setq start (text-property-any point end property value)))
1134     (if start
1135         (remove-text-properties start end properties object))
1136     t))
1137
1138 ;; This might use `compare-strings' to reduce consing in the
1139 ;; case-insensitive case, but it has to cope with null args.
1140 ;; (`string-equal' uses symbol print names.)
1141 (defun gnus-string-equal (x y)
1142   "Like `string-equal', except it compares case-insensitively."
1143   (and (= (length x) (length y))
1144        (or (string-equal x y)
1145            (string-equal (downcase x) (downcase y)))))
1146
1147 (defcustom gnus-use-byte-compile t
1148   "If non-nil, byte-compile crucial run-time code.
1149 Setting it to nil has no effect after the first time `gnus-byte-compile'
1150 is run."
1151   :type 'boolean
1152   :version "21.1"
1153   :group 'gnus-various)
1154
1155 (defun gnus-byte-compile (form)
1156   "Byte-compile FORM if `gnus-use-byte-compile' is non-nil."
1157   (if gnus-use-byte-compile
1158       (progn
1159         (condition-case nil
1160             ;; Work around a bug in XEmacs 21.4
1161             (require 'byte-optimize)
1162           (error))
1163         (require 'bytecomp)
1164         (defalias 'gnus-byte-compile
1165           (lambda (form)
1166             (let ((byte-compile-warnings '(unresolved callargs redefine)))
1167               (byte-compile form))))
1168         (gnus-byte-compile form))
1169     form))
1170
1171 (defun gnus-remassoc (key alist)
1172   "Delete by side effect any elements of LIST whose car is `equal' to KEY.
1173 The modified LIST is returned.  If the first member
1174 of LIST has a car that is `equal' to KEY, there is no way to remove it
1175 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
1176 sure of changing the value of `foo'."
1177   (when alist
1178     (if (equal key (caar alist))
1179         (cdr alist)
1180       (setcdr alist (gnus-remassoc key (cdr alist)))
1181       alist)))
1182
1183 (defun gnus-update-alist-soft (key value alist)
1184   (if value
1185       (cons (cons key value) (gnus-remassoc key alist))
1186     (gnus-remassoc key alist)))
1187
1188 (defun gnus-create-info-command (node)
1189   "Create a command that will go to info NODE."
1190   `(lambda ()
1191      (interactive)
1192      ,(concat "Enter the info system at node " node)
1193      (Info-goto-node ,node)
1194      (setq gnus-info-buffer (current-buffer))
1195      (gnus-configure-windows 'info)))
1196
1197 (defun gnus-not-ignore (&rest args)
1198   t)
1199
1200 (defvar gnus-directory-sep-char-regexp "/"
1201   "The regexp of directory separator character.
1202 If you find some problem with the directory separator character, try
1203 \"[/\\\\\]\" for some systems.")
1204
1205 (defun gnus-url-unhex (x)
1206   (if (> x ?9)
1207       (if (>= x ?a)
1208           (+ 10 (- x ?a))
1209         (+ 10 (- x ?A)))
1210     (- x ?0)))
1211
1212 ;; Fixme: Do it like QP.
1213 (defun gnus-url-unhex-string (str &optional allow-newlines)
1214   "Remove %XX, embedded spaces, etc in a url.
1215 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
1216 decoding of carriage returns and line feeds in the string, which is normally
1217 forbidden in URL encoding."
1218   (let ((tmp "")
1219         (case-fold-search t))
1220     (while (string-match "%[0-9a-f][0-9a-f]" str)
1221       (let* ((start (match-beginning 0))
1222              (ch1 (gnus-url-unhex (elt str (+ start 1))))
1223              (code (+ (* 16 ch1)
1224                       (gnus-url-unhex (elt str (+ start 2))))))
1225         (setq tmp (concat
1226                    tmp (substring str 0 start)
1227                    (cond
1228                     (allow-newlines
1229                      (char-to-string code))
1230                     ((or (= code ?\n) (= code ?\r))
1231                      " ")
1232                     (t (char-to-string code))))
1233               str (substring str (match-end 0)))))
1234     (setq tmp (concat tmp str))
1235     tmp))
1236
1237 (defun gnus-make-predicate (spec)
1238   "Transform SPEC into a function that can be called.
1239 SPEC is a predicate specifier that contains stuff like `or', `and',
1240 `not', lists and functions.  The functions all take one parameter."
1241   `(lambda (elem) ,(gnus-make-predicate-1 spec)))
1242
1243 (defun gnus-make-predicate-1 (spec)
1244   (cond
1245    ((symbolp spec)
1246     `(,spec elem))
1247    ((listp spec)
1248     (if (memq (car spec) '(or and not))
1249         `(,(car spec) ,@(mapcar 'gnus-make-predicate-1 (cdr spec)))
1250       (error "Invalid predicate specifier: %s" spec)))))
1251
1252 (defun gnus-completing-read (prompt table &optional predicate require-match
1253                                     history)
1254   (when (and history
1255              (not (boundp history)))
1256     (set history nil))
1257   (completing-read
1258    (if (symbol-value history)
1259        (concat prompt " (" (car (symbol-value history)) "): ")
1260      (concat prompt ": "))
1261    table
1262    predicate
1263    require-match
1264    nil
1265    history
1266    (car (symbol-value history))))
1267
1268 (defun gnus-graphic-display-p ()
1269   (or (and (fboundp 'display-graphic-p)
1270            (display-graphic-p))
1271       ;;;!!!This is bogus.  Fixme!
1272       (and (featurep 'xemacs)
1273            t)))
1274
1275 (put 'gnus-parse-without-error 'lisp-indent-function 0)
1276 (put 'gnus-parse-without-error 'edebug-form-spec '(body))
1277
1278 (defmacro gnus-parse-without-error (&rest body)
1279   "Allow continuing onto the next line even if an error occurs."
1280   `(while (not (eobp))
1281      (condition-case ()
1282          (progn
1283            ,@body
1284            (goto-char (point-max)))
1285        (error
1286         (gnus-error 4 "Invalid data on line %d"
1287                     (count-lines (point-min) (point)))
1288         (forward-line 1)))))
1289
1290 (defun gnus-cache-file-contents (file variable function)
1291   "Cache the contents of FILE in VARIABLE.  The contents come from FUNCTION."
1292   (let ((time (nth 5 (file-attributes file)))
1293         contents value)
1294     (if (or (null (setq value (symbol-value variable)))
1295             (not (equal (car value) file))
1296             (not (equal (nth 1 value) time)))
1297         (progn
1298           (setq contents (funcall function file))
1299           (set variable (list file time contents))
1300           contents)
1301       (nth 2 value))))
1302
1303 (defun gnus-multiple-choice (prompt choice &optional idx)
1304   "Ask user a multiple choice question.
1305 CHOICE is a list of the choice char and help message at IDX."
1306   (let (tchar buf)
1307     (save-window-excursion
1308       (save-excursion
1309         (while (not tchar)
1310           (message "%s (%s): "
1311                    prompt
1312                    (concat
1313                     (mapconcat (lambda (s) (char-to-string (car s)))
1314                                choice ", ") ", ?"))
1315           (setq tchar (read-char))
1316           (when (not (assq tchar choice))
1317             (setq tchar nil)
1318             (setq buf (get-buffer-create "*Gnus Help*"))
1319             (pop-to-buffer buf)
1320             (fundamental-mode)          ; for Emacs 20.4+
1321             (buffer-disable-undo)
1322             (erase-buffer)
1323             (insert prompt ":\n\n")
1324             (let ((max -1)
1325                   (list choice)
1326                   (alist choice)
1327                   (idx (or idx 1))
1328                   (i 0)
1329                   n width pad format)
1330               ;; find the longest string to display
1331               (while list
1332                 (setq n (length (nth idx (car list))))
1333                 (unless (> max n)
1334                   (setq max n))
1335                 (setq list (cdr list)))
1336               (setq max (+ max 4))      ; %c, `:', SPACE, a SPACE at end
1337               (setq n (/ (1- (window-width)) max)) ; items per line
1338               (setq width (/ (1- (window-width)) n)) ; width of each item
1339               ;; insert `n' items, each in a field of width `width'
1340               (while alist
1341                 (if (< i n)
1342                     ()
1343                   (setq i 0)
1344                   (delete-char -1)              ; the `\n' takes a char
1345                   (insert "\n"))
1346                 (setq pad (- width 3))
1347                 (setq format (concat "%c: %-" (int-to-string pad) "s"))
1348                 (insert (format format (caar alist) (nth idx (car alist))))
1349                 (setq alist (cdr alist))
1350                 (setq i (1+ i))))))))
1351     (if (buffer-live-p buf)
1352         (kill-buffer buf))
1353     tchar))
1354
1355 (defun gnus-select-frame-set-input-focus (frame)
1356   "Select FRAME, raise it, and set input focus, if possible."
1357   (cond ((featurep 'xemacs)
1358          (raise-frame frame)
1359          (select-frame frame)
1360          (focus-frame frame))
1361         ;; The function `select-frame-set-input-focus' won't set
1362         ;; the input focus under Emacs 21.2 and X window system.
1363         ;;((fboundp 'select-frame-set-input-focus)
1364         ;; (defalias 'gnus-select-frame-set-input-focus
1365         ;;   'select-frame-set-input-focus)
1366         ;; (select-frame-set-input-focus frame))
1367         (t
1368          (raise-frame frame)
1369          (select-frame frame)
1370          (cond ((and (eq window-system 'x)
1371                      (fboundp 'x-focus-frame))
1372                 (x-focus-frame frame))
1373                ((eq window-system 'w32)
1374                 (w32-focus-frame frame)))
1375          (when (or (not (boundp 'focus-follows-mouse))
1376                    (symbol-value 'focus-follows-mouse))
1377            (set-mouse-position frame (1- (frame-width frame)) 0)))))
1378
1379 (unless (fboundp 'frame-parameter)
1380   (defalias 'frame-parameter
1381     (lambda (frame parameter)
1382       "Return FRAME's value for parameter PARAMETER.
1383 If FRAME is nil, describe the currently selected frame."
1384       (cdr (assq parameter (frame-parameters frame))))))
1385
1386 (defun gnus-frame-or-window-display-name (object)
1387   "Given a frame or window, return the associated display name.
1388 Return nil otherwise."
1389   (if (featurep 'xemacs)
1390       (device-connection (dfw-device object))
1391     (if (or (framep object)
1392             (and (windowp object)
1393                  (setq object (window-frame object))))
1394         (let ((display (frame-parameter object 'display)))
1395           (if (and (stringp display)
1396                    ;; Exclude invalid display names.
1397                    (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'"
1398                                  display))
1399               display)))))
1400
1401 ;; Fixme: This has only one use (in gnus-agent), which isn't worthwhile.
1402 (defmacro gnus-mapcar (function seq1 &rest seqs2_n)
1403   "Apply FUNCTION to each element of the sequences, and make a list of the results.
1404 If there are several sequences, FUNCTION is called with that many arguments,
1405 and mapping stops as soon as the shortest sequence runs out.  With just one
1406 sequence, this is like `mapcar'.  With several, it is like the Common Lisp
1407 `mapcar' function extended to arbitrary sequence types."
1408
1409   (if seqs2_n
1410       (let* ((seqs (cons seq1 seqs2_n))
1411              (cnt 0)
1412              (heads (mapcar (lambda (seq)
1413                               (make-symbol (concat "head"
1414                                                    (int-to-string
1415                                                     (setq cnt (1+ cnt))))))
1416                             seqs))
1417              (result (make-symbol "result"))
1418              (result-tail (make-symbol "result-tail")))
1419         `(let* ,(let* ((bindings (cons nil nil))
1420                        (heads heads))
1421                   (nconc bindings (list (list result '(cons nil nil))))
1422                   (nconc bindings (list (list result-tail result)))
1423                   (while heads
1424                     (nconc bindings (list (list (pop heads) (pop seqs)))))
1425                   (cdr bindings))
1426            (while (and ,@heads)
1427              (setcdr ,result-tail (cons (funcall ,function
1428                                                  ,@(mapcar (lambda (h) (list 'car h))
1429                                                            heads))
1430                                         nil))
1431              (setq ,result-tail (cdr ,result-tail)
1432                    ,@(apply 'nconc (mapcar (lambda (h) (list h (list 'cdr h))) heads))))
1433            (cdr ,result)))
1434     `(mapcar ,function ,seq1)))
1435
1436 (if (fboundp 'merge)
1437     (defalias 'gnus-merge 'merge)
1438   ;; Adapted from cl-seq.el
1439   (defun gnus-merge (type list1 list2 pred)
1440     "Destructively merge lists LIST1 and LIST2 to produce a new list.
1441 Argument TYPE is for compatibility and ignored.
1442 Ordering of the elements is preserved according to PRED, a `less-than'
1443 predicate on the elements."
1444     (let ((res nil))
1445       (while (and list1 list2)
1446         (if (funcall pred (car list2) (car list1))
1447             (push (pop list2) res)
1448           (push (pop list1) res)))
1449       (nconc (nreverse res) list1 list2))))
1450
1451 (eval-when-compile
1452   (defvar xemacs-codename))
1453
1454 (defun gnus-emacs-version ()
1455   "Stringified Emacs version."
1456   (let ((system-v
1457          (cond
1458           ((eq gnus-user-agent 'emacs-gnus-config)
1459            system-configuration)
1460           ((eq gnus-user-agent 'emacs-gnus-type)
1461            (symbol-name system-type))
1462           (t nil))))
1463     (cond
1464      ((eq gnus-user-agent 'gnus)
1465       nil)
1466      ((string-match "^\\(\\([.0-9]+\\)*\\)\\.[0-9]+$" emacs-version)
1467       (concat "Emacs/" (match-string 1 emacs-version)
1468               (if system-v
1469                   (concat " (" system-v ")")
1470                 "")))
1471      ((string-match
1472        "\\([A-Z]*[Mm][Aa][Cc][Ss]\\)[^(]*\\(\\((beta.*)\\|'\\)\\)?"
1473        emacs-version)
1474       (concat
1475        (match-string 1 emacs-version)
1476        (format "/%d.%d" emacs-major-version emacs-minor-version)
1477        (if (match-beginning 3)
1478            (match-string 3 emacs-version)
1479          "")
1480        (if (boundp 'xemacs-codename)
1481            (concat
1482             " (" xemacs-codename
1483             (if system-v
1484                 (concat ", " system-v ")")
1485               ")"))
1486          "")))
1487      (t emacs-version))))
1488
1489 (provide 'gnus-util)
1490
1491 ;;; gnus-util.el ends here