# text-modes / autoinsert.el

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 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 ;;; autoinsert.el --- automatic mode-dependent insertion of text into new files ;; Copyright (C) 1985, 1986, 1987, 1994, 1995 Free Software Foundation, Inc. ;; Author: Charlie Martin ;; Adapted-By: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389 ;; This file is part of XEmacs. ;; XEmacs is free software; you can redistribute it and/or modify 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. ;; XEmacs 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 ;; along with XEmacs; see the file COPYING. If not, write to the Free ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA ;; 02111-1307, USA. ;;; Synched up with: FSF 19.34. ;;; Commentary: ;; 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. ;; ;; To use: ;; (add-hook 'find-file-hooks 'auto-insert) ;; setq auto-insert-directory to an appropriate slash-terminated value ;; ;; Author: Charlie Martin ;; Department of Computer Science and ;; National Biomedical Simulation Resource ;; Box 3709 ;; Duke University Medical Center ;; Durham, NC 27710 ;; (crm@cs.duke.edu,mcnc!duke!crm) ;;; Code: (defgroup auto-insert nil "Automatic mode-dependent insertion of text into new files." :group 'tools) (defcustom auto-insert 'not-modified "*Controls automatic insertion into newly found empty files: 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. This variable is used when auto-insert' is called as a function, e.g. when you do (add-hook 'find-file-hooks 'auto-insert). With \\[auto-insert], this is always treated as if it were t'." :type '(radio (const :tag "Do nothing" nil) (const :tag "Insert if possible" t) (sexp :format "%t\n" :tag "Insert if possible, but mark as unmodified" other)) :require 'autoinsert :group 'auto-insert) (defcustom auto-insert-query 'function "*If non-nil', ask user before auto-inserting. When this is function', only ask when called non-interactively." :type '(choice (const :tag "Don't ask" nil) (const :tag "Ask when non-interactive" function) (sexp :format "%t\n" :tag "Ask" other)) :group 'auto-insert) (defcustom auto-insert-prompt "Perform %s auto-insertion? " "*Prompt to use when querying whether to auto-insert. If this contains a %s, that will be replaced by the matching rule." :type 'string :group 'auto-insert) (defvar auto-insert-alist '((("\\.\$$[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 \"" ;; nop without latest cc-mode (and (fboundp 'c-companion-file) ;(file-readable-p (c-companion-file 'name)) (file-name-nondirectory (c-companion-file 'name))) & ?\" | -10) ("[Mm]akefile\\'" . "makefile.inc") (html-mode . (lambda () (sgml-tag "html"))) (plain-tex-mode . "tex-insert.tex") (bibtex-mode . "tex-insert.tex") (latex-mode ;; should try to offer completing read for these "options, RET: " "\\documentstyle[" str & ?$ | -1 ?{ (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))) (ada-mode . ada-header) (("\\.el\\'" . "Emacs Lisp header") "Short description: " ";;; " (file-name-nondirectory (buffer-file-name)) " --- " str " ;; Copyright (C) " (substring (current-time-string) -4) " by " (getenv "ORGANIZATION") | "Free Software Foundation, Inc." " ;; Author: " (user-full-name) '(if (search-backward "&" (save-excursion (beginning-of-line 1) (point)) t) (replace-match (capitalize (user-login-name)) t t)) '(end-of-line 1) " <" (user-login-name) ?@ (system-name) "> ;; 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 " ;; This file is part of XEmacs. ;; XEmacs is free software; you can redistribute it and/or modify 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. ;; XEmacs 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 ;; along with XEmacs; see the file COPYING. If not, write to the Free ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA ;; 02111-1307, USA. ;;; Synched up with: Not in FSF ;;; Commentary: ;; " _ " ;;; Code: (provide '" (file-name-sans-extension (file-name-nondirectory (buffer-file-name))) ") ;;; " (file-name-nondirectory (buffer-file-name)) " ends here ")) "A list specifying text to insert by default into a new file. 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 described above, e.g. [\"header.insert\" date-and-author-update].") ;; Establish a default value for auto-insert-directory (defvar auto-insert-directory "~/insert/" "*Directory from which auto-inserted files are taken.") ;;;###autoload (defun auto-insert () "Insert default contents into a new file if auto-insert' is non-nil. Matches the visited file name against the elements of auto-insert-alist'." (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) (string-match cond buffer-file-name)) (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)) (set-buffer-modified-p (eq auto-insert t)))))) ;;;###autoload (defun define-auto-insert (key action &optional after) "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." (let ((elt (assoc key auto-insert-alist))) (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 (nconc auto-insert-alist (list (cons key action))) (setq auto-insert-alist (cons (cons key action) auto-insert-alist)))))) (provide 'autoinsert) ;;; autoinsert.el ends here `