;;; supercite.el --- minor mode for citing mail and news replies
-;; Copyright (C) 1993, 1997, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1997, 2001-2014 Free Software Foundation, Inc.
;; Author: 1993 Barry A. Warsaw <bwarsaw@python.org>
-;; Maintainer: Glenn Morris <rgm@gnu.org>
-;; Created: February 1993
+;; Maintainer: emacs-devel@gnu.org
+;; Created: February 1993
;; Keywords: mail, news
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; 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., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;; LCD Archive Entry
;; supercite|Barry A. Warsaw|supercite-help@python.org
\f
(require 'regi)
-(require 'sendmail) ;; For mail-header-end.
;; start user configuration variables
;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
:group 'supercite)
(defcustom sc-auto-fill-region-p t
- "*If non-nil, automatically fill each paragraph after it has been cited."
+ "If non-nil, automatically fill each paragraph after it has been cited."
:type 'boolean
:group 'supercite)
(defcustom sc-blank-lines-after-headers 1
- "*Number of blank lines to leave after mail headers have been nuked.
+ "Number of blank lines to leave after mail headers have been nuked.
Set to nil, to use whatever blank lines happen to occur naturally."
:type '(choice (const :tag "leave" nil)
integer)
:group 'supercite)
(defcustom sc-citation-leader " "
- "*String comprising first part of a citation."
+ "String comprising first part of a citation."
:type 'string
:group 'supercite-cite)
(defcustom sc-citation-delimiter ">"
- "*String comprising third part of a citation.
+ "String comprising third part of a citation.
This string is used in both nested and non-nested citations."
:type 'string
:group 'supercite-cite)
(defcustom sc-citation-separator " "
- "*String comprising fourth and last part of a citation."
+ "String comprising fourth and last part of a citation."
:type 'string
:group 'supercite-cite)
(defcustom sc-citation-leader-regexp "[ \t]*"
- "*Regexp describing citation leader for a cited line.
+ "Regexp describing citation leader for a cited line.
This should NOT have a leading `^' character."
:type 'regexp
:group 'supercite-cite)
;; Nemacs and Mule users note: please see the texinfo manual for
;; suggestions on setting these variables.
(defcustom sc-citation-root-regexp "[-._[:alnum:]]*"
- "*Regexp describing variable root part of a citation for a cited line.
+ "Regexp describing variable root part of a citation for a cited line.
This should NOT have a leading `^' character. See also
`sc-citation-nonnested-root-regexp'."
:type 'regexp
:group 'supercite-cite)
(defcustom sc-citation-nonnested-root-regexp "[-._[:alnum:]]+"
- "*Regexp describing the variable root part of a nested citation.
+ "Regexp describing the variable root part of a nested citation.
This should NOT have a leading `^' character. This variable is
related to `sc-citation-root-regexp' but whereas that variable
describes both nested and non-nested citation roots, this variable
:group 'supercite-cite)
(defcustom sc-citation-delimiter-regexp "[>]+"
- "*Regexp describing citation delimiter for a cited line.
+ "Regexp describing citation delimiter for a cited line.
This should NOT have a leading `^' character."
:type 'regexp
:group 'supercite-cite)
(defcustom sc-citation-separator-regexp "[ \t]*"
- "*Regexp describing citation separator for a cited line.
+ "Regexp describing citation separator for a cited line.
This should NOT have a leading `^' character."
:type 'regexp
:group 'supercite-cite)
(defcustom sc-cite-blank-lines-p nil
- "*If non-nil, put a citation on blank lines."
+ "If non-nil, put a citation on blank lines."
:type 'boolean
:group 'supercite-cite)
(defcustom sc-cite-frame-alist '()
- "*Alist for frame selection during citing.
+ "Alist for frame selection during citing.
Each element of this list has the following form:
(INFOKEY ((REGEXP . FRAME)
(REGEXP . FRAME)
(put 'sc-cite-frame-alist 'risky-local-variable t)
(defcustom sc-uncite-frame-alist '()
- "*Alist for frame selection during unciting.
+ "Alist for frame selection during unciting.
See the variable `sc-cite-frame-alist' for details."
:type '(repeat (list symbol (repeat (cons regexp
(choice (repeat (repeat sexp))
(put 'sc-uncite-frame-alist 'risky-local-variable t)
(defcustom sc-recite-frame-alist '()
- "*Alist for frame selection during reciting.
+ "Alist for frame selection during reciting.
See the variable `sc-cite-frame-alist' for details."
:type '(repeat (list symbol (repeat (cons regexp
(choice (repeat (repeat sexp))
(concat "\\("
(sc-cite-regexp "")
"\\)"
- (sc-cite-regexp sc-citation-nonnested-root-regexp))
- )))
+ (sc-cite-regexp
+ sc-citation-nonnested-root-regexp)))))
;; blank lines mean paragraph separators, so fill the last cited
;; paragraph, unless sc-cite-blank-lines-p is non-nil, in which
;; case we treat blank lines just like any other line.
("^[ \t]*$" (if sc-cite-blank-lines-p
- (sc-cite-line)
+ (if sc-nested-citation-p
+ (sc-add-citation-level)
+ (sc-cite-line))
(sc-fill-if-different "")))
;; do nothing if looking at a reference tag. make sure that the
;; tag string isn't the empty string since this will match every
;; citations, so cite it with a non-nested citation
(t (sc-cite-line))
;; be sure when we're done that we fill the last cited paragraph.
- (end (sc-fill-if-different ""))
- )
- "*Default REGI frame for citing a region."
+ (end (sc-fill-if-different "")))
+ "Default REGI frame for citing a region."
:type '(repeat (repeat sexp))
:group 'supercite-frames)
(put 'sc-default-cite-frame 'risky-local-variable t)
'(;; do nothing on a blank line
("^[ \t]*$" nil)
;; if the line is cited, uncite it
- ((sc-cite-regexp) (sc-uncite-line))
- )
- "*Default REGI frame for unciting a region."
+ ((sc-cite-regexp) (sc-uncite-line)))
+ "Default REGI frame for unciting a region."
:type '(repeat (repeat sexp))
:group 'supercite-frames)
(put 'sc-default-uncite-frame 'risky-local-variable t)
;; otherwise, the line is uncited, so just cite it
(t (sc-cite-line))
;; be sure when we're done that we fill the last cited paragraph.
- (end (sc-fill-if-different ""))
- )
- "*Default REGI frame for reciting a region."
+ (end (sc-fill-if-different "")))
+ "Default REGI frame for reciting a region."
:type '(repeat (repeat sexp))
:group 'supercite-frames)
(put 'sc-default-recite-frame 'risky-local-variable t)
(defcustom sc-cite-region-limit t
- "*This variable controls automatic citation of yanked text.
+ "This variable controls automatic citation of yanked text.
Valid values are:
non-nil -- cite the entire region, regardless of its size
:group 'supercite-cite)
(defcustom sc-confirm-always-p t
- "*If non-nil, always confirm attribution string before citing text body."
+ "If non-nil, always confirm attribution string before citing text body."
:type 'boolean
:group 'supercite-attr)
(defcustom sc-default-attribution "Anon"
- "*String used when author's attribution cannot be determined."
+ "String used when author's attribution cannot be determined."
:type 'string
:group 'supercite-attr)
(defcustom sc-default-author-name "Anonymous"
- "*String used when author's name cannot be determined."
+ "String used when author's name cannot be determined."
:type 'string
:group 'supercite-attr)
(defcustom sc-downcase-p nil
- "*Non-nil means downcase the attribution and citation strings."
+ "Non-nil means downcase the attribution and citation strings."
:type 'boolean
:group 'supercite-attr
:group 'supercite-cite)
(defcustom sc-electric-circular-p t
- "*If non-nil, treat electric references as circular."
+ "If non-nil, treat electric references as circular."
:type 'boolean
:group 'supercite-attr)
(defcustom sc-electric-mode-hook nil
- "*Hook for `sc-electric-mode' electric references mode."
+ "Hook for `sc-electric-mode' electric references mode."
:type 'hook
:group 'supercite-hooks)
(defcustom sc-electric-references-p nil
- "*Use electric references if non-nil."
+ "Use electric references if non-nil."
:type 'boolean
:group 'supercite)
(defcustom sc-fixup-whitespace-p nil
- "*If non-nil, delete all leading white space before citing."
+ "If non-nil, delete all leading white space before citing."
:type 'boolean
:group 'supercite)
(defcustom sc-load-hook nil
- "*Hook which gets run once after Supercite loads."
+ "Hook which gets run once after Supercite loads."
:type 'hook
:group 'supercite-hooks)
(defcustom sc-pre-hook nil
- "*Hook which gets run before each invocation of `sc-cite-original'."
+ "Hook which gets run before each invocation of `sc-cite-original'."
:type 'hook
:group 'supercite-hooks)
(defcustom sc-post-hook nil
- "*Hook which gets run after each invocation of `sc-cite-original'."
+ "Hook which gets run after each invocation of `sc-cite-original'."
:type 'hook
:group 'supercite-hooks)
(defcustom sc-mail-warn-if-non-rfc822-p t
- "*Warn if mail headers don't conform to RFC822."
+ "Warn if mail headers don't conform to RFC822."
:type 'boolean
:group 'supercite-attr)
(defcustom sc-mumble ""
- "*Value returned by `sc-mail-field' if field isn't in mail headers."
+ "Value returned by `sc-mail-field' if field isn't in mail headers."
:type 'string
:group 'supercite-attr)
("^\\(Jr\\|Sr\\)[.]?$" . last)
("^ASTS$" . 0)
("^[I]+$" . last))
- "*Name list components which are filtered out as noise.
+ "Name list components which are filtered out as noise.
This variable contains an association list where each element is of
the form: (REGEXP . POSITION).
:group 'supercite-attr)
(defcustom sc-nested-citation-p nil
- "*Controls whether to use nested or non-nested citation style.
+ "Controls whether to use nested or non-nested citation style.
Non-nil uses nested citations, nil uses non-nested citations."
:type 'boolean
:group 'supercite)
(defcustom sc-nuke-mail-headers 'all
- "*Controls mail header nuking.
+ "Controls mail header nuking.
Used in conjunction with `sc-nuke-mail-header-list'. Valid values are:
`all' -- nuke all mail headers
:group 'supercite)
(defcustom sc-nuke-mail-header-list nil
- "*List of mail header regexps to remove or keep in body of reply.
+ "List of mail header regexps to remove or keep in body of reply.
This list contains regular expressions describing the mail headers to
keep or nuke, depending on the value of `sc-nuke-mail-headers'."
:type '(repeat regexp)
(defcustom sc-preferred-attribution-list
'("sc-lastchoice" "x-attribution" "firstname" "initials" "lastname")
- "*Specifies what to use as the attribution string.
+ "Specifies what to use as the attribution string.
Supercite creates a list of possible attributions when it scans the
mail headers from the original message. Each attribution choice is
associated with a key in an attribution alist. Supercite tries to
:group 'supercite-attr)
(defcustom sc-attrib-selection-list nil
- "*An alist for selecting preferred attribution based on mail headers.
+ "An alist for selecting preferred attribution based on mail headers.
Each element of this list has the following form:
(INFOKEY ((REGEXP . ATTRIBUTION)
(put 'sc-attrib-selection-list 'risky-local-variable t)
(defcustom sc-attribs-preselect-hook nil
- "*Hook to run before selecting an attribution."
+ "Hook to run before selecting an attribution."
:type 'hook
:group 'supercite-attr
:group 'supercite-hooks)
(defcustom sc-attribs-postselect-hook nil
- "*Hook to run after selecting an attribution, but before confirmation."
+ "Hook to run after selecting an attribution, but before confirmation."
:type 'hook
:group 'supercite-attr
:group 'supercite-hooks)
(defcustom sc-pre-cite-hook nil
- "*Hook to run before citing a region of text."
+ "Hook to run before citing a region of text."
:type 'hook
:group 'supercite-cite
:group 'supercite-hooks)
(defcustom sc-pre-uncite-hook nil
- "*Hook to run before unciting a region of text."
+ "Hook to run before unciting a region of text."
:type 'hook
:group 'supercite-cite
:group 'supercite-hooks)
(defcustom sc-pre-recite-hook nil
- "*Hook to run before reciting a region of text."
+ "Hook to run before reciting a region of text."
:type 'hook
:group 'supercite-cite
:group 'supercite-hooks)
(defcustom sc-preferred-header-style 4
- "*Index into `sc-rewrite-header-list' specifying preferred header style.
+ "Index into `sc-rewrite-header-list' specifying preferred header style.
Index zero accesses the first function in the list."
:type 'integer
:group 'supercite)
(defcustom sc-reference-tag-string ">>>>> "
- "*String used at the beginning of built-in reference headers."
+ "String used at the beginning of built-in reference headers."
:type 'string
:group 'supercite)
(sc-header-attributed-writes)
(sc-header-author-writes)
(sc-header-verbose)
- (sc-no-blank-line-or-header)
- )
- "*List of reference header rewrite functions.
+ (sc-no-blank-line-or-header))
+ "List of reference header rewrite functions.
The variable `sc-preferred-header-style' controls which function in
this list is chosen for automatic reference header insertions.
Electric reference mode will cycle through this list of functions."
(put 'sc-rewrite-header-list 'risky-local-variable t)
(defcustom sc-titlecue-regexp "\\s +-+\\s +"
- "*Regular expression describing the separator between names and titles.
+ "Regular expression describing the separator between names and titles.
Set to nil to treat entire field as a name."
:type '(choice (const :tag "entire field as name" nil)
regexp)
:group 'supercite-attr)
(defcustom sc-use-only-preference-p nil
- "*Controls what happens when the preferred attribution cannot be found.
+ "Controls what happens when the preferred attribution cannot be found.
If non-nil, then `sc-default-attribution' will be used. If nil, then
some secondary scheme will be employed to find a suitable attribution
string."
:type 'boolean
:group 'supercite-attr)
+(defcustom sc-mode-map-prefix "\C-c\C-p"
+ "Key binding to install Supercite keymap."
+ :type 'string
+ :group 'supercite)
+
;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
;; end user configuration variables
\f
-(define-obsolete-variable-alias 'sc-version 'emacs-version "23.1")
-
(defvar sc-mail-info nil
"Alist of mail header information gleaned from reply buffer.")
(defvar sc-attributions nil
;; ======================================================================
;; supercite keymaps
-(defvar sc-mode-map-prefix "\C-c\C-p"
- "*Key binding to install Supercite keymap.
-If this is nil, Supercite keymap is not installed.")
-
(defvar sc-T-keymap
(let ((map (make-sparse-keymap)))
(define-key map "a" 'sc-S-preferred-attribution-list)
(define-key map "r" 'sc-recite-region)
(define-key map "\C-p" 'sc-raw-mode-toggle)
(define-key map "u" 'sc-uncite-region)
- (define-key map "v" 'sc-version)
(define-key map "w" 'sc-insert-reference)
(define-key map "\C-t" sc-T-keymap)
- (define-key map "\C-b" 'sc-submit-bug-report)
(define-key map "?" 'sc-describe)
map)
"Keymap for Supercite quasi-mode.")
Note that WORD is a string and LETTER is a character. All LETTERs in
the list should be unique."
(let* ((prompt (concat
- (mapconcat (function (lambda (elt) (car elt))) alist ", ")
+ (mapconcat (lambda (elt) (car elt)) alist ", ")
"? ("
(mapconcat
- (function
- (lambda (elt) (char-to-string (cdr elt)))) alist "/")
+ (lambda (elt) (char-to-string (cdr elt))) alist "/")
") "))
(p prompt)
(event
(let* ((elem (car alist))
(infokey (car elem))
(infoval (sc-mail-field infokey))
- (mlist (car (cdr elem))))
+ (mlist (cadr elem)))
(while mlist
(let* ((ml-elem (car mlist))
(regexp (car ml-elem))
mlist nil
alist nil)
;; else we didn't find a match
- (setq mlist (cdr mlist))
- ))) ;end of mlist loop
- (setq alist (cdr alist))
- )) ;end of alist loop
+ (setq mlist (cdr mlist))))) ;end of mlist loop
+ (setq alist (cdr alist)))) ;end of alist loop
rtnvalue))
\f
"For minibuffer completion on mail field modifications.")
(defvar sc-mail-glom-frame
'((begin (setq sc-mail-headers-start (point)))
+ ("^From " (sc-mail-check-from) nil nil)
("^x-attribution:[ \t]+.*$" (sc-mail-fetch-field t) nil t)
("^\\S +:.*$" (sc-mail-fetch-field) nil t)
("^$" (list 'abort '(step . 0)))
(defvar curline) ; dynamic bondage
;; regi functions
+
+;; http://lists.gnu.org/archive/html/emacs-devel/2009-02/msg00691.html
+;; When rmail replies to a message with full headers visible, the "From "
+;; line can be included.
+(defun sc-mail-check-from ()
+ "Deal with a \"From \" line in the header.
+Such a line should only occur at the very start of the headers."
+ (and sc-mail-warn-if-non-rfc822-p
+ (/= (point) sc-mail-headers-start)
+ (sc-mail-error-in-mail-field)))
+
(defun sc-mail-fetch-field (&optional attribs-p)
"Insert a key and value into `sc-mail-info' alist.
If optional ATTRIBS-P is non-nil, the key/value pair is placed in
;; we never get far enough to interpret a frame if s-n-m-h == 'none
((eq sc-nuke-mail-headers 'none))
(t (error "Invalid value for sc-nuke-mail-headers: %s"
- sc-nuke-mail-headers))
- ) ; end-cond
+ sc-nuke-mail-headers))) ; end-cond
(append
(and entry-func
(regi-mapcar sc-nuke-mail-header-list entry-func nil t))
'(("^[ \t]+" (sc-mail-nuke-continuation-line))))
'((begin (setq sc-mail-last-header-zapped-p nil)))
'((end (sc-mail-cleanup-blank-lines)))
- (and every-func (list (list 'every every-func)))
- )))
+ (and every-func (list (list 'every every-func))))))
;; mail processing and zapping. this is the top level entry defun to
;; all header processing.
(setq sc-mail-info info
sc-attributions attribs))
(regi-interpret (sc-mail-build-nuke-frame)
- sc-mail-headers-start sc-mail-headers-end)
- )))
+ sc-mail-headers-start sc-mail-headers-end))))
\f
;; let the user change mail field information
(concat key ": ") (cdr keyval)
'sc-mail-field-modification-history))))
((eq action ?a)
- (push (cons key (read-string (concat key ": "))) sc-mail-info))
- ))))
+ (push (cons key (read-string (concat key ": "))) sc-mail-info))))))
\f
;; ======================================================================
from 0))
(mend (match-end 0)))
(and mstart
- (substring from (1+ mstart) (- mend (if (= mend eos) 0 1)))
- )))
+ (substring from (1+ mstart) (- mend (if (= mend eos) 0 1))))))
(defun sc-attribs-<>-addresses (from)
"Extract the author's email terminus from email address FROM.
address))
(if (string-match "[-[:alnum:]!@%._]+" from 0)
(match-string 0 from)
- "")
- )))
+ ""))))
(defun sc-attribs-emailname (from)
"Get the email terminus name from FROM."
(let ((sos (+ start extend))
(eos (- end extend)))
(substring string sos
- (or (string-match sc-titlecue-regexp string sos) eos)
- ))))
+ (or (string-match sc-titlecue-regexp string sos) eos)))))
(defun sc-attribs-extract-namestring (from)
"Extract the name string from FROM.
=> (\"John\" \"Xavier\" \"Doe\")"
(if (string-match "\\([ \t]*\\)\\([^ \t._]+\\)\\([ \t]*\\)" namestring)
(cons (match-string 2 namestring)
- (sc-attribs-chop-namestring (substring namestring (match-end 3)))
- )))
+ (sc-attribs-chop-namestring (substring namestring (match-end 3))))))
(defun sc-attribs-strip-initials (namelist)
"Extract the author's initials from the NAMELIST."
(mapconcat
- (function
- (lambda (name)
- (if (< 0 (length name))
- (substring name 0 1))))
+ (lambda (name)
+ (if (< 0 (length name))
+ (substring name 0 1)))
namelist ""))
(defun sc-guess-attribution (&optional string)
(position -1)
keepers filtered-list)
(mapc
- (function
- (lambda (name)
- (setq position (1+ position))
- (let ((keep-p t))
- (mapc
- (function
- (lambda (filter)
- (let ((regexp (car filter))
- (pos (cdr filter)))
- (if (and (string-match regexp name)
- (or (and (numberp pos)
- (= pos position))
- (and (eq pos 'last)
- (= position (1- elements)))
- (eq pos 'any)))
- (setq keep-p nil))
- )))
- sc-name-filter-alist)
- (if keep-p
- (setq keepers (cons position keepers)))
- )))
+ (lambda (name)
+ (setq position (1+ position))
+ (let ((keep-p t))
+ (mapc
+ (function
+ (lambda (filter)
+ (let ((regexp (car filter))
+ (pos (cdr filter)))
+ (if (and (string-match regexp name)
+ (or (and (numberp pos)
+ (= pos position))
+ (and (eq pos 'last)
+ (= position (1- elements)))
+ (eq pos 'any)))
+ (setq keep-p nil)))))
+ sc-name-filter-alist)
+ (if keep-p
+ (setq keepers (cons position keepers)))))
namelist)
(mapc
- (function
- (lambda (position)
- (setq filtered-list (cons (nth position namelist) filtered-list))
- ))
+ (lambda (position)
+ (setq filtered-list (cons (nth position namelist) filtered-list)))
keepers)
filtered-list))
(setq
;; put middle names and build sc-author entry
middlenames (mapconcat
- (function
- (lambda (midname)
- (let ((key-attribs (format "middlename-%d" n))
- (key-mail (format "sc-middlename-%d" n)))
- (push (cons key-attribs midname) sc-attributions)
- (push (cons key-mail midname) sc-mail-info)
- (setq n (1+ n))
- midname)))
+ (lambda (midname)
+ (let ((key-attribs (format "middlename-%d" n))
+ (key-mail (format "sc-middlename-%d" n)))
+ (push (cons key-attribs midname) sc-attributions)
+ (push (cons key-mail midname) sc-mail-info)
+ (setq n (1+ n))
+ midname))
midnames " ")
author (concat firstname " " middlenames (and midnames " ") lastname)
namestring))
(cons "sc-sender-address" (sc-get-address
(sc-mail-field "sender")
- namestring))
- )
- sc-mail-info)
- ))
+ namestring)))
+ sc-mail-info)))
;; from string is empty
(push (cons "sc-author" sc-default-author-name) sc-mail-info)))
(setq attribution nil
attriblist (cdr attriblist))))
(t (error "%s did not evaluate to a string or list!"
- "sc-attrib-selection-list"))
- )))
+ "sc-attrib-selection-list")))))
((setq attribution (cdr (assoc preferred sc-attributions)))
(setq attriblist nil))
(t
- (setq attriblist (cdr attriblist)))
- )))
+ (setq attriblist (cdr attriblist))))))
;; if preference was not found, we may use a secondary method to
;; find a valid attribution
;; query for confirmation
(if query-p
- (let* ((query-alist (mapcar (function (lambda (entry)
- (list (cdr entry))))
+ (let* ((query-alist (mapcar (lambda (entry) (list (cdr entry)))
sc-attributions))
(minibuffer-local-completion-map
sc-minibuffer-local-completion-map)
"Complete attribution name: "
query-alist nil nil
(cons initial 0)
- 'sc-attribution-confirmation-history)
- ))
+ 'sc-attribution-confirmation-history)))
nil)))
(if sc-attrib-or-cite
;; since the citation was chosen, we have to guess at
citation))
(setq citation (sc-make-citation choice)
- attribution choice))
- ))
+ attribution choice))))
;; its possible that the user wants to downcase the citation and
;; attribution
(lastchoice (assoc lkey sc-attributions)))
(if lastchoice
(setcdr lastchoice attribution)
- (push (cons lkey attribution) sc-attributions)))
- ))
+ (push (cons lkey attribution) sc-attributions)))))
\f
;; ======================================================================
(if (not (string= fill-prefix ""))
(fill-region sc-fill-begin (line-beginning-position)))
(setq sc-fill-line-prefix prefix
- sc-fill-begin (line-beginning-position))))
- )
+ sc-fill-begin (line-beginning-position)))))
nil)
(defun sc-cite-coerce-cited-line ()
"Does nothing. Use this instead of nil to get a blank header."
())
-(defun sc-no-blank-line-or-header()
+(declare-function mh-in-header-p "mh-utils" ())
+
+(defun sc-no-blank-line-or-header ()
"Similar to `sc-no-header' except it removes the preceding blank line."
- (if (not (bobp))
- (if (and (eolp)
- (progn (forward-line -1)
- (or (= (point) (mail-header-end))
- (and (eq major-mode 'mh-letter-mode)
- (with-no-warnings
- (mh-in-header-p))))))
- (progn (forward-line)
- (let ((kill-lines-magic t))
- (kill-line))))))
+ (and (not (bobp))
+ (eolp)
+ (progn (forward-line -1)
+ (or (= (point)
+ (save-excursion
+ (rfc822-goto-eoh)
+ (line-beginning-position 2)))
+ (and (eq major-mode 'mh-letter-mode)
+ (mh-in-header-p))))
+ (progn
+ (forward-line)
+ (kill-line))))
(defun sc-header-on-said ()
"\"On <date>, <from> said:\" unless:
(sc-mail-field "subject") "\n")
(sc-hdr (concat tag "(see ")
(sc-mail-field "references")
- " for more details)\n")
- ))))
+ " for more details)\n")))))
\f
;; ======================================================================
(void-function
(progn (message
"Symbol's function definition is void: %s (Header %d)"
- (car (cdr err)) sc-eref-style)
- (beep)
- ))
- )))
+ (cadr err) sc-eref-style)
+ (beep))))))
-(defun sc-electric-mode (&optional arg)
- "
-Mode for viewing Supercite reference headers. Commands are:
+(defun sc-electric-mode (&optional style)
+ "Mode for viewing Supercite reference headers. Commands are:
\n\\{sc-electric-mode-map}
`sc-electric-mode' is not intended to be run interactively, but rather
accessed through Supercite's electric reference feature. See
-`sc-insert-reference' for more details. Optional ARG is the initial
+`sc-insert-reference' for more details. Optional STYLE is the initial
header style to use, unless not supplied or invalid, in which case
`sc-preferred-header-style' is used."
(let ((info sc-mail-info))
(setq sc-eref-style
- (or (sc-valid-index-p arg)
+ (or (sc-valid-index-p style)
(sc-valid-index-p sc-preferred-header-style)
0))
(use-local-map sc-electric-mode-map)
(sc-eref-show sc-eref-style)
(run-mode-hooks 'sc-electric-mode-hook)
- (recursive-edit)
- )))
+ (recursive-edit))))
(and sc-eref-style
(sc-eref-insert-selected))
- (kill-buffer sc-electric-bufname)
- ))
+ (kill-buffer sc-electric-bufname)))
;; functions for electric reference mode
(defun sc-eref-show (index)
((>= index last)
(if sc-electric-circular-p
0
- (progn (error msg "follow") (1- last))))
- ))
- (save-excursion
- (set-buffer sc-electric-bufname)
- (let ((buffer-read-only nil))
- (erase-buffer)
- (goto-char (point-min))
- (sc-eref-insert-selected)
- ;; now shrink the window to just contain the electric reference
- ;; header.
- (let ((hdrlines (count-lines (point-min) (point-max)))
- (winlines (1- (window-height))))
- (if (/= hdrlines winlines)
- (if (> hdrlines winlines)
- ;; we have to enlarge the window
- (enlarge-window (- hdrlines winlines))
- ;; we have to shrink the window
- (shrink-window (- winlines (max hdrlines window-min-height)))
- )))
- ))))
+ (progn (error msg "follow") (1- last))))))
+ (with-current-buffer sc-electric-bufname
+ (let ((inhibit-read-only t))
+ (erase-buffer)
+ (goto-char (point-min))
+ (sc-eref-insert-selected)
+ ;; now shrink the window to just contain the electric reference
+ ;; header.
+ (let ((hdrlines (count-lines (point-min) (point-max)))
+ (winlines (1- (window-height))))
+ (if (/= hdrlines winlines)
+ (if (> hdrlines winlines)
+ ;; we have to enlarge the window
+ (enlarge-window (- hdrlines winlines))
+ ;; we have to shrink the window
+ (shrink-window (- winlines (max hdrlines
+ window-min-height))))))))))
(defun sc-eref-next ()
"Display next reference in other buffer."
(if (sc-valid-index-p refnum)
(sc-eref-show refnum)
(error "Invalid reference: %d. (Range: [%d .. %d])"
- refnum 0 (1- (length sc-rewrite-header-list)))
- ))
+ refnum 0 (1- (length sc-rewrite-header-list)))))
(defun sc-eref-jump ()
"Set reference header to preferred header."
0)))
(if sc-electric-references-p
(sc-electric-mode preference)
- (sc-eref-insert-selected t)
- ))))
+ (sc-eref-insert-selected t)))))
\f
;; ======================================================================
;; ======================================================================
;; published interface to mail and news readers
-(define-minor-mode sc-minor-mode
- "Supercite minor mode."
+(define-minor-mode sc-minor-mode nil
:group 'supercite
:lighter (" SC" (sc-auto-fill-region-p
(":f" (sc-fixup-whitespace-p "w"))
5) Mark is at the end of the body of text to be cited.
-For Emacs 19's, the region need not be active (and typically isn't
-when this function is called. Also, the hook `sc-pre-hook' is run
-before, and `sc-post-hook' is run after the guts of this function."
+The region need not be active (and typically isn't when this
+function is called). Also, the hook `sc-pre-hook' is run before,
+and `sc-post-hook' is run after the guts of this function."
(run-hooks 'sc-pre-hook)
(sc-minor-mode 1)
;; finally, free the point-marker
(set-marker point nil)
- (set-marker mark nil)
- )
+ (set-marker mark nil))
(run-hooks 'sc-post-hook))
\f
(while (< 0 arg)
(insert prefix)
(forward-line 1)
- (setq arg (1- arg))
- ))))
+ (setq arg (1- arg))))))
(defun sc-insert-citation (arg)
"Insert citation string at beginning of current line if not already cited.
(insert (sc-mail-field "sc-citation"))
(error "Line is already cited"))))
-(defun sc-version (message)
- "Echo the current version of Supercite in the minibuffer.
-If MESSAGE is non-nil (interactively, with no prefix argument),
-inserts the version string in the current buffer instead."
- (interactive (not current-prefix-arg))
- (let ((verstr (format "Using Supercite.el %s" emacs-version)))
- (if message
- (message verstr)
- (insert "`sc-version' says: " verstr))))
-
(defun sc-describe ()
- "
-Supercite is a package which provides a flexible mechanism for citing
-email and news replies. Please see the associated texinfo file for
-more information. Info node `(SC)Top'."
+ "Read the Supercite info node."
(interactive)
- (describe-function 'sc-describe))
-
-(define-obsolete-function-alias 'sc-submit-bug-report 'report-emacs-bug "23.1")
+ (info "(SC)top"))
\f
;; useful stuff
(provide 'supercite)
(run-hooks 'sc-load-hook)
-;; arch-tag: a5d5bfa6-3bd5-4414-8c65-0afc83e45cd3
;;; supercite.el ends here
HCoop / bpt / emacs.git / blobdiff