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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1985-1987, 1994-1995, 1998, 2000-2015 Free Software
4
;; 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
9
;; Maintainer: emacs-devel@gnu.org
Jim Blandy's avatar
Jim Blandy committed
10 11 12

;; This file is part of GNU Emacs.

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

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

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

28 29 30 31 32 33
;;  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
34
;;  To use:
35
;;     (add-hook 'find-file-hook 'auto-insert)
36 37
;;     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 41
;;  (auto-insert-mode 1)
;;
42 43 44 45 46 47
;;  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
48
;;	      (crm@cs.duke.edu,mcnc!duke!crm)
Jim Blandy's avatar
Jim Blandy committed
49

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

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


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

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

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


93
(defcustom auto-insert-alist
94 95 96 97 98 99
  '((("\\.\\([Hh]\\|hh\\|hpp\\|hxx\\|h\\+\\+\\)\\'" . "C / C++ header")
     (replace-regexp-in-string
      "[^A-Z0-9]" "_"
      (replace-regexp-in-string
       "\\+" "P"
       (upcase (file-name-nondirectory buffer-file-name))))
100 101 102 103
     "#ifndef " str \n
     "#define " str "\n\n"
     _ "\n\n#endif")

104
    (("\\.\\([Cc]\\|cc\\|cpp\\|cxx\\|c\\+\\+\\)\\'" . "C / C++ program")
105 106
     nil
     "#include \""
107 108 109 110 111
     (let ((stem (file-name-sans-extension buffer-file-name))
           ret)
       (dolist (ext '("H" "h" "hh" "hpp" "hxx" "h++") ret)
         (when (file-exists-p (concat stem "." ext))
           (setq ret (file-name-nondirectory (concat stem "." ext))))))
112 113 114
     & ?\" | -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
     ?{ (read-string "class: ") "}\n"
     ("package, %s: "
      "\\usepackage[" (read-string "options, RET: ") & ?\] | -1 ?{ str "}\n")
     _ "\n\\begin{document}\n" _
     "\n\\end{document}")

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

135 136
    (ada-mode . ada-header)

137 138
    (("\\.[1-9]\\'" . "Man page skeleton")
     "Short description: "
Paul Eggert's avatar
Paul Eggert committed
139
     ".\\\" Copyright (C), " (format-time-string "%Y") "  "
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
.TH " (file-name-base)
145 146 147
     " " (file-name-extension (buffer-file-name))
     " " (format-time-string "%Y-%m-%d ")
     "\n.SH NAME\n"
148
     (file-name-base)
149 150
     " \\- " str
     "\n.SH SYNOPSIS
151
.B " (file-name-base)
152 153 154 155 156 157 158 159 160 161 162 163 164 165
     "\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
    (("\\.el\\'" . "Emacs Lisp header")
     "Short description: "
168 169
     ";;; " (file-name-nondirectory (buffer-file-name)) " --- " str
     (make-string (max 2 (- 80 (current-column) 27)) ?\s)
170
     "-*- lexical-binding: t; -*-" '(setq lexical-binding t)
171
     "
172

Paul Eggert's avatar
Paul Eggert committed
173
;; Copyright (C) " (format-time-string "%Y") "  "
174
 (getenv "ORGANIZATION") | (progn user-full-name) "
175 176

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

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

197
\;; This program is distributed in the hope that it will be useful,
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.
201

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

205
\;;; Commentary:
206

207
\;; " _ "
208

209
\;;; Code:
210 211 212



213
\(provide '"
214
       (file-name-base)
215
       ")
216 217 218 219 220 221
\;;; " (file-name-nondirectory (buffer-file-name)) " ends here\n")
    (("\\.texi\\(nfo\\)?\\'" . "Texinfo file skeleton")
     "Title: "
     "\\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename "
222
     (file-name-base) ".info\n"
223 224 225 226 227
      "@settitle " str "
@c %**end of header
@copying\n"
      (setq short-description (read-string "Short description: "))
      ".\n\n"
Paul Eggert's avatar
Paul Eggert committed
228
      "Copyright @copyright{} " (format-time-string "%Y") "  "
229 230 231 232
      (getenv "ORGANIZATION") | (progn user-full-name) "

@quotation
Permission is granted to copy, distribute and/or modify this document
233
under the terms of the GNU Free Documentation License, Version 1.3
234
or any later version published by the Free Software Foundation;
235 236
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
237
Free Documentation License''.
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 294 295 296 297

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

312 313

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

321 322 323

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

	 ;; Now, if we found something, do it
	 (and action
350 351 352 353 354 355 356
	      (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)))
357
	      (mapc
358 359 360
	       (lambda (action)
		 (if (stringp action)
		     (if (file-readable-p
361 362
			  (setq action (expand-file-name
                                        action auto-insert-directory)))
363 364 365 366
			 (insert-file-contents action))
		   (save-window-excursion
		     ;; make buffer visible before skeleton or function
		     ;; which might ask the user for something
367
		     (switch-to-buffer (current-buffer))
368 369 370 371 372 373 374 375 376
		     (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
377 378 379 380
	      (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)
381 382 383


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

402
;;;###autoload
403
(define-minor-mode auto-insert-mode
404 405 406 407
  "Toggle Auto-insert mode, a global minor mode.
With a prefix argument ARG, enable Auto-insert mode if ARG is
positive, and disable it otherwise.  If called from Lisp, enable
the mode if ARG is omitted or nil.
408

Dave Love's avatar
Dave Love committed
409
When Auto-insert mode is enabled, when new files are created you can
410
insert a template for the file depending on the mode of the buffer."
411
  :global t :group 'auto-insert
412
  (if auto-insert-mode
413 414
      (add-hook 'find-file-hook 'auto-insert)
    (remove-hook 'find-file-hook 'auto-insert)))
415

Richard M. Stallman's avatar
Richard M. Stallman committed
416 417
(provide 'autoinsert)

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