autoinsert.el 13.6 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

3
;; Copyright (C) 1985-1987, 1994-1995, 1998, 2000-2011 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
24

Eric S. Raymond's avatar
Eric S. Raymond committed
25
;;; Commentary:
Jim Blandy's avatar
Jim Blandy committed
26

27 28 29 30 31 32
;;  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
33
;;  To use:
34
;;     (add-hook 'find-file-hook 'auto-insert)
35 36
;;     setq auto-insert-directory to an appropriate slash-terminated value
;;
37 38 39 40
;;  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)
;;
41 42 43 44 45 46
;;  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
47
;;	      (crm@cs.duke.edu,mcnc!duke!crm)
Jim Blandy's avatar
Jim Blandy committed
48

Eric S. Raymond's avatar
Eric S. Raymond committed
49 50
;;; Code:

51 52 53
(defgroup auto-insert nil
  "Automatic mode-dependent insertion of text into new files."
  :prefix "auto-insert-"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
54
  :group 'files
Juanma Barranquero's avatar
Juanma Barranquero committed
55 56
  :group 'convenience
  :link '(custom-manual "(autotype) Autoinserting"))
57 58 59


(defcustom auto-insert 'not-modified
Lute Kamstra's avatar
Lute Kamstra committed
60
  "Controls automatic insertion into newly found empty files.
Dave Love's avatar
Dave Love committed
61
Possible values:
62 63 64 65 66 67
	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
68
This variable is used when the function `auto-insert' is called, e.g.
69
when you do (add-hook 'find-file-hook 'auto-insert).
Dave Love's avatar
Dave Love committed
70
With \\[auto-insert], this is always treated as if it were t."
71 72
  :type '(choice (const :tag "Insert if possible" t)
                 (const :tag "Do nothing" nil)
Dave Love's avatar
Dave Love committed
73
                 (other :tag "insert if possible, mark as unmodified."
74
                        not-modified))
75
  :group 'auto-insert)
76

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

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


92
(defcustom auto-insert-alist
93 94
  '((("\\.\\([Hh]\\|hh\\|hpp\\)\\'" . "C / C++ header")
     (upcase (concat (file-name-nondirectory
95
		      (file-name-sans-extension buffer-file-name))
96
		     "_"
97
		     (file-name-extension buffer-file-name)))
98 99 100 101 102 103 104
     "#ifndef " str \n
     "#define " str "\n\n"
     _ "\n\n#endif")

    (("\\.\\([Cc]\\|cc\\|cpp\\)\\'" . "C / C++ program")
     nil
     "#include \""
105 106 107 108 109 110 111 112
     (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")
113

114
    (html-mode . (lambda () (sgml-tag "html")))
115

116 117 118 119 120
    (plain-tex-mode . "tex-insert.tex")
    (bibtex-mode . "tex-insert.tex")
    (latex-mode
     ;; should try to offer completing read for these
     "options, RET: "
121
     "\\documentclass[" str & ?\] | -1
122 123 124 125 126 127
     ?{ (read-string "class: ") "}\n"
     ("package, %s: "
      "\\usepackage[" (read-string "options, RET: ") & ?\] | -1 ?{ str "}\n")
     _ "\n\\begin{document}\n" _
     "\n\\end{document}")

128 129
    (("/bin/.*[^/]\\'" . "Shell-Script mode magic number") .
     (lambda ()
130
       (if (eq major-mode (default-value 'major-mode))
131
	   (sh-mode))))
132

133 134
    (ada-mode . ada-header)

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

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

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

;; Author: " (user-full-name)
Dave Love's avatar
Dave Love committed
172
'(if (search-backward "&" (line-beginning-position) t)
173
     (replace-match (capitalize (user-login-name)) t t))
174
'(end-of-line 1) " <" (progn user-mail-address) ">
175 176 177 178 179
;; 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)
180
	v2 (mapconcat (lambda (x) (format "%12s:  %s" (car x) (cdr x)))
181 182 183 184 185 186
	   finder-known-keywords
	   "\n"))
 ((let ((minibuffer-help-form v2))
    (completing-read "Keyword, C-h: " v1 nil t))
    str ", ") & -2 "

187
\;; This program is free software; you can redistribute it and/or modify
188
\;; it under the terms of the GNU General Public License as published by
189 190
\;; the Free Software Foundation, either version 3 of the License, or
\;; (at your option) any later version.
191

192
\;; This program is distributed in the hope that it will be useful,
193 194 195
\;; 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.
196

197
\;; You should have received a copy of the GNU General Public License
198
\;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
199

200
\;;; Commentary:
201

202
\;; " _ "
203

204
\;;; Code:
205 206 207



208 209 210
\(provide '"
       (file-name-sans-extension (file-name-nondirectory (buffer-file-name)))
       ")
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
\;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n")
    (("\\.texi\\(nfo\\)?\\'" . "Texinfo file skeleton")
     "Title: "
     "\\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename "
     (file-name-sans-extension
      (file-name-nondirectory (buffer-file-name))) ".info\n"
      "@settitle " str "
@c %**end of header
@copying\n"
      (setq short-description (read-string "Short description: "))
      ".\n\n"
      "Copyright @copyright{} " (substring (current-time-string) -4) "  "
      (getenv "ORGANIZATION") | (progn user-full-name) "

@quotation
Permission is granted to copy, distribute and/or modify this document
229
under the terms of the GNU Free Documentation License, Version 1.3
230
or any later version published by the Free Software Foundation;
231 232
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled ``GNU
233
Free Documentation License''.
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 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

A copy of the license is also available from the Free Software
Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.

@end quotation

The document was typeset with
@uref{http://www.texinfo.org/, GNU Texinfo}.

@end copying

@titlepage
@title " str "
@subtitle " short-description "
@author " (getenv "ORGANIZATION") | (progn user-full-name)
     " <" (progn user-mail-address) ">
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@c Output the table of the contents at the beginning.
@contents

@ifnottex
@node Top
@top " str "

@insertcopying
@end ifnottex

@c Generate the nodes for this menu with `C-c C-u C-m'.
@menu
@end menu

@c Update all node entries with `C-c C-u C-n'.
@c Insert new nodes with `C-c C-c n'.
@node Chapter One
@chapter Chapter One

" _ "

@node Copying This Manual
@appendix Copying This Manual

@menu
* GNU Free Documentation License::  License for copying this manual.
@end menu

@c Get fdl.texi from http://www.gnu.org/licenses/fdl.html
@include fdl.texi

@node Index
@unnumbered Index

@printindex cp

@bye

@c " (file-name-nondirectory (buffer-file-name)) " ends here\n"))
Jim Blandy's avatar
Jim Blandy committed
294
  "A list specifying text to insert by default into a new file.
295
Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
Eli Zaretskii's avatar
Eli Zaretskii committed
296
CONDITION may be a regexp that must match the new file's name, or it may be
297 298 299 300 301 302
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
303 304 305
described above, e.g. [\"header.insert\" date-and-author-update]."
  :type 'sexp
  :group 'auto-insert)
Jim Blandy's avatar
Jim Blandy committed
306

307 308

;; Establish a default value for auto-insert-directory
309
(defcustom auto-insert-directory "~/insert/"
Lute Kamstra's avatar
Lute Kamstra committed
310
  "Directory from which auto-inserted files are taken.
311 312
The value must be an absolute directory name;
thus, on a GNU or Unix system, it must end in a slash."
313 314
  :type 'directory
  :group 'auto-insert)
Jim Blandy's avatar
Jim Blandy committed
315

316 317 318

;;;###autoload
(defun auto-insert ()
Dave Love's avatar
Dave Love committed
319
  "Insert default contents into new files if variable `auto-insert' is non-nil.
Jim Blandy's avatar
Jim Blandy committed
320
Matches the visited file name against the elements of `auto-insert-alist'."
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  (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
337 338
		 (and buffer-file-name
		      (string-match cond buffer-file-name)))
339 340 341 342 343 344
	       (setq action (cdr (car alist))
		     alist nil)
	     (setq alist (cdr alist))))

	 ;; Now, if we found something, do it
	 (and action
345 346 347 348 349 350 351
	      (or (not (stringp action))
                  (file-readable-p (expand-file-name
                                    action auto-insert-directory)))
	      (or (not auto-insert-query)
                  (if (eq auto-insert-query 'function)
                      (eq this-command 'auto-insert))
                  (y-or-n-p (format auto-insert-prompt desc)))
352
	      (mapc
353 354 355
	       (lambda (action)
		 (if (stringp action)
		     (if (file-readable-p
356 357
			  (setq action (expand-file-name
                                        action auto-insert-directory)))
358 359 360 361 362 363 364 365 366 367 368 369 370 371
			 (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
372 373 374 375
	      (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)
376 377 378


;;;###autoload
379
(defun define-auto-insert (condition action &optional after)
380 381 382
  "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."
383
  (let ((elt (assoc condition auto-insert-alist)))
384 385 386 387 388 389 390 391 392 393
    (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
394
	  (nconc auto-insert-alist (list (cons condition action)))
395
        (push (cons condition action) auto-insert-alist)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
396

397
;;;###autoload
398
(define-minor-mode auto-insert-mode
Dave Love's avatar
Dave Love committed
399 400 401
  "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).
402

Dave Love's avatar
Dave Love committed
403
When Auto-insert mode is enabled, when new files are created you can
404
insert a template for the file depending on the mode of the buffer."
405
  :global t :group 'auto-insert
406
  (if auto-insert-mode
407 408
      (add-hook 'find-file-hook 'auto-insert)
    (remove-hook 'find-file-hook 'auto-insert)))
409

Richard M. Stallman's avatar
Richard M. Stallman committed
410 411
(provide 'autoinsert)

Eric S. Raymond's avatar
Eric S. Raymond committed
412
;;; autoinsert.el ends here