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.47 $
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.47 1997/02/01 18:29:43 morioka 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
126 (expand-file-name "~/.mu-cite.el")
127 "*The name of the user environment file for mu-cite.")
129 (defvar mu-cite/allow-null-string-registration nil
130 "*If non-nil, null-string citation-name is registered.")
132 (defvar mu-cite/registration-symbol 'mu-cite/citation-name-alist)
134 (defvar mu-cite/citation-name-alist nil)
135 (load mu-cite/registration-file t t t)
136 (or (eq 'mu-cite/citation-name-alist mu-cite/registration-symbol)
137 (setq mu-cite/citation-name-alist
138 (symbol-value mu-cite/registration-symbol))
140 (defvar mu-cite/minibuffer-history nil)
142 ;; get citation-name from the database
143 (defun mu-cite/get-citation-name (from)
144 (assoc-value from mu-cite/citation-name-alist)
147 ;; register citation-name to the database
148 (defun mu-cite/add-citation-name (name from)
149 (setq mu-cite/citation-name-alist
150 (put-alist from name mu-cite/citation-name-alist))
151 (mu-cite/save-to-file)
155 (defun mu-cite/save-to-file ()
156 (let* ((filename mu-cite/registration-file)
157 (buffer (get-buffer-create " *mu-register*")))
160 (setq buffer-file-name filename)
163 (format ";;; %s\n" (file-name-nondirectory filename)))
165 (format ";;; This file is generated automatically by mu-cite %s.\n\n"
167 (insert (format "(setq %s\n '(" mu-cite/registration-symbol))
169 (function prin1-to-string)
170 mu-cite/citation-name-alist "\n "))
173 (format ";;; %s ends here.\n" (file-name-nondirectory filename)))
175 (kill-buffer buffer)))
184 (defvar mu-cite/ml-count-field-list
185 '("X-Ml-Count" "X-Mail-Count" "X-Seqno" "X-Sequence" "Mailinglist-Id")
186 "*List of header fields which contain sequence number of mailing list.")
188 (defun mu-cite/get-ml-count-method ()
189 (let ((field-list mu-cite/ml-count-field-list))
192 (let* ((field (car field-list))
193 (ml-count (mu-cite/get-field-value field)))
194 (if (and ml-count (string-match "[0-9]+" ml-count))
197 (match-beginning 0)(match-end 0))
199 (setq field-list (cdr field-list))
203 ;;; @@ prefix and registration
206 (defun mu-cite/get-prefix-method ()
207 (or (mu-cite/get-citation-name (mu-cite/get-value 'address))
211 (defun mu-cite/get-prefix-register-method ()
212 (let ((addr (mu-cite/get-value 'address)))
213 (or (mu-cite/get-citation-name addr)
215 (read-string "Citation name? "
216 (or (mu-cite/get-value 'x-attribution)
217 (mu-cite/get-value 'full-name))
218 'mu-cite/minibuffer-history)
220 (if (and (or mu-cite/allow-null-string-registration
221 (not (string-equal return "")))
222 (y-or-n-p (format "Register \"%s\"? " return)))
223 (mu-cite/add-citation-name return addr)
227 (defun mu-cite/get-prefix-register-verbose-method ()
228 (let* ((addr (mu-cite/get-value 'address))
229 (return1 (mu-cite/get-citation-name addr))
230 (return (read-string "Citation name? "
232 (mu-cite/get-value 'x-attribution)
233 (mu-cite/get-value 'full-name))
234 'mu-cite/minibuffer-history))
236 (if (and (or mu-cite/allow-null-string-registration
237 (not (string-equal return "")))
238 (not (string-equal return return1))
239 (y-or-n-p (format "Register \"%s\"? " return))
241 (mu-cite/add-citation-name return addr)
249 (defvar mu-cite/default-methods-alist
253 (mu-cite/get-field-value "From")
258 (mu-cite/get-field-value "Date")
263 (mu-cite/get-field-value "Message-Id")
268 (mu-cite/get-field-value "Subject")
273 (mu-cite/get-field-value "X-Ml-Name")
275 (cons 'ml-count (function mu-cite/get-ml-count-method))
276 (cons 'address-structure
280 (std11-parse-address-string (mu-cite/get-value 'from))
285 (std11-full-name-string
286 (mu-cite/get-value 'address-structure))
291 (std11-address-string
292 (mu-cite/get-value 'address-structure))
297 (let ((ml-name (mu-cite/get-value 'ml-name)))
302 (mu-cite/get-value 'ml-count)
304 (mu-cite/get-value 'message-id)
309 (let ((id (mu-cite/get-value 'id)))
311 (format ">>>>> In %s \n" id)
313 (cons 'prefix (function mu-cite/get-prefix-method))
314 (cons 'prefix-register
315 (function mu-cite/get-prefix-register-method))
316 (cons 'prefix-register-verbose
317 (function mu-cite/get-prefix-register-verbose-method))
321 (mu-cite/get-field-value "X-Attribution")
329 (defvar mu-cite/methods-alist nil)
331 (defun mu-cite/make-methods ()
332 (setq mu-cite/methods-alist
333 (copy-alist mu-cite/default-methods-alist))
334 (run-hooks 'mu-cite/instantiation-hook)
337 (defun mu-cite/get-value (item)
338 (let ((ret (assoc-value item mu-cite/methods-alist)))
341 (setq ret (funcall ret))
342 (set-alist 'mu-cite/methods-alist item ret)
346 (defun mu-cite/eval-format (list)
349 (cond ((stringp elt) elt)
350 ((symbolp elt) (mu-cite/get-value elt))
359 (defun mu-cite/cite-original ()
360 "Citing filter function.
361 This is callable from the various mail and news readers' reply
362 function according to the agreed upon standard."
364 (mu-cite/make-methods)
366 (if (< (mark t) (point))
367 (exchange-point-and-mark))
368 (narrow-to-region (point)(point-max))
369 (run-hooks 'mu-cite/pre-cite-hook)
370 (let ((last-point (point))
371 (top (mu-cite/eval-format mu-cite/top-format))
372 (prefix (mu-cite/eval-format mu-cite/prefix-format))
374 (if (re-search-forward "^-*$" nil nil)
378 (delete-region last-point (point))
380 (setq last-point (point))
381 (while (< (point)(mark t))
382 (or (looking-at mu-cite/cited-prefix-regexp)
385 (goto-char last-point)
387 (run-hooks 'mu-cite/post-cite-hook)
391 ;;; @ message editing utilities
394 (defvar citation-mark-chars ">}|"
395 "*String of characters for citation delimiter. [mu-cite.el]")
397 (defvar citation-disable-chars "<{"
398 "*String of characters not allowed as citation-prefix.")
400 (defun detect-paragraph-cited-prefix ()
402 (goto-char (point-min))
406 (progn (beginning-of-line)(point))
407 (progn (end-of-line)(point))
410 (while (and (= (forward-line) 0)
411 (setq str (buffer-substring
412 (progn (beginning-of-line)(point))
413 (progn (end-of-line)(point))))
414 (setq ret (string-compare-from-top prefix str))
422 (cond ((> i 1) prefix)
424 (goto-char (point-min))
426 (narrow-to-region (point)
427 (+ (point)(length prefix)))
428 (goto-char (point-max))
429 (if (re-search-backward
430 (concat "[" citation-mark-chars "]") nil t)
432 (goto-char (match-end 0))
433 (if (looking-at "[ \t]+")
434 (goto-char (match-end 0))
436 (buffer-substring (point-min)(point))
440 (goto-char (point-max))
442 (concat "[" citation-disable-chars "]") nil t)
444 (concat "[" citation-mark-chars "]") nil t)
446 (goto-char (match-end 0))
447 (if (looking-at "[ \t]+")
448 (goto-char (match-end 0))
450 (buffer-substring (point-min)(point))
455 (defun fill-cited-region (beg end)
460 (and (search-backward "\n" nil t)
461 (setq end (match-end 0))
463 (narrow-to-region beg end)
464 (let* ((fill-prefix (detect-paragraph-cited-prefix))
465 (pat (concat fill-prefix "\n"))
467 (goto-char (point-min))
468 (while (search-forward pat nil t)
469 (let ((b (match-beginning 0))
473 (if (and (> b (point-min))
474 (let ((cat (char-category
476 (or (string-match "a" cat)
477 (string-match "l" cat)
483 (goto-char (point-min))
484 (fill-region (point-min) (point-max))
487 (defun compress-cited-prefix ()
490 (goto-char (point-min))
492 (concat "^" (regexp-quote mail-header-separator) "$") nil t)
493 (while (re-search-forward
494 (concat "^\\([ \t]*[^ \t\n" citation-mark-chars "]*["
495 citation-mark-chars "]\\)+") nil t)
496 (let* ((b (match-beginning 0))
498 (prefix (buffer-substring b e))
501 (if (string-match "<[^<>]+>" prefix)
502 (setq prefix (substring prefix 0 (match-beginning 0)))
505 (concat "\\([" citation-mark-chars "]+\\)[ \t]*")
507 (setq i (+ i (- (match-end 1)(match-beginning 1)))
509 pe (match-beginning 1)
513 (if (and ps (< ps pe))
516 (insert (concat (substring prefix ps pe) (make-string nest ?>)))
519 (defun replace-top-string (old new)
520 (interactive "*sOld string: \nsNew string: ")
521 (while (re-search-forward
522 (concat "^" (regexp-quote old)) nil t)
532 (run-hooks 'mu-cite-load-hook)
534 ;;; mu-cite.el ends here