[bpt/emacs.git] / lisp / autoinsert.el

;;; autoinsert.el --- automatic mode-dependent insertion of text into new files

;; Copyright (C) 1985, 1986, 1987, 1994, 1995, 1998, 2000, 2002, 2003,
;;   2004, 2005, 2006 Free Software Foundation, Inc.

;; Author: Charlie Martin <crm@cs.duke.edu>
;; Adapted-By: Daniel Pfeiffer <occitan@esperanto.org>
;; Keywords: convenience
;; Maintainer: FSF

;; This file is part of GNU Emacs.

;; 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.

;; GNU Emacs 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, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;;  The following defines an association list for text to be
;;  automatically inserted when a new file is created, and a function
;;  which automatically inserts these files; the idea is to insert
;;  default text much as the mode is automatically set using
;;  auto-mode-alist.
;;
;;  To use:
;;     (add-hook 'find-file-hook '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)

;;; Code:

(defgroup auto-insert nil
  "Automatic mode-dependent insertion of text into new files."
  :prefix "auto-insert-"
  :group 'files
  :group 'convenience)


(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.
Insertion is possible when something appropriate is found in
`auto-insert-alist'.  When the insertion is marked as unmodified, you can
save it with  \\[write-file] RET.
This variable is used when the function `auto-insert' is called, e.g.
when you do (add-hook 'find-file-hook 'auto-insert).
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."
  :type 'string
  :group 'auto-insert)


(defcustom auto-insert-alist
  '((("\\.\\([Hh]\\|hh\\|hpp\\)\\'" . "C / C++ header")
     (upcase (concat (file-name-nondirectory
		      (substring buffer-file-name 0 (match-beginning 0)))
		     "_"
		     (substring buffer-file-name (1+ (match-beginning 0)))))
     "#ifndef " str \n
     "#define " str "\n\n"
     _ "\n\n#endif")

    (("\\.\\([Cc]\\|cc\\|cpp\\)\\'" . "C / C++ program")
     nil
     "#include \""
     (let ((stem (file-name-sans-extension buffer-file-name)))
       (cond ((file-exists-p (concat stem ".h"))
	      (file-name-nondirectory (concat stem ".h")))
	     ((file-exists-p (concat stem ".hh"))
	      (file-name-nondirectory (concat stem ".hh")))))
     & ?\" | -10)

    (("[Mm]akefile\\'" . "Makefile") . "makefile.inc")

    (html-mode . (lambda () (sgml-tag "html")))

    (plain-tex-mode . "tex-insert.tex")
    (bibtex-mode . "tex-insert.tex")
    (latex-mode
     ;; should try to offer completing read for these
     "options, RET: "
     "\\documentclass[" str & ?\] | -1
     ?{ (read-string "class: ") "}\n"
     ("package, %s: "
      "\\usepackage[" (read-string "options, RET: ") & ?\] | -1 ?{ str "}\n")
     _ "\n\\begin{document}\n" _
     "\n\\end{document}")

    (("/bin/.*[^/]\\'" . "Shell-Script mode magic number")
     lambda ()
       (if (eq major-mode default-major-mode)
	 (sh-mode)))

    (ada-mode . ada-header)

    (("\\.[1-9]\\'" . "Man page skeleton")
     "Short description: "
     ".\\\" Copyright (C), " (substring (current-time-string) -4) "  "
     (getenv "ORGANIZATION") | (progn user-full-name)
     "
.\\\" You may distribute this file under the terms of the GNU Free
.\\\" Documentation License.
.TH " (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
     " " (file-name-extension (buffer-file-name))
     " " (format-time-string "%Y-%m-%d ")
     "\n.SH NAME\n"
     (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
     " \\- " str
     "\n.SH SYNOPSIS
.B " (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
     "\n"
     _
     "
.SH DESCRIPTION
.SH OPTIONS
.SH FILES
.SH \"SEE ALSO\"
.SH BUGS
.SH AUTHOR
" (user-full-name)
     '(if (search-backward "&" (line-beginning-position) t)
	  (replace-match (capitalize (user-login-name)) t t))
     '(end-of-line 1) " <" (progn user-mail-address) ">\n")

    (("\\.el\\'" . "Emacs Lisp header")
     "Short description: "
     ";;; " (file-name-nondirectory (buffer-file-name)) " --- " str "

;; Copyright (C) " (substring (current-time-string) -4) "  "
 (getenv "ORGANIZATION") | (progn user-full-name) "

;; Author: " (user-full-name)
'(if (search-backward "&" (line-beginning-position) t)
     (replace-match (capitalize (user-login-name)) t t))
'(end-of-line 1) " <" (progn user-mail-address) ">
;; Keywords: "
 '(require 'finder)
 ;;'(setq v1 (apply 'vector (mapcar 'car finder-known-keywords)))
 '(setq v1 (mapcar (lambda (x) (list (symbol-name (car x))))
		   finder-known-keywords)
	v2 (mapconcat (lambda (x) (format "%10.0s:  %s" (car x) (cdr x)))
	   finder-known-keywords
	   "\n"))
 ((let ((minibuffer-help-form v2))
    (completing-read "Keyword, C-h: " v1 nil t))
    str ", ") & -2 "

;; 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.

;; 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, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; " _ "

;;; Code:


\(provide '"
       (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
       ")
;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n"))
  "A list specifying text to insert by default into a new file.
Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
CONDITION maybe a regexp that must match the new file's name, or it may be
a symbol that must match the major mode for this element to apply.
Only the first matching element is effective.
Optional DESCRIPTION is a string for filling `auto-insert-prompt'.
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]."
  :type 'sexp
  :group 'auto-insert)


;; Establish a default value for auto-insert-directory
(defcustom auto-insert-directory "~/insert/"
  "*Directory from which auto-inserted files are taken.
The value must be an absolute directory name;
thus, on a GNU or Unix system, it must end in a slash."
  :type 'directory
  :group 'auto-insert)


;;;###autoload
(defun auto-insert ()
  "Insert default contents into new files if variable `auto-insert' is non-nil.
Matches the visited file name against the elements of `auto-insert-alist'."
  (interactive)
  (and (not buffer-read-only)
       (or (eq this-command 'auto-insert)
	   (and auto-insert
		(bobp) (eobp)))
       (let ((alist auto-insert-alist)
	     case-fold-search cond desc action)
	 (goto-char 1)
	 ;; find first matching alist entry
	 (while alist
	   (if (atom (setq cond (car (car alist))))
	       (setq desc cond)
	     (setq desc (cdr cond)
		   cond (car cond)))
	   (if (if (symbolp cond)
		   (eq cond major-mode)
		 (and buffer-file-name
		      (string-match cond buffer-file-name)))
	       (setq action (cdr (car alist))
		     alist nil)
	     (setq alist (cdr alist))))

	 ;; Now, if we found something, do it
	 (and action
	      (if (stringp action)
		  (file-readable-p (concat auto-insert-directory action))
		t)
	      (if auto-insert-query
		  (or (if (eq auto-insert-query 'function)
			  (eq this-command 'auto-insert))
		      (y-or-n-p (format auto-insert-prompt desc)))
		t)
	      (mapcar
	       (lambda (action)
		 (if (stringp action)
		     (if (file-readable-p
			  (setq action (concat auto-insert-directory action)))
			 (insert-file-contents action))
		   (save-window-excursion
		     ;; make buffer visible before skeleton or function
		     ;; which might ask the user for something
		     (switch-to-buffer (current-buffer))
		     (if (and (consp action)
			      (not (eq (car action) 'lambda)))
			 (skeleton-insert action)
		       (funcall action)))))
	       (if (vectorp action)
		   action
		 (vector action))))
	 (and (buffer-modified-p)
	      (not (eq this-command 'auto-insert))
	      (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 (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 condition auto-insert-alist)))
    (if elt
	(setcdr elt
		(if (vectorp (cdr elt))
		    (vconcat (if after (cdr elt))
			     (if (vectorp action) action (vector action))
			     (if after () (cdr elt)))
		  (if after
		      (vector (cdr elt) action)
		    (vector action (cdr elt)))))
      (if after
	  (nconc auto-insert-alist (list (cons condition action)))
	(setq auto-insert-alist (cons (cons condition action)
				      auto-insert-alist))))))

;;;###autoload
(define-minor-mode auto-insert-mode
  "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."
  :global t :group 'auto-insert
  (if auto-insert-mode
      (add-hook 'find-file-hook 'auto-insert)
    (remove-hook 'find-file-hook 'auto-insert)))

(provide 'autoinsert)

;; arch-tag: 5b6630ac-c735-43cf-b097-b78c622af909
;;; autoinsert.el ends here
Commit	Line	Data
c0274f38	1	;;; autoinsert.el --- automatic mode-dependent insertion of text into new files
b578f267	2
0d30b337	3	;; Copyright (C) 1985, 1986, 1987, 1994, 1995, 1998, 2000, 2002, 2003,
aaef169d	4	;; 2004, 2005, 2006 Free Software Foundation, Inc.
9750e079	5
e5167999	6	;; Author: Charlie Martin <crm@cs.duke.edu>
3e910376	7	;; Adapted-By: Daniel Pfeiffer <occitan@esperanto.org>
f5f727f8	8	;; Keywords: convenience
4228277d	9	;; Maintainer: FSF
b1d6ae0b JB	10
	11	;; This file is part of GNU Emacs.
	12
	13	;; GNU Emacs is free software; you can redistribute it and/or modify
	14	;; it under the terms of the GNU General Public License as published by
e5167999	15	;; the Free Software Foundation; either version 2, or (at your option)
b1d6ae0b JB	16	;; any later version.
	17
	18	;; GNU Emacs is distributed in the hope that it will be useful,
	19	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	;; GNU General Public License for more details.
	22
	23	;; You should have received a copy of the GNU General Public License
b578f267	24	;; along with GNU Emacs; see the file COPYING. If not, write to the
a587bb3c LK	25	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a587bb3c LK	26	;; Boston, MA 02110-1301, USA.
b1d6ae0b	27
e5167999	28	;;; Commentary:
b1d6ae0b	29
c11af8a5 KH	30	;; The following defines an association list for text to be
	31	;; automatically inserted when a new file is created, and a function
	32	;; which automatically inserts these files; the idea is to insert
	33	;; default text much as the mode is automatically set using
	34	;; auto-mode-alist.
	35	;;
12394086	36	;; To use:
a702ffbb	37	;; (add-hook 'find-file-hook 'auto-insert)
c11af8a5 KH	38	;; setq auto-insert-directory to an appropriate slash-terminated value
c11af8a5 KH	39	;;
6c5b39e4 SE	40	;; You can also customize the variable `auto-insert-mode' to load the
	41	;; package. Alternatively, add the following to your .emacs file:
	42	;; (auto-insert-mode 1)
	43	;;
c11af8a5 KH	44	;; Author: Charlie Martin
	45	;; Department of Computer Science and
	46	;; National Biomedical Simulation Resource
	47	;; Box 3709
	48	;; Duke University Medical Center
	49	;; Durham, NC 27710
12394086	50	;; (crm@cs.duke.edu,mcnc!duke!crm)
b1d6ae0b	51
e5167999 ER	52	;;; Code:
e5167999 ER	53
6c5b39e4 SE	54	(defgroup auto-insert nil
	55	"Automatic mode-dependent insertion of text into new files."
	56	:prefix "auto-insert-"
f5f727f8 DN	57	:group 'files
f5f727f8 DN	58	:group 'convenience)
6c5b39e4 SE	59
6c5b39e4 SE	60
6c5b39e4	61	(defcustom auto-insert 'not-modified
12394086 DL	62	"*Controls automatic insertion into newly found empty files.
12394086 DL	63	Possible values:
c11af8a5 KH	64	nil do nothing
	65	t insert if possible
	66	other insert if possible, but mark as unmodified.
	67	Insertion is possible when something appropriate is found in
	68	`auto-insert-alist'. When the insertion is marked as unmodified, you can
	69	save it with \\[write-file] RET.
a461758e	70	This variable is used when the function `auto-insert' is called, e.g.
a702ffbb	71	when you do (add-hook 'find-file-hook 'auto-insert).
12394086	72	With \\[auto-insert], this is always treated as if it were t."
4605a50d DL	73	:type '(choice (const :tag "Insert if possible" t)
4605a50d DL	74	(const :tag "Do nothing" nil)
12394086	75	(other :tag "insert if possible, mark as unmodified."
4605a50d	76	not-modified))
6c5b39e4	77	:group 'auto-insert)
c11af8a5	78
6c5b39e4	79	(defcustom auto-insert-query 'function
12394086	80	"*Non-nil means ask user before auto-inserting.
6c5b39e4	81	When this is `function', only ask when called non-interactively."
5c213454 AS	82	:type '(choice (const :tag "Don't ask" nil)
	83	(const :tag "Ask if called non-interactively" function)
	84	(other :tag "Ask" t))
6c5b39e4	85	:group 'auto-insert)
c11af8a5	86
6c5b39e4	87	(defcustom auto-insert-prompt "Perform %s auto-insertion? "
c11af8a5	88	"*Prompt to use when querying whether to auto-insert.
6c5b39e4 SE	89	If this contains a %s, that will be replaced by the matching rule."
	90	:type 'string
	91	:group 'auto-insert)
c11af8a5 KH	92
c11af8a5 KH	93
6c5b39e4	94	(defcustom auto-insert-alist
c11af8a5 KH	95	'((("\\.\\([Hh]\\\|hh\\\|hpp\\)\\'" . "C / C++ header")
	96	(upcase (concat (file-name-nondirectory
	97	(substring buffer-file-name 0 (match-beginning 0)))
	98	"_"
	99	(substring buffer-file-name (1+ (match-beginning 0)))))
	100	"#ifndef " str \n
	101	"#define " str "\n\n"
	102	_ "\n\n#endif")
	103
	104	(("\\.\\([Cc]\\\|cc\\\|cpp\\)\\'" . "C / C++ program")
	105	nil
	106	"#include \""
f6ec1532 RS	107	(let ((stem (file-name-sans-extension buffer-file-name)))
	108	(cond ((file-exists-p (concat stem ".h"))
	109	(file-name-nondirectory (concat stem ".h")))
	110	((file-exists-p (concat stem ".hh"))
	111	(file-name-nondirectory (concat stem ".hh")))))
	112	& ?\" \| -10)
	113
	114	(("[Mm]akefile\\'" . "Makefile") . "makefile.inc")
c11af8a5	115
d60ae75c	116	(html-mode . (lambda () (sgml-tag "html")))
71296446	117
c11af8a5 KH	118	(plain-tex-mode . "tex-insert.tex")
	119	(bibtex-mode . "tex-insert.tex")
	120	(latex-mode
	121	;; should try to offer completing read for these
	122	"options, RET: "
47e58cf5	123	"\\documentclass[" str & ?\] \| -1
c11af8a5 KH	124	?{ (read-string "class: ") "}\n"
	125	("package, %s: "
	126	"\\usepackage[" (read-string "options, RET: ") & ?\] \| -1 ?{ str "}\n")
	127	_ "\n\\begin{document}\n" _
	128	"\n\\end{document}")
	129
	130	(("/bin/.*[^/]\\'" . "Shell-Script mode magic number")
	131	lambda ()
	132	(if (eq major-mode default-major-mode)
	133	(sh-mode)))
71296446	134
c11af8a5 KH	135	(ada-mode . ada-header)
c11af8a5 KH	136
bf9f5c17 DL	137	(("\\.[1-9]\\'" . "Man page skeleton")
	138	"Short description: "
	139	".\\\" Copyright (C), " (substring (current-time-string) -4) " "
12148b0e	140	(getenv "ORGANIZATION") \| (progn user-full-name)
bf9f5c17 DL	141	"
bf9f5c17 DL	142	.\\\" You may distribute this file under the terms of the GNU Free
2201b59a	143	.\\\" Documentation License.
bf9f5c17 DL	144	.TH " (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
	145	" " (file-name-extension (buffer-file-name))
	146	" " (format-time-string "%Y-%m-%d ")
	147	"\n.SH NAME\n"
	148	(file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
	149	" \\- " str
	150	"\n.SH SYNOPSIS
	151	.B " (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
	152	"\n"
	153	_
	154	"
	155	.SH DESCRIPTION
	156	.SH OPTIONS
	157	.SH FILES
	158	.SH \"SEE ALSO\"
	159	.SH BUGS
	160	.SH AUTHOR
	161	" (user-full-name)
	162	'(if (search-backward "&" (line-beginning-position) t)
	163	(replace-match (capitalize (user-login-name)) t t))
	164	'(end-of-line 1) " <" (progn user-mail-address) ">\n")
	165
c11af8a5 KH	166	(("\\.el\\'" . "Emacs Lisp header")
	167	"Short description: "
	168	";;; " (file-name-nondirectory (buffer-file-name)) " --- " str "
	169
2103c9fb	170	;; Copyright (C) " (substring (current-time-string) -4) " "
fbee29e6	171	(getenv "ORGANIZATION") \| (progn user-full-name) "
c11af8a5 KH	172
c11af8a5 KH	173	;; Author: " (user-full-name)
a461758e	174	'(if (search-backward "&" (line-beginning-position) t)
c11af8a5	175	(replace-match (capitalize (user-login-name)) t t))
c5f7d536	176	'(end-of-line 1) " <" (progn user-mail-address) ">
c11af8a5 KH	177	;; Keywords: "
	178	'(require 'finder)
	179	;;'(setq v1 (apply 'vector (mapcar 'car finder-known-keywords)))
	180	'(setq v1 (mapcar (lambda (x) (list (symbol-name (car x))))
	181	finder-known-keywords)
	182	v2 (mapconcat (lambda (x) (format "%10.0s: %s" (car x) (cdr x)))
	183	finder-known-keywords
	184	"\n"))
	185	((let ((minibuffer-help-form v2))
	186	(completing-read "Keyword, C-h: " v1 nil t))
	187	str ", ") & -2 "
	188
c5178e8e	189	;; This file is free software; you can redistribute it and/or modify
c11af8a5 KH	190	;; it under the terms of the GNU General Public License as published by
	191	;; the Free Software Foundation; either version 2, or (at your option)
	192	;; any later version.
	193
c5178e8e	194	;; This file is distributed in the hope that it will be useful,
c11af8a5 KH	195	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	196	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	197	;; GNU General Public License for more details.
	198
	199	;; You should have received a copy of the GNU General Public License
	200	;; along with GNU Emacs; see the file COPYING. If not, write to
086add15 LK	201	;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
086add15 LK	202	;; Boston, MA 02110-1301, USA.
c11af8a5 KH	203
	204	;;; Commentary:
	205
	206	;; " _ "
	207
	208	;;; Code:
	209
	210
	211
3c98b2e9 SM	212	\(provide '"
	213	(file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
	214	")
2103c9fb	215	;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n"))
b1d6ae0b	216	"A list specifying text to insert by default into a new file.
c11af8a5 KH	217	Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
	218	CONDITION maybe a regexp that must match the new file's name, or it may be
	219	a symbol that must match the major mode for this element to apply.
	220	Only the first matching element is effective.
	221	Optional DESCRIPTION is a string for filling `auto-insert-prompt'.
	222	ACTION may be a skeleton to insert (see `skeleton-insert'), an absolute
	223	file-name or one relative to `auto-insert-directory' or a function to call.
	224	ACTION may also be a vector containing several successive single actions as
6c5b39e4 SE	225	described above, e.g. [\"header.insert\" date-and-author-update]."
	226	:type 'sexp
	227	:group 'auto-insert)
b1d6ae0b	228
c11af8a5 KH	229
c11af8a5 KH	230	;; Establish a default value for auto-insert-directory
6c5b39e4	231	(defcustom auto-insert-directory "~/insert/"
66e0fd2b	232	"*Directory from which auto-inserted files are taken.
87810ca9 RS	233	The value must be an absolute directory name;
87810ca9 RS	234	thus, on a GNU or Unix system, it must end in a slash."
6c5b39e4 SE	235	:type 'directory
6c5b39e4 SE	236	:group 'auto-insert)
b1d6ae0b	237
c11af8a5 KH	238
	239	;;;###autoload
	240	(defun auto-insert ()
a461758e	241	"Insert default contents into new files if variable `auto-insert' is non-nil.
b1d6ae0b	242	Matches the visited file name against the elements of `auto-insert-alist'."
c11af8a5 KH	243	(interactive)
	244	(and (not buffer-read-only)
	245	(or (eq this-command 'auto-insert)
	246	(and auto-insert
	247	(bobp) (eobp)))
	248	(let ((alist auto-insert-alist)
	249	case-fold-search cond desc action)
	250	(goto-char 1)
	251	;; find first matching alist entry
	252	(while alist
	253	(if (atom (setq cond (car (car alist))))
	254	(setq desc cond)
	255	(setq desc (cdr cond)
	256	cond (car cond)))
	257	(if (if (symbolp cond)
	258	(eq cond major-mode)
a461758e DL	259	(and buffer-file-name
a461758e DL	260	(string-match cond buffer-file-name)))
c11af8a5 KH	261	(setq action (cdr (car alist))
	262	alist nil)
	263	(setq alist (cdr alist))))
	264
	265	;; Now, if we found something, do it
	266	(and action
	267	(if (stringp action)
	268	(file-readable-p (concat auto-insert-directory action))
	269	t)
	270	(if auto-insert-query
	271	(or (if (eq auto-insert-query 'function)
	272	(eq this-command 'auto-insert))
	273	(y-or-n-p (format auto-insert-prompt desc)))
	274	t)
	275	(mapcar
	276	(lambda (action)
	277	(if (stringp action)
	278	(if (file-readable-p
	279	(setq action (concat auto-insert-directory action)))
	280	(insert-file-contents action))
	281	(save-window-excursion
	282	;; make buffer visible before skeleton or function
	283	;; which might ask the user for something
	284	(switch-to-buffer (current-buffer))
	285	(if (and (consp action)
	286	(not (eq (car action) 'lambda)))
	287	(skeleton-insert action)
	288	(funcall action)))))
	289	(if (vectorp action)
	290	action
	291	(vector action))))
	292	(and (buffer-modified-p)
	293	(not (eq this-command 'auto-insert))
12394086 DL	294	(set-buffer-modified-p (eq auto-insert t)))))
	295	;; Return nil so that it could be used in
	296	;; `find-file-not-found-hooks', though that's probably inadvisable.
	297	nil)
c11af8a5 KH	298
	299
	300	;;;###autoload
4605a50d	301	(defun define-auto-insert (condition action &optional after)
c11af8a5 KH	302	"Associate CONDITION with (additional) ACTION in `auto-insert-alist'.
	303	Optional AFTER means to insert action after all existing actions for CONDITION,
	304	or if CONDITION had no actions, after all other CONDITIONs."
4605a50d	305	(let ((elt (assoc condition auto-insert-alist)))
c11af8a5 KH	306	(if elt
	307	(setcdr elt
	308	(if (vectorp (cdr elt))
	309	(vconcat (if after (cdr elt))
	310	(if (vectorp action) action (vector action))
	311	(if after () (cdr elt)))
	312	(if after
	313	(vector (cdr elt) action)
	314	(vector action (cdr elt)))))
	315	(if after
4605a50d DL	316	(nconc auto-insert-alist (list (cons condition action)))
4605a50d DL	317	(setq auto-insert-alist (cons (cons condition action)
c11af8a5	318	auto-insert-alist))))))
c0274f38	319
6c5b39e4	320	;;;###autoload
bff6da3d	321	(define-minor-mode auto-insert-mode
12394086 DL	322	"Toggle Auto-insert mode.
	323	With prefix ARG, turn Auto-insert mode on if and only if ARG is positive.
	324	Returns the new status of Auto-insert mode (non-nil means on).
6c5b39e4	325
12394086	326	When Auto-insert mode is enabled, when new files are created you can
6c5b39e4	327	insert a template for the file depending on the mode of the buffer."
44e70da2	328	:global t :group 'auto-insert
bff6da3d	329	(if auto-insert-mode
a702ffbb SM	330	(add-hook 'find-file-hook 'auto-insert)
a702ffbb SM	331	(remove-hook 'find-file-hook 'auto-insert)))
6c5b39e4	332
896546cd RS	333	(provide 'autoinsert)
896546cd RS	334
a702ffbb	335	;; arch-tag: 5b6630ac-c735-43cf-b097-b78c622af909
c0274f38	336	;;; autoinsert.el ends here