autoinsert.el 11.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, 86, 87, 94, 95, 98, 2000, 03 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 12 13

;; 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
Eric S. Raymond's avatar
Eric S. Raymond committed
14
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
15 16 17 18 19 20 21 22
;; 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
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
26

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

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

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

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


(defcustom auto-insert 'not-modified
Dave Love's avatar
Dave Love committed
61 62
  "*Controls automatic insertion into newly found empty files.
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-hooks '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
Dave Love's avatar
Dave Love 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? "
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 100 101 102 103 104 105
  '((("\\.\\([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 \""
106 107 108 109 110 111 112 113
     (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")
114

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

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

134 135
    (ada-mode . ada-header)

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

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

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

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

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

193
;; This file is distributed in the hope that it will be useful,
194 195 196 197 198 199
;; 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
200 201
;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
202 203 204 205 206 207 208 209 210

;;; Commentary:

;; " _ "

;;; Code:



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

228 229

;; Establish a default value for auto-insert-directory
230
(defcustom auto-insert-directory "~/insert/"
231
  "*Directory from which auto-inserted files are taken.
232 233
The value must be an absolute directory name;
thus, on a GNU or Unix system, it must end in a slash."
234 235
  :type 'directory
  :group 'auto-insert)
Jim Blandy's avatar
Jim Blandy committed
236

237 238 239

;;;###autoload
(defun auto-insert ()
Dave Love's avatar
Dave Love committed
240
  "Insert default contents into new files if variable `auto-insert' is non-nil.
Jim Blandy's avatar
Jim Blandy committed
241
Matches the visited file name against the elements of `auto-insert-alist'."
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
  (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
258 259
		 (and buffer-file-name
		      (string-match cond buffer-file-name)))
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
	       (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
293 294 295 296
	      (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)
297 298 299


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

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

Dave Love's avatar
Dave Love committed
325
When Auto-insert mode is enabled, when new files are created you can
326
insert a template for the file depending on the mode of the buffer."
327
  :global t :group 'auto-insert
328 329 330
  (if auto-insert-mode
      (add-hook 'find-file-hooks 'auto-insert)
    (remove-hook 'find-file-hooks 'auto-insert)))
331

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

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