;;; mu-cite.el --- yet another citation tool for GNU Emacs
-
-;; Copyright (C) 1995,1996,1997,1998,1999 Free Software Foundation, Inc.
+;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2005, 2007
+;; Free Software Foundation, Inc.
;; Author: MORIOKA Tomohiko <tomo@m17n.org>
;; Shuhei KOBAYASHI <shuhei@aqua.ocn.ne.jp>
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; - How to use
-;; 1. bytecompile this file and copy it to the apropriate directory.
-;; 2. put the following lines to your ~/.emacs:
-;; for EMACS 19 or later and XEmacs
+;; 1. Bytecompile this file and copy it to the apropriate directory.
+;; 2. Put the following lines in your ~/.emacs file:
+;; For EMACS 19 or later and XEmacs
;; (autoload 'mu-cite-original "mu-cite" nil t)
;; ;; for all but message-mode
;; (add-hook 'mail-citation-hook (function mu-cite-original))
;; ;; for message-mode only
;; (setq message-cite-function (function mu-cite-original))
-;; for EMACS 18
+;; For EMACS 18
;; ;; for all but mh-e
;; (add-hook 'mail-yank-hooks (function mu-cite-original))
;; ;; for mh-e only
;;; Code:
-;; Pickup some macros, e.g. `with-temp-buffer', for old Emacsen.
-(require 'poe)
+;; For picking up the macros `char-next-index', `with-temp-buffer', etc.
+(require 'poem)
(require 'pcustom)
-(require 'widget)
(require 'std11)
(require 'alist)
;;; @ version
;;;
-(defconst mu-cite-version "8.0")
+(defconst mu-cite-version "8.1")
-;;; @ obsoletes
+;;; @ macro
;;;
-;; This part will be abolished in the future.
-
-(eval-when-compile (require 'static))
-
-(defconst mu-cite-obsolete-variable-alist
- '((mu-cite/cited-prefix-regexp mu-cite-cited-prefix-regexp)
- (mu-cite/default-methods-alist mu-cite-default-methods-alist)
- (mu-cite/get-field-value-method-alist
- mu-cite-get-field-value-method-alist)
- (mu-cite/instantiation-hook mu-cite-instantiation-hook)
- (mu-cite/ml-count-field-list mu-cite-ml-count-field-list)
- (mu-cite/post-cite-hook mu-cite-post-cite-hook)
- (mu-cite/pre-cite-hook mu-cite-pre-cite-hook)
- (mu-cite/prefix-format mu-cite-prefix-format)
- (mu-cite/top-format mu-cite-top-format)))
-
-(static-if (featurep 'xemacs)
- (dolist (def mu-cite-obsolete-variable-alist)
- (apply (function define-obsolete-variable-alias) def)))
-
-(dolist (def '((mu-cite/cite-original mu-cite-original)
- (mu-cite/get-field-value mu-cite-get-field-value)
- (mu-cite/get-value mu-cite-get-value)))
- (apply (function define-obsolete-function-alias) def))
+(defmacro mu-cite-remove-text-properties (string)
+ "Remove text properties from STRING which is read from minibuffer."
+ (cond ((featurep 'xemacs)
+ `(let ((string (copy-sequence ,string)))
+ (map-extents (function (lambda (extent maparg)
+ (delete-extent extent)))
+ string 0 (length string))
+ string))
+ ((or (boundp 'minibuffer-allow-text-properties);; Emacs 20.1 or later.
+ (not (fboundp 'set-text-properties)));; under Emacs 19.7.
+ string)
+ (t
+ `(let ((string (copy-sequence ,string)))
+ (set-text-properties 0 (length string) nil string)
+ string))))
;;; @ set up
;;;
(defgroup mu-cite nil
- "yet another citation tool for GNU Emacs."
+ "Yet another citation tool for GNU Emacs."
:prefix "mu-cite-"
:group 'mail
:group 'news)
(cons 'id
(function
(lambda ()
- (let ((ml-name (mu-cite-get-value 'ml-name)))
+ (let ((ml-name (mu-cite-get-value 'ml-name))
+ (ml-count (mu-cite-get-value 'ml-count)))
(if ml-name
(concat "["
ml-name
- " : No."
- (mu-cite-get-value 'ml-count)
+ (if ml-count
+ (concat " : No." ml-count))
"]")
(mu-cite-get-value 'message-id))))))
(cons 'in-id
(function
(lambda ()
(mu-cite-get-field-value "X-Attribution"))))
+ (cons 'x-cite-me
+ (function
+ (lambda ()
+ (mu-cite-get-field-value "X-Cite-Me"))))
;; mu-register
(cons 'prefix (function mu-cite-get-prefix-method))
(cons 'prefix-register
(function mu-bbdb-get-prefix-register-verbose-method))
))
-(defun mu-cite-method-list ()
- (mapcar (function car) mu-cite-default-methods-alist))
-
;;; @ formats
;;;
-(defvar widget-mu-cite-method-prompt-value-history nil
- "History of input to `widget-mu-cite-method-prompt-value'.")
-
-(define-widget 'mu-cite-method 'symbol
- "A mu-cite-method."
- :format "%{%t%}: %v"
- :tag "Method"
- :prompt-history 'widget-mu-cite-method-prompt-value-history
- :prompt-value 'widget-mu-cite-method-prompt-value
- :action 'widget-mu-cite-method-action)
-
-(defun widget-mu-cite-method-prompt-value (widget prompt value unbound)
- ;; Read mu-cite-method from minibuffer.
- (intern
- (completing-read (format "%s (default %s) " prompt value)
- (mapcar (function
- (lambda (sym)
- (list (symbol-name sym))
- ))
- (mu-cite-method-list)))))
-
-(defun widget-mu-cite-method-action (widget &optional event)
- ;; Read a mu-cite-method from the minibuffer.
- (let ((answer
- (widget-mu-cite-method-prompt-value
- widget
- (widget-apply widget :menu-tag-get)
- (widget-value widget)
- t)))
- (widget-value-set widget answer)
- (widget-apply widget :notify widget event)
- (widget-setup)))
-
(defcustom mu-cite-cited-prefix-regexp
"\\(^[^ \t\n<>]+>+[ \t]*\\|^[ \t]*$\\)"
"Regexp to match the citation prefix.
(defcustom mu-cite-prefix-format '(prefix-register-verbose "> ")
"List to represent citation prefix.
-Each elements must be string or method name."
- :type '(repeat
- (choice :tag "String or Method name"
- mu-cite-method
- (item "-")
- (choice-item :tag "String: \"> \"" "> ")
- (string :tag "Other String")))
+Each elements must be a string or a method name."
+ :type (list
+ 'repeat
+ (list
+ 'group
+ :convert-widget
+ (function
+ (lambda (widget)
+ (list
+ 'choice
+ :tag "Method or String"
+ :args
+ (nconc
+ (mapcar
+ (function (lambda (elem) (list 'choice-item (car elem))))
+ mu-cite-default-methods-alist)
+ '((symbol :tag "Method")
+ (const :tag "-" nil)
+ (choice-item :tag "String: \"> \"" "> ")
+ (string))))))))
+ :set (function (lambda (symbol value)
+ (set-default symbol (delq nil value))))
:group 'mu-cite)
(defcustom mu-cite-top-format '(in-id ">>>>>\t" from " wrote:\n")
"List to represent top string of citation.
-Each elements must be string or method name."
- :type '(repeat
- (choice :tag "String or Method name"
- mu-cite-method
- (item "-")
- (choice-item :tag "String: \">>>>>\\t\"" ">>>>>\t")
- (choice-item :tag "String: \" wrote:\\n\"" " wrote:\n")
- (string :tag "Other String")))
+Each elements must be a string or a method name."
+ :type (list
+ 'repeat
+ (list
+ 'group
+ :convert-widget
+ (function
+ (lambda (widget)
+ (list 'choice
+ :tag "Method or String"
+ :args
+ (nconc
+ (mapcar
+ (function (lambda (elem) (list 'choice-item (car elem))))
+ mu-cite-default-methods-alist)
+ '((symbol :tag "Method")
+ (const :tag "-" nil)
+ (choice-item :tag "String: \">>>>>\\t\"" ">>>>>\t")
+ (choice-item :tag "String: \" wrote:\\n\"" " wrote:\n")
+ (string :tag "String"))))))))
+ :set (function (lambda (symbol value)
+ (set-default symbol (delq nil value))))
:group 'mu-cite)
(defcustom mu-cite-ml-count-field-list
'("X-Ml-Count" "X-Mail-Count" "X-Seqno" "X-Sequence" "Mailinglist-Id")
- "List of header fields which contain sequence number of mailing list."
- :type '(repeat (choice (choice-item "X-Ml-Count")
+ "List of header fields which contains a sequence number of the mailing list."
+ :type '(repeat (choice :tag "Field Name"
+ (choice-item "X-Ml-Count")
(choice-item "X-Mail-Count")
(choice-item "X-Seqno")
(choice-item "X-Sequence")
(choice-item "Mailinglist-Id")
- (item "-")
+ (const :tag "-" nil)
(string :tag "Other")))
+ :set (function (lambda (symbol value)
+ (set-default symbol (delq nil value))))
:group 'mu-cite)
(defun mu-cite-get-ml-count-method ()
"A mu-cite method to return a ML-count.
This function searches a field about ML-count, which is specified by
-variable `mu-cite-ml-count-field-list', in a header.
+the variable `mu-cite-ml-count-field-list', in a header.
If the field is found, the function returns a number part of the
field.
Notice that please use (mu-cite-get-value 'ml-count)
-instead of call the function directly."
+instead of to call the function directly."
(let ((field-list mu-cite-ml-count-field-list))
(catch 'tag
(while field-list
(run-hooks 'mu-cite-instantiation-hook))
(defun mu-cite-get-value (item)
- "Return current value of ITEM."
+ "Return a current value of ITEM."
(let ((ret (cdr (assoc item mu-cite-methods-alist))))
(if (functionp ret)
(prog1
(insert top)
(setq last-point (point))
(while (< (point)(mark t))
- (or (looking-at mu-cite-cited-prefix-regexp)
+ (or (and mu-cite-cited-prefix-regexp
+ (looking-at mu-cite-cited-prefix-regexp))
(insert prefix))
(forward-line 1))
(goto-char last-point))
:type 'string
:group 'mu-cite)
-(defun-maybe-cond char-category (character)
- "Return string of category mnemonics for CHAR in TABLE.
-CHAR can be any multilingual character
-TABLE defaults to the current buffer's category table."
- ((and (subr-fboundp 'char-category-set)
- (subr-fboundp 'category-set-mnemonics))
- (category-set-mnemonics (char-category-set character))
- )
- ((fboundp 'char-category-list)
- (mapconcat (lambda (chr)
- (char-to-string (int-char chr)))
- (char-category-list character)
- "")
- )
- ((boundp 'NEMACS)
- (if (< (char-int character) 128)
- "al"
- "j")
- )
- (t
- (if (< (char-int character) 128)
- "al"
- "l")
- ))
+(eval-and-compile
+ ;; Don't use the function `char-category' which may have been
+ ;; defined by emu.el. Anyway, the best way is not to use emu.el.
+ (if (and (fboundp 'char-category)
+ (subrp (symbol-function 'char-category)))
+ (defalias 'mu-cite-char-category 'char-category)
+ (defun-maybe-cond mu-cite-char-category (character &optional table)
+ "Return a string of category mnemonics for CHARACTER in TABLE.
+CHARACTER can be any multilingual characters,
+TABLE defaults to the current buffer's category table (it is currently
+ignored)."
+ ((and (subr-fboundp 'char-category-set)
+ (subr-fboundp 'category-set-mnemonics))
+ (category-set-mnemonics (char-category-set character)))
+ ((and (fboundp 'char-category-list)
+ ;; `char-category-list' returns a list of characters
+ ;; in XEmacs 21.2.25 and later, otherwise integers.
+ (characterp (car-safe (char-category-list ?a))))
+ (concat (char-category-list character)))
+ ((fboundp 'char-category-list)
+ (mapconcat (lambda (chr)
+ (char-to-string (int-char chr)))
+ (char-category-list character)
+ ""))
+ ((boundp 'NEMACS)
+ (if (< (char-int character) 128)
+ "al"
+ "j"))
+ (t
+ (if (< (char-int character) 128)
+ "al"
+ "l")))))
(defun detect-paragraph-cited-prefix ()
(save-excursion
(let ((i 0)
(prefix
(buffer-substring (line-beginning-position)
- (line-end-position)))
- str ret)
- (while (and (= (forward-line) 0)
- (setq str (buffer-substring
- (progn (beginning-of-line)(point))
- (progn (end-of-line)(point))))
- (setq ret (string-compare-from-top prefix str)))
- (setq prefix
- (if (stringp ret)
- ret
- (cadr ret)))
- (setq i (1+ i)))
+ (line-end-position))))
+ (let ((init prefix)
+ str ret)
+ (while (and (= (forward-line) 0)
+ (setq str (buffer-substring
+ (progn (beginning-of-line)(point))
+ (progn (end-of-line)(point))))
+ (setq ret (string-compare-from-top prefix str)))
+ (setq prefix
+ (if (stringp ret)
+ ret
+ (car (cdr ret))))
+ (or (string-equal init prefix)
+ (setq i (1+ i)))))
(cond ((> i 1) prefix)
((> i 0)
(goto-char (point-min))
(goto-char (match-end 0))
(if (looking-at "[ \t]+")
(goto-char (match-end 0)))
- (buffer-substring (point-min)(point)))
+ (buffer-substring (line-beginning-position)(point)))
(t "")))))
+(defcustom fill-column-for-fill-cited-region nil
+ "Integer to override `fill-column' while `fill-cited-region' is being
+executed. If you wish people call you ****-san, you may set the value
+of `fill-column' to 60 in the buffer for message sending and set this
+to 70. :-)"
+ :type `(choice (const :tag "Off" nil)
+ (integer ,default-fill-column))
+ :group 'mu-cite)
+
;;;###autoload
(defun fill-cited-region (beg end)
"Fill each of the paragraphs in the region as a cited text."
(setq end (match-end 0)))
(narrow-to-region beg end)
(let* ((fill-prefix (detect-paragraph-cited-prefix))
- (pat (concat fill-prefix "\n")))
+ (fill-column (max (+ 1 (current-left-margin)
+ (string-width fill-prefix))
+ (or fill-column-for-fill-cited-region
+ (current-fill-column))))
+ (pat (concat fill-prefix "\n"))
+ filladapt-mode)
(goto-char (point-min))
(while (search-forward pat nil t)
(let ((b (match-beginning 0))
(e (match-end 0)))
(delete-region b e)
(if (and (> b (point-min))
- (let ((cat (char-category
- (char-before b))))
+ (let ((cat (mu-cite-char-category (char-before b))))
(or (string-match "a" cat)
(string-match "l" cat))))
(insert " "))))
pe (match-beginning 1)
s (match-end 0)))
i)))
- (when (and ps (< ps pe))
- (delete-region b e)
- (insert (concat (substring prefix ps pe) (make-string nest ?>))))
+ (if (and ps (< ps pe))
+ (progn
+ (delete-region b e)
+ (insert (concat (substring prefix ps pe)
+ (make-string nest ?>)))))
))))
(defun replace-top-string (old new)
(run-hooks 'mu-cite-load-hook)
-;; This part will be abolished in the future.
-
-(static-unless (featurep 'xemacs)
- (let ((rest mu-cite-obsolete-variable-alist)
- def new-sym old-sym)
- (while rest
- (setq def (car rest))
- (apply (function make-obsolete-variable) def)
- (setq old-sym (car def)
- new-sym (car (cdr def)))
- (or (get new-sym 'saved-value) ; saved?
- (not (eq (eval (car (get new-sym 'standard-value)))
- (symbol-value new-sym))) ; set as new name?
- (and (boundp old-sym) ; old name seems used
- (or (eq (symbol-value new-sym)
- (symbol-value old-sym))
- (set new-sym (symbol-value old-sym)))))
- (setq rest (cdr rest)))))
-
;;; mu-cite.el ends here
projects / elisp / mu-cite.git / blobdiff