1 ;;; autoinsert.el --- automatic mode-dependent insertion of text into new files
3 ;; Copyright (C) 1985, 86, 87, 94, 95, 98, 2000, 03 Free Software Foundation, Inc.
5 ;; Author: Charlie Martin <crm@cs.duke.edu>
6 ;; Adapted-By: Daniel Pfeiffer <occitan@esperanto.org>
7 ;; Keywords: convenience
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; The following defines an association list for text to be
30 ;; automatically inserted when a new file is created, and a function
31 ;; which automatically inserts these files; the idea is to insert
32 ;; default text much as the mode is automatically set using
36 ;; (add-hook 'find-file-hooks 'auto-insert)
37 ;; setq auto-insert-directory to an appropriate slash-terminated value
39 ;; You can also customize the variable `auto-insert-mode' to load the
40 ;; package. Alternatively, add the following to your .emacs file:
41 ;; (auto-insert-mode 1)
43 ;; Author: Charlie Martin
44 ;; Department of Computer Science and
45 ;; National Biomedical Simulation Resource
47 ;; Duke University Medical Center
49 ;; (crm@cs.duke.edu,mcnc!duke!crm)
53 (defgroup auto-insert nil
54 "Automatic mode-dependent insertion of text into new files."
55 :prefix "auto-insert-"
60 (defcustom auto-insert 'not-modified
61 "*Controls automatic insertion into newly found empty files.
65 other insert if possible, but mark as unmodified.
66 Insertion is possible when something appropriate is found in
67 `auto-insert-alist'. When the insertion is marked as unmodified, you can
68 save it with \\[write-file] RET.
69 This variable is used when the function `auto-insert' is called, e.g.
70 when you do (add-hook 'find-file-hooks 'auto-insert).
71 With \\[auto-insert], this is always treated as if it were t."
72 :type '(choice (const :tag "Insert if possible" t)
73 (const :tag "Do nothing" nil)
74 (other :tag "insert if possible, mark as unmodified."
78 (defcustom auto-insert-query 'function
79 "*Non-nil means ask user before auto-inserting.
80 When this is `function', only ask when called non-interactively."
81 :type '(choice (const :tag "Don't ask" nil)
82 (const :tag "Ask if called non-interactively" function)
86 (defcustom auto-insert-prompt "Perform %s auto-insertion? "
87 "*Prompt to use when querying whether to auto-insert.
88 If this contains a %s, that will be replaced by the matching rule."
93 (defcustom auto-insert-alist
94 '((("\\.\\([Hh]\\|hh\\|hpp\\)\\'" . "C / C++ header")
95 (upcase (concat (file-name-nondirectory
96 (substring buffer-file-name 0 (match-beginning 0)))
98 (substring buffer-file-name (1+ (match-beginning 0)))))
100 "#define " str "\n\n"
103 (("\\.\\([Cc]\\|cc\\|cpp\\)\\'" . "C / C++ program")
106 (let ((stem (file-name-sans-extension buffer-file-name)))
107 (cond ((file-exists-p (concat stem ".h"))
108 (file-name-nondirectory (concat stem ".h")))
109 ((file-exists-p (concat stem ".hh"))
110 (file-name-nondirectory (concat stem ".hh")))))
113 (("[Mm]akefile\\'" . "Makefile") . "makefile.inc")
115 (html-mode . (lambda () (sgml-tag "html")))
117 (plain-tex-mode . "tex-insert.tex")
118 (bibtex-mode . "tex-insert.tex")
120 ;; should try to offer completing read for these
122 "\\documentclass[" str & ?\] | -1
123 ?{ (read-string "class: ") "}\n"
125 "\\usepackage[" (read-string "options, RET: ") & ?\] | -1 ?{ str "}\n")
126 _ "\n\\begin{document}\n" _
129 (("/bin/.*[^/]\\'" . "Shell-Script mode magic number")
131 (if (eq major-mode default-major-mode)
134 (ada-mode . ada-header)
136 (("\\.[1-9]\\'" . "Man page skeleton")
137 "Short description: "
138 ".\\\" Copyright (C), " (substring (current-time-string) -4) " "
139 (getenv "ORGANIZATION") | "Free Software Foundation, Inc."
141 .\\\" You may distribute this file under the terms of the GNU Free
142 .\\\" Documentation Licence.
143 .TH " (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
144 " " (file-name-extension (buffer-file-name))
145 " " (format-time-string "%Y-%m-%d ")
147 (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
150 .B " (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
161 '(if (search-backward "&" (line-beginning-position) t)
162 (replace-match (capitalize (user-login-name)) t t))
163 '(end-of-line 1) " <" (progn user-mail-address) ">\n")
165 (("\\.el\\'" . "Emacs Lisp header")
166 "Short description: "
167 ";;; " (file-name-nondirectory (buffer-file-name)) " --- " str "
169 ;; Copyright (C) " (substring (current-time-string) -4) " "
170 (getenv "ORGANIZATION") | "Free Software Foundation, Inc." "
172 ;; Author: " (user-full-name)
173 '(if (search-backward "&" (line-beginning-position) t)
174 (replace-match (capitalize (user-login-name)) t t))
175 '(end-of-line 1) " <" (progn user-mail-address) ">
178 ;;'(setq v1 (apply 'vector (mapcar 'car finder-known-keywords)))
179 '(setq v1 (mapcar (lambda (x) (list (symbol-name (car x))))
180 finder-known-keywords)
181 v2 (mapconcat (lambda (x) (format "%10.0s: %s" (car x) (cdr x)))
182 finder-known-keywords
184 ((let ((minibuffer-help-form v2))
185 (completing-read "Keyword, C-h: " v1 nil t))
188 ;; This file is free software; you can redistribute it and/or modify
189 ;; it under the terms of the GNU General Public License as published by
190 ;; the Free Software Foundation; either version 2, or (at your option)
191 ;; any later version.
193 ;; This file is distributed in the hope that it will be useful,
194 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
195 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
196 ;; GNU General Public License for more details.
198 ;; You should have received a copy of the GNU General Public License
199 ;; along with GNU Emacs; see the file COPYING. If not, write to
200 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
201 ;; Boston, MA 02111-1307, USA.
212 (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
214 ;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n"))
215 "A list specifying text to insert by default into a new file.
216 Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
217 CONDITION maybe a regexp that must match the new file's name, or it may be
218 a symbol that must match the major mode for this element to apply.
219 Only the first matching element is effective.
220 Optional DESCRIPTION is a string for filling `auto-insert-prompt'.
221 ACTION may be a skeleton to insert (see `skeleton-insert'), an absolute
222 file-name or one relative to `auto-insert-directory' or a function to call.
223 ACTION may also be a vector containing several successive single actions as
224 described above, e.g. [\"header.insert\" date-and-author-update]."
229 ;; Establish a default value for auto-insert-directory
230 (defcustom auto-insert-directory "~/insert/"
231 "*Directory from which auto-inserted files are taken.
232 The value must be an absolute directory name;
233 thus, on a GNU or Unix system, it must end in a slash."
239 (defun auto-insert ()
240 "Insert default contents into new files if variable `auto-insert' is non-nil.
241 Matches the visited file name against the elements of `auto-insert-alist'."
243 (and (not buffer-read-only)
244 (or (eq this-command 'auto-insert)
247 (let ((alist auto-insert-alist)
248 case-fold-search cond desc action)
250 ;; find first matching alist entry
252 (if (atom (setq cond (car (car alist))))
254 (setq desc (cdr cond)
256 (if (if (symbolp cond)
258 (and buffer-file-name
259 (string-match cond buffer-file-name)))
260 (setq action (cdr (car alist))
262 (setq alist (cdr alist))))
264 ;; Now, if we found something, do it
267 (file-readable-p (concat auto-insert-directory action))
269 (if auto-insert-query
270 (or (if (eq auto-insert-query 'function)
271 (eq this-command 'auto-insert))
272 (y-or-n-p (format auto-insert-prompt desc)))
278 (setq action (concat auto-insert-directory action)))
279 (insert-file-contents action))
280 (save-window-excursion
281 ;; make buffer visible before skeleton or function
282 ;; which might ask the user for something
283 (switch-to-buffer (current-buffer))
284 (if (and (consp action)
285 (not (eq (car action) 'lambda)))
286 (skeleton-insert action)
291 (and (buffer-modified-p)
292 (not (eq this-command 'auto-insert))
293 (set-buffer-modified-p (eq auto-insert t)))))
294 ;; Return nil so that it could be used in
295 ;; `find-file-not-found-hooks', though that's probably inadvisable.
300 (defun define-auto-insert (condition action &optional after)
301 "Associate CONDITION with (additional) ACTION in `auto-insert-alist'.
302 Optional AFTER means to insert action after all existing actions for CONDITION,
303 or if CONDITION had no actions, after all other CONDITIONs."
304 (let ((elt (assoc condition auto-insert-alist)))
307 (if (vectorp (cdr elt))
308 (vconcat (if after (cdr elt))
309 (if (vectorp action) action (vector action))
310 (if after () (cdr elt)))
312 (vector (cdr elt) action)
313 (vector action (cdr elt)))))
315 (nconc auto-insert-alist (list (cons condition action)))
316 (setq auto-insert-alist (cons (cons condition action)
317 auto-insert-alist))))))
320 (define-minor-mode auto-insert-mode
321 "Toggle Auto-insert mode.
322 With prefix ARG, turn Auto-insert mode on if and only if ARG is positive.
323 Returns the new status of Auto-insert mode (non-nil means on).
325 When Auto-insert mode is enabled, when new files are created you can
326 insert a template for the file depending on the mode of the buffer."
327 :global t :group 'auto-insert
329 (add-hook 'find-file-hooks 'auto-insert)
330 (remove-hook 'find-file-hooks 'auto-insert)))
332 (provide 'autoinsert)
334 ;;; autoinsert.el ends here