Refill some long/short copyright headers.
[bpt/emacs.git] / lisp / mh-e / mh-identity.el
index dc07675..7e8b857 100644 (file)
@@ -1,6 +1,6 @@
-;;; mh-identity.el --- Multiple identify support for MH-E.
+;;; mh-identity.el --- multiple identify support for MH-E
 
-;; Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
+;; Copyright (C) 2002-2011  Free Software Foundation, Inc.
 
 ;; Author: Peter S. Galbraith <psg@debian.org>
 ;; Maintainer: Bill Wohler <wohler@newt.com>
@@ -9,10 +9,10 @@
 
 ;; 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 2, 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., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
 ;; Multiple identity support for MH-E.
-;;
-;; Used to easily set different fields such as From and Organization, as
-;; well as different signature files.
-;;
-;; Customize the variable `mh-identity-list' and an Identity menu will
-;; appear in mh-letter-mode.  The command 'mh-insert-identity can be used
-;; from the command line.
+
+;; Used to easily set different fields such as From and Organization,
+;; as well as different signature files.
+
+;; Customize the variable `mh-identity-list' and see the Identity menu
+;; in MH-Letter mode. The command `mh-insert-identity' can be used
+;; to manually insert an identity.
 
 ;;; Change Log:
 
 ;;; Code:
 
-(eval-when-compile (require 'mh-acros))
-(mh-require-cl)
-(require 'mh-comp)
+(require 'mh-e)
 
 (autoload 'mml-insert-tag "mml")
 
 (defvar mh-identity-pgg-default-user-id nil
   "Holds the GPG key ID to be used by pgg.el.
-This is normally set as part of an Identity in `mh-identity-list'.")
+This is normally set as part of an Identity in
+`mh-identity-list'.")
 (make-variable-buffer-local 'mh-identity-pgg-default-user-id)
 
+(defvar mh-identity-menu nil
+  "The Identity menu.")
+
+(defalias 'mh-identity-make-menu-no-autoload 'mh-identity-make-menu)
+
 ;;;###mh-autoload
 (defun mh-identity-make-menu ()
   "Build the Identity menu.
-This should be called any time `mh-identity-list' or `mh-auto-fields-list'
-change."
+This should be called any time `mh-identity-list' or
+`mh-auto-fields-list' change.
+See `mh-identity-add-menu'."
   (easy-menu-define mh-identity-menu mh-letter-mode-map
     "MH-E identity menu"
     (append
@@ -85,13 +88,11 @@ change."
        ))))
 
 ;;;###mh-autoload
-(defun mh-identity-list-set (symbol value)
-  "Update the `mh-identity-list' variable, and rebuild the menu.
-Sets the default for SYMBOL (for example, `mh-identity-list') to VALUE (as set
-in customization). This is called after 'customize is used to alter
-`mh-identity-list'."
-  (set-default symbol value)
-  (mh-identity-make-menu))
+(defun mh-identity-add-menu ()
+  "Add the current Identity menu.
+See `mh-identity-make-menu'."
+  (if mh-identity-menu
+      (easy-menu-add mh-identity-menu)))
 
 (defvar mh-identity-local nil
   "Buffer-local variable that holds the identity currently in use.")
@@ -120,19 +121,24 @@ Return t if anything is deleted."
 
 (defun mh-identity-field-handler (field)
   "Return the handler for header FIELD or nil if none set.
-The field name is downcased. If the FIELD begins with the character
-`:', then it must have a special handler defined in
-`mh-identity-handlers', else return an error since it is not a valid
-header field."
-  (or (cdr (assoc (downcase field) mh-identity-handlers))
+The field name is downcased. If the FIELD begins with the
+character \":\", then it must have a special handler defined in
+`mh-identity-handlers', else return an error since it is not a
+valid header field."
+  (or (cdr (mh-assoc-string field mh-identity-handlers t))
       (and (eq (aref field 0) ?:)
-           (error (format "Field %s - unknown mh-identity-handler" field)))
+           (error "Field %s not found in `mh-identity-handlers'" field))
       (cdr (assoc ":default" mh-identity-handlers))
       'mh-identity-handler-default))
 
 ;;;###mh-autoload
-(defun mh-insert-identity (identity)
+(defun mh-insert-identity (identity &optional maybe-insert)
   "Insert fields specified by given IDENTITY.
+
+In a program, do not insert fields if MAYBE-INSERT is non-nil,
+`mh-identity-default' is non-nil, and fields have already been
+inserted.
+
 See `mh-identity-list'."
   (interactive
    (list (completing-read
@@ -141,36 +147,42 @@ See `mh-identity-list'."
               (cons '("None")
                     (mapcar 'list (mapcar 'car mh-identity-list)))
             (mapcar 'list (mapcar 'car mh-identity-list)))
-          nil t)))
-  (save-excursion
-    ;;First remove old settings, if any.
-    (when mh-identity-local
-      (let ((pers-list (cadr (assoc mh-identity-local mh-identity-list))))
-        (while pers-list
-          (let* ((field (caar pers-list))
-                 (handler (mh-identity-field-handler field)))
-            (funcall handler field 'remove))
-          (setq pers-list (cdr pers-list)))))
-    ;; Then insert the replacement
-    (when (not (equal "None" identity))
-      (let ((pers-list (cadr (assoc identity mh-identity-list))))
-        (while pers-list
-          (let* ((field (caar pers-list))
-                 (value (cdar pers-list))
-                 (handler (mh-identity-field-handler field)))
-            (funcall handler field 'add value))
-          (setq pers-list (cdr pers-list))))))
-  ;; Remember what is in use in this buffer
-  (if (equal "None" identity)
-      (setq mh-identity-local nil)
-    (setq mh-identity-local identity)))
+          nil t)
+         nil))
+
+  (when (or (not maybe-insert)
+            (and (boundp 'mh-identity-default)
+                 mh-identity-default
+                 (not mh-identity-local)))
+    (save-excursion
+      ;;First remove old settings, if any.
+      (when mh-identity-local
+        (let ((pers-list (cadr (assoc mh-identity-local mh-identity-list))))
+          (while pers-list
+            (let* ((field (caar pers-list))
+                   (handler (mh-identity-field-handler field)))
+              (funcall handler field 'remove))
+            (setq pers-list (cdr pers-list)))))
+      ;; Then insert the replacement
+      (when (not (equal "None" identity))
+        (let ((pers-list (cadr (assoc identity mh-identity-list))))
+          (while pers-list
+            (let* ((field (caar pers-list))
+                   (value (cdar pers-list))
+                   (handler (mh-identity-field-handler field)))
+              (funcall handler field 'add value))
+            (setq pers-list (cdr pers-list))))))
+    ;; Remember what is in use in this buffer
+    (if (equal "None" identity)
+        (setq mh-identity-local nil)
+      (setq mh-identity-local identity))))
 
 ;;;###mh-autoload
 (defun mh-identity-handler-gpg-identity (field action &optional value)
   "Process header FIELD \":pgg-default-user-id\".
 The ACTION is one of 'remove or 'add. If 'add, the VALUE is added.
-The buffer-local variable `mh-identity-pgg-default-user-id' is set to VALUE
-when action 'add is selected."
+The buffer-local variable `mh-identity-pgg-default-user-id' is set to
+VALUE when action 'add is selected."
   (cond
    ((or (equal action 'remove)
         (not value)
@@ -182,7 +194,8 @@ when action 'add is selected."
 ;;;###mh-autoload
 (defun mh-identity-handler-signature (field action &optional value)
   "Process header FIELD \":signature\".
-The ACTION is one of 'remove or 'add. If 'add, the VALUE is added."
+The ACTION is one of 'remove or 'add. If 'add, the VALUE is
+added."
   (cond
    ((equal action 'remove)
     (when (and (markerp mh-identity-signature-start)
@@ -212,7 +225,8 @@ The ACTION is one of 'remove or 'add. If 'add, the VALUE is added."
 ;;;###mh-autoload
 (defun mh-identity-handler-attribution-verb (field action &optional value)
   "Process header FIELD \":attribution-verb\".
-The ACTION is one of 'remove or 'add. If 'add, the VALUE is added."
+The ACTION is one of 'remove or 'add. If 'add, the VALUE is
+added."
   (when (and (markerp mh-identity-attribution-verb-start)
              (markerp mh-identity-attribution-verb-end))
     (delete-region mh-identity-attribution-verb-start
@@ -241,9 +255,9 @@ If VALUE is nil, use `mh-extract-from-attribution-verb'."
 
 (defun mh-identity-handler-default (field action top &optional value)
   "Process header FIELD.
-The ACTION is one of 'remove or 'add. If TOP is non-nil, add the field and its
-VALUE at the top of the header, else add it at the bottom of the header. If
-action is 'add, the VALUE is added."
+The ACTION is one of 'remove or 'add. If TOP is non-nil, add the
+field and its VALUE at the top of the header, else add it at the
+bottom of the header. If action is 'add, the VALUE is added."
   (let ((field-colon (if (string-match "^.*:$" field)
                          field
                        (concat field ":"))))
@@ -263,29 +277,30 @@ action is 'add, the VALUE is added."
        (t
         (goto-char (point-min))
         (if (not top)
-           (mh-goto-header-end 0))
+            (mh-goto-header-end 0))
         (insert field-colon " " value "\n")))))))
 
 ;;;###mh-autoload
 (defun mh-identity-handler-top (field action &optional value)
   "Process header FIELD.
-The ACTION is one of 'remove or 'add. If 'add, the VALUE is added.
-If the field wasn't present, it is added to the top of the header."
+The ACTION is one of 'remove or 'add. If 'add, the VALUE is
+added. If the field wasn't present, it is added to the top of the
+header."
   (mh-identity-handler-default field action t value))
 
 ;;;###mh-autoload
 (defun mh-identity-handler-bottom (field action &optional value)
   "Process header FIELD.
-The ACTION is one of 'remove or 'add. If 'add, the VALUE is added.
-If the field wasn't present, it is added to the bottom of the header."
+The ACTION is one of 'remove or 'add. If 'add, the VALUE is
+added. If the field wasn't present, it is added to the bottom of
+the header."
   (mh-identity-handler-default field action nil value))
 
 (provide 'mh-identity)
 
-;;; Local Variables:
-;;; indent-tabs-mode: nil
-;;; sentence-end-double-space: nil
-;;; End:
+;; Local Variables:
+;; indent-tabs-mode: nil
+;; sentence-end-double-space: nil
+;; End:
 
-;;; arch-tag: 07d66ef6-8726-4ac6-9ecf-e566cd5bfb45
 ;;; mh-identity.el ends here