autoinsert.el 11.7 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1
;;; autoinsert.el --- automatic mode-dependent insertion of text into new files
Erik Naggum's avatar
Erik Naggum committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1985, 1986, 1987, 1994, 1995, 1998, 2000, 2001, 2002,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Author: Charlie Martin <crm@cs.duke.edu>
Karl Heuer's avatar
Karl Heuer committed
7
;; Adapted-By: Daniel Pfeiffer <occitan@esperanto.org>
Dan Nicolaescu's avatar
Dan Nicolaescu committed
8
;; Keywords: convenience
Richard M. Stallman's avatar
Richard M. Stallman committed
9
;; Maintainer: FSF
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14

;; 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
15
;; the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
16 17 18 19 20 21 22 23
;; 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
Erik Naggum's avatar
Erik Naggum committed
24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Jim Blandy's avatar
Jim Blandy committed
27

Eric S. Raymond's avatar
Eric S. Raymond committed
28
;;; Commentary:
Jim Blandy's avatar
Jim Blandy committed
29

30 31 32 33 34 35
;;  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.
;;
Dave Love's avatar
Dave Love committed
36
;;  To use:
37
;;     (add-hook 'find-file-hook 'auto-insert)
38 39
;;     setq auto-insert-directory to an appropriate slash-terminated value
;;
40 41 42 43
;;  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)
;;
44 45 46 47 48 49
;;  Author:  Charlie Martin
;;           Department of Computer Science and
;;           National Biomedical Simulation Resource
;;           Box 3709
;;           Duke University Medical Center
;;           Durham, NC 27710
Dave Love's avatar
Dave Love committed
50
;;	      (crm@cs.duke.edu,mcnc!duke!crm)
Jim Blandy's avatar
Jim Blandy committed
51

Eric S. Raymond's avatar
Eric S. Raymond committed
52 53
;;; Code:

54 55 56
(defgroup auto-insert nil
  "Automatic mode-dependent insertion of text into new files."
  :prefix "auto-insert-"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
57 58
  :group 'files
  :group 'convenience)
59 60 61


(defcustom auto-insert 'not-modified
Dave Love's avatar
Dave Love committed
62 63
  "*Controls automatic insertion into newly found empty files.
Possible values:
64 65 66 67 68 69
	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.
Dave Love's avatar
Dave Love committed
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).
Dave Love's avatar
Dave Love committed
72
With \\[auto-insert], this is always treated as if it were t."
73 74
  :type '(choice (const :tag "Insert if possible" t)
                 (const :tag "Do nothing" nil)
Dave Love's avatar
Dave Love committed
75
                 (other :tag "insert if possible, mark as unmodified."
76
                        not-modified))
77
  :group 'auto-insert)
78

79
(defcustom auto-insert-query 'function
Dave Love's avatar
Dave Love committed
80
  "*Non-nil means ask user before auto-inserting.
81
When this is `function', only ask when called non-interactively."
82 83 84
  :type '(choice (const :tag "Don't ask" nil)
                 (const :tag "Ask if called non-interactively" function)
                 (other :tag "Ask" t))
85
  :group 'auto-insert)
86

87
(defcustom auto-insert-prompt "Perform %s auto-insertion? "
88
  "*Prompt to use when querying whether to auto-insert.
89 90 91
If this contains a %s, that will be replaced by the matching rule."
  :type 'string
  :group 'auto-insert)
92 93


94
(defcustom auto-insert-alist
95 96 97 98 99 100 101 102 103 104 105 106
  '((("\\.\\([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 \""
107 108 109 110 111 112 113 114
     (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")
115

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

118 119 120 121 122
    (plain-tex-mode . "tex-insert.tex")
    (bibtex-mode . "tex-insert.tex")
    (latex-mode
     ;; should try to offer completing read for these
     "options, RET: "
123
     "\\documentclass[" str & ?\] | -1
124 125 126 127 128 129 130 131 132 133
     ?{ (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)))
134

135 136
    (ada-mode . ada-header)

137 138 139
    (("\\.[1-9]\\'" . "Man page skeleton")
     "Short description: "
     ".\\\" Copyright (C), " (substring (current-time-string) -4) "  "
140
     (getenv "ORGANIZATION") | (progn user-full-name)
141 142
     "
.\\\" You may distribute this file under the terms of the GNU Free
143
.\\\" Documentation License.
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
.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")

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

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

;; Author: " (user-full-name)
Dave Love's avatar
Dave Love committed
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) ">
177 178 179 180 181
;; 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)
182
	v2 (mapconcat (lambda (x) (format "%12s:  %s" (car x) (cdr x)))
183 184 185 186 187 188
	   finder-known-keywords
	   "\n"))
 ((let ((minibuffer-help-form v2))
    (completing-read "Keyword, C-h: " v1 nil t))
    str ", ") & -2 "

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 3, or (at your option)
192 193
;; any later version.

194
;; This file is distributed in the hope that it will be useful,
195 196 197 198 199 200
;; 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
Lute Kamstra's avatar
Lute Kamstra committed
201 202
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
203 204 205 206 207 208 209 210 211

;;; Commentary:

;; " _ "

;;; Code:



212 213 214
\(provide '"
       (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
       ")
215
;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n"))
Jim Blandy's avatar
Jim Blandy committed
216
  "A list specifying text to insert by default into a new file.
217
Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
Eli Zaretskii's avatar
Eli Zaretskii committed
218
CONDITION may be a regexp that must match the new file's name, or it may be
219 220 221 222 223 224
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
225 226 227
described above, e.g. [\"header.insert\" date-and-author-update]."
  :type 'sexp
  :group 'auto-insert)
Jim Blandy's avatar
Jim Blandy committed
228

229 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 234
The value must be an absolute directory name;
thus, on a GNU or Unix system, it must end in a slash."
235 236
  :type 'directory
  :group 'auto-insert)
Jim Blandy's avatar
Jim Blandy committed
237

238 239 240

;;;###autoload
(defun auto-insert ()
Dave Love's avatar
Dave Love committed
241
  "Insert default contents into new files if variable `auto-insert' is non-nil.
Jim Blandy's avatar
Jim Blandy committed
242
Matches the visited file name against the elements of `auto-insert-alist'."
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
  (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)
Dave Love's avatar
Dave Love committed
259 260
		 (and buffer-file-name
		      (string-match cond buffer-file-name)))
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
	       (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))
Dave Love's avatar
Dave Love committed
294 295 296 297
	      (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)
298 299 300


;;;###autoload
301
(defun define-auto-insert (condition action &optional after)
302 303 304
  "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."
305
  (let ((elt (assoc condition auto-insert-alist)))
306 307 308 309 310 311 312 313 314 315
    (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
316 317
	  (nconc auto-insert-alist (list (cons condition action)))
	(setq auto-insert-alist (cons (cons condition action)
318
				      auto-insert-alist))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
319

320
;;;###autoload
321
(define-minor-mode auto-insert-mode
Dave Love's avatar
Dave Love committed
322 323 324
  "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).
325

Dave Love's avatar
Dave Love committed
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
329
  (if auto-insert-mode
330 331
      (add-hook 'find-file-hook 'auto-insert)
    (remove-hook 'find-file-hook 'auto-insert)))
332

Richard M. Stallman's avatar
Richard M. Stallman committed
333 334
(provide 'autoinsert)

335
;; arch-tag: 5b6630ac-c735-43cf-b097-b78c622af909
Eric S. Raymond's avatar
Eric S. Raymond committed
336
;;; autoinsert.el ends here