1 ;;; autoinsert.el --- automatic mode-dependent insertion of text into new files
3 ;; Copyright (C) 1985, 1986, 1987, 1994, 1995, 1998, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Charlie Martin <crm@cs.duke.edu>
7 ;; Adapted-By: Daniel Pfeiffer <occitan@esperanto.org>
8 ;; Keywords: convenience
11 ;; This file is part of GNU Emacs.
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
15 ;; the Free Software Foundation; either version 2, or (at your option)
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.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
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
37 ;; (add-hook 'find-file-hook 'auto-insert)
38 ;; setq auto-insert-directory to an appropriate slash-terminated value
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)
44 ;; Author: Charlie Martin
45 ;; Department of Computer Science and
46 ;; National Biomedical Simulation Resource
48 ;; Duke University Medical Center
50 ;; (crm@cs.duke.edu,mcnc!duke!crm)
54 (defgroup auto-insert nil
55 "Automatic mode-dependent insertion of text into new files."
56 :prefix "auto-insert-"
61 (defcustom auto-insert 'not-modified
62 "*Controls automatic insertion into newly found empty files.
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.
70 This variable is used when the function `auto-insert' is called, e.g.
71 when you do (add-hook 'find-file-hook 'auto-insert).
72 With \\[auto-insert], this is always treated as if it were t."
73 :type '(choice (const :tag "Insert if possible" t)
74 (const :tag "Do nothing" nil)
75 (other :tag "insert if possible, mark as unmodified."
79 (defcustom auto-insert-query 'function
80 "*Non-nil means ask user before auto-inserting.
81 When this is `function', only ask when called non-interactively."
82 :type '(choice (const :tag "Don't ask" nil)
83 (const :tag "Ask if called non-interactively" function)
87 (defcustom auto-insert-prompt "Perform %s auto-insertion? "
88 "*Prompt to use when querying whether to auto-insert.
89 If this contains a %s, that will be replaced by the matching rule."
94 (defcustom auto-insert-alist
95 '((("\\.\\([Hh]\\|hh\\|hpp\\)\\'" . "C / C++ header")
96 (upcase (concat (file-name-nondirectory
97 (substring buffer-file-name 0 (match-beginning 0)))
99 (substring buffer-file-name (1+ (match-beginning 0)))))
101 "#define " str "\n\n"
104 (("\\.\\([Cc]\\|cc\\|cpp\\)\\'" . "C / C++ program")
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")))))
114 (("[Mm]akefile\\'" . "Makefile") . "makefile.inc")
116 (html-mode . (lambda () (sgml-tag "html")))
118 (plain-tex-mode . "tex-insert.tex")
119 (bibtex-mode . "tex-insert.tex")
121 ;; should try to offer completing read for these
123 "\\documentclass[" str & ?\] | -1
124 ?{ (read-string "class: ") "}\n"
126 "\\usepackage[" (read-string "options, RET: ") & ?\] | -1 ?{ str "}\n")
127 _ "\n\\begin{document}\n" _
130 (("/bin/.*[^/]\\'" . "Shell-Script mode magic number")
132 (if (eq major-mode default-major-mode)
135 (ada-mode . ada-header)
137 (("\\.[1-9]\\'" . "Man page skeleton")
138 "Short description: "
139 ".\\\" Copyright (C), " (substring (current-time-string) -4) " "
140 (getenv "ORGANIZATION") | (progn user-full-name)
142 .\\\" You may distribute this file under the terms of the GNU Free
143 .\\\" Documentation License.
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 ")
148 (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
151 .B " (file-name-sans-extension (file-name-nondirectory (buffer-file-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")
166 (("\\.el\\'" . "Emacs Lisp header")
167 "Short description: "
168 ";;; " (file-name-nondirectory (buffer-file-name)) " --- " str "
170 ;; Copyright (C) " (substring (current-time-string) -4) " "
171 (getenv "ORGANIZATION") | (progn user-full-name) "
173 ;; Author: " (user-full-name)
174 '(if (search-backward "&" (line-beginning-position) t)
175 (replace-match (capitalize (user-login-name)) t t))
176 '(end-of-line 1) " <" (progn user-mail-address) ">
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
185 ((let ((minibuffer-help-form v2))
186 (completing-read "Keyword, C-h: " v1 nil t))
189 ;; This file is free software; you can redistribute it and/or modify
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.
194 ;; This file is distributed in the hope that it will be useful,
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.
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
201 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
202 ;; Boston, MA 02110-1301, USA.
213 (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
215 ;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n"))
216 "A list specifying text to insert by default into a new file.
217 Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
218 CONDITION may be 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
225 described above, e.g. [\"header.insert\" date-and-author-update]."
230 ;; Establish a default value for auto-insert-directory
231 (defcustom auto-insert-directory "~/insert/"
232 "*Directory from which auto-inserted files are taken.
233 The value must be an absolute directory name;
234 thus, on a GNU or Unix system, it must end in a slash."
240 (defun auto-insert ()
241 "Insert default contents into new files if variable `auto-insert' is non-nil.
242 Matches the visited file name against the elements of `auto-insert-alist'."
244 (and (not buffer-read-only)
245 (or (eq this-command 'auto-insert)
248 (let ((alist auto-insert-alist)
249 case-fold-search cond desc action)
251 ;; find first matching alist entry
253 (if (atom (setq cond (car (car alist))))
255 (setq desc (cdr cond)
257 (if (if (symbolp cond)
259 (and buffer-file-name
260 (string-match cond buffer-file-name)))
261 (setq action (cdr (car alist))
263 (setq alist (cdr alist))))
265 ;; Now, if we found something, do it
268 (file-readable-p (concat auto-insert-directory action))
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)))
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)
292 (and (buffer-modified-p)
293 (not (eq this-command 'auto-insert))
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.
301 (defun define-auto-insert (condition action &optional after)
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."
305 (let ((elt (assoc condition auto-insert-alist)))
308 (if (vectorp (cdr elt))
309 (vconcat (if after (cdr elt))
310 (if (vectorp action) action (vector action))
311 (if after () (cdr elt)))
313 (vector (cdr elt) action)
314 (vector action (cdr elt)))))
316 (nconc auto-insert-alist (list (cons condition action)))
317 (setq auto-insert-alist (cons (cons condition action)
318 auto-insert-alist))))))
321 (define-minor-mode auto-insert-mode
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).
326 When Auto-insert mode is enabled, when new files are created you can
327 insert a template for the file depending on the mode of the buffer."
328 :global t :group 'auto-insert
330 (add-hook 'find-file-hook 'auto-insert)
331 (remove-hook 'find-file-hook 'auto-insert)))
333 (provide 'autoinsert)
335 ;; arch-tag: 5b6630ac-c735-43cf-b097-b78c622af909
336 ;;; autoinsert.el ends here