gnus-util.el 61.2 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; gnus-util.el --- utility functions for Gnus
2

3
;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
5

6
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
7 8 9 10
;; Keywords: news

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
15 16 17

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
19 20 21
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
23 24 25 26 27 28 29 30

;;; Commentary:

;; Nothing in this file depends on any other parts of Gnus -- all
;; functions and macros in this file are utility functions that are
;; used by Gnus and may be used by any other package without loading
;; Gnus first.

31
;; [Unfortunately, it does depend on other parts of Gnus, e.g. the
32
;; autoloads and defvars below...]
33

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
34 35
;;; Code:

36 37 38
;; For Emacs < 22.2.
(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
39
(eval-when-compile
Dan Nicolaescu's avatar
Dan Nicolaescu committed
40 41 42 43 44 45 46 47 48 49
  (require 'cl))
;; Fixme: this should be a gnus variable, not nnmail-.
(defvar nnmail-pathname-coding-system)
(defvar nnmail-active-file-coding-system)

;; Inappropriate references to other parts of Gnus.
(defvar gnus-emphasize-whitespace-regexp)
(defvar gnus-original-article-buffer)
(defvar gnus-user-agent)

50
(require 'time-date)
51
(require 'netrc)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
52 53

(eval-and-compile
54
  (autoload 'message-fetch-field "message")
55
  (autoload 'gnus-get-buffer-window "gnus-win")
56 57
  (autoload 'rmail-insert-rmail-file-header "rmail")
  (autoload 'rmail-count-new-messages "rmail")
58 59 60 61 62 63
  (autoload 'rmail-show-message "rmail")
  (autoload 'nnheader-narrow-to-headers "nnheader")
  (autoload 'nnheader-replace-chars-in-string "nnheader"))

(eval-and-compile
  (cond
64 65 66 67 68
   ;; Prefer `replace-regexp-in-string' (present in Emacs, XEmacs 21.5,
   ;; SXEmacs 22.1.4) over `replace-in-string'.  The later leads to inf-loops
   ;; on empty matches:
   ;;   (replace-in-string "foo" "/*$" "/")
   ;;   (replace-in-string "xe" "\\(x\\)?" "")
69
   ((fboundp 'replace-regexp-in-string)
70
    (defun gnus-replace-in-string  (string regexp newtext &optional literal)
71 72 73 74 75
      "Replace all matches for REGEXP with NEWTEXT in STRING.
If LITERAL is non-nil, insert NEWTEXT literally.  Return a new
string containing the replacements.

This is a compatibility function for different Emacsen."
76
      (replace-regexp-in-string regexp newtext string nil literal)))
77
   ((fboundp 'replace-in-string)
78
    (defalias 'gnus-replace-in-string 'replace-in-string))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
79 80 81 82 83 84 85 86 87

(defun gnus-boundp (variable)
  "Return non-nil if VARIABLE is bound and non-nil."
  (and (boundp variable)
       (symbol-value variable)))

(defmacro gnus-eval-in-buffer-window (buffer &rest forms)
  "Pop to BUFFER, evaluate FORMS, and then return to the original window."
  (let ((tempvar (make-symbol "GnusStartBufferWindow"))
88 89
	(w (make-symbol "w"))
	(buf (make-symbol "buf")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
90
    `(let* ((,tempvar (selected-window))
91 92
	    (,buf ,buffer)
	    (,w (gnus-get-buffer-window ,buf 'visible)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
93
       (unwind-protect
94 95 96 97 98 99 100 101
	   (progn
	     (if ,w
		 (progn
		   (select-window ,w)
		   (set-buffer (window-buffer ,w)))
	       (pop-to-buffer ,buf))
	     ,@forms)
	 (select-window ,tempvar)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
102 103 104 105 106

(put 'gnus-eval-in-buffer-window 'lisp-indent-function 1)
(put 'gnus-eval-in-buffer-window 'edebug-form-spec '(form body))

(defmacro gnus-intern-safe (string hashtable)
Miles Bader's avatar
Miles Bader committed
107
  "Get hash value.  Arguments are STRING and HASHTABLE."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121
  `(let ((symbol (intern ,string ,hashtable)))
     (or (boundp symbol)
	 (set symbol nil))
     symbol))

(defsubst gnus-goto-char (point)
  (and point (goto-char point)))

(defmacro gnus-buffer-exists-p (buffer)
  `(let ((buffer ,buffer))
     (when buffer
       (funcall (if (stringp buffer) 'get-buffer 'buffer-name)
		buffer))))

122 123 124 125 126 127 128 129 130 131
;; The LOCAL arg to `add-hook' is interpreted differently in Emacs and
;; XEmacs.  In Emacs we don't need to call `make-local-hook' first.
;; It's harmless, though, so the main purpose of this alias is to shut
;; up the byte compiler.
(defalias 'gnus-make-local-hook
  (if (eq (get 'make-local-hook 'byte-compile)
	  'byte-compile-obsolete)
      'ignore				; Emacs
    'make-local-hook))			; XEmacs

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145
(defun gnus-delete-first (elt list)
  "Delete by side effect the first occurrence of ELT as a member of LIST."
  (if (equal (car list) elt)
      (cdr list)
    (let ((total list))
      (while (and (cdr list)
		  (not (equal (cadr list) elt)))
	(setq list (cdr list)))
      (when (cdr list)
	(setcdr list (cddr list)))
      total)))

;; Delete the current line (and the next N lines).
(defmacro gnus-delete-line (&optional n)
146
  `(delete-region (point-at-bol)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
147 148 149 150
		  (progn (forward-line ,(or n 1)) (point))))

(defun gnus-byte-code (func)
  "Return a form that can be `eval'ed based on FUNC."
151 152
  (let ((fval (indirect-function func)))
    (if (byte-code-function-p fval)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
153 154 155 156 157 158
	(let ((flist (append fval nil)))
	  (setcar flist 'byte-code)
	  flist)
      (cons 'progn (cddr fval)))))

(defun gnus-extract-address-components (from)
159 160 161 162 163
  "Extract address components from a From header.
Given an RFC-822 address FROM, extract full name and canonical address.
Returns a list of the form (FULL-NAME CANONICAL-ADDRESS).  Much more simple
solution than `mail-extract-address-components', which works much better, but
is slower."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
164 165 166 167
  (let (name address)
    ;; First find the address - the thing with the @ in it.  This may
    ;; not be accurate in mail addresses, but does the trick most of
    ;; the time in news messages.
Miles Bader's avatar
Miles Bader committed
168 169 170 171 172 173 174
    (cond (;; Check ``<foo@bar>'' first in order to handle the quite common
	   ;; form ``"abc@xyz" <foo@bar>'' (i.e. ``@'' as part of a comment)
	   ;; correctly.
	   (string-match "<\\([^@ \t<>]+[!@][^@ \t<>]+\\)>" from)
	   (setq address (substring from (match-beginning 1) (match-end 1))))
	  ((string-match "\\b[^@ \t<>]+[!@][^@ \t<>]+\\b" from)
	   (setq address (substring from (match-beginning 0) (match-end 0)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
175 176 177 178 179 180
    ;; Then we check whether the "name <address>" format is used.
    (and address
	 ;; Linear white space is not required.
	 (string-match (concat "[ \t]*<" (regexp-quote address) ">") from)
	 (and (setq name (substring from 0 (match-beginning 0)))
	      ;; Strip any quotes from the name.
181
	      (string-match "^\".*\"$" name)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
182 183 184 185 186 187 188 189 190 191 192 193
	      (setq name (substring name 1 (1- (match-end 0))))))
    ;; If not, then "address (name)" is used.
    (or name
	(and (string-match "(.+)" from)
	     (setq name (substring from (1+ (match-beginning 0))
				   (1- (match-end 0)))))
	(and (string-match "()" from)
	     (setq name address))
	;; XOVER might not support folded From headers.
	(and (string-match "(.*" from)
	     (setq name (substring from (1+ (match-beginning 0))
				   (match-end 0)))))
194 195
    (list (if (string= name "") nil name) (or address from))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
196 197 198 199 200

(defun gnus-fetch-field (field)
  "Return the value of the header FIELD of current article."
  (save-excursion
    (save-restriction
201
      (let ((inhibit-point-motion-hooks t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
202 203 204
	(nnheader-narrow-to-headers)
	(message-fetch-field field)))))

205 206 207 208 209 210
(defun gnus-fetch-original-field (field)
  "Fetch FIELD from the original version of the current article."
  (with-current-buffer gnus-original-article-buffer
    (gnus-fetch-field field)))


Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
211 212
(defun gnus-goto-colon ()
  (beginning-of-line)
213
  (let ((eol (point-at-eol)))
214 215 216 217
    (goto-char (or (text-property-any (point) eol 'gnus-position t)
		   (search-forward ":" eol t)
		   (point)))))

218 219 220 221 222 223 224
(declare-function gnus-find-method-for-group "gnus" (group &optional info))
(autoload 'gnus-group-name-decode "gnus-group")
(declare-function gnus-group-name-charset "gnus-group" (method group))
;; gnus-group requires gnus-int which requires message.
(declare-function message-tokenize-header "message"
                  (header &optional separator))

225 226 227 228 229 230 231
(defun gnus-decode-newsgroups (newsgroups group &optional method)
  (let ((method (or method (gnus-find-method-for-group group))))
    (mapconcat (lambda (group)
		 (gnus-group-name-decode group (gnus-group-name-charset
						method group)))
	       (message-tokenize-header newsgroups)
	       ",")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
232 233 234

(defun gnus-remove-text-with-property (prop)
  "Delete all text in the current buffer with text property PROP."
235 236 237 238 239 240 241 242 243
  (let ((start (point-min))
	end)
    (unless (get-text-property start prop)
      (setq start (next-single-property-change start prop)))
    (while start
      (setq end (text-property-any start (point-max) prop nil))
      (delete-region start (or end (point-max)))
      (setq start (when end
		    (next-single-property-change start prop))))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
244 245 246

(defun gnus-newsgroup-directory-form (newsgroup)
  "Make hierarchical directory name from NEWSGROUP name."
247 248 249 250 251 252 253 254
  (let* ((newsgroup (gnus-newsgroup-savable-name newsgroup))
	 (idx (string-match ":" newsgroup)))
    (concat
     (if idx (substring newsgroup 0 idx))
     (if idx "/")
     (nnheader-replace-chars-in-string
      (if idx (substring newsgroup (1+ idx)) newsgroup)
      ?. ?/))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
255 256 257 258 259 260 261 262 263 264

(defun gnus-newsgroup-savable-name (group)
  ;; Replace any slashes in a group name (eg. an ange-ftp nndoc group)
  ;; with dots.
  (nnheader-replace-chars-in-string group ?/ ?.))

(defun gnus-string> (s1 s2)
  (not (or (string< s1 s2)
	   (string= s1 s2))))

Miles Bader's avatar
Miles Bader committed
265 266 267 268 269 270 271 272 273
(defun gnus-string< (s1 s2)
  "Return t if first arg string is less than second in lexicographic order.
Case is significant if and only if `case-fold-search' is nil.
Symbols are also allowed; their print names are used instead."
  (if case-fold-search
      (string-lessp (downcase (if (symbolp s1) (symbol-name s1) s1))
		    (downcase (if (symbolp s2) (symbol-name s2) s2)))
    (string-lessp s1 s2)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
;;; Time functions.

(defun gnus-file-newer-than (file date)
  (let ((fdate (nth 5 (file-attributes file))))
    (or (> (car fdate) (car date))
	(and (= (car fdate) (car date))
	     (> (nth 1 fdate) (nth 1 date))))))

;;; Keymap macros.

(defmacro gnus-local-set-keys (&rest plist)
  "Set the keys in PLIST in the current keymap."
  `(gnus-define-keys-1 (current-local-map) ',plist))

(defmacro gnus-define-keys (keymap &rest plist)
  "Define all keys in PLIST in KEYMAP."
  `(gnus-define-keys-1 (quote ,keymap) (quote ,plist)))

(defmacro gnus-define-keys-safe (keymap &rest plist)
  "Define all keys in PLIST in KEYMAP without overwriting previous definitions."
  `(gnus-define-keys-1 (quote ,keymap) (quote ,plist) t))

(put 'gnus-define-keys 'lisp-indent-function 1)
(put 'gnus-define-keys-safe 'lisp-indent-function 1)
(put 'gnus-local-set-keys 'lisp-indent-function 1)

(defmacro gnus-define-keymap (keymap &rest plist)
  "Define all keys in PLIST in KEYMAP."
  `(gnus-define-keys-1 ,keymap (quote ,plist)))

(put 'gnus-define-keymap 'lisp-indent-function 1)

(defun gnus-define-keys-1 (keymap plist &optional safe)
  (when (null keymap)
    (error "Can't set keys in a null keymap"))
  (cond ((symbolp keymap)
	 (setq keymap (symbol-value keymap)))
	((keymapp keymap))
	((listp keymap)
	 (set (car keymap) nil)
	 (define-prefix-command (car keymap))
	 (define-key (symbol-value (caddr keymap)) (cadr keymap) (car keymap))
	 (setq keymap (symbol-value (car keymap)))))
  (let (key)
    (while plist
      (when (symbolp (setq key (pop plist)))
	(setq key (symbol-value key)))
      (if (or (not safe)
	      (eq (lookup-key keymap key) 'undefined))
	  (define-key keymap key (pop plist))
	(pop plist)))))

326
(defun gnus-completing-read-with-default (default prompt &rest args)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
327 328
  ;; Like `completing-read', except that DEFAULT is the default argument.
  (let* ((prompt (if default
329 330
		     (concat prompt " (default " default "): ")
		   (concat prompt ": ")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
331 332 333 334 335 336 337
	 (answer (apply 'completing-read prompt args)))
    (if (or (null answer) (zerop (length answer)))
	default
      answer)))

;; Two silly functions to ensure that all `y-or-n-p' questions clear
;; the echo area.
Miles Bader's avatar
Miles Bader committed
338
;;
Miles Bader's avatar
Miles Bader committed
339 340
;; Do we really need these functions?  Workarounds for bugs in the corresponding
;; Emacs functions?  Maybe these bugs are no longer present in any supported
Miles Bader's avatar
Miles Bader committed
341
;; (X)Emacs version?  Alias them to the original functions and see if anyone
Miles Bader's avatar
Miles Bader committed
342 343
;; reports a problem.  If not, replace with original functions.  --rsteib,
;; 2007-12-14
Miles Bader's avatar
Miles Bader committed
344
;;
Miles Bader's avatar
Miles Bader committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
;; All supported Emacsen clear the echo area after `yes-or-no-p', so we can
;; remove `yes-or-no-p'.  RMS says that not clearing after `y-or-n-p' is
;; intentional (see below), so we could remove `gnus-y-or-n-p' too.
;; Objections?  --rsteib, 2008-02-16
;;
;; ,----[ http://thread.gmane.org/gmane.emacs.gnus.general/65099/focus=66070 ]
;; | From: Richard Stallman
;; | Subject: Re: Do we need gnus-yes-or-no-p and gnus-y-or-n-p?
;; | To: Katsumi Yamaoka [...]
;; | Cc: emacs-devel@[...], xemacs-beta@[...], ding@[...]
;; | Date: Mon, 07 Jan 2008 12:16:05 -0500
;; | Message-ID: <E1JBva1-000528-VY@fencepost.gnu.org>
;; |
;; |     The behavior of `y-or-n-p' that it doesn't clear the question
;; |     and the answer is not serious of course, but I feel it is not
;; |     cool.
;; |
;; | It is intentional.
;; |
;; |     Currently, it is commented out in the trunk by Reiner Steib.  He
;; |     also wrote the benefit of leaving the question and the answer in
;; |     the echo area as follows:
;; |
;; |     (http://article.gmane.org/gmane.emacs.gnus.general/66061)
;; |     > In contrast to yes-or-no-p it is much easier to type y, n,
;; |     > SPC, DEL, etc accidentally, so it might be useful for the user
;; |     > to see what he has typed.
;; |
;; | Yes, that is the reason.
;; `----

Miles Bader's avatar
Miles Bader committed
376 377 378 379 380 381 382 383 384 385 386
;; (defun gnus-y-or-n-p (prompt)
;;   (prog1
;;       (y-or-n-p prompt)
;;     (message "")))
;; (defun gnus-yes-or-no-p (prompt)
;;   (prog1
;;       (yes-or-no-p prompt)
;;     (message "")))

(defalias 'gnus-y-or-n-p 'y-or-n-p)
(defalias 'gnus-yes-or-no-p 'yes-or-no-p)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
387

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
;; By Frank Schmitt <ich@Frank-Schmitt.net>. Allows to have
;; age-depending date representations. (e.g. just the time if it's
;; from today, the day of the week if it's within the last 7 days and
;; the full date if it's older)

(defun gnus-seconds-today ()
  "Return the number of seconds passed today."
  (let ((now (decode-time (current-time))))
    (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600))))

(defun gnus-seconds-month ()
  "Return the number of seconds passed this month."
  (let ((now (decode-time (current-time))))
    (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600)
       (* (- (car (nthcdr 3 now)) 1) 3600 24))))

(defun gnus-seconds-year ()
  "Return the number of seconds passed this year."
  (let ((now (decode-time (current-time)))
	(days (format-time-string "%j" (current-time))))
    (+ (car now) (* (car (cdr now)) 60) (* (car (nthcdr 2 now)) 3600)
       (* (- (string-to-number days) 1) 3600 24))))

(defvar gnus-user-date-format-alist
  '(((gnus-seconds-today) . "%k:%M")
    (604800 . "%a %k:%M")                   ;;that's one week
    ((gnus-seconds-month) . "%a %d")
    ((gnus-seconds-year) . "%b %d")
    (t . "%b %d '%y"))                      ;;this one is used when no
					    ;;other does match
  "Specifies date format depending on age of article.
This is an alist of items (AGE . FORMAT).  AGE can be a number (of
seconds) or a Lisp expression evaluating to a number.  When the age of
the article is less than this number, then use `format-time-string'
with the corresponding FORMAT for displaying the date of the article.
If AGE is not a number or a Lisp expression evaluating to a
non-number, then the corresponding FORMAT is used as a default value.

Note that the list is processed from the beginning, so it should be
sorted by ascending AGE.  Also note that items following the first
non-number AGE will be ignored.

You can use the functions `gnus-seconds-today', `gnus-seconds-month'
and `gnus-seconds-year' in the AGE spec.  They return the number of
seconds passed since the start of today, of this month, of this year,
respectively.")

(defun gnus-user-date (messy-date)
  "Format the messy-date according to gnus-user-date-format-alist.
Returns \"  ?  \" if there's bad input or if an other error occurs.
Input should look like this: \"Sun, 14 Oct 2001 13:34:39 +0200\"."
  (condition-case ()
      (let* ((messy-date (time-to-seconds (safe-date-to-time messy-date)))
	     (now (time-to-seconds (current-time)))
	     ;;If we don't find something suitable we'll use this one
	     (my-format "%b %d '%y"))
	(let* ((difference (- now messy-date))
	       (templist gnus-user-date-format-alist)
	       (top (eval (caar templist))))
	  (while (if (numberp top) (< top difference) (not top))
	    (progn
	      (setq templist (cdr templist))
	      (setq top (eval (caar templist)))))
	  (if (stringp (cdr (car templist)))
	      (setq my-format (cdr (car templist)))))
	(format-time-string (eval my-format) (seconds-to-time messy-date)))
    (error "  ?   ")))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
456
(defun gnus-dd-mmm (messy-date)
457
  "Return a string like DD-MMM from a big messy string."
458 459 460
  (condition-case ()
      (format-time-string "%d-%b" (safe-date-to-time messy-date))
    (error "  -   ")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
461 462 463 464 465 466 467 468 469 470

(defmacro gnus-date-get-time (date)
  "Convert DATE string to Emacs time.
Cache the result as a text property stored in DATE."
  ;; Either return the cached value...
  `(let ((d ,date))
     (if (equal "" d)
	 '(0 0)
       (or (get-text-property 0 'gnus-time d)
	   ;; or compute the value...
471
	   (let ((time (safe-date-to-time d)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
472 473 474 475 476
	     ;; and store it back in the string.
	     (put-text-property 0 1 'gnus-time time d)
	     time)))))

(defsubst gnus-time-iso8601 (time)
Dave Love's avatar
Dave Love committed
477
  "Return a string of TIME in YYYYMMDDTHHMMSS format."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
478 479
  (format-time-string "%Y%m%dT%H%M%S" time))

480
(defun gnus-date-iso8601 (date)
Dave Love's avatar
Dave Love committed
481
  "Convert the DATE to YYYYMMDDTHHMMSS."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
482
  (condition-case ()
483
      (gnus-time-iso8601 (gnus-date-get-time date))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
484 485 486 487
    (error "")))

(defun gnus-mode-string-quote (string)
  "Quote all \"%\"'s in STRING."
488
  (gnus-replace-in-string string "%" "%%"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515

;; Make a hash table (default and minimum size is 256).
;; Optional argument HASHSIZE specifies the table size.
(defun gnus-make-hashtable (&optional hashsize)
  (make-vector (if hashsize (max (gnus-create-hash-size hashsize) 256) 256) 0))

;; Make a number that is suitable for hashing; bigger than MIN and
;; equal to some 2^x.  Many machines (such as sparcs) do not have a
;; hardware modulo operation, so they implement it in software.  On
;; many sparcs over 50% of the time to intern is spent in the modulo.
;; Yes, it's slower than actually computing the hash from the string!
;; So we use powers of 2 so people can optimize the modulo to a mask.
(defun gnus-create-hash-size (min)
  (let ((i 1))
    (while (< i min)
      (setq i (* 2 i)))
    i))

(defcustom gnus-verbose 7
  "*Integer that says how verbose Gnus should be.
The higher the number, the more messages Gnus will flash to say what
it's doing.  At zero, Gnus will be totally mute; at five, Gnus will
display most important messages; and at ten, Gnus will keep on
jabbering all the time."
  :group 'gnus-start
  :type 'integer)

516 517 518 519 520 521
(defcustom gnus-add-timestamp-to-message nil
  "Non-nil means add timestamps to messages that Gnus issues.
If it is `log', add timestamps to only the messages that go into the
\"*Messages*\" buffer (in XEmacs, it is the \" *Message-Log*\" buffer).
If it is neither nil nor `log', add timestamps not only to log messages
but also to the ones displayed in the echo area."
522
  :version "23.1" ;; No Gnus
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  :group  'gnus-various
  :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
		 (const :tag "Logged messages only" log)
		 (sexp :tag "All messages"
		       :match (lambda (widget value) value)
		       :value t)
		 (const :tag "No timestamp" nil)))

(eval-when-compile
  (defmacro gnus-message-with-timestamp-1 (format-string args)
    (let ((timestamp '((format-time-string "%Y%m%dT%H%M%S" time)
		       "." (format "%03d" (/ (nth 2 time) 1000)) "> ")))
      (if (featurep 'xemacs)
	  `(let (str time)
	     (if (or (and (null ,format-string) (null ,args))
		     (progn
		       (setq str (apply 'format ,format-string ,args))
		       (zerop (length str))))
		 (prog1
		     (and ,format-string str)
		   (clear-message nil))
	       (cond ((eq gnus-add-timestamp-to-message 'log)
		      (setq time (current-time))
		      (display-message 'no-log str)
		      (log-message 'message (concat ,@timestamp str)))
		     (gnus-add-timestamp-to-message
		      (setq time (current-time))
		      (display-message 'message (concat ,@timestamp str)))
		     (t
		      (display-message 'message str))))
	     str)
	`(let (str time)
	   (cond ((eq gnus-add-timestamp-to-message 'log)
		  (setq str (let (message-log-max)
			      (apply 'message ,format-string ,args)))
		  (when (and message-log-max
			     (> message-log-max 0)
			     (/= (length str) 0))
		    (setq time (current-time))
		    (with-current-buffer (get-buffer-create "*Messages*")
		      (goto-char (point-max))
		      (insert ,@timestamp str "\n")
		      (forward-line (- message-log-max))
		      (delete-region (point-min) (point))
		      (goto-char (point-max))))
		  str)
		 (gnus-add-timestamp-to-message
		  (if (or (and (null ,format-string) (null ,args))
			  (progn
			    (setq str (apply 'format ,format-string ,args))
			    (zerop (length str))))
		      (prog1
			  (and ,format-string str)
			(message nil))
		    (setq time (current-time))
		    (message "%s" (concat ,@timestamp str))
		    str))
		 (t
		  (apply 'message ,format-string ,args))))))))

(defun gnus-message-with-timestamp (format-string &rest args)
  "Display message with timestamp.  Arguments are the same as `message'.
The `gnus-add-timestamp-to-message' variable controls how to add
timestamp to message."
  (gnus-message-with-timestamp-1 format-string args))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
589
(defun gnus-message (level &rest args)
590 591 592 593 594 595
  "If LEVEL is lower than `gnus-verbose' print ARGS using `message'.

Guideline for numbers:
1 - error messages, 3 - non-serious error messages, 5 - messages for things
that take a long time, 7 - not very important messages on stuff, 9 - messages
inside loops."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
596
  (if (<= level gnus-verbose)
597 598 599
      (if gnus-add-timestamp-to-message
	  (apply 'gnus-message-with-timestamp args)
	(apply 'message args))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
600 601 602 603 604 605
    ;; We have to do this format thingy here even if the result isn't
    ;; shown - the return value has to be the same as the return value
    ;; from `message'.
    (apply 'format args)))

(defun gnus-error (level &rest args)
606 607
  "Beep an error if LEVEL is equal to or less than `gnus-verbose'.
ARGS are passed to `message'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
608 609 610 611 612 613 614 615 616 617 618 619
  (when (<= (floor level) gnus-verbose)
    (apply 'message args)
    (ding)
    (let (duration)
      (when (and (floatp level)
		 (not (zerop (setq duration (* 10 (- level (floor level)))))))
	(sit-for duration))))
  nil)

(defun gnus-split-references (references)
  "Return a list of Message-IDs in REFERENCES."
  (let ((beg 0)
620
	(references (or references ""))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
621
	ids)
622
    (while (string-match "<[^<]+[^< \t]" references beg)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
623 624 625 626
      (push (substring references (match-beginning 0) (setq beg (match-end 0)))
	    ids))
    (nreverse ids)))

627 628 629 630 631 632 633 634 635 636
(defun gnus-extract-references (references)
  "Return a list of Message-IDs in REFERENCES (in In-Reply-To
  format), trimmed to only contain the Message-IDs."
  (let ((ids (gnus-split-references references))
	refs)
    (dolist (id ids)
      (when (string-match "<[^<>]+>" id)
	(push (match-string 0 id) refs)))
    refs))

637
(defsubst gnus-parent-id (references &optional n)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
638 639
  "Return the last Message-ID in REFERENCES.
If N, return the Nth ancestor instead."
640 641 642 643 644 645 646 647 648 649 650
  (when (and references
	     (not (zerop (length references))))
    (if n
	(let ((ids (inline (gnus-split-references references))))
	  (while (nthcdr n ids)
	    (setq ids (cdr ids)))
	  (car ids))
      (when (string-match "\\(<[^<]+>\\)[ \t]*\\'" references)
	(match-string 1 references)))))

(defun gnus-buffer-live-p (buffer)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
651 652 653 654 655 656 657 658
  "Say whether BUFFER is alive or not."
  (and buffer
       (get-buffer buffer)
       (buffer-name (get-buffer buffer))))

(defun gnus-horizontal-recenter ()
  "Recenter the current buffer horizontally."
  (if (< (current-column) (/ (window-width) 2))
659
      (set-window-hscroll (gnus-get-buffer-window (current-buffer) t) 0)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
660
    (let* ((orig (point))
661
	   (end (window-end (gnus-get-buffer-window (current-buffer) t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
662
	   (max 0))
663 664 665 666 667 668 669 670 671 672 673 674
      (when end
	;; Find the longest line currently displayed in the window.
	(goto-char (window-start))
	(while (and (not (eobp))
		    (< (point) end))
	  (end-of-line)
	  (setq max (max max (current-column)))
	  (forward-line 1))
	(goto-char orig)
	;; Scroll horizontally to center (sort of) the point.
	(if (> max (window-width))
	    (set-window-hscroll
675
	     (gnus-get-buffer-window (current-buffer) t)
676 677
	     (min (- (current-column) (/ (window-width) 3))
		  (+ 2 (- max (window-width)))))
678
	  (set-window-hscroll (gnus-get-buffer-window (current-buffer) t) 0))
679
	max))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
680

681
(defun gnus-read-event-char (&optional prompt)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
682
  "Get the next event."
683
  (let ((event (read-event prompt)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
684 685 686 687
    ;; should be gnus-characterp, but this can't be called in XEmacs anyway
    (cons (and (numberp event) event) event)))

(defun gnus-sortable-date (date)
688 689
  "Make string suitable for sorting from DATE."
  (gnus-time-iso8601 (date-to-time date)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704

(defun gnus-copy-file (file &optional to)
  "Copy FILE to TO."
  (interactive
   (list (read-file-name "Copy file: " default-directory)
	 (read-file-name "Copy file to: " default-directory)))
  (unless to
    (setq to (read-file-name "Copy file to: " default-directory)))
  (when (file-directory-p to)
    (setq to (concat (file-name-as-directory to)
		     (file-name-nondirectory file))))
  (copy-file file to))

(defvar gnus-work-buffer " *gnus work*")

705 706 707 708
(declare-function gnus-get-buffer-create "gnus" (name))
;; gnus.el requires mm-util.
(declare-function mm-enable-multibyte "mm-util")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
709 710 711 712 713 714
(defun gnus-set-work-buffer ()
  "Put point in the empty Gnus work buffer."
  (if (get-buffer gnus-work-buffer)
      (progn
	(set-buffer gnus-work-buffer)
	(erase-buffer))
715
    (set-buffer (gnus-get-buffer-create gnus-work-buffer))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
716
    (kill-all-local-variables)
717
    (mm-enable-multibyte)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
718 719 720 721 722 723 724 725

(defmacro gnus-group-real-name (group)
  "Find the real name of a foreign newsgroup."
  `(let ((gname ,group))
     (if (string-match "^[^:]+:" gname)
	 (substring gname (match-end 0))
       gname)))

Miles Bader's avatar
Miles Bader committed
726 727 728 729 730 731 732 733 734 735 736
(defmacro gnus-group-server (group)
  "Find the server name of a foreign newsgroup.
For example, (gnus-group-server \"nnimap+yxa:INBOX.foo\") would
yield \"nnimap:yxa\"."
  `(let ((gname ,group))
     (if (string-match "^\\([^:+]+\\)\\(?:\\+\\([^:]*\\)\\)?:" gname)
	 (format "%s:%s" (match-string 1 gname) (or
						 (match-string 2 gname)
						 ""))
       (format "%s:%s" (car gnus-select-method) (cadr gnus-select-method)))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
737
(defun gnus-make-sort-function (funs)
738
  "Return a composite sort condition based on the functions in FUNS."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
739
  (cond
740
   ;; Just a simple function.
741
   ((functionp funs) funs)
742
   ;; No functions at all.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
743
   ((null funs) funs)
744 745 746
   ;; A list of functions.
   ((or (cdr funs)
	(listp (car funs)))
747 748 749
    (gnus-byte-compile
     `(lambda (t1 t2)
	,(gnus-make-sort-function-1 (reverse funs)))))
750
   ;; A list containing just one function.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
751 752 753 754
   (t
    (car funs))))

(defun gnus-make-sort-function-1 (funs)
755
  "Return a composite sort condition based on the functions in FUNS."
756 757 758 759 760 761 762 763 764 765
  (let ((function (car funs))
	(first 't1)
	(last 't2))
    (when (consp function)
      (cond
       ;; Reversed spec.
       ((eq (car function) 'not)
	(setq function (cadr function)
	      first 't2
	      last 't1))
766
       ((functionp function)
767 768 769 770 771 772 773 774 775
	;; Do nothing.
	)
       (t
	(error "Invalid sort spec: %s" function))))
    (if (cdr funs)
	`(or (,function ,first ,last)
	     (and (not (,function ,last ,first))
		  ,(gnus-make-sort-function-1 (cdr funs))))
      `(,function ,first ,last))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
776 777 778 779 780 781

(defun gnus-turn-off-edit-menu (type)
  "Turn off edit menu in `gnus-TYPE-mode-map'."
  (define-key (symbol-value (intern (format "gnus-%s-mode-map" type)))
    [menu-bar edit] 'undefined))

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
(defmacro gnus-bind-print-variables (&rest forms)
  "Bind print-* variables and evaluate FORMS.
This macro is used with `prin1', `pp', etc. in order to ensure printed
Lisp objects are loadable.  Bind `print-quoted' and `print-readably'
to t, and `print-escape-multibyte', `print-escape-newlines',
`print-escape-nonascii', `print-length', `print-level' and
`print-string-length' to nil."
  `(let ((print-quoted t)
	 (print-readably t)
	 ;;print-circle
	 ;;print-continuous-numbering
	 print-escape-multibyte
	 print-escape-newlines
	 print-escape-nonascii
	 ;;print-gensym
	 print-length
	 print-level
	 print-string-length)
     ,@forms))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
802 803
(defun gnus-prin1 (form)
  "Use `prin1' on FORM in the current buffer.
804 805 806
Bind `print-quoted' and `print-readably' to t, and `print-length' and
`print-level' to nil.  See also `gnus-bind-print-variables'."
  (gnus-bind-print-variables (prin1 form (current-buffer))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
807 808

(defun gnus-prin1-to-string (form)
809 810 811 812 813
  "The same as `prin1'.
Bind `print-quoted' and `print-readably' to t, and `print-length' and
`print-level' to nil.  See also `gnus-bind-print-variables'."
  (gnus-bind-print-variables (prin1-to-string form)))

814
(defun gnus-pp (form &optional stream)
815 816 817
  "Use `pp' on FORM in the current buffer.
Bind `print-quoted' and `print-readably' to t, and `print-length' and
`print-level' to nil.  See also `gnus-bind-print-variables'."
818
  (gnus-bind-print-variables (pp form (or stream (current-buffer)))))
819 820 821 822 823 824

(defun gnus-pp-to-string (form)
  "The same as `pp-to-string'.
Bind `print-quoted' and `print-readably' to t, and `print-length' and
`print-level' to nil.  See also `gnus-bind-print-variables'."
  (gnus-bind-print-variables (pp-to-string form)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
825 826 827

(defun gnus-make-directory (directory)
  "Make DIRECTORY (and all its parents) if it doesn't exist."
828
  (require 'nnmail)
829 830 831 832
  (let ((file-name-coding-system nnmail-pathname-coding-system))
    (when (and directory
	       (not (file-exists-p directory)))
      (make-directory directory t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
833 834 835 836
  t)

(defun gnus-write-buffer (file)
  "Write the current buffer's contents to FILE."
837
  (let ((file-name-coding-system nnmail-pathname-coding-system))
838 839
    ;; Make sure the directory exists.
    (gnus-make-directory (file-name-directory file))
840 841
    ;; Write the buffer.
    (write-region (point-min) (point-max) file nil 'quietly)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
842 843 844 845 846 847

(defun gnus-delete-file (file)
  "Delete FILE if it exists."
  (when (file-exists-p file)
    (delete-file file)))

848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
(defun gnus-delete-directory (directory)
  "Delete files in DIRECTORY.  Subdirectories remain.
If there's no subdirectory, delete DIRECTORY as well."
  (when (file-directory-p directory)
    (let ((files (directory-files
		  directory t "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))
	  file dir)
      (while files
	(setq file (pop files))
	(if (eq t (car (file-attributes file)))
	    ;; `file' is a subdirectory.
	    (setq dir t)
	  ;; `file' is a file or a symlink.
	  (delete-file file)))
      (unless dir
	(delete-directory directory)))))

Miles Bader's avatar
Miles Bader committed
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
;; The following two functions are used in gnus-registry.
;; They were contributed by Andreas Fuchs <asf@void.at>.
(defun gnus-alist-to-hashtable (alist)
  "Build a hashtable from the values in ALIST."
  (let ((ht (make-hash-table
	     :size 4096
	     :test 'equal)))
    (mapc
     (lambda (kv-pair)
       (puthash (car kv-pair) (cdr kv-pair) ht))
     alist)
     ht))

(defun gnus-hashtable-to-alist (hash)
  "Build an alist from the values in HASH."
  (let ((list nil))
    (maphash
     (lambda (key value)
       (setq list (cons (cons key value) list)))
     hash)
    list))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
887 888 889 890 891 892
(defun gnus-strip-whitespace (string)
  "Return STRING stripped of all whitespace."
  (while (string-match "[\r\n\t ]+" string)
    (setq string (replace-match "" t t string)))
  string)

893 894 895
(declare-function gnus-put-text-property "gnus"
                  (start end property value &optional object))

896
(defsubst gnus-put-text-property-excluding-newlines (beg end prop val)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
897 898 899 900 901
  "The same as `put-text-property', but don't put this prop on any newlines in the region."
  (save-match-data
    (save-excursion
      (save-restriction
	(goto-char beg)
902
	(while (re-search-forward gnus-emphasize-whitespace-regexp end 'move)
903
	  (gnus-put-text-property beg (match-beginning 0) prop val)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
904
	  (setq beg (point)))
905 906
	(gnus-put-text-property beg (point) prop val)))))

907 908 909 910
(declare-function gnus-overlay-put  "gnus" (overlay prop value))
(declare-function gnus-make-overlay "gnus"
                  (beg end &optional buffer front-advance rear-advance))

911 912 913 914 915 916 917 918 919 920 921 922 923
(defsubst gnus-put-overlay-excluding-newlines (beg end prop val)
  "The same as `put-text-property', but don't put this prop on any newlines in the region."
  (save-match-data
    (save-excursion
      (save-restriction
	(goto-char beg)
	(while (re-search-forward gnus-emphasize-whitespace-regexp end 'move)
	  (gnus-overlay-put
	   (gnus-make-overlay beg (match-beginning 0))
	   prop val)
	  (setq beg (point)))
	(gnus-overlay-put (gnus-make-overlay beg (point)) prop val)))))

924 925 926 927 928 929 930 931
(defun gnus-put-text-property-excluding-characters-with-faces (beg end
								   prop val)
  "The same as `put-text-property', but don't put props on characters with the `gnus-face' property."
  (let ((b beg))
    (while (/= b end)
      (when (get-text-property b 'gnus-face)
	(setq b (next-single-property-change b 'gnus-face nil end)))
      (when (/= b end)
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
	(inline
	  (gnus-put-text-property
	   b (setq b (next-single-property-change b 'gnus-face nil end))
	   prop val))))))

(defmacro gnus-faces-at (position)
  "Return a list of faces at POSITION."
  (if (featurep 'xemacs)
      `(let ((pos ,position))
	 (mapcar-extents 'extent-face
			 nil (current-buffer) pos pos nil 'face))
    `(let ((pos ,position))
       (delq nil (cons (get-text-property pos 'face)
		       (mapcar
			(lambda (overlay)
			  (overlay-get overlay 'face))
			(overlays-at pos)))))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978

;;; Protected and atomic operations.  dmoore@ucsd.edu 21.11.1996
;;; The primary idea here is to try to protect internal datastructures
;;; from becoming corrupted when the user hits C-g, or if a hook or
;;; similar blows up.  Often in Gnus multiple tables/lists need to be
;;; updated at the same time, or information can be lost.

(defvar gnus-atomic-be-safe t
  "If t, certain operations will be protected from interruption by C-g.")

(defmacro gnus-atomic-progn (&rest forms)
  "Evaluate FORMS atomically, which means to protect the evaluation
from being interrupted by the user.  An error from the forms themselves
will return without finishing the operation.  Since interrupts from
the user are disabled, it is recommended that only the most minimal
operations are performed by FORMS.  If you wish to assign many
complicated values atomically, compute the results into temporary
variables and then do only the assignment atomically."
  `(let ((inhibit-quit gnus-atomic-be-safe))
     ,@forms))

(put 'gnus-atomic-progn 'lisp-indent-function 0)

(defmacro gnus-atomic-progn-assign (protect &rest forms)
  "Evaluate FORMS, but insure that the variables listed in PROTECT
are not changed if anything in FORMS signals an error or otherwise
non-locally exits.  The variables listed in PROTECT are updated atomically.
It is safe to use gnus-atomic-progn-assign with long computations.

Note that if any of the symbols in PROTECT were unbound, they will be
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
979
set to nil on a successful assignment.  In case of an error or other
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
non-local exit, it will still be unbound."
  (let* ((temp-sym-map (mapcar (lambda (x) (list (make-symbol
						  (concat (symbol-name x)
							  "-tmp"))
						 x))
			       protect))
	 (sym-temp-map (mapcar (lambda (x) (list (cadr x) (car x)))
			       temp-sym-map))
	 (temp-sym-let (mapcar (lambda (x) (list (car x)
						 `(and (boundp ',(cadr x))
						       ,(cadr x))))
			       temp-sym-map))
	 (sym-temp-let sym-temp-map)
	 (temp-sym-assign (apply 'append temp-sym-map))
	 (sym-temp-assign (apply 'append sym-temp-map))
	 (result (make-symbol "result-tmp")))
    `(let (,@temp-sym-let
	   ,result)
       (let ,sym-temp-let
	 (setq ,result (progn ,@forms))
	 (setq ,@temp-sym-assign))
       (let ((inhibit-quit gnus-atomic-be-safe))
	 (setq ,@sym-temp-assign))
       ,result)))

(put 'gnus-atomic-progn-assign 'lisp-indent-function 1)
;(put 'gnus-atomic-progn-assign 'edebug-form-spec '(sexp body))

(defmacro gnus-atomic-setq (&rest pairs)
  "Similar to setq, except that the real symbols are only assigned when
there are no errors.  And when the real symbols are assigned, they are
done so atomically.  If other variables might be changed via side-effect,
see gnus-atomic-progn-assign.  It is safe to use gnus-atomic-setq
with potentially long computations."
  (let ((tpairs pairs)
	syms)
    (while tpairs
      (push (car tpairs) syms)
      (setq tpairs (cddr tpairs)))
    `(gnus-atomic-progn-assign ,syms
       (setq ,@pairs))))

;(put 'gnus-atomic-setq 'edebug-form-spec '(body))


;;; Functions for saving to babyl/mail files.

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
(eval-when-compile
  (condition-case nil
      (progn
	(require 'rmail)
	(autoload 'rmail-update-summary "rmailsum"))
    (error
     (define-compiler-macro rmail-select-summary (&rest body)
       ;; Rmail of the XEmacs version is supplied by the package, and
       ;; requires tm and apel packages.  However, there may be those
       ;; who haven't installed those packages.  This macro helps such
       ;; people even if they install those packages later.
       `(eval '(rmail-select-summary ,@body)))
     ;; If there's rmail but there's no tm (or there's apel of the
     ;; mainstream, not the XEmacs version), loading rmail of the XEmacs
     ;; version fails halfway, however it provides the rmail-select-summary
     ;; macro which uses the following functions:
     (autoload 'rmail-summary-displayed "rmail")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1044 1045 1046 1047
     (autoload 'rmail-maybe-display-summary "rmail"))))

(defvar rmail-default-rmail-file)
(defvar mm-text-coding-system)
1048

1049 1050 1051
(declare-function mm-append-to-file "mm-util"
                  (start end filename &optional codesys inhibit))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1052 1053 1054
(defun gnus-output-to-rmail (filename &optional ask)
  "Append the current article to an Rmail file named FILENAME."
  (require 'rmail)
1055
  (require 'mm-util)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
  ;; Most of these codes are borrowed from rmailout.el.
  (setq filename (expand-file-name filename))
  (setq rmail-default-rmail-file filename)
  (let ((artbuf (current-buffer))
	(tmpbuf (get-buffer-create " *Gnus-output*")))
    (save-excursion
      (or (get-file-buffer filename)
	  (file-exists-p filename)
	  (if (or (not ask)
		  (gnus-yes-or-no-p
		   (concat "\"" filename "\" does not exist, create it? ")))
	      (let ((file-buffer (create-file-buffer filename)))
		(save-excursion
		  (set-buffer file-buffer)
		  (rmail-insert-rmail-file-header)
1071 1072
		  (let ((require-final-newline nil)
			(coding-system-for-write mm-text-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
		    (gnus-write-buffer filename)))
		(kill-buffer file-buffer))
	    (error "Output file does not exist")))
      (set-buffer tmpbuf)
      (erase-buffer)
      (insert-buffer-substring artbuf)
      (gnus-convert-article-to-rmail)
      ;; Decide whether to append to a file or to an Emacs buffer.
      (let ((outbuf (get-file-buffer filename)))
	(if (not outbuf)
1083 1084
	    (let ((file-name-coding-system nnmail-pathname-coding-system))
	      (mm-append-to-file (point-min) (point-max) filename))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
	  ;; File has been visited, in buffer OUTBUF.
	  (set-buffer outbuf)
	  (let ((buffer-read-only nil)
		(msg (and (boundp 'rmail-current-message)
			  (symbol-value 'rmail-current-message))))
	    ;; If MSG is non-nil, buffer is in RMAIL mode.
	    (when msg
	      (widen)
	      (narrow-to-region (point-max) (point-max)))
	    (insert-buffer-substring tmpbuf)
	    (when msg
	      (goto-char (point-min))
	      (widen)
1098 1099 1100 1101
	      (search-backward "\n\^_")
	      (narrow-to-region (point) (point-max))
	      (rmail-count-new-messages t)
	      (when (rmail-summary-exists)
1102 1103
		(rmail-select-summary
		 (rmail-update-summary)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1104
	      (rmail-count-new-messages t)
1105 1106
	      (rmail-show-message msg))
	    (save-buffer)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
    (kill-buffer tmpbuf)))

(defun gnus-output-to-mail (filename &optional ask)
  "Append the current article to a mail file named FILENAME."
  (setq filename (expand-file-name filename))
  (let ((artbuf (current-buffer))
	(tmpbuf (get-buffer-create " *Gnus-output*")))
    (save-excursion
      ;; Create the file, if it doesn't exist.
      (when (and (not (get-file-buffer filename))
		 (not (file-exists-p filename)))
	(if (or (not ask)
		(gnus-y-or-n-p
		 (concat "\"" filename "\" does not exist, create it? ")))
	    (let ((file-buffer (create-file-buffer filename)))
	      (save-excursion
		(set-buffer file-buffer)
1124 1125
		(let ((require-final-newline nil)
		      (coding-system-for-write mm-text-coding-system))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
		  (gnus-write-buffer filename)))
	      (kill-buffer file-buffer))
	  (error "Output file does not exist")))
      (set-buffer tmpbuf)
      (erase-buffer)
      (insert-buffer-substring artbuf)
      (goto-char (point-min))
      (if (looking-at "From ")
	  (forward-line 1)
	(insert "From nobody " (current-time-string) "\n"))
      (let (case-fold-search)
	(while (re-search-forward "^From " nil t)
	  (beginning-of-line)
	  (insert ">")))
      ;; Decide whether to append to a file or to an Emacs buffer.
      (let ((outbuf (get-file-buffer filename)))
	(if (not outbuf)
	    (let ((buffer-read-only nil))
	      (save-excursion
		(goto-char (point-max))
		(forward-char -2)
		(unless (looking-at "\n\n")
		  (goto-char (point-max))
		  (unless (bolp)
		    (insert "\n"))
		  (insert "\n"))
		(goto-char (point-max))
1153 1154
		(let ((file-name-coding-system nnmail-pathname-coding-system))
		  (mm-append-to-file (point-min) (point-max) filename))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
	  ;; File has been visited, in buffer OUTBUF.
	  (set-buffer outbuf)
	  (let ((buffer-read-only nil))
	    (goto-char (point-max))
	    (unless (eobp)
	      (insert "\n"))
	    (insert "\n")
	    (insert-buffer-substring tmpbuf)))))
    (kill-buffer tmpbuf)))

(defun gnus-convert-article-to-rmail ()
  "Convert article in current buffer to Rmail message format."
  (let ((buffer-read-only nil))
    ;; Convert article directly into Babyl format.
    (goto-char (point-min))
    (insert "\^L\n0, unseen,,\n*** EOOH ***\n")
    (while (search-forward "\n\^_" nil t) ;single char
      (replace-match "\n^_" t t))	;2 chars: "^" and "_"
    (goto-char (point-max))
    (insert "\^_")))

1176
(defun gnus-map-function (funs arg)
1177
  "Apply the result of the first function in FUNS to the second, and so on.
1178
ARG is passed to the first function."
1179 1180 1181
  (while funs
    (setq arg (funcall (pop funs) arg)))
  arg)
1182 1183

(defun gnus-run-hooks (&rest funcs)
1184 1185 1186
  "Does the same as `run-hooks', but saves the current buffer."
  (save-current-buffer
    (apply 'run-hooks funcs)))
1187

1188
(defun gnus-run-mode-hooks (&rest funcs)
1189 1190
  "Run `run-mode-hooks' if it is available, otherwise `run-hooks'.
This function saves the current buffer."
1191
  (if (fboundp 'run-mode-hooks)
1192 1193
      (save-current-buffer (apply 'run-mode-hooks funcs))
    (save-current-buffer (apply 'run-hooks funcs))))
1194

1195 1196
;;; Various

1197
(defvar gnus-group-buffer)		; Compiler directive
1198 1199 1200 1201 1202 1203 1204 1205
(defun gnus-alive-p ()
  "Say whether Gnus is running or not."
  (and (boundp 'gnus-group-buffer)
       (get-buffer gnus-group-buffer)
       (save-excursion
	 (set-buffer gnus-group-buffer)
	 (eq major-mode 'gnus-group-mode))))

1206 1207
(defun gnus-remove-if (predicate list)
  "Return a copy of LIST with all items satisfying PREDICATE removed."
1208 1209 1210 1211
  (let (out)
    (while list
      (unless (funcall predicate (car list))
	(push (car list) out))
1212
      (setq list (cdr list)))
1213 1214
    (nreverse out)))

1215 1216 1217 1218 1219 1220 1221 1222 1223
(if (fboundp 'assq-delete-all)
    (defalias 'gnus-delete-alist 'assq-delete-all)
  (defun gnus-delete-alist (key alist)
    "Delete from ALIST all elements whose car is KEY.
Return the modified alist."
    (let (entry)
      (while (setq entry (assq key alist))
	(setq alist (delq entry alist)))
      alist)))
1224

1225
(defmacro gnus-pull (key alist &optional assoc-p)
1226 1227 1228
  "Modify ALIST to be without KEY."
  (unless (symbolp alist)
    (error "Not a symbol: %s" alist))
1229 1230
  (let ((fun (if assoc-p 'assoc 'assq)))
    `(setq ,alist (delq (,fun ,key ,alist) ,alist))))
1231 1232

(defun gnus-globalify-regexp (re)
1233
  "Return a regexp that matches a whole line, if RE matches a part of it."
1234 1235 1236 1237
  (concat (unless (string-match "^\\^" re) "^.*")
	  re
	  (unless (string-match "\\$$" re) ".*$")))

1238 1239
(defun gnus-set-window-start (&optional point)
  "Set the window start to POINT, or (point) if nil."
1240
  (let ((win (gnus-get-buffer-window (current-buffer) t)))
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
    (when win
      (set-window-start win (or point (point))))))

(defun gnus-annotation-in-region-p (b e)
  (if (= b e)
      (eq (cadr (memq 'gnus-undeletable (text-properties-at b))) t)
    (text-property-any b e 'gnus-undeletable t)))

(defun gnus-or (&rest elems)
  "Return non-nil if any of the elements are non-nil."
  (catch 'found
    (while elems
      (when (pop elems)
	(throw 'found t)))))

(defun gnus-and (&rest elems)
  "Return non-nil if all of the elements are non-nil."
  (catch 'found
    (while elems
      (unless (pop elems)
	(throw 'found nil)))
    t))

1264 1265 1266
;; gnus.el requires mm-util.
(declare-function mm-disable-multibyte "mm-util")

1267
(defun gnus-write-active-file (file hashtb &optional full-names)
1268
  ;; `coding-system-for-write' should be `raw-text' or equivalent.
1269 1270
  (let ((coding-system-for-write nnmail-active-file-coding-system))
    (with-temp-file file
1271 1272 1273
      ;; The buffer should be in the unibyte mode because group names
      ;; are ASCII text or encoded non-ASCII text (i.e., unibyte).
      (mm-disable-multibyte)
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
      (mapatoms
       (lambda (sym)
	 (when (and sym
		    (boundp sym)
		    (symbol-value sym))
	   (insert (format "%S %d %d y\n"
			   (if full-names
			       sym
			     (intern (gnus-group-real-name (symbol-name sym))))
			   (or (cdr (symbol-value sym))
			       (car (symbol-value sym)))
			   (car (symbol-value sym))))))
       hashtb)
      (goto-char (point-max))
      (while (search-backward "\\." nil t)
	(delete-char 1)))))

1291