1 ;;; mu-cite.el --- yet another citation tool for GNU Emacs
3 ;; Copyright (C) 1995,1996,1997 Free Software Foundation, Inc.
5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; MINOURA Makoto <minoura@netlaputa.or.jp>
7 ;; Shuhei KOBAYASHI <shuhei-k@jaist.ac.jp>
8 ;; Maintainer: Shuhei KOBAYASHI <shuhei-k@jaist.ac.jp>
9 ;; Version: $Revision: 7.48 $
10 ;; Keywords: mail, news, citation
12 ;; This file is part of MU (Message Utilities).
14 ;; This program is free software; you can redistribute it and/or
15 ;; modify it under the terms of the GNU General Public License as
16 ;; published by the Free Software Foundation; either version 2, or (at
17 ;; your option) any later version.
19 ;; This program is distributed in the hope that it will be useful, but
20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 ;; General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
32 ;; 1. bytecompile this file and copy it to the apropriate directory.
33 ;; 2. put the following lines to your ~/.emacs:
34 ;; for EMACS 19 or later and XEmacs
35 ;; (autoload 'mu-cite/cite-original "mu-cite" nil t)
36 ;; ;; for all but message-mode
37 ;; (add-hook 'mail-citation-hook 'mu-cite/cite-original)
38 ;; ;; for message-mode only
39 ;; (setq message-cite-function (function mu-cite/cite-original))
41 ;; ;; for all but mh-e
42 ;; (add-hook 'mail-yank-hooks (function mu-cite/cite-original))
44 ;; (add-hook 'mh-yank-hooks (function mu-cite/cite-original))
56 (defconst mu-cite/RCS-ID
57 "$Id: mu-cite.el,v 7.48 1997/03/10 06:13:17 shuhei-k Exp $")
58 (defconst mu-cite/version (get-version-string mu-cite/RCS-ID))
64 (defvar mu-cite/cited-prefix-regexp "\\(^[^ \t\n<>]+>+[ \t]*\\|^[ \t]*$\\)"
65 "*Regexp to match the citation prefix.
66 If match, mu-cite doesn't insert citation prefix.")
68 (defvar mu-cite/prefix-format '(prefix-register-verbose "> ")
69 "*List to represent citation prefix.
70 Each elements must be string or method name.")
72 (defvar mu-cite/top-format '(in-id
73 ">>>>> " from " wrote:\n")
74 "*List to represent top string of citation.
75 Each elements must be string or method name.")
81 (defvar mu-cite-load-hook nil
82 "*List of functions called after mu-cite is loaded.
83 Use this hook to add your own methods to `mu-cite/default-methods-alist'.")
85 (defvar mu-cite/instantiation-hook nil
86 "*List of functions called just before narrowing to the message.")
88 (defvar mu-cite/pre-cite-hook nil
89 "*List of functions called before citing a region of text.")
91 (defvar mu-cite/post-cite-hook nil
92 "*List of functions called after citing a region of text.")
98 (defvar mu-cite/get-field-value-method-alist
99 (list (cons 'mh-letter-mode
102 (if (and (stringp mh-sent-from-folder)
103 (numberp mh-sent-from-msg))
105 (set-buffer mh-sent-from-folder)
106 (set-buffer mh-show-buffer)
107 (and (boundp 'mime::preview/article-buffer)
108 (bufferp mime::preview/article-buffer)
109 (set-buffer mime::preview/article-buffer))
110 (std11-field-body name)
114 (defun mu-cite/get-field-value (name)
115 (or (std11-field-body name)
116 (let ((method (assq major-mode mu-cite/get-field-value-method-alist)))
118 (funcall (cdr method) name)
122 ;;; @ prefix registration
125 (defvar mu-cite/registration-file (expand-file-name "~/.mu-cite.el")
126 "*The name of the user environment file for mu-cite.")
128 (defvar mu-cite/allow-null-string-registration nil
129 "*If non-nil, null-string citation-name is registered.")
131 (defvar mu-cite/registration-symbol 'mu-cite/citation-name-alist)
133 (defvar mu-cite/citation-name-alist nil)
134 (or (eq 'mu-cite/citation-name-alist mu-cite/registration-symbol)
135 (setq mu-cite/citation-name-alist
136 (symbol-value mu-cite/registration-symbol))
138 (defvar mu-cite/minibuffer-history nil)
140 ;; get citation-name from the database
141 (defun mu-cite/get-citation-name (from)
142 (assoc-value from mu-cite/citation-name-alist)
145 ;; register citation-name to the database
146 (defun mu-cite/add-citation-name (name from)
147 (setq mu-cite/citation-name-alist
148 (put-alist from name mu-cite/citation-name-alist))
149 (mu-cite/save-registration-file)
152 ;; load/save registration file
153 (defun mu-cite/load-registration-file ()
154 (let* ((file mu-cite/registration-file)
155 (buffer (get-buffer-create " *mu-register*")))
156 (if (file-readable-p file)
161 (insert-file-contents file)
163 (eval-current-buffer))
164 (kill-buffer buffer))
166 (add-hook 'mu-cite-load-hook (function mu-cite/load-registration-file))
168 (defun mu-cite/save-registration-file ()
169 (let* ((file mu-cite/registration-file)
170 (buffer (get-buffer-create " *mu-register*")))
174 (setq buffer-file-name file)
176 (insert ";;; " (file-name-nondirectory file) "\n")
177 (insert ";;; This file is generated automatically by mu-cite "
178 mu-cite/version "\n\n")
180 (symbol-name mu-cite/registration-symbol)
183 (function prin1-to-string)
184 mu-cite/citation-name-alist "\n "))
187 (file-name-nondirectory file)
190 (kill-buffer buffer))))
199 (defvar mu-cite/ml-count-field-list
200 '("X-Ml-Count" "X-Mail-Count" "X-Seqno" "X-Sequence" "Mailinglist-Id")
201 "*List of header fields which contain sequence number of mailing list.")
203 (defun mu-cite/get-ml-count-method ()
204 (let ((field-list mu-cite/ml-count-field-list))
207 (let* ((field (car field-list))
208 (ml-count (mu-cite/get-field-value field)))
209 (if (and ml-count (string-match "[0-9]+" ml-count))
212 (match-beginning 0)(match-end 0))
214 (setq field-list (cdr field-list))
218 ;;; @@ prefix and registration
221 (defun mu-cite/get-prefix-method ()
222 (or (mu-cite/get-citation-name (mu-cite/get-value 'address))
226 (defun mu-cite/get-prefix-register-method ()
227 (let ((addr (mu-cite/get-value 'address)))
228 (or (mu-cite/get-citation-name addr)
230 (read-string "Citation name? "
231 (or (mu-cite/get-value 'x-attribution)
232 (mu-cite/get-value 'full-name))
233 'mu-cite/minibuffer-history)
235 (if (and (or mu-cite/allow-null-string-registration
236 (not (string-equal return "")))
237 (y-or-n-p (format "Register \"%s\"? " return)))
238 (mu-cite/add-citation-name return addr)
242 (defun mu-cite/get-prefix-register-verbose-method ()
243 (let* ((addr (mu-cite/get-value 'address))
244 (return1 (mu-cite/get-citation-name addr))
245 (return (read-string "Citation name? "
247 (mu-cite/get-value 'x-attribution)
248 (mu-cite/get-value 'full-name))
249 'mu-cite/minibuffer-history))
251 (if (and (or mu-cite/allow-null-string-registration
252 (not (string-equal return "")))
253 (not (string-equal return return1))
254 (y-or-n-p (format "Register \"%s\"? " return))
256 (mu-cite/add-citation-name return addr)
264 (defvar mu-cite/default-methods-alist
268 (mu-cite/get-field-value "From")
273 (mu-cite/get-field-value "Date")
278 (mu-cite/get-field-value "Message-Id")
283 (mu-cite/get-field-value "Subject")
288 (mu-cite/get-field-value "X-Ml-Name")
290 (cons 'ml-count (function mu-cite/get-ml-count-method))
291 (cons 'address-structure
295 (std11-parse-address-string (mu-cite/get-value 'from))
300 (std11-full-name-string
301 (mu-cite/get-value 'address-structure))
306 (std11-address-string
307 (mu-cite/get-value 'address-structure))
312 (let ((ml-name (mu-cite/get-value 'ml-name)))
317 (mu-cite/get-value 'ml-count)
319 (mu-cite/get-value 'message-id)
324 (let ((id (mu-cite/get-value 'id)))
326 (format ">>>>> In %s \n" id)
328 (cons 'prefix (function mu-cite/get-prefix-method))
329 (cons 'prefix-register
330 (function mu-cite/get-prefix-register-method))
331 (cons 'prefix-register-verbose
332 (function mu-cite/get-prefix-register-verbose-method))
336 (mu-cite/get-field-value "X-Attribution")
344 (defvar mu-cite/methods-alist nil)
346 (defun mu-cite/make-methods ()
347 (setq mu-cite/methods-alist
348 (copy-alist mu-cite/default-methods-alist))
349 (run-hooks 'mu-cite/instantiation-hook)
352 (defun mu-cite/get-value (item)
353 (let ((ret (assoc-value item mu-cite/methods-alist)))
356 (setq ret (funcall ret))
357 (set-alist 'mu-cite/methods-alist item ret)
361 (defun mu-cite/eval-format (list)
364 (cond ((stringp elt) elt)
365 ((symbolp elt) (mu-cite/get-value elt))
374 (defun mu-cite/cite-original ()
375 "Citing filter function.
376 This is callable from the various mail and news readers' reply
377 function according to the agreed upon standard."
379 (mu-cite/make-methods)
381 (if (< (mark t) (point))
382 (exchange-point-and-mark))
383 (narrow-to-region (point)(point-max))
384 (run-hooks 'mu-cite/pre-cite-hook)
385 (let ((last-point (point))
386 (top (mu-cite/eval-format mu-cite/top-format))
387 (prefix (mu-cite/eval-format mu-cite/prefix-format))
389 (if (re-search-forward "^-*$" nil nil)
393 (delete-region last-point (point))
395 (setq last-point (point))
396 (while (< (point)(mark t))
397 (or (looking-at mu-cite/cited-prefix-regexp)
400 (goto-char last-point)
402 (run-hooks 'mu-cite/post-cite-hook)
406 ;;; @ message editing utilities
409 (defvar citation-mark-chars ">}|"
410 "*String of characters for citation delimiter. [mu-cite.el]")
412 (defvar citation-disable-chars "<{"
413 "*String of characters not allowed as citation-prefix.")
415 (defun detect-paragraph-cited-prefix ()
417 (goto-char (point-min))
421 (progn (beginning-of-line)(point))
422 (progn (end-of-line)(point))
425 (while (and (= (forward-line) 0)
426 (setq str (buffer-substring
427 (progn (beginning-of-line)(point))
428 (progn (end-of-line)(point))))
429 (setq ret (string-compare-from-top prefix str))
437 (cond ((> i 1) prefix)
439 (goto-char (point-min))
441 (narrow-to-region (point)
442 (+ (point)(length prefix)))
443 (goto-char (point-max))
444 (if (re-search-backward
445 (concat "[" citation-mark-chars "]") nil t)
447 (goto-char (match-end 0))
448 (if (looking-at "[ \t]+")
449 (goto-char (match-end 0))
451 (buffer-substring (point-min)(point))
455 (goto-char (point-max))
457 (concat "[" citation-disable-chars "]") nil t)
459 (concat "[" citation-mark-chars "]") nil t)
461 (goto-char (match-end 0))
462 (if (looking-at "[ \t]+")
463 (goto-char (match-end 0))
465 (buffer-substring (point-min)(point))
470 (defun fill-cited-region (beg end)
475 (and (search-backward "\n" nil t)
476 (setq end (match-end 0))
478 (narrow-to-region beg end)
479 (let* ((fill-prefix (detect-paragraph-cited-prefix))
480 (pat (concat fill-prefix "\n"))
482 (goto-char (point-min))
483 (while (search-forward pat nil t)
484 (let ((b (match-beginning 0))
488 (if (and (> b (point-min))
489 (let ((cat (char-category
491 (or (string-match "a" cat)
492 (string-match "l" cat)
498 (goto-char (point-min))
499 (fill-region (point-min) (point-max))
502 (defun compress-cited-prefix ()
505 (goto-char (point-min))
507 (concat "^" (regexp-quote mail-header-separator) "$") nil t)
508 (while (re-search-forward
509 (concat "^\\([ \t]*[^ \t\n" citation-mark-chars "]*["
510 citation-mark-chars "]\\)+") nil t)
511 (let* ((b (match-beginning 0))
513 (prefix (buffer-substring b e))
516 (if (string-match "<[^<>]+>" prefix)
517 (setq prefix (substring prefix 0 (match-beginning 0)))
520 (concat "\\([" citation-mark-chars "]+\\)[ \t]*")
522 (setq i (+ i (- (match-end 1)(match-beginning 1)))
524 pe (match-beginning 1)
528 (if (and ps (< ps pe))
531 (insert (concat (substring prefix ps pe) (make-string nest ?>)))
534 (defun replace-top-string (old new)
535 (interactive "*sOld string: \nsNew string: ")
536 (while (re-search-forward
537 (concat "^" (regexp-quote old)) nil t)
547 (run-hooks 'mu-cite-load-hook)
549 ;;; mu-cite.el ends here