autoinsert.el 14.2 KB
Newer Older
1
;;; autoinsert.el --- automatic mode-dependent insertion of text into new files  -*- lexical-binding: t -*-
Erik Naggum's avatar
Erik Naggum committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1985-1987, 1994-1995, 1998, 2000-2019 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 <https://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
(require 'seq)

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
  :group 'files
Juanma Barranquero's avatar
Juanma Barranquero committed
58 59
  :group 'convenience
  :link '(custom-manual "(autotype) Autoinserting"))
60 61 62


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

79
(defcustom auto-insert-query 'function
Lute Kamstra's avatar
Lute Kamstra committed
80
  "Non-nil means ask user before auto-inserting.
81
When this is `function', only ask when called non-interactively."
82 83
  :type '(choice (const :tag "Don't ask" nil)
                 (const :tag "Ask if called non-interactively" function)
84
                 (other :tag "Ask" t)))
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
If this contains a %s, that will be replaced by the matching rule."
89
  :type 'string)
90 91


92
(defcustom auto-insert-alist
93 94 95 96 97 98
  '((("\\.\\([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))))
99 100 101 102
     "#ifndef " str \n
     "#define " str "\n\n"
     _ "\n\n#endif")

103
    (("\\.\\([Cc]\\|cc\\|cpp\\|cxx\\|c\\+\\+\\)\\'" . "C / C++ program")
104 105
     nil
     "#include \""
106 107 108 109 110
     (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))))))
111 112 113
     & ?\" | -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
     ?{ (read-string "class: ") "}\n"
     ("package, %s: "
      "\\usepackage[" (read-string "options, RET: ") & ?\] | -1 ?{ str "}\n")
     _ "\n\\begin{document}\n" _
     "\n\\end{document}")

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

134 135
    (ada-mode . ada-header)

136 137
    (("\\.[1-9]\\'" . "Man page skeleton")
     "Short description: "
Paul Eggert's avatar
Paul Eggert committed
138
     ".\\\" Copyright (C), " (format-time-string "%Y") "  "
139
     (getenv "ORGANIZATION") | (progn user-full-name)
140 141
     "
.\\\" You may distribute this file under the terms of the GNU Free
142
.\\\" Documentation License.
143
.TH " (file-name-base (buffer-file-name))
144 145 146
     " " (file-name-extension (buffer-file-name))
     " " (format-time-string "%Y-%m-%d ")
     "\n.SH NAME\n"
147
     (file-name-base (buffer-file-name))
148 149
     " \\- " str
     "\n.SH SYNOPSIS
150
.B " (file-name-base (buffer-file-name))
151 152 153 154 155 156 157 158 159 160 161 162 163 164
     "\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
    (("\\.el\\'" . "Emacs Lisp header")
     "Short description: "
167 168
     ";;; " (file-name-nondirectory (buffer-file-name)) " --- " str
     (make-string (max 2 (- 80 (current-column) 27)) ?\s)
169
     "-*- lexical-binding: t; -*-" '(setq lexical-binding t)
170
     "
171

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

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

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 194
\;; the Free Software Foundation, either version 3 of the License, or
\;; (at your option) any later version.
195

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

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

204
\;;; Commentary:
205

206
\;; " _ "
207

208
\;;; Code:
209 210 211



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

@quotation
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 235
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
236
Free Documentation License''.
237 238

A copy of the license is also available from the Free Software
239
Foundation Web site at @url{https://www.gnu.org/licenses/fdl.html}.
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

@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

286
@c Get fdl.texi from https://www.gnu.org/licenses/fdl.html
287 288 289 290 291 292 293 294 295 296
@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
297
  "A list specifying text to insert by default into a new file.
298
Elements look like (CONDITION . ACTION) or ((CONDITION . DESCRIPTION) . ACTION).
Eli Zaretskii's avatar
Eli Zaretskii committed
299
CONDITION may be a regexp that must match the new file's name, or it may be
300 301 302 303 304 305
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
306
described above, e.g. [\"header.insert\" date-and-author-update]."
307 308 309 310 311 312 313 314 315 316 317
  :type '(alist :key-type
                (choice (regexp :tag "Regexp matching file name")
                        (symbol :tag "Major mode")
                        (cons :tag "Condition and description"
                              (choice :tag "Condition"
                               (regexp :tag "Regexp matching file name")
                               (symbol :tag "Major mode"))
                              (string :tag "Description")))
                ;; There's no custom equivalent of "repeat" for vectors.
                :value-type (choice file function
                                    (sexp :tag "Skeleton or vector")))
318
  :version "25.1")
Jim Blandy's avatar
Jim Blandy committed
319

320 321

;; Establish a default value for auto-insert-directory
322
(defcustom auto-insert-directory "~/insert/"
Lute Kamstra's avatar
Lute Kamstra committed
323
  "Directory from which auto-inserted files are taken.
324 325
The value must be an absolute directory name;
thus, on a GNU or Unix system, it must end in a slash."
326
  :type 'directory)
Jim Blandy's avatar
Jim Blandy committed
327

328 329 330

;;;###autoload
(defun auto-insert ()
Dave Love's avatar
Dave Love committed
331
  "Insert default contents into new files if variable `auto-insert' is non-nil.
Jim Blandy's avatar
Jim Blandy committed
332
Matches the visited file name against the elements of `auto-insert-alist'."
333 334 335 336 337
  (interactive)
  (and (not buffer-read-only)
       (or (eq this-command 'auto-insert)
	   (and auto-insert
		(bobp) (eobp)))
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
       (let* ((case-fold-search nil)
              (desc nil)
              ;; Find first matching alist entry.
              (action
               (seq-some
                (pcase-lambda (`(,cond . ,action))
                  (if (atom cond)
                      (setq desc cond)
                    (setq desc (cdr cond)
                          cond (car cond)))
                  (when (if (symbolp cond)
                            (derived-mode-p cond)
                          (and buffer-file-name
                               (string-match cond buffer-file-name)))
                    action))
                auto-insert-alist)))
         (goto-char 1)
355 356
	 ;; Now, if we found something, do it
	 (and action
357 358 359 360 361 362 363
	      (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)))
364
	      (mapc
365 366 367
	       (lambda (action)
		 (if (stringp action)
		     (if (file-readable-p
368 369
			  (setq action (expand-file-name
                                        action auto-insert-directory)))
370 371 372 373
			 (insert-file-contents action))
		   (save-window-excursion
		     ;; make buffer visible before skeleton or function
		     ;; which might ask the user for something
374
		     (switch-to-buffer (current-buffer))
375 376 377 378 379 380 381 382 383
		     (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
384 385
	      (set-buffer-modified-p (eq auto-insert t)))))
  ;; Return nil so that it could be used in
386
  ;; `find-file-not-found-functions', though that's probably inadvisable.
Dave Love's avatar
Dave Love committed
387
  nil)
388 389 390


;;;###autoload
391
(defun define-auto-insert (condition action &optional after)
392 393 394
  "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."
395
  (let ((elt (assoc condition auto-insert-alist)))
396 397 398 399 400 401 402 403 404 405
    (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
406
	  (nconc auto-insert-alist (list (cons condition action)))
407
        (push (cons condition action) auto-insert-alist)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
408

409
;;;###autoload
410
(define-minor-mode auto-insert-mode
411
  "Toggle Auto-insert mode, a global minor mode.
412

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

Richard M. Stallman's avatar
Richard M. Stallman committed
420 421
(provide 'autoinsert)

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