;;; autoinsert.el --- automatic mode-dependent insertion of text into new files
-;; Copyright (C) 1985, 1986, 1987, 1994, 1995 Free Software Foundation, Inc.
+
+;; Copyright (C) 1985, 86, 87, 94, 95, 98 Free Software Foundation, Inc.
;; Author: Charlie Martin <crm@cs.duke.edu>
-;; Adapted-By: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389
+;; Adapted-By: Daniel Pfeiffer <occitan@esperanto.org>
+;; Keywords: convenience
+;; Maintainer: FSF
;; This file is part of GNU Emacs.
;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; 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.
;;; Commentary:
;; default text much as the mode is automatically set using
;; auto-mode-alist.
;;
-;; To use:
+;; To use:
;; (add-hook 'find-file-hooks 'auto-insert)
;; setq auto-insert-directory to an appropriate slash-terminated value
;;
+;; You can also customize the variable `auto-insert-mode' to load the
+;; package. Alternatively, add the following to your .emacs file:
+;; (auto-insert-mode 1)
+;;
;; Author: Charlie Martin
;; Department of Computer Science and
;; National Biomedical Simulation Resource
;; Box 3709
;; Duke University Medical Center
;; Durham, NC 27710
-;; (crm@cs.duke.edu,mcnc!duke!crm)
+;; (crm@cs.duke.edu,mcnc!duke!crm)
;;; Code:
-(defvar auto-insert 'not-modified
- "*Controls automatic insertion into newly found empty files:
+(defgroup auto-insert nil
+ "Automatic mode-dependent insertion of text into new files."
+ :prefix "auto-insert-"
+ :group 'files
+ :group 'convenience)
+
+
+(defcustom auto-insert-mode nil
+ "Toggle Auto-insert mode.
+Setting this variable directly does not take effect;
+use either \\[customize] or the function `auto-insert-mode'."
+ :set (lambda (symbol value)
+ (auto-insert-mode (or value 0)))
+ :initialize 'custom-initialize-default
+ :type 'boolean
+ :group 'auto-insert
+ :require 'autoinsert)
+
+(defcustom auto-insert 'not-modified
+ "*Controls automatic insertion into newly found empty files.
+Possible values:
nil do nothing
t insert if possible
other insert if possible, but mark as unmodified.
save it with \\[write-file] RET.
This variable is used when `auto-insert' is called as a function, e.g.
when you do (add-hook 'find-file-hooks 'auto-insert).
-With \\[auto-insert], this is always treated as if it were `t'.")
-
-
-(defvar auto-insert-query 'function
- "*If non-`nil', ask user before auto-inserting.
-When this is `function', only ask when called non-interactively.")
-
-
-(defvar auto-insert-prompt "Perform %s auto-insertion? "
+With \\[auto-insert], this is always treated as if it were t."
+ :type '(choice (const :tag "Insert if possible" t)
+ (const :tag "Do nothing" nil)
+ (other :tag "insert if possible, mark as unmodified."
+ not-modified))
+ :group 'auto-insert)
+
+(defcustom auto-insert-query 'function
+ "*Non-nil means ask user before auto-inserting.
+When this is `function', only ask when called non-interactively."
+ :type '(choice (const :tag "Don't ask" nil)
+ (const :tag "Ask if called non-interactively" function)
+ (other :tag "Ask" t))
+ :group 'auto-insert)
+
+(defcustom auto-insert-prompt "Perform %s auto-insertion? "
"*Prompt to use when querying whether to auto-insert.
-If this contains a %s, that will be replaced by the matching rule.")
+If this contains a %s, that will be replaced by the matching rule."
+ :type 'string
+ :group 'auto-insert)
-(defvar auto-insert-alist
+(defcustom auto-insert-alist
'((("\\.\\([Hh]\\|hh\\|hpp\\)\\'" . "C / C++ header")
(upcase (concat (file-name-nondirectory
(substring buffer-file-name 0 (match-beginning 0)))
;; Author: " (user-full-name)
'(if (search-backward "&" (save-excursion (beginning-of-line 1) (point)) t)
(replace-match (capitalize (user-login-name)) t t))
-'(end-of-line 1) " <" (user-login-name) ?@ (system-name) ">
+'(end-of-line 1) " <" (progn user-mail-address) ">
;; Keywords: "
'(require 'finder)
;;'(setq v1 (apply 'vector (mapcar 'car finder-known-keywords)))
(completing-read "Keyword, C-h: " v1 nil t))
str ", ") & -2 "
-;; This file is part of GNU Emacs.
-
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; This file 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.
-;; GNU Emacs is distributed in the hope that it will be useful,
+;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
;;; Commentary:
ACTION may be a skeleton to insert (see `skeleton-insert'), an absolute
file-name or one relative to `auto-insert-directory' or a function to call.
ACTION may also be a vector containing several successive single actions as
-described above, e.g. [\"header.insert\" date-and-author-update].")
+described above, e.g. [\"header.insert\" date-and-author-update]."
+ :type 'sexp
+ :group 'auto-insert)
;; Establish a default value for auto-insert-directory
-(defvar auto-insert-directory "~/insert/"
- "*Directory from which auto-inserted files are taken.")
+(defcustom auto-insert-directory "~/insert/"
+ "*Directory from which auto-inserted files are taken."
+ :type 'directory
+ :group 'auto-insert)
;;;###autoload
(vector action))))
(and (buffer-modified-p)
(not (eq this-command 'auto-insert))
- (set-buffer-modified-p (eq auto-insert t))))))
+ (set-buffer-modified-p (eq auto-insert t)))))
+ ;; Return nil so that it could be used in
+ ;; `find-file-not-found-hooks', though that's probably inadvisable.
+ nil)
;;;###autoload
-(defun define-auto-insert (key action &optional after)
+(defun define-auto-insert (condition action &optional after)
"Associate CONDITION with (additional) ACTION in `auto-insert-alist'.
Optional AFTER means to insert action after all existing actions for CONDITION,
or if CONDITION had no actions, after all other CONDITIONs."
- (let ((elt (assoc key auto-insert-alist)))
+ (let ((elt (assoc condition auto-insert-alist)))
(if elt
(setcdr elt
(if (vectorp (cdr elt))
(vector (cdr elt) action)
(vector action (cdr elt)))))
(if after
- (nconc auto-insert-alist (list (cons key action)))
- (setq auto-insert-alist (cons (cons key action)
+ (nconc auto-insert-alist (list (cons condition action)))
+ (setq auto-insert-alist (cons (cons condition action)
auto-insert-alist))))))
+;;;###autoload
+(defun auto-insert-mode (&optional arg)
+ "Toggle Auto-insert mode.
+With prefix ARG, turn Auto-insert mode on if and only if ARG is positive.
+Returns the new status of Auto-insert mode (non-nil means on).
+
+When Auto-insert mode is enabled, when new files are created you can
+insert a template for the file depending on the mode of the buffer."
+ (interactive "P")
+ (let ((on-p (if arg
+ (> (prefix-numeric-value arg) 0)
+ (not auto-insert-mode))))
+ (if on-p
+ (add-hook 'find-file-hooks 'auto-insert)
+ (remove-hook 'find-file-hooks 'auto-insert))
+ (if (interactive-p)
+ (message "Auto-insert now %s." (if on-p "on" "off")))
+ (setq auto-insert-mode on-p)))
+
+(if auto-insert-mode
+ (auto-insert-mode 1))
+
+(provide 'autoinsert)
+
;;; autoinsert.el ends here