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, 2007, 2008, 2009, 2010 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 3 of the License, or
16 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
28 ;; The following defines an association list for text to be
29 ;; automatically inserted when a new file is created, and a function
30 ;; which automatically inserts these files; the idea is to insert
31 ;; default text much as the mode is automatically set using
35 ;; (add-hook 'find-file-hook 'auto-insert)
36 ;; setq auto-insert-directory to an appropriate slash-terminated value
38 ;; You can also customize the variable `auto-insert-mode' to load the
39 ;; package. Alternatively, add the following to your .emacs file:
40 ;; (auto-insert-mode 1)
42 ;; Author: Charlie Martin
43 ;; Department of Computer Science and
44 ;; National Biomedical Simulation Resource
46 ;; Duke University Medical Center
48 ;; (crm@cs.duke.edu,mcnc!duke!crm)
52 (defgroup auto-insert nil
53 "Automatic mode-dependent insertion of text into new files."
54 :prefix "auto-insert-"
57 :link '(custom-manual "(autotype) Autoinserting"))
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-hook '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 (file-name-sans-extension buffer-file-name))
98 (file-name-extension buffer-file-name)))
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-value '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") | (progn user-full-name)
141 .\\\" You may distribute this file under the terms of the GNU Free
142 .\\\" Documentation License.
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") | (progn user-full-name) "
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 "%12s: %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 program 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 3 of the License, or
191 \;; (at your option) any later version.
193 \;; This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
210 (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
212 \;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n")
213 (("\\.texi\\(nfo\\)?\\'" . "Texinfo file skeleton")
215 "\\input texinfo @c -*-texinfo-*-
216 @c %**start of header
218 (file-name-sans-extension
219 (file-name-nondirectory (buffer-file-name))) ".info\n"
223 (setq short-description (read-string "Short description: "))
225 "Copyright @copyright{} " (substring (current-time-string) -4) " "
226 (getenv "ORGANIZATION") | (progn user-full-name) "
229 Permission is granted to copy, distribute and/or modify this document
230 under the terms of the GNU Free Documentation License, Version 1.3
231 or any later version published by the Free Software Foundation;
232 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
233 A copy of the license is included in the section entitled ``GNU
234 Free Documentation License''.
236 A copy of the license is also available from the Free Software
237 Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
241 The document was typeset with
242 @uref{http://www.texinfo.org/, GNU Texinfo}.
248 @subtitle " short-description "
249 @author " (getenv "ORGANIZATION") | (progn user-full-name)
250 " <" (progn user-mail-address) ">
252 @vskip 0pt plus 1filll
256 @c Output the table of the contents at the beginning.
266 @c Generate the nodes for this menu with `C-c C-u C-m'.
270 @c Update all node entries with `C-c C-u C-n'.
271 @c Insert new nodes with `C-c C-c n'.
277 @node Copying This Manual
278 @appendix Copying This Manual
281 * GNU Free Documentation License:: License for copying this manual.
284 @c Get fdl.texi from http://www.gnu.org/licenses/fdl.html
294 @c " (file-name-nondirectory (buffer-file-name)) " ends here\n"))
295 "A list specifying text to insert by default into a new file.
296 Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
297 CONDITION may be a regexp that must match the new file's name, or it may be
298 a symbol that must match the major mode for this element to apply.
299 Only the first matching element is effective.
300 Optional DESCRIPTION is a string for filling `auto-insert-prompt'.
301 ACTION may be a skeleton to insert (see `skeleton-insert'), an absolute
302 file-name or one relative to `auto-insert-directory' or a function to call.
303 ACTION may also be a vector containing several successive single actions as
304 described above, e.g. [\"header.insert\" date-and-author-update]."
309 ;; Establish a default value for auto-insert-directory
310 (defcustom auto-insert-directory "~/insert/"
311 "Directory from which auto-inserted files are taken.
312 The value must be an absolute directory name;
313 thus, on a GNU or Unix system, it must end in a slash."
319 (defun auto-insert ()
320 "Insert default contents into new files if variable `auto-insert' is non-nil.
321 Matches the visited file name against the elements of `auto-insert-alist'."
323 (and (not buffer-read-only)
324 (or (eq this-command 'auto-insert)
327 (let ((alist auto-insert-alist)
328 case-fold-search cond desc action)
330 ;; find first matching alist entry
332 (if (atom (setq cond (car (car alist))))
334 (setq desc (cdr cond)
336 (if (if (symbolp cond)
338 (and buffer-file-name
339 (string-match cond buffer-file-name)))
340 (setq action (cdr (car alist))
342 (setq alist (cdr alist))))
344 ;; Now, if we found something, do it
346 (or (not (stringp action))
347 (file-readable-p (expand-file-name
348 action auto-insert-directory)))
349 (or (not auto-insert-query)
350 (if (eq auto-insert-query 'function)
351 (eq this-command 'auto-insert))
352 (y-or-n-p (format auto-insert-prompt desc)))
357 (setq action (expand-file-name
358 action auto-insert-directory)))
359 (insert-file-contents action))
360 (save-window-excursion
361 ;; make buffer visible before skeleton or function
362 ;; which might ask the user for something
363 (switch-to-buffer (current-buffer))
364 (if (and (consp action)
365 (not (eq (car action) 'lambda)))
366 (skeleton-insert action)
371 (and (buffer-modified-p)
372 (not (eq this-command 'auto-insert))
373 (set-buffer-modified-p (eq auto-insert t)))))
374 ;; Return nil so that it could be used in
375 ;; `find-file-not-found-hooks', though that's probably inadvisable.
380 (defun define-auto-insert (condition action &optional after)
381 "Associate CONDITION with (additional) ACTION in `auto-insert-alist'.
382 Optional AFTER means to insert action after all existing actions for CONDITION,
383 or if CONDITION had no actions, after all other CONDITIONs."
384 (let ((elt (assoc condition auto-insert-alist)))
387 (if (vectorp (cdr elt))
388 (vconcat (if after (cdr elt))
389 (if (vectorp action) action (vector action))
390 (if after () (cdr elt)))
392 (vector (cdr elt) action)
393 (vector action (cdr elt)))))
395 (nconc auto-insert-alist (list (cons condition action)))
396 (push (cons condition action) auto-insert-alist)))))
399 (define-minor-mode auto-insert-mode
400 "Toggle Auto-insert mode.
401 With prefix ARG, turn Auto-insert mode on if and only if ARG is positive.
402 Returns the new status of Auto-insert mode (non-nil means on).
404 When Auto-insert mode is enabled, when new files are created you can
405 insert a template for the file depending on the mode of the buffer."
406 :global t :group 'auto-insert
408 (add-hook 'find-file-hook 'auto-insert)
409 (remove-hook 'find-file-hook 'auto-insert)))
411 (provide 'autoinsert)
413 ;; arch-tag: 5b6630ac-c735-43cf-b097-b78c622af909
414 ;;; autoinsert.el ends here