1 ;;; autoinsert.el --- automatic mode-dependent insertion of text into new files
3 ;; Copyright (C) 1985-1987, 1994-1995, 1998, 2000-2014 Free Software
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 init 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), " (format-time-string "%Y") " "
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-base)
144 " " (file-name-extension (buffer-file-name))
145 " " (format-time-string "%Y-%m-%d ")
150 .B " (file-name-base)
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
168 (make-string (max 2 (- 80 (current-column) 27)) ?\s)
169 "-*- lexical-binding: t; -*-" '(setq lexical-binding t)
172 ;; Copyright (C) " (format-time-string "%Y") " "
173 (getenv "ORGANIZATION") | (progn user-full-name) "
175 ;; Author: " (user-full-name)
176 '(if (search-backward "&" (line-beginning-position) t)
177 (replace-match (capitalize (user-login-name)) t t))
178 '(end-of-line 1) " <" (progn user-mail-address) ">
181 ;;'(setq v1 (apply 'vector (mapcar 'car finder-known-keywords)))
182 '(setq v1 (mapcar (lambda (x) (list (symbol-name (car x))))
183 finder-known-keywords)
184 v2 (mapconcat (lambda (x) (format "%12s: %s" (car x) (cdr x)))
185 finder-known-keywords
187 ((let ((minibuffer-help-form v2))
188 (completing-read "Keyword, C-h: " v1 nil t))
191 \;; This program is free software; you can redistribute it and/or modify
192 \;; it under the terms of the GNU General Public License as published by
193 \;; the Free Software Foundation, either version 3 of the License, or
194 \;; (at your option) any later version.
196 \;; This program is distributed in the hope that it will be useful,
197 \;; but WITHOUT ANY WARRANTY; without even the implied warranty of
198 \;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
199 \;; GNU General Public License for more details.
201 \;; You should have received a copy of the GNU General Public License
202 \;; along with this program. If not, see <http://www.gnu.org/licenses/>.
215 \;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n")
216 (("\\.texi\\(nfo\\)?\\'" . "Texinfo file skeleton")
218 "\\input texinfo @c -*-texinfo-*-
219 @c %**start of header
221 (file-name-base) ".info\n"
225 (setq short-description (read-string "Short description: "))
227 "Copyright @copyright{} " (format-time-string "%Y") " "
228 (getenv "ORGANIZATION") | (progn user-full-name) "
231 Permission is granted to copy, distribute and/or modify this document
232 under the terms of the GNU Free Documentation License, Version 1.3
233 or any later version published by the Free Software Foundation;
234 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
235 A copy of the license is included in the section entitled ``GNU
236 Free Documentation License''.
238 A copy of the license is also available from the Free Software
239 Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
243 The document was typeset with
244 @uref{http://www.texinfo.org/, GNU Texinfo}.
250 @subtitle " short-description "
251 @author " (getenv "ORGANIZATION") | (progn user-full-name)
252 " <" (progn user-mail-address) ">
254 @vskip 0pt plus 1filll
258 @c Output the table of the contents at the beginning.
268 @c Generate the nodes for this menu with `C-c C-u C-m'.
272 @c Update all node entries with `C-c C-u C-n'.
273 @c Insert new nodes with `C-c C-c n'.
279 @node Copying This Manual
280 @appendix Copying This Manual
283 * GNU Free Documentation License:: License for copying this manual.
286 @c Get fdl.texi from http://www.gnu.org/licenses/fdl.html
296 @c " (file-name-nondirectory (buffer-file-name)) " ends here\n"))
297 "A list specifying text to insert by default into a new file.
298 Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
299 CONDITION may be a regexp that must match the new file's name, or it may be
300 a symbol that must match the major mode for this element to apply.
301 Only the first matching element is effective.
302 Optional DESCRIPTION is a string for filling `auto-insert-prompt'.
303 ACTION may be a skeleton to insert (see `skeleton-insert'), an absolute
304 file-name or one relative to `auto-insert-directory' or a function to call.
305 ACTION may also be a vector containing several successive single actions as
306 described above, e.g. [\"header.insert\" date-and-author-update]."
311 ;; Establish a default value for auto-insert-directory
312 (defcustom auto-insert-directory "~/insert/"
313 "Directory from which auto-inserted files are taken.
314 The value must be an absolute directory name;
315 thus, on a GNU or Unix system, it must end in a slash."
321 (defun auto-insert ()
322 "Insert default contents into new files if variable `auto-insert' is non-nil.
323 Matches the visited file name against the elements of `auto-insert-alist'."
325 (and (not buffer-read-only)
326 (or (eq this-command 'auto-insert)
329 (let ((alist auto-insert-alist)
330 case-fold-search cond desc action)
332 ;; find first matching alist entry
334 (if (atom (setq cond (car (car alist))))
336 (setq desc (cdr cond)
338 (if (if (symbolp cond)
340 (and buffer-file-name
341 (string-match cond buffer-file-name)))
342 (setq action (cdr (car alist))
344 (setq alist (cdr alist))))
346 ;; Now, if we found something, do it
348 (or (not (stringp action))
349 (file-readable-p (expand-file-name
350 action auto-insert-directory)))
351 (or (not auto-insert-query)
352 (if (eq auto-insert-query 'function)
353 (eq this-command 'auto-insert))
354 (y-or-n-p (format auto-insert-prompt desc)))
359 (setq action (expand-file-name
360 action auto-insert-directory)))
361 (insert-file-contents action))
362 (save-window-excursion
363 ;; make buffer visible before skeleton or function
364 ;; which might ask the user for something
365 (switch-to-buffer (current-buffer))
366 (if (and (consp action)
367 (not (eq (car action) 'lambda)))
368 (skeleton-insert action)
373 (and (buffer-modified-p)
374 (not (eq this-command 'auto-insert))
375 (set-buffer-modified-p (eq auto-insert t)))))
376 ;; Return nil so that it could be used in
377 ;; `find-file-not-found-hooks', though that's probably inadvisable.
382 (defun define-auto-insert (condition action &optional after)
383 "Associate CONDITION with (additional) ACTION in `auto-insert-alist'.
384 Optional AFTER means to insert action after all existing actions for CONDITION,
385 or if CONDITION had no actions, after all other CONDITIONs."
386 (let ((elt (assoc condition auto-insert-alist)))
389 (if (vectorp (cdr elt))
390 (vconcat (if after (cdr elt))
391 (if (vectorp action) action (vector action))
392 (if after () (cdr elt)))
394 (vector (cdr elt) action)
395 (vector action (cdr elt)))))
397 (nconc auto-insert-alist (list (cons condition action)))
398 (push (cons condition action) auto-insert-alist)))))
401 (define-minor-mode auto-insert-mode
402 "Toggle Auto-insert mode, a global minor mode.
403 With a prefix argument ARG, enable Auto-insert mode if ARG is
404 positive, and disable it otherwise. If called from Lisp, enable
405 the mode if ARG is omitted or nil.
407 When Auto-insert mode is enabled, when new files are created you can
408 insert a template for the file depending on the mode of the buffer."
409 :global t :group 'auto-insert
411 (add-hook 'find-file-hook 'auto-insert)
412 (remove-hook 'find-file-hook 'auto-insert)))
414 (provide 'autoinsert)
416 ;;; autoinsert.el ends here