]> code.delx.au - gnu-emacs/blob - lisp/files.el
(f90-mode-abbrev-table): Mark all the predefined abbrevs as "system"
[gnu-emacs] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
4 ;;; Free Software Foundation, Inc.
5
6 ;; Maintainer: FSF
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
30
31 ;;; Code:
32
33 (defgroup backup nil
34 "Backups of edited data files."
35 :group 'files)
36
37 (defgroup find-file nil
38 "Finding files."
39 :group 'files)
40
41
42 (defcustom delete-auto-save-files t
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
44
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
47 :type 'boolean
48 :group 'auto-save)
49
50 (defcustom directory-abbrev-alist
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
57
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
60
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
64 :type '(repeat (cons :format "%v"
65 :value ("" . "")
66 (regexp :tag "From")
67 (regexp :tag "To")))
68 :group 'abbrev
69 :group 'find-file)
70
71 ;; Turn off backup files on VMS since it has version numbers.
72 (defcustom make-backup-files (not (eq system-type 'vax-vms))
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
75
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
80
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
85
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
90 :type 'boolean
91 :group 'backup)
92
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
95 (defvar backup-inhibited nil
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
98 But it is local only if you make it local.")
99 (put 'backup-inhibited 'permanent-local t)
100
101 (defcustom backup-by-copying nil
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
104 :type 'boolean
105 :group 'backup)
106
107 (defcustom backup-by-copying-when-linked nil
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
111 :type 'boolean
112 :group 'backup)
113
114 (defcustom backup-by-copying-when-mismatch nil
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
121 :type 'boolean
122 :group 'backup)
123
124 (defcustom backup-by-copying-when-privileged-mismatch 200
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
133 :type '(choice (const nil) integer)
134 :group 'backup)
135
136 (defvar backup-enable-predicate 'normal-backup-enable-predicate
137 "Predicate that looks at a file name and decides whether to make backups.
138 Called with an absolute file name as argument, it returns t to enable backup.")
139
140 (defcustom buffer-offer-save nil
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
144 :type 'boolean
145 :group 'backup)
146 (make-variable-buffer-local 'buffer-offer-save)
147
148 (defcustom find-file-existing-other-name t
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
152 :type 'boolean
153 :group 'find-file)
154
155 (defcustom find-file-visit-truename nil
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
159 :type 'boolean
160 :group 'find-file)
161
162 (defcustom revert-without-query
163 nil
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
169 :type '(repeat regexp)
170 :group 'find-file)
171
172 (defvar buffer-file-number nil
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
176 If the buffer is visiting a new file, the value is nil.")
177 (make-variable-buffer-local 'buffer-file-number)
178 (put 'buffer-file-number 'permanent-local t)
179
180 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
181 "Non-nil means that buffer-file-number uniquely identifies files.")
182
183 (defvar buffer-file-read-only nil
184 "Non-nil if visited file was read-only when visited.")
185 (make-variable-buffer-local 'buffer-file-read-only)
186
187 (defcustom temporary-file-directory
188 (file-name-as-directory
189 (cond ((memq system-type '(ms-dos windows-nt))
190 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
191 ((memq system-type '(vax-vms axp-vms))
192 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
193 (t
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
195 "The directory for writing temporary files."
196 :group 'files
197 :type 'directory)
198
199 (defcustom small-temporary-file-directory
200 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
205 :group 'files
206 :type 'directory)
207
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
209 (defvar null-device "/dev/null" "The system null device.")
210
211 (defvar file-name-invalid-regexp
212 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
213 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
214 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
215 "[\000-\031]\\|" ; control characters
216 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
217 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
218 ((memq system-type '(ms-dos windows-nt))
219 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
220 "[|<>\"?*\000-\031]")) ; invalid characters
221 (t "[\000]"))
222 "Regexp recognizing file names which aren't allowed by the filesystem.")
223
224 (defcustom file-precious-flag nil
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
227
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
232
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
236 :type 'boolean
237 :group 'backup)
238
239 (defcustom version-control nil
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil means make them for files that have some already.
243 `never' means do not make them."
244 :type '(choice (const :tag "Never" never)
245 (const :tag "If existing" nil)
246 (other :tag "Always" t))
247 :group 'backup
248 :group 'vc)
249
250 (defcustom dired-kept-versions 2
251 "*When cleaning directory, number of versions to keep."
252 :type 'integer
253 :group 'backup
254 :group 'dired)
255
256 (defcustom delete-old-versions nil
257 "*If t, delete excess backup versions silently.
258 If nil, ask confirmation. Any other value prevents any trimming."
259 :type '(choice (const :tag "Delete" t)
260 (const :tag "Ask" nil)
261 (other :tag "Leave" other))
262 :group 'backup)
263
264 (defcustom kept-old-versions 2
265 "*Number of oldest versions to keep when a new numbered backup is made."
266 :type 'integer
267 :group 'backup)
268
269 (defcustom kept-new-versions 2
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
272 :type 'integer
273 :group 'backup)
274
275 (defcustom require-final-newline nil
276 "*Value of t says silently ensure a file ends in a newline when it is saved.
277 Non-nil but not t says ask user whether to add a newline when there isn't one.
278 nil means don't add newlines."
279 :type '(choice (const :tag "Off" nil)
280 (const :tag "Add" t)
281 (other :tag "Ask" ask))
282 :group 'editing-basics)
283
284 (defcustom auto-save-default t
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
286 :type 'boolean
287 :group 'auto-save)
288
289 (defcustom auto-save-visited-file-name nil
290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
291 Normally auto-save files are written under other names."
292 :type 'boolean
293 :group 'auto-save)
294
295 (defcustom auto-save-file-name-transforms
296 `(("\\`/[^/]*:\\(.+/\\)*\\(.*\\)"
297 ,(expand-file-name "\\2" temporary-file-directory)))
298 "*Transforms to apply to buffer file name before making auto-save file name.
299 Each transform is a list (REGEXP REPLACEMENT):
300 REGEXP is a regular expression to match against the file name.
301 If it matches, `replace-match' is used to replace the
302 matching part with REPLACEMENT.
303 All the transforms in the list are tried, in the order they are listed.
304 When one transform applies, its result is final;
305 no further transforms are tried.
306
307 The default value is set up to put the auto-save file into the
308 temporary directory (see the variable `temporary-file-directory') for
309 editing a remote file."
310 :group 'auto-save
311 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")))
312 :version "21.1")
313
314 (defcustom save-abbrevs t
315 "*Non-nil means save word abbrevs too when files are saved.
316 If `silently', don't ask the user before saving."
317 :type '(choice (const t) (const nil) (const silently))
318 :group 'abbrev)
319
320 (defcustom find-file-run-dired t
321 "*Non-nil means allow `find-file' to visit directories.
322 To visit the directory, `find-file' runs `find-directory-functions'."
323 :type 'boolean
324 :group 'find-file)
325
326 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
327 "*List of functions to try in sequence to visit a directory.
328 Each function is called with the directory name as the sole argument
329 and should return either a buffer or nil."
330 :type '(hook :options (cvs-dired-noselect dired-noselect))
331 :group 'find-file)
332
333 ;;;It is not useful to make this a local variable.
334 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
335 (defvar find-file-not-found-hooks nil
336 "List of functions to be called for `find-file' on nonexistent file.
337 These functions are called as soon as the error is detected.
338 Variable `buffer-file-name' is already set up.
339 The functions are called in the order given until one of them returns non-nil.")
340
341 ;;;It is not useful to make this a local variable.
342 ;;;(put 'find-file-hooks 'permanent-local t)
343 (defvar find-file-hooks nil
344 "List of functions to be called after a buffer is loaded from a file.
345 The buffer's local variables (if any) will have been processed before the
346 functions are called.")
347
348 (defvar write-file-hooks nil
349 "List of functions to be called before writing out a buffer to a file.
350 If one of them returns non-nil, the file is considered already written
351 and the rest are not called.
352 These hooks are considered to pertain to the visited file.
353 So any buffer-local binding of `write-file-hooks' is
354 discarded if you change the visited file name with \\[set-visited-file-name].
355
356 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
357 See also `write-contents-hooks'.")
358 ;;; However, in case someone does make it local...
359 (put 'write-file-hooks 'permanent-local t)
360
361 (defvar local-write-file-hooks nil
362 "Just like `write-file-hooks', except intended for per-buffer use.
363 The functions in this list are called before the ones in
364 `write-file-hooks'.
365
366 This variable is meant to be used for hooks that have to do with a
367 particular visited file. Therefore, it is a permanent local, so that
368 changing the major mode does not clear it. However, calling
369 `set-visited-file-name' does clear it.")
370 (make-variable-buffer-local 'local-write-file-hooks)
371 (put 'local-write-file-hooks 'permanent-local t)
372
373 (defvar write-contents-hooks nil
374 "List of functions to be called before writing out a buffer to a file.
375 If one of them returns non-nil, the file is considered already written
376 and the rest are not called.
377
378 This variable is meant to be used for hooks that pertain to the
379 buffer's contents, not to the particular visited file; thus,
380 `set-visited-file-name' does not clear this variable; but changing the
381 major mode does clear it.
382
383 This variable automatically becomes buffer-local whenever it is set.
384 If you use `add-hook' to add elements to the list, use nil for the
385 LOCAL argument.
386
387 See also `write-file-hooks'.")
388 (make-variable-buffer-local 'write-contents-hooks)
389
390 (defcustom enable-local-variables t
391 "*Control use of local variables in files you visit.
392 The value can be t, nil or something else.
393 A value of t means file local variables specifications are obeyed;
394 nil means they are ignored; anything else means query.
395 This variable also controls use of major modes specified in
396 a -*- line.
397
398 The command \\[normal-mode], when used interactively,
399 always obeys file local variable specifications and the -*- line,
400 and ignores this variable."
401 :type '(choice (const :tag "Obey" t)
402 (const :tag "Ignore" nil)
403 (other :tag "Query" other))
404 :group 'find-file)
405
406 (defvar local-enable-local-variables t
407 "Like `enable-local-variables' but meant for buffer-local bindings.
408 The meaningful values are nil and non-nil. The default is non-nil.
409 If a major mode sets this to nil, buffer-locally, then any local
410 variables list in the file will be ignored.
411
412 This variable does not affect the use of major modes
413 specified in a -*- line.")
414
415 (defcustom enable-local-eval 'maybe
416 "*Control processing of the \"variable\" `eval' in a file's local variables.
417 The value can be t, nil or something else.
418 A value of t means obey `eval' variables;
419 nil means ignore them; anything else means query.
420
421 The command \\[normal-mode] always obeys local-variables lists
422 and ignores this variable."
423 :type '(choice (const :tag "Obey" t)
424 (const :tag "Ignore" nil)
425 (other :tag "Query" other))
426 :group 'find-file)
427
428 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
429 (or (fboundp 'lock-buffer)
430 (defalias 'lock-buffer 'ignore))
431 (or (fboundp 'unlock-buffer)
432 (defalias 'unlock-buffer 'ignore))
433 (or (fboundp 'file-locked-p)
434 (defalias 'file-locked-p 'ignore))
435
436 (defvar view-read-only nil
437 "*Non-nil means buffers visiting files read-only, do it in view mode.")
438
439 (defun ange-ftp-completion-hook-function (op &rest args)
440 "Provides support for ange-ftp host name completion.
441 Runs the usual ange-ftp hook, but only for completion operations."
442 ;; Having this here avoids the need to load ange-ftp when it's not
443 ;; really in use.
444 (if (memq op '(file-name-completion file-name-all-completions))
445 (apply 'ange-ftp-hook-function op args)
446 (let ((inhibit-file-name-handlers
447 (cons 'ange-ftp-completion-hook-function
448 (and (eq inhibit-file-name-operation op)
449 inhibit-file-name-handlers)))
450 (inhibit-file-name-operation op))
451 (apply op args))))
452
453 (defun convert-standard-filename (filename)
454 "Convert a standard file's name to something suitable for the current OS.
455 This function's standard definition is trivial; it just returns the argument.
456 However, on some systems, the function is redefined with a definition
457 that really does change some file names to canonicalize certain
458 patterns and to guarantee valid names."
459 filename)
460 \f
461 (defun pwd ()
462 "Show the current default directory."
463 (interactive nil)
464 (message "Directory %s" default-directory))
465
466 (defvar cd-path nil
467 "Value of the CDPATH environment variable, as a list.
468 Not actually set up until the first time you use it.")
469
470 (defun parse-colon-path (cd-path)
471 "Explode a colon-separated search path into a list of directory names.
472 \(For values of `colon' equal to `path-separator'.)"
473 ;; We could use split-string here.
474 (and cd-path
475 (let (cd-prefix cd-list (cd-start 0) cd-colon)
476 (setq cd-path (concat cd-path path-separator))
477 (while (setq cd-colon (string-match path-separator cd-path cd-start))
478 (setq cd-list
479 (nconc cd-list
480 (list (if (= cd-start cd-colon)
481 nil
482 (substitute-in-file-name
483 (file-name-as-directory
484 (substring cd-path cd-start cd-colon)))))))
485 (setq cd-start (+ cd-colon 1)))
486 cd-list)))
487
488 (defun cd-absolute (dir)
489 "Change current directory to given absolute file name DIR."
490 ;; Put the name into directory syntax now,
491 ;; because otherwise expand-file-name may give some bad results.
492 (if (not (eq system-type 'vax-vms))
493 (setq dir (file-name-as-directory dir)))
494 (setq dir (abbreviate-file-name (expand-file-name dir)))
495 (if (not (file-directory-p dir))
496 (if (file-exists-p dir)
497 (error "%s is not a directory" dir)
498 (error "%s: no such directory" dir))
499 (if (file-executable-p dir)
500 (setq default-directory dir)
501 (error "Cannot cd to %s: Permission denied" dir))))
502
503 (defun cd (dir)
504 "Make DIR become the current buffer's default directory.
505 If your environment includes a `CDPATH' variable, try each one of that
506 colon-separated list of directories when resolving a relative directory name."
507 (interactive
508 (list (read-file-name "Change default directory: "
509 default-directory default-directory
510 (and (member cd-path '(nil ("./")))
511 (null (getenv "CDPATH"))))))
512 (if (file-name-absolute-p dir)
513 (cd-absolute (expand-file-name dir))
514 (if (null cd-path)
515 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
516 (setq cd-path (or trypath (list "./")))))
517 (if (not (catch 'found
518 (mapcar
519 (function (lambda (x)
520 (let ((f (expand-file-name (concat x dir))))
521 (if (file-directory-p f)
522 (progn
523 (cd-absolute f)
524 (throw 'found t))))))
525 cd-path)
526 nil))
527 (error "No such directory found via CDPATH environment variable"))))
528
529 (defun load-file (file)
530 "Load the Lisp file named FILE."
531 ;; This is a case where .elc makes a lot of sense.
532 (interactive (list (let ((completion-ignored-extensions
533 (remove ".elc" completion-ignored-extensions)))
534 (read-file-name "Load file: "))))
535 (load (expand-file-name file) nil nil t))
536
537 (defun load-library (library)
538 "Load the library named LIBRARY.
539 This is an interface to the function `load'."
540 (interactive "sLoad library: ")
541 (load library))
542
543 (defun file-local-copy (file)
544 "Copy the file FILE into a temporary file on this machine.
545 Returns the name of the local copy, or nil, if FILE is directly
546 accessible."
547 ;; This formerly had an optional BUFFER argument that wasn't used by
548 ;; anything.
549 (let ((handler (find-file-name-handler file 'file-local-copy)))
550 (if handler
551 (funcall handler 'file-local-copy file)
552 nil)))
553
554 (defun file-truename (filename &optional counter prev-dirs)
555 "Return the truename of FILENAME, which should be absolute.
556 The truename of a file name is found by chasing symbolic links
557 both at the level of the file and at the level of the directories
558 containing it, until no links are left at any level.
559
560 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
561 Do not specify them in other calls."
562 ;; COUNTER can be a cons cell whose car is the count of how many more links
563 ;; to chase before getting an error.
564 ;; PREV-DIRS can be a cons cell whose car is an alist
565 ;; of truenames we've just recently computed.
566
567 ;; The last test looks dubious, maybe `+' is meant here? --simon.
568 (if (or (string= filename "") (string= filename "~")
569 (and (string= (substring filename 0 1) "~")
570 (string-match "~[^/]*" filename)))
571 (progn
572 (setq filename (expand-file-name filename))
573 (if (string= filename "")
574 (setq filename "/"))))
575 (or counter (setq counter (list 100)))
576 (let (done
577 ;; For speed, remove the ange-ftp completion handler from the list.
578 ;; We know it's not needed here.
579 ;; For even more speed, do this only on the outermost call.
580 (file-name-handler-alist
581 (if prev-dirs file-name-handler-alist
582 (let ((tem (copy-sequence file-name-handler-alist)))
583 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
584 (or prev-dirs (setq prev-dirs (list nil)))
585
586 ;; andrewi@harlequin.co.uk - none of the following code (except for
587 ;; invoking the file-name handler) currently applies on Windows
588 ;; (ie. there are no native symlinks), but there is an issue with
589 ;; case differences being ignored by the OS, and short "8.3 DOS"
590 ;; name aliases existing for all files. (The short names are not
591 ;; reported by directory-files, but can be used to refer to files.)
592 ;; It seems appropriate for file-truename to resolve these issues in
593 ;; the most natural way, which on Windows is to call the function
594 ;; `w32-long-file-name' - this returns the exact name of a file as
595 ;; it is stored on disk (expanding short name aliases with the full
596 ;; name in the process).
597 (if (eq system-type 'windows-nt)
598 (let ((handler (find-file-name-handler filename 'file-truename))
599 newname)
600 ;; For file name that has a special handler, call handler.
601 ;; This is so that ange-ftp can save time by doing a no-op.
602 (if handler
603 (setq filename (funcall handler 'file-truename filename))
604 ;; If filename contains a wildcard, newname will be the old name.
605 (if (string-match "[[*?]" filename)
606 (setq newname filename)
607 ;; If filename doesn't exist, newname will be nil.
608 (setq newname (w32-long-file-name filename)))
609 (setq filename (or newname filename)))
610 (setq done t)))
611
612 ;; If this file directly leads to a link, process that iteratively
613 ;; so that we don't use lots of stack.
614 (while (not done)
615 (setcar counter (1- (car counter)))
616 (if (< (car counter) 0)
617 (error "Apparent cycle of symbolic links for %s" filename))
618 (let ((handler (find-file-name-handler filename 'file-truename)))
619 ;; For file name that has a special handler, call handler.
620 ;; This is so that ange-ftp can save time by doing a no-op.
621 (if handler
622 (setq filename (funcall handler 'file-truename filename)
623 done t)
624 (let ((dir (or (file-name-directory filename) default-directory))
625 target dirfile)
626 ;; Get the truename of the directory.
627 (setq dirfile (directory-file-name dir))
628 ;; If these are equal, we have the (or a) root directory.
629 (or (string= dir dirfile)
630 ;; If this is the same dir we last got the truename for,
631 ;; save time--don't recalculate.
632 (if (assoc dir (car prev-dirs))
633 (setq dir (cdr (assoc dir (car prev-dirs))))
634 (let ((old dir)
635 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
636 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
637 (setq dir new))))
638 (if (equal ".." (file-name-nondirectory filename))
639 (setq filename
640 (directory-file-name (file-name-directory (directory-file-name dir)))
641 done t)
642 (if (equal "." (file-name-nondirectory filename))
643 (setq filename (directory-file-name dir)
644 done t)
645 ;; Put it back on the file name.
646 (setq filename (concat dir (file-name-nondirectory filename)))
647 ;; Is the file name the name of a link?
648 (setq target (file-symlink-p filename))
649 (if target
650 ;; Yes => chase that link, then start all over
651 ;; since the link may point to a directory name that uses links.
652 ;; We can't safely use expand-file-name here
653 ;; since target might look like foo/../bar where foo
654 ;; is itself a link. Instead, we handle . and .. above.
655 (setq filename
656 (if (file-name-absolute-p target)
657 target
658 (concat dir target))
659 done nil)
660 ;; No, we are done!
661 (setq done t))))))))
662 filename))
663
664 (defun file-chase-links (filename)
665 "Chase links in FILENAME until a name that is not a link.
666 Does not examine containing directories for links,
667 unlike `file-truename'."
668 (let (tem (count 100) (newname filename))
669 (while (setq tem (file-symlink-p newname))
670 (save-match-data
671 (if (= count 0)
672 (error "Apparent cycle of symbolic links for %s" filename))
673 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
674 (while (string-match "//+" tem)
675 (setq tem (replace-match "/" nil nil tem)))
676 ;; Handle `..' by hand, since it needs to work in the
677 ;; target of any directory symlink.
678 ;; This code is not quite complete; it does not handle
679 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
680 (while (string-match "\\`\\.\\./" tem)
681 (setq tem (substring tem 3))
682 (setq newname (expand-file-name newname))
683 ;; Chase links in the default dir of the symlink.
684 (setq newname
685 (file-chase-links
686 (directory-file-name (file-name-directory newname))))
687 ;; Now find the parent of that dir.
688 (setq newname (file-name-directory newname)))
689 (setq newname (expand-file-name tem (file-name-directory newname)))
690 (setq count (1- count))))
691 newname))
692 \f
693 (defun switch-to-buffer-other-window (buffer &optional norecord)
694 "Select buffer BUFFER in another window.
695 Optional second arg NORECORD non-nil means
696 do not put this buffer at the front of the list of recently selected ones.
697
698 This uses the function `display-buffer' as a subroutine; see its
699 documentation for additional customization information."
700 (interactive "BSwitch to buffer in other window: ")
701 (let ((pop-up-windows t))
702 (pop-to-buffer buffer t norecord)))
703
704 (defun switch-to-buffer-other-frame (buffer &optional norecord)
705 "Switch to buffer BUFFER in another frame.
706 Optional second arg NORECORD non-nil means
707 do not put this buffer at the front of the list of recently selected ones.
708
709 This uses the function `display-buffer' as a subroutine; see its
710 documentation for additional customization information."
711 (interactive "BSwitch to buffer in other frame: ")
712 (let ((pop-up-frames t))
713 (pop-to-buffer buffer t norecord)
714 (raise-frame (window-frame (selected-window)))))
715
716 (defun find-file (filename &optional wildcards)
717 "Edit file FILENAME.
718 Switch to a buffer visiting file FILENAME,
719 creating one if none already exists.
720 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
721 expand wildcards (if any) and visit multiple files. Wildcard expansion
722 can be suppressed by setting `find-file-wildcards'."
723 (interactive "FFind file: \np")
724 (let ((value (find-file-noselect filename nil nil wildcards)))
725 (if (listp value)
726 (mapcar 'switch-to-buffer (nreverse value))
727 (switch-to-buffer value))))
728
729 (defun find-file-other-window (filename &optional wildcards)
730 "Edit file FILENAME, in another window.
731 May create a new window, or reuse an existing one.
732 See the function `display-buffer'.
733 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
734 expand wildcards (if any) and visit multiple files."
735 (interactive "FFind file in other window: \np")
736 (let ((value (find-file-noselect filename nil nil wildcards)))
737 (if (listp value)
738 (progn
739 (setq value (nreverse value))
740 (switch-to-buffer-other-window (car value))
741 (mapcar 'switch-to-buffer (cdr value)))
742 (switch-to-buffer-other-window value))))
743
744 (defun find-file-other-frame (filename &optional wildcards)
745 "Edit file FILENAME, in another frame.
746 May create a new frame, or reuse an existing one.
747 See the function `display-buffer'.
748 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
749 expand wildcards (if any) and visit multiple files."
750 (interactive "FFind file in other frame: \np")
751 (let ((value (find-file-noselect filename nil nil wildcards)))
752 (if (listp value)
753 (progn
754 (setq value (nreverse value))
755 (switch-to-buffer-other-frame (car value))
756 (mapcar 'switch-to-buffer (cdr value)))
757 (switch-to-buffer-other-frame value))))
758
759 (defun find-file-read-only (filename &optional wildcards)
760 "Edit file FILENAME but don't allow changes.
761 Like `find-file' but marks buffer as read-only.
762 Use \\[toggle-read-only] to permit editing."
763 (interactive "fFind file read-only: \np")
764 (find-file filename wildcards)
765 (toggle-read-only 1)
766 (current-buffer))
767
768 (defun find-file-read-only-other-window (filename &optional wildcards)
769 "Edit file FILENAME in another window but don't allow changes.
770 Like \\[find-file-other-window] but marks buffer as read-only.
771 Use \\[toggle-read-only] to permit editing."
772 (interactive "fFind file read-only other window: \np")
773 (find-file-other-window filename wildcards)
774 (toggle-read-only 1)
775 (current-buffer))
776
777 (defun find-file-read-only-other-frame (filename &optional wildcards)
778 "Edit file FILENAME in another frame but don't allow changes.
779 Like \\[find-file-other-frame] but marks buffer as read-only.
780 Use \\[toggle-read-only] to permit editing."
781 (interactive "fFind file read-only other frame: \np")
782 (find-file-other-frame filename wildcards)
783 (toggle-read-only 1)
784 (current-buffer))
785
786 (defun find-alternate-file-other-window (filename)
787 "Find file FILENAME as a replacement for the file in the next window.
788 This command does not select that window."
789 (interactive
790 (save-selected-window
791 (other-window 1)
792 (let ((file buffer-file-name)
793 (file-name nil)
794 (file-dir nil))
795 (and file
796 (setq file-name (file-name-nondirectory file)
797 file-dir (file-name-directory file)))
798 (list (read-file-name
799 "Find alternate file: " file-dir nil nil file-name)))))
800 (if (one-window-p)
801 (find-file-other-window filename)
802 (save-selected-window
803 (other-window 1)
804 (find-alternate-file filename))))
805
806 (defun find-alternate-file (filename)
807 "Find file FILENAME, select its buffer, kill previous buffer.
808 If the current buffer now contains an empty file that you just visited
809 \(presumably by mistake), use this command to visit the file you really want."
810 (interactive
811 (let ((file buffer-file-name)
812 (file-name nil)
813 (file-dir nil))
814 (and file
815 (setq file-name (file-name-nondirectory file)
816 file-dir (file-name-directory file)))
817 (list (read-file-name
818 "Find alternate file: " file-dir nil nil file-name))))
819 (and (buffer-modified-p) (buffer-file-name)
820 ;; (not buffer-read-only)
821 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
822 (buffer-name))))
823 (error "Aborted"))
824 (let ((obuf (current-buffer))
825 (ofile buffer-file-name)
826 (onum buffer-file-number)
827 (otrue buffer-file-truename)
828 (oname (buffer-name)))
829 (if (get-buffer " **lose**")
830 (kill-buffer " **lose**"))
831 (rename-buffer " **lose**")
832 (unwind-protect
833 (progn
834 (unlock-buffer)
835 (setq buffer-file-name nil)
836 (setq buffer-file-number nil)
837 (setq buffer-file-truename nil)
838 (find-file filename))
839 (cond ((eq obuf (current-buffer))
840 (setq buffer-file-name ofile)
841 (setq buffer-file-number onum)
842 (setq buffer-file-truename otrue)
843 (lock-buffer)
844 (rename-buffer oname))))
845 (or (eq (current-buffer) obuf)
846 (kill-buffer obuf))))
847 \f
848 (defun create-file-buffer (filename)
849 "Create a suitably named buffer for visiting FILENAME, and return it.
850 FILENAME (sans directory) is used unchanged if that name is free;
851 otherwise a string <2> or <3> or ... is appended to get an unused name."
852 (let ((lastname (file-name-nondirectory filename)))
853 (if (string= lastname "")
854 (setq lastname filename))
855 (generate-new-buffer lastname)))
856
857 (defun generate-new-buffer (name)
858 "Create and return a buffer with a name based on NAME.
859 Choose the buffer's name using `generate-new-buffer-name'."
860 (get-buffer-create (generate-new-buffer-name name)))
861
862 (defcustom automount-dir-prefix "^/tmp_mnt/"
863 "Regexp to match the automounter prefix in a directory name."
864 :group 'files
865 :type 'regexp)
866
867 (defvar abbreviated-home-dir nil
868 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
869
870 (defun abbreviate-file-name (filename)
871 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
872 This also substitutes \"~\" for the user's home directory.
873 Type \\[describe-variable] directory-abbrev-alist RET for more information."
874 ;; Get rid of the prefixes added by the automounter.
875 (if (and automount-dir-prefix
876 (string-match automount-dir-prefix filename)
877 (file-exists-p (file-name-directory
878 (substring filename (1- (match-end 0))))))
879 (setq filename (substring filename (1- (match-end 0)))))
880 (let ((tail directory-abbrev-alist))
881 ;; If any elt of directory-abbrev-alist matches this name,
882 ;; abbreviate accordingly.
883 (while tail
884 (if (string-match (car (car tail)) filename)
885 (setq filename
886 (concat (cdr (car tail)) (substring filename (match-end 0)))))
887 (setq tail (cdr tail)))
888 ;; Compute and save the abbreviated homedir name.
889 ;; We defer computing this until the first time it's needed, to
890 ;; give time for directory-abbrev-alist to be set properly.
891 ;; We include a slash at the end, to avoid spurious matches
892 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
893 (or abbreviated-home-dir
894 (setq abbreviated-home-dir
895 (let ((abbreviated-home-dir "$foo"))
896 (concat "^" (abbreviate-file-name (expand-file-name "~"))
897 "\\(/\\|$\\)"))))
898
899 ;; If FILENAME starts with the abbreviated homedir,
900 ;; make it start with `~' instead.
901 (if (and (string-match abbreviated-home-dir filename)
902 ;; If the home dir is just /, don't change it.
903 (not (and (= (match-end 0) 1)
904 (= (aref filename 0) ?/)))
905 ;; MS-DOS root directories can come with a drive letter;
906 ;; Novell Netware allows drive letters beyond `Z:'.
907 (not (and (or (eq system-type 'ms-dos)
908 (eq system-type 'windows-nt))
909 (save-match-data
910 (string-match "^[a-zA-`]:/$" filename)))))
911 (setq filename
912 (concat "~"
913 (substring filename (match-beginning 1) (match-end 1))
914 (substring filename (match-end 0)))))
915 filename))
916
917 (defcustom find-file-not-true-dirname-list nil
918 "*List of logical names for which visiting shouldn't save the true dirname.
919 On VMS, when you visit a file using a logical name that searches a path,
920 you may or may not want the visited file name to record the specific
921 directory where the file was found. If you *do not* want that, add the logical
922 name to this list as a string."
923 :type '(repeat (string :tag "Name"))
924 :group 'find-file)
925
926 (defun find-buffer-visiting (filename)
927 "Return the buffer visiting file FILENAME (a string).
928 This is like `get-file-buffer', except that it checks for any buffer
929 visiting the same file, possibly under a different name.
930 If there is no such live buffer, return nil."
931 (let ((buf (get-file-buffer filename))
932 (truename (abbreviate-file-name (file-truename filename))))
933 (or buf
934 (let ((list (buffer-list)) found)
935 (while (and (not found) list)
936 (save-excursion
937 (set-buffer (car list))
938 (if (and buffer-file-name
939 (string= buffer-file-truename truename))
940 (setq found (car list))))
941 (setq list (cdr list)))
942 found)
943 (let* ((attributes (file-attributes truename))
944 (number (nthcdr 10 attributes))
945 (list (buffer-list)) found)
946 (and buffer-file-numbers-unique
947 number
948 (while (and (not found) list)
949 (with-current-buffer (car list)
950 (if (and buffer-file-name
951 (equal buffer-file-number number)
952 ;; Verify this buffer's file number
953 ;; still belongs to its file.
954 (file-exists-p buffer-file-name)
955 (equal (file-attributes buffer-file-name)
956 attributes))
957 (setq found (car list))))
958 (setq list (cdr list))))
959 found))))
960 \f
961 (defcustom find-file-wildcards t
962 "*Non-nil means file-visiting commands should handle wildcards.
963 For example, if you specify `*.c', that would visit all the files
964 whose names match the pattern."
965 :group 'files
966 :version "20.4"
967 :type 'boolean)
968
969 (defcustom find-file-suppress-same-file-warnings nil
970 "*Non-nil means suppress warning messages for symlinked files.
971 When nil, Emacs prints a warning when visiting a file that is already
972 visited, but with a different name. Setting this option to t
973 suppresses this warning."
974 :group 'files
975 :version "21.1"
976 :type 'boolean)
977
978 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
979 "Read file FILENAME into a buffer and return the buffer.
980 If a buffer exists visiting FILENAME, return that one, but
981 verify that the file has not changed since visited or saved.
982 The buffer is not selected, just returned to the caller.
983 Optional first arg NOWARN non-nil means suppress any warning messages.
984 Optional second arg RAWFILE non-nil means the file is read literally.
985 Optional third arg WILDCARDS non-nil means do wildcard processing
986 and visit all the matching files. When wildcards are actually
987 used and expanded, the value is a list of buffers
988 that are visiting the various files."
989 (setq filename
990 (abbreviate-file-name
991 (expand-file-name filename)))
992 (if (file-directory-p filename)
993 (or (and find-file-run-dired
994 (run-hook-with-args-until-success
995 'find-directory-functions
996 (if find-file-visit-truename
997 (abbreviate-file-name (file-truename filename))
998 filename)))
999 (error "%s is a directory" filename))
1000 (if (and wildcards
1001 find-file-wildcards
1002 (not (string-match "\\`/:" filename))
1003 (string-match "[[*?]" filename))
1004 (let ((files (condition-case nil
1005 (file-expand-wildcards filename t)
1006 (error (list filename))))
1007 (find-file-wildcards nil))
1008 (if (null files)
1009 (find-file-noselect filename)
1010 (mapcar #'find-file-noselect files)))
1011 (let* ((buf (get-file-buffer filename))
1012 (truename (abbreviate-file-name (file-truename filename)))
1013 (number (nthcdr 10 (file-attributes truename)))
1014 ;; Find any buffer for a file which has same truename.
1015 (other (and (not buf) (find-buffer-visiting filename))))
1016 ;; Let user know if there is a buffer with the same truename.
1017 (if other
1018 (progn
1019 (or nowarn
1020 find-file-suppress-same-file-warnings
1021 (string-equal filename (buffer-file-name other))
1022 (message "%s and %s are the same file"
1023 filename (buffer-file-name other)))
1024 ;; Optionally also find that buffer.
1025 (if (or find-file-existing-other-name find-file-visit-truename)
1026 (setq buf other))))
1027 (if buf
1028 ;; We are using an existing buffer.
1029 (progn
1030 (or nowarn
1031 (verify-visited-file-modtime buf)
1032 (cond ((not (file-exists-p filename))
1033 (error "File %s no longer exists!" filename))
1034 ;; Certain files should be reverted automatically
1035 ;; if they have changed on disk and not in the buffer.
1036 ((and (not (buffer-modified-p buf))
1037 (let ((tail revert-without-query)
1038 (found nil))
1039 (while tail
1040 (if (string-match (car tail) filename)
1041 (setq found t))
1042 (setq tail (cdr tail)))
1043 found))
1044 (with-current-buffer buf
1045 (message "Reverting file %s..." filename)
1046 (revert-buffer t t)
1047 (message "Reverting file %s...done" filename)))
1048 ((yes-or-no-p
1049 (if (string= (file-name-nondirectory filename)
1050 (buffer-name buf))
1051 (format
1052 (if (buffer-modified-p buf)
1053 "File %s changed on disk. Discard your edits? "
1054 "File %s changed on disk. Reread from disk? ")
1055 (file-name-nondirectory filename))
1056 (format
1057 (if (buffer-modified-p buf)
1058 "File %s changed on disk. Discard your edits in %s? "
1059 "File %s changed on disk. Reread from disk into %s? ")
1060 (file-name-nondirectory filename)
1061 (buffer-name buf))))
1062 (with-current-buffer buf
1063 (revert-buffer t t)))))
1064 (with-current-buffer buf
1065
1066 ;; Check if a formerly read-only file has become
1067 ;; writable and vice versa, but if the buffer agrees
1068 ;; with the new state of the file, that is ok too.
1069 (let ((read-only (not (file-writable-p buffer-file-name))))
1070 (unless (or (eq read-only buffer-file-read-only)
1071 (eq read-only buffer-read-only))
1072 (when (or nowarn
1073 (let ((question
1074 (format "File %s is %s on disk. Change buffer mode? "
1075 buffer-file-name
1076 (if read-only "read-only" "writable"))))
1077 (y-or-n-p question)))
1078 (setq buffer-read-only read-only)))
1079 (setq buffer-file-read-only read-only))
1080
1081 (when (not (eq (not (null rawfile))
1082 (not (null find-file-literally))))
1083 (if (buffer-modified-p)
1084 (if (y-or-n-p (if rawfile
1085 "Save file and revisit literally? "
1086 "Save file and revisit non-literally? "))
1087 (progn
1088 (save-buffer)
1089 (find-file-noselect-1 buf filename nowarn
1090 rawfile truename number))
1091 (if (y-or-n-p (if rawfile
1092 "Discard your edits and revisit file literally? "
1093 "Discard your edits and revisit file non-literally? "))
1094 (find-file-noselect-1 buf filename nowarn
1095 rawfile truename number)
1096 (error (if rawfile "File already visited non-literally"
1097 "File already visited literally"))))
1098 (if (y-or-n-p (if rawfile
1099 "Revisit file literally? "
1100 "Revisit file non-literally? "))
1101 (find-file-noselect-1 buf filename nowarn
1102 rawfile truename number)
1103 (error (if rawfile "File already visited non-literally"
1104 "File already visited literally"))))))
1105 ;; Return the buffer we are using.
1106 buf)
1107 ;; Create a new buffer.
1108 (setq buf (create-file-buffer filename))
1109 (set-buffer-major-mode buf)
1110 ;; find-file-noselect-1 may use a different buffer.
1111 (find-file-noselect-1 buf filename nowarn
1112 rawfile truename number))))))
1113
1114 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1115 (let ((inhibit-read-only t)
1116 error)
1117 (with-current-buffer buf
1118 (kill-local-variable 'find-file-literally)
1119 ;; Needed in case we are re-visiting the file with a different
1120 ;; text representation.
1121 (kill-local-variable 'buffer-file-coding-system)
1122 (erase-buffer)
1123 (and (default-value 'enable-multibyte-characters)
1124 (not rawfile)
1125 (set-buffer-multibyte t))
1126 (if rawfile
1127 (condition-case ()
1128 (insert-file-contents-literally filename t)
1129 (file-error
1130 (when (and (file-exists-p filename)
1131 (not (file-readable-p filename)))
1132 (kill-buffer buf)
1133 (signal 'file-error (list "File is not readable"
1134 filename)))
1135 ;; Unconditionally set error
1136 (setq error t)))
1137 (condition-case ()
1138 (insert-file-contents filename t)
1139 (file-error
1140 (when (and (file-exists-p filename)
1141 (not (file-readable-p filename)))
1142 (kill-buffer buf)
1143 (signal 'file-error (list "File is not readable"
1144 filename)))
1145 ;; Run find-file-not-found-hooks until one returns non-nil.
1146 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
1147 ;; If they fail too, set error.
1148 (setq error t)))))
1149 ;; Record the file's truename, and maybe use that as visited name.
1150 (if (equal filename buffer-file-name)
1151 (setq buffer-file-truename truename)
1152 (setq buffer-file-truename
1153 (abbreviate-file-name (file-truename buffer-file-name))))
1154 (setq buffer-file-number number)
1155 ;; On VMS, we may want to remember which directory in a search list
1156 ;; the file was found in.
1157 (and (eq system-type 'vax-vms)
1158 (let (logical)
1159 (if (string-match ":" (file-name-directory filename))
1160 (setq logical (substring (file-name-directory filename)
1161 0 (match-beginning 0))))
1162 (not (member logical find-file-not-true-dirname-list)))
1163 (setq buffer-file-name buffer-file-truename))
1164 (if find-file-visit-truename
1165 (setq buffer-file-name
1166 (setq filename
1167 (expand-file-name buffer-file-truename))))
1168 ;; Set buffer's default directory to that of the file.
1169 (setq default-directory (file-name-directory buffer-file-name))
1170 ;; Turn off backup files for certain file names. Since
1171 ;; this is a permanent local, the major mode won't eliminate it.
1172 (and (not (funcall backup-enable-predicate buffer-file-name))
1173 (progn
1174 (make-local-variable 'backup-inhibited)
1175 (setq backup-inhibited t)))
1176 (if rawfile
1177 (progn
1178 (set-buffer-multibyte nil)
1179 (setq buffer-file-coding-system 'no-conversion)
1180 (make-local-variable 'find-file-literally)
1181 (setq find-file-literally t))
1182 (after-find-file error (not nowarn)))
1183 (current-buffer))))
1184 \f
1185 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1186 "Like `insert-file-contents', but only reads in the file literally.
1187 A buffer may be modified in several ways after reading into the buffer,
1188 to Emacs features such as format decoding, character code
1189 conversion, `find-file-hooks', automatic uncompression, etc.
1190
1191 This function ensures that none of these modifications will take place."
1192 (let ((format-alist nil)
1193 (after-insert-file-functions nil)
1194 (coding-system-for-read 'no-conversion)
1195 (coding-system-for-write 'no-conversion)
1196 (find-buffer-file-type-function
1197 (if (fboundp 'find-buffer-file-type)
1198 (symbol-function 'find-buffer-file-type)
1199 nil))
1200 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
1201 (inhibit-file-name-operation 'insert-file-contents))
1202 (unwind-protect
1203 (progn
1204 (fset 'find-buffer-file-type (lambda (filename) t))
1205 (insert-file-contents filename visit beg end replace))
1206 (if find-buffer-file-type-function
1207 (fset 'find-buffer-file-type find-buffer-file-type-function)
1208 (fmakunbound 'find-buffer-file-type)))))
1209
1210 (defun insert-file-literally (filename)
1211 "Insert contents of file FILENAME into buffer after point with no conversion.
1212
1213 This function is meant for the user to run interactively.
1214 Don't call it from programs! Use `insert-file-contents-literally' instead.
1215 \(Its calling sequence is different; see its documentation)."
1216 (interactive "*fInsert file literally: ")
1217 (if (file-directory-p filename)
1218 (signal 'file-error (list "Opening input file" "file is a directory"
1219 filename)))
1220 (let ((tem (insert-file-contents-literally filename)))
1221 (push-mark (+ (point) (car (cdr tem))))))
1222
1223 (defvar find-file-literally nil
1224 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1225 This is a permanent local.")
1226 (put 'find-file-literally 'permanent-local t)
1227
1228 (defun find-file-literally (filename)
1229 "Visit file FILENAME with no conversion of any kind.
1230 Format conversion and character code conversion are both disabled,
1231 and multibyte characters are disabled in the resulting buffer.
1232 The major mode used is Fundamental mode regardless of the file name,
1233 and local variable specifications in the file are ignored.
1234 Automatic uncompression and adding a newline at the end of the
1235 file due to `require-final-newline' is also disabled.
1236
1237 You cannot absolutely rely on this function to result in
1238 visiting the file literally. If Emacs already has a buffer
1239 which is visiting the file, you get the existing buffer,
1240 regardless of whether it was created literally or not.
1241
1242 In a Lisp program, if you want to be sure of accessing a file's
1243 contents literally, you should create a temporary buffer and then read
1244 the file contents into it using `insert-file-contents-literally'."
1245 (interactive "FFind file literally: ")
1246 (switch-to-buffer (find-file-noselect filename nil t)))
1247 \f
1248 (defvar after-find-file-from-revert-buffer nil)
1249
1250 (defun after-find-file (&optional error warn noauto
1251 after-find-file-from-revert-buffer
1252 nomodes)
1253 "Called after finding a file and by the default revert function.
1254 Sets buffer mode, parses local variables.
1255 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1256 error in reading the file. WARN non-nil means warn if there
1257 exists an auto-save file more recent than the visited file.
1258 NOAUTO means don't mess with auto-save mode.
1259 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1260 means this call was from `revert-buffer'.
1261 Fifth arg NOMODES non-nil means don't alter the file's modes.
1262 Finishes by calling the functions in `find-file-hooks'
1263 unless NOMODES is non-nil."
1264 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1265 (if noninteractive
1266 nil
1267 (let* (not-serious
1268 (msg
1269 (cond
1270 ((not warn) nil)
1271 ((and error (file-attributes buffer-file-name))
1272 (setq buffer-read-only t)
1273 "File exists, but cannot be read")
1274 ((not buffer-read-only)
1275 (if (and warn
1276 ;; No need to warn if buffer is auto-saved
1277 ;; under the name of the visited file.
1278 (not (and buffer-file-name
1279 auto-save-visited-file-name))
1280 (file-newer-than-file-p (or buffer-auto-save-file-name
1281 (make-auto-save-file-name))
1282 buffer-file-name))
1283 (format "%s has auto save data; consider M-x recover-file"
1284 (file-name-nondirectory buffer-file-name))
1285 (setq not-serious t)
1286 (if error "(New file)" nil)))
1287 ((not error)
1288 (setq not-serious t)
1289 "Note: file is write protected")
1290 ((file-attributes (directory-file-name default-directory))
1291 "File not found and directory write-protected")
1292 ((file-exists-p (file-name-directory buffer-file-name))
1293 (setq buffer-read-only nil))
1294 (t
1295 (setq buffer-read-only nil)
1296 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1297 "Use M-x make-directory RET RET to create the directory"
1298 "Use C-u M-x make-directory RET RET to create directory and its parents")))))
1299 (when msg
1300 (message msg)
1301 (or not-serious (sit-for 1 nil t))))
1302 (when (and auto-save-default (not noauto))
1303 (auto-save-mode t)))
1304 ;; Make people do a little extra work (C-x C-q)
1305 ;; before altering a backup file.
1306 (when (backup-file-name-p buffer-file-name)
1307 (setq buffer-read-only t))
1308 (unless nomodes
1309 (when (and view-read-only view-mode)
1310 (view-mode-disable))
1311 (normal-mode t)
1312 (when (and buffer-read-only
1313 view-read-only
1314 (not (eq (get major-mode 'mode-class) 'special)))
1315 (view-mode-enter))
1316 (run-hooks 'find-file-hooks)))
1317
1318 (defun normal-mode (&optional find-file)
1319 "Choose the major mode for this buffer automatically.
1320 Also sets up any specified local variables of the file.
1321 Uses the visited file name, the -*- line, and the local variables spec.
1322
1323 This function is called automatically from `find-file'. In that case,
1324 we may set up the file-specified mode and local variables,
1325 depending on the value of `enable-local-variables': if it is t, we do;
1326 if it is nil, we don't; otherwise, we query.
1327 In addition, if `local-enable-local-variables' is nil, we do
1328 not set local variables (though we do notice a mode specified with -*-.)
1329
1330 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1331 or from Lisp without specifying the optional argument FIND-FILE;
1332 in that case, this function acts as if `enable-local-variables' were t."
1333 (interactive)
1334 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1335 (condition-case err
1336 (set-auto-mode)
1337 (error (message "File mode specification error: %s"
1338 (prin1-to-string err))))
1339 (condition-case err
1340 (let ((enable-local-variables (or (not find-file)
1341 enable-local-variables)))
1342 (hack-local-variables))
1343 (error (message "File local-variables error: %s"
1344 (prin1-to-string err)))))
1345
1346 (defvar auto-mode-alist
1347 (mapc
1348 (lambda (elt)
1349 (cons (purecopy (car elt)) (cdr elt)))
1350 '(("\\.te?xt\\'" . text-mode)
1351 ("\\.c\\'" . c-mode)
1352 ("\\.h\\'" . c-mode)
1353 ("\\.tex\\'" . tex-mode)
1354 ("\\.ltx\\'" . latex-mode)
1355 ("\\.el\\'" . emacs-lisp-mode)
1356 ("\\.scm\\'" . scheme-mode)
1357 ("\\.l\\'" . lisp-mode)
1358 ("\\.lisp\\'" . lisp-mode)
1359 ("\\.f\\'" . fortran-mode)
1360 ("\\.F\\'" . fortran-mode)
1361 ("\\.for\\'" . fortran-mode)
1362 ("\\.p\\'" . pascal-mode)
1363 ("\\.pas\\'" . pascal-mode)
1364 ("\\.ad[abs]\\'" . ada-mode)
1365 ("\\.\\([pP]\\([Llm]\\|erl\\)\\|al\\)\\'" . perl-mode)
1366 ("\\.s?html?\\'" . html-mode)
1367 ("\\.cc\\'" . c++-mode)
1368 ("\\.hh\\'" . c++-mode)
1369 ("\\.hpp\\'" . c++-mode)
1370 ("\\.C\\'" . c++-mode)
1371 ("\\.H\\'" . c++-mode)
1372 ("\\.cpp\\'" . c++-mode)
1373 ("\\.cxx\\'" . c++-mode)
1374 ("\\.hxx\\'" . c++-mode)
1375 ("\\.c\\+\\+\\'" . c++-mode)
1376 ("\\.h\\+\\+\\'" . c++-mode)
1377 ("\\.m\\'" . objc-mode)
1378 ("\\.java\\'" . java-mode)
1379 ("\\.mk\\'" . makefile-mode)
1380 ("\\(M\\|m\\|GNUm\\)akefile\\(\\.in\\)?\\'" . makefile-mode)
1381 ("\\.am\\'" . makefile-mode) ;For Automake.
1382 ;; Less common extensions come here
1383 ;; so more common ones above are found faster.
1384 ("\\.texinfo\\'" . texinfo-mode)
1385 ("\\.te?xi\\'" . texinfo-mode)
1386 ("\\.s\\'" . asm-mode)
1387 ("\\.S\\'" . asm-mode)
1388 ("\\.asm\\'" . asm-mode)
1389 ("ChangeLog\\'" . change-log-mode)
1390 ("change\\.log\\'" . change-log-mode)
1391 ("changelo\\'" . change-log-mode)
1392 ("ChangeLog\\.[0-9]+\\'" . change-log-mode)
1393 ;; for MSDOS and MS-Windows (which are case-insensitive)
1394 ("changelog\\'" . change-log-mode)
1395 ("changelog\\.[0-9]+\\'" . change-log-mode)
1396 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1397 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1398 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1399 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1400 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1401 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1402 ("\\.m?spec\\'" . sh-mode)
1403 ("\\.mm\\'" . nroff-mode)
1404 ("\\.me\\'" . nroff-mode)
1405 ("\\.ms\\'" . nroff-mode)
1406 ("\\.man\\'" . nroff-mode)
1407 ("\\.\\(u?lpc\\|pike\\|pmod\\)\\'" . pike-mode)
1408 ("\\.TeX\\'" . tex-mode)
1409 ("\\.sty\\'" . latex-mode)
1410 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1411 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
1412 ("\\.bbl\\'" . latex-mode)
1413 ("\\.bib\\'" . bibtex-mode)
1414 ("\\.sql\\'" . sql-mode)
1415 ("\\.m4\\'" . m4-mode)
1416 ("\\.mc\\'" . m4-mode)
1417 ("\\.mf\\'" . metafont-mode)
1418 ("\\.mp\\'" . metapost-mode)
1419 ("\\.vhdl?\\'" . vhdl-mode)
1420 ("\\.article\\'" . text-mode)
1421 ("\\.letter\\'" . text-mode)
1422 ("\\.tcl\\'" . tcl-mode)
1423 ("\\.exp\\'" . tcl-mode)
1424 ("\\.itcl\\'" . tcl-mode)
1425 ("\\.itk\\'" . tcl-mode)
1426 ("\\.icn\\'" . icon-mode)
1427 ("\\.sim\\'" . simula-mode)
1428 ("\\.mss\\'" . scribe-mode)
1429 ("\\.f90\\'" . f90-mode)
1430 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
1431 ("\\.pro\\'" . idlwave-mode)
1432 ("\\.lsp\\'" . lisp-mode)
1433 ("\\.awk\\'" . awk-mode)
1434 ("\\.prolog\\'" . prolog-mode)
1435 ("\\.tar\\'" . tar-mode)
1436 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\)\\'" . archive-mode)
1437 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\)\\'" . archive-mode)
1438 ;; Mailer puts message to be edited in
1439 ;; /tmp/Re.... or Message
1440 ("\\`/tmp/Re" . text-mode)
1441 ("/Message[0-9]*\\'" . text-mode)
1442 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1443 ("\\.zone\\'" . zone-mode)
1444 ;; some news reader is reported to use this
1445 ("\\`/tmp/fol/" . text-mode)
1446 ("\\.y\\'" . c-mode)
1447 ("\\.lex\\'" . c-mode)
1448 ("\\.oak\\'" . scheme-mode)
1449 ("\\.sgml?\\'" . sgml-mode)
1450 ("\\.xml\\'" . sgml-mode)
1451 ("\\.dtd\\'" . sgml-mode)
1452 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1453 ("\\.idl\\'" . idl-mode)
1454 ;; .emacs following a directory delimiter
1455 ;; in Unix, MSDOG or VMS syntax.
1456 ("[]>:/\\]\\..*emacs\\'" . emacs-lisp-mode)
1457 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1458 ;; _emacs following a directory delimiter
1459 ;; in MsDos syntax
1460 ("[:/]_emacs\\'" . emacs-lisp-mode)
1461 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1462 ("\\.ml\\'" . lisp-mode)
1463 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1464 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
1465 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
1466 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
1467 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
1468 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
1469 ("BROWSE\\'" . ebrowse-tree-mode)
1470 ("\\.ebrowse\\'" . ebrowse-tree-mode)
1471 ("#\\*mail\\*" . mail-mode)
1472 ;; Get rid of any trailing .n.m and try again.
1473 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1474 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1475 ;; Using mode nil rather than `ignore' would let the search continue
1476 ;; through this list (with the shortened name) rather than start over.
1477 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" ignore t)
1478 ;; The following should come after the ChangeLog pattern
1479 ;; for the sake of ChangeLog.1, etc.
1480 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1481 ("\\.[1-9]\\'" . nroff-mode)
1482 ("\\.g\\'" . antlr-mode)))
1483 "Alist of filename patterns vs corresponding major mode functions.
1484 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1485 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1486 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1487 mode function to use. FUNCTION will be called, unless it is nil.
1488
1489 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1490 calling FUNCTION (if it's not nil), we delete the suffix that matched
1491 REGEXP and search the list again for another match.")
1492
1493
1494 (defvar interpreter-mode-alist
1495 (mapc
1496 (lambda (l)
1497 (cons (purecopy (car l)) (cdr l)))
1498 '(("perl" . perl-mode)
1499 ("perl5" . perl-mode)
1500 ("miniperl" . perl-mode)
1501 ("wish" . tcl-mode)
1502 ("wishx" . tcl-mode)
1503 ("tcl" . tcl-mode)
1504 ("tclsh" . tcl-mode)
1505 ("awk" . awk-mode)
1506 ("mawk" . awk-mode)
1507 ("nawk" . awk-mode)
1508 ("gawk" . awk-mode)
1509 ("scm" . scheme-mode)
1510 ("ash" . sh-mode)
1511 ("bash" . sh-mode)
1512 ("bash2" . sh-mode)
1513 ("csh" . sh-mode)
1514 ("dtksh" . sh-mode)
1515 ("es" . sh-mode)
1516 ("itcsh" . sh-mode)
1517 ("jsh" . sh-mode)
1518 ("ksh" . sh-mode)
1519 ("oash" . sh-mode)
1520 ("pdksh" . sh-mode)
1521 ("rc" . sh-mode)
1522 ("rpm" . sh-mode)
1523 ("sh" . sh-mode)
1524 ("sh5" . sh-mode)
1525 ("tcsh" . sh-mode)
1526 ("wksh" . sh-mode)
1527 ("wsh" . sh-mode)
1528 ("zsh" . sh-mode)
1529 ("tail" . text-mode)
1530 ("more" . text-mode)
1531 ("less" . text-mode)
1532 ("pg" . text-mode)
1533 ("make" . makefile-mode) ; Debian uses this
1534 ("guile" . scheme-mode)
1535 ("clisp" . lisp-mode)))
1536 "Alist mapping interpreter names to major modes.
1537 This alist applies to files whose first line starts with `#!'.
1538 Each element looks like (INTERPRETER . MODE).
1539 The car of each element is compared with
1540 the name of the interpreter specified in the first line.
1541 If it matches, mode MODE is selected.")
1542
1543 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
1544 "List of regexps; if one matches a file name, don't look for `-*-'.")
1545
1546 (defvar inhibit-first-line-modes-suffixes nil
1547 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1548 When checking `inhibit-first-line-modes-regexps', we first discard
1549 from the end of the file name anything that matches one of these regexps.")
1550
1551 (defvar auto-mode-interpreter-regexp
1552 "#![ \t]?\\([^ \t\n]*\
1553 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
1554 "Regular expression matching interpreters, for file mode determination.
1555 This regular expression is matched against the first line of a file
1556 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1557 a mode from the file's name. If it matches, the file is assumed to
1558 be interpreted by the interpreter matched by the second group of the
1559 regular expression. The mode is then determined as the mode associated
1560 with that interpreter in `interpreter-mode-alist'.")
1561
1562 (defun set-auto-mode (&optional just-from-file-name)
1563 "Select major mode appropriate for current buffer.
1564 This checks for a -*- mode tag in the buffer's text,
1565 compares the filename against the entries in `auto-mode-alist',
1566 or checks the interpreter that runs this file against
1567 `interpreter-mode-alist'.
1568
1569 It does not check for the `mode:' local variable in the
1570 Local Variables section of the file; for that, use `hack-local-variables'.
1571
1572 If `enable-local-variables' is nil, this function does not check for a
1573 -*- mode tag.
1574
1575 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1576 then we do not set anything but the major mode,
1577 and we don't even do that unless it would come from the file name."
1578 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1579 (let (end done modes)
1580 (save-excursion
1581 (goto-char (point-min))
1582 (skip-chars-forward " \t\n")
1583 (and enable-local-variables
1584 (setq end (set-auto-mode-1))
1585 (if (save-excursion (search-forward ":" end t))
1586 ;; Find all specifications for the `mode:' variable
1587 ;; and execute them left to right.
1588 (while (let ((case-fold-search t))
1589 (or (and (looking-at "mode:")
1590 (goto-char (match-end 0)))
1591 (re-search-forward "[ \t;]mode:" end t)))
1592 (skip-chars-forward " \t")
1593 (let ((beg (point)))
1594 (if (search-forward ";" end t)
1595 (forward-char -1)
1596 (goto-char end))
1597 (skip-chars-backward " \t")
1598 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1599 modes)))
1600 ;; Simple -*-MODE-*- case.
1601 (push (intern (concat (downcase (buffer-substring (point) end))
1602 "-mode"))
1603 modes))))
1604 ;; If we found modes to use, invoke them now,
1605 ;; outside the save-excursion.
1606 (unless just-from-file-name
1607 (dolist (mode (nreverse modes))
1608 (if (not (functionp mode))
1609 (message "Ignoring unknown mode `%s'" mode)
1610 (setq done t)
1611 (funcall mode))))
1612 ;; If we didn't find a mode from a -*- line, try using the file name.
1613 (if (and (not done) buffer-file-name)
1614 (let ((name buffer-file-name)
1615 (keep-going t))
1616 ;; Remove backup-suffixes from file name.
1617 (setq name (file-name-sans-versions name))
1618 (while keep-going
1619 (setq keep-going nil)
1620 (let ((alist auto-mode-alist)
1621 (mode nil))
1622 ;; Find first matching alist entry.
1623 (let ((case-fold-search
1624 (memq system-type '(vax-vms windows-nt))))
1625 (while (and (not mode) alist)
1626 (if (string-match (car (car alist)) name)
1627 (if (and (consp (cdr (car alist)))
1628 (nth 2 (car alist)))
1629 (setq mode (car (cdr (car alist)))
1630 name (substring name 0 (match-beginning 0))
1631 keep-going t)
1632 (setq mode (cdr (car alist))
1633 keep-going nil)))
1634 (setq alist (cdr alist))))
1635 (if mode
1636 ;; When JUST-FROM-FILE-NAME is set,
1637 ;; we are working on behalf of set-visited-file-name.
1638 ;; In that case, if the major mode specified is the
1639 ;; same one we already have, don't actually reset it.
1640 ;; We don't want to lose minor modes such as Font Lock.
1641 (unless (and just-from-file-name (eq mode major-mode))
1642 (funcall mode))
1643 ;; If we can't deduce a mode from the file name,
1644 ;; look for an interpreter specified in the first line.
1645 ;; As a special case, allow for things like "#!/bin/env perl",
1646 ;; which finds the interpreter anywhere in $PATH.
1647 (let ((interpreter
1648 (save-excursion
1649 (goto-char (point-min))
1650 (if (looking-at auto-mode-interpreter-regexp)
1651 (match-string 2)
1652 "")))
1653 elt)
1654 ;; Map interpreter name to a mode.
1655 (setq elt (assoc (file-name-nondirectory interpreter)
1656 interpreter-mode-alist))
1657 (unless just-from-file-name
1658 (if elt
1659 (funcall (cdr elt))))))))))))
1660
1661
1662 (defun set-auto-mode-1 ()
1663 "Find the -*- spec in the buffer.
1664 Call with point at the place to start searching from.
1665 If one is found, set point to the beginning
1666 and return the position of the end.
1667 Otherwise, return nil; point may be changed."
1668 (let (beg end)
1669 (and
1670 ;; Don't look for -*- if this file name matches any
1671 ;; of the regexps in inhibit-first-line-modes-regexps.
1672 (let ((temp inhibit-first-line-modes-regexps)
1673 (name (if buffer-file-name
1674 (file-name-sans-versions buffer-file-name)
1675 (buffer-name))))
1676 (while (let ((sufs inhibit-first-line-modes-suffixes))
1677 (while (and sufs (not (string-match (car sufs) name)))
1678 (setq sufs (cdr sufs)))
1679 sufs)
1680 (setq name (substring name 0 (match-beginning 0))))
1681 (while (and temp
1682 (not (string-match (car temp) name)))
1683 (setq temp (cdr temp)))
1684 (not temp))
1685
1686 (search-forward "-*-" (save-excursion
1687 ;; If the file begins with "#!"
1688 ;; (exec interpreter magic), look
1689 ;; for mode frobs in the first two
1690 ;; lines. You cannot necessarily
1691 ;; put them in the first line of
1692 ;; such a file without screwing up
1693 ;; the interpreter invocation.
1694 (end-of-line (and (looking-at "^#!") 2))
1695 (point)) t)
1696 (progn
1697 (skip-chars-forward " \t")
1698 (setq beg (point))
1699 (search-forward "-*-"
1700 (save-excursion (end-of-line) (point))
1701 t))
1702 (progn
1703 (forward-char -3)
1704 (skip-chars-backward " \t")
1705 (setq end (point))
1706 (goto-char beg)
1707 end))))
1708
1709 (defun hack-local-variables-prop-line ()
1710 "Set local variables specified in the -*- line.
1711 Ignore any specification for `mode:' and `coding:';
1712 `set-auto-mode' should already have handled `mode:',
1713 `set-auto-coding' should already have handled `coding:'."
1714 (save-excursion
1715 (goto-char (point-min))
1716 (let ((result nil)
1717 (end (set-auto-mode-1))
1718 (enable-local-variables
1719 (and local-enable-local-variables enable-local-variables)))
1720 ;; Parse the -*- line into the `result' alist.
1721 (cond ((not end)
1722 nil)
1723 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1724 ;; Simple form: "-*- MODENAME -*-". Already handled.
1725 nil)
1726 (t
1727 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1728 ;; (last ";" is optional).
1729 (while (< (point) end)
1730 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1731 (error "Malformed -*- line"))
1732 (goto-char (match-end 0))
1733 ;; There used to be a downcase here,
1734 ;; but the manual didn't say so,
1735 ;; and people want to set var names that aren't all lc.
1736 (let ((key (intern (buffer-substring
1737 (match-beginning 1)
1738 (match-end 1))))
1739 (val (save-restriction
1740 (narrow-to-region (point) end)
1741 (read (current-buffer)))))
1742 ;; It is traditional to ignore
1743 ;; case when checking for `mode' in set-auto-mode,
1744 ;; so we must do that here as well.
1745 ;; That is inconsistent, but we're stuck with it.
1746 ;; The same can be said for `coding' in set-auto-coding.
1747 (or (equal (downcase (symbol-name key)) "mode")
1748 (equal (downcase (symbol-name key)) "coding")
1749 (setq result (cons (cons key val) result)))
1750 (skip-chars-forward " \t;")))
1751 (setq result (nreverse result))))
1752
1753 (if (and result
1754 (or (eq enable-local-variables t)
1755 (and enable-local-variables
1756 (save-window-excursion
1757 (condition-case nil
1758 (switch-to-buffer (current-buffer))
1759 (error
1760 ;; If we fail to switch in the selected window,
1761 ;; it is probably a minibuffer.
1762 ;; So try another window.
1763 (condition-case nil
1764 (switch-to-buffer-other-window (current-buffer))
1765 (error
1766 (switch-to-buffer-other-frame (current-buffer))))))
1767 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1768 (file-name-nondirectory buffer-file-name)))))))
1769 (let ((enable-local-eval enable-local-eval))
1770 (while result
1771 (hack-one-local-variable (car (car result)) (cdr (car result)))
1772 (setq result (cdr result))))))))
1773
1774 (defvar hack-local-variables-hook nil
1775 "Normal hook run after processing a file's local variables specs.
1776 Major modes can use this to examine user-specified local variables
1777 in order to initialize other data structure based on them.")
1778
1779 (defun hack-local-variables (&optional mode-only)
1780 "Parse and put into effect this buffer's local variables spec.
1781 If MODE-ONLY is non-nil, all we do is check whether the major mode
1782 is specified, returning t if it is specified."
1783 (unless mode-only
1784 (hack-local-variables-prop-line))
1785 ;; Look for "Local variables:" line in last page.
1786 (let (mode-specified
1787 (enable-local-variables
1788 (and local-enable-local-variables enable-local-variables)))
1789 (save-excursion
1790 (goto-char (point-max))
1791 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1792 (if (let ((case-fold-search t))
1793 (and (search-forward "Local Variables:" nil t)
1794 (or (eq enable-local-variables t)
1795 mode-only
1796 (and enable-local-variables
1797 (save-window-excursion
1798 (switch-to-buffer (current-buffer))
1799 (save-excursion
1800 (beginning-of-line)
1801 (set-window-start (selected-window) (point)))
1802 (y-or-n-p (format "Set local variables as specified at end of %s? "
1803 (if buffer-file-name
1804 (file-name-nondirectory
1805 buffer-file-name)
1806 (concat "buffer "
1807 (buffer-name))))))))))
1808 (let ((continue t)
1809 prefix prefixlen suffix beg
1810 mode-specified
1811 (enable-local-eval enable-local-eval))
1812 ;; The prefix is what comes before "local variables:" in its line.
1813 ;; The suffix is what comes after "local variables:" in its line.
1814 (skip-chars-forward " \t")
1815 (or (eolp)
1816 (setq suffix (buffer-substring (point)
1817 (progn (end-of-line) (point)))))
1818 (goto-char (match-beginning 0))
1819 (or (bolp)
1820 (setq prefix
1821 (buffer-substring (point)
1822 (progn (beginning-of-line) (point)))))
1823
1824 (if prefix (setq prefixlen (length prefix)
1825 prefix (regexp-quote prefix)))
1826 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1827 (while continue
1828 ;; Look at next local variable spec.
1829 (if selective-display (re-search-forward "[\n\C-m]")
1830 (forward-line 1))
1831 ;; Skip the prefix, if any.
1832 (if prefix
1833 (if (looking-at prefix)
1834 (forward-char prefixlen)
1835 (error "Local variables entry is missing the prefix")))
1836 ;; Find the variable name; strip whitespace.
1837 (skip-chars-forward " \t")
1838 (setq beg (point))
1839 (skip-chars-forward "^:\n")
1840 (if (eolp) (error "Missing colon in local variables entry"))
1841 (skip-chars-backward " \t")
1842 (let* ((str (buffer-substring beg (point)))
1843 (var (read str))
1844 val)
1845 ;; Setting variable named "end" means end of list.
1846 (if (string-equal (downcase str) "end")
1847 (setq continue nil)
1848 ;; Otherwise read the variable value.
1849 (skip-chars-forward "^:")
1850 (forward-char 1)
1851 (setq val (read (current-buffer)))
1852 (skip-chars-backward "\n")
1853 (skip-chars-forward " \t")
1854 (or (if suffix (looking-at suffix) (eolp))
1855 (error "Local variables entry is terminated incorrectly"))
1856 (if mode-only
1857 (if (eq var 'mode)
1858 (setq mode-specified t))
1859 ;; Set the variable. "Variables" mode and eval are funny.
1860 (hack-one-local-variable var val))))))))
1861 (unless mode-only
1862 (run-hooks 'hack-local-variables-hook))
1863 mode-specified))
1864
1865 (defvar ignored-local-variables
1866 '(enable-local-eval)
1867 "Variables to be ignored in a file's local variable spec.")
1868
1869 ;; Get confirmation before setting these variables as locals in a file.
1870 (put 'debugger 'risky-local-variable t)
1871 (put 'enable-local-eval 'risky-local-variable t)
1872 (put 'ignored-local-variables 'risky-local-variable t)
1873 (put 'eval 'risky-local-variable t)
1874 (put 'file-name-handler-alist 'risky-local-variable t)
1875 (put 'minor-mode-map-alist 'risky-local-variable t)
1876 (put 'after-load-alist 'risky-local-variable t)
1877 (put 'buffer-file-name 'risky-local-variable t)
1878 (put 'buffer-auto-save-file-name 'risky-local-variable t)
1879 (put 'buffer-file-truename 'risky-local-variable t)
1880 (put 'exec-path 'risky-local-variable t)
1881 (put 'load-path 'risky-local-variable t)
1882 (put 'exec-directory 'risky-local-variable t)
1883 (put 'process-environment 'risky-local-variable t)
1884 (put 'dabbrev-case-fold-search 'risky-local-variable t)
1885 (put 'dabbrev-case-replace 'risky-local-variable t)
1886 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1887 (put 'outline-level 'risky-local-variable t)
1888 (put 'rmail-output-file-alist 'risky-local-variable t)
1889 (put 'font-lock-defaults 'risky-local-variable t)
1890
1891 ;; This one is safe because the user gets to check it before it is used.
1892 (put 'compile-command 'safe-local-variable t)
1893
1894 (defun hack-one-local-variable-quotep (exp)
1895 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1896
1897 (defun hack-one-local-variable (var val)
1898 "\"Set\" one variable in a local variables spec.
1899 A few variable names are treated specially."
1900 (cond ((eq var 'mode)
1901 (funcall (intern (concat (downcase (symbol-name val))
1902 "-mode"))))
1903 ((eq var 'coding)
1904 ;; We have already handled coding: tag in set-auto-coding.
1905 nil)
1906 ((memq var ignored-local-variables)
1907 nil)
1908 ;; "Setting" eval means either eval it or do nothing.
1909 ;; Likewise for setting hook variables.
1910 ((or (get var 'risky-local-variable)
1911 (and
1912 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$"
1913 (symbol-name var))
1914 (not (get var 'safe-local-variable))))
1915 ;; Permit evalling a put of a harmless property.
1916 ;; if the args do nothing tricky.
1917 (if (or (and (eq var 'eval)
1918 (consp val)
1919 (eq (car val) 'put)
1920 (hack-one-local-variable-quotep (nth 1 val))
1921 (hack-one-local-variable-quotep (nth 2 val))
1922 ;; Only allow safe values of lisp-indent-hook;
1923 ;; not functions.
1924 (or (numberp (nth 3 val))
1925 (equal (nth 3 val) ''defun))
1926 (memq (nth 1 (nth 2 val))
1927 '(lisp-indent-hook)))
1928 ;; Permit eval if not root and user says ok.
1929 (and (not (zerop (user-uid)))
1930 (or (eq enable-local-eval t)
1931 (and enable-local-eval
1932 (save-window-excursion
1933 (switch-to-buffer (current-buffer))
1934 (save-excursion
1935 (beginning-of-line)
1936 (set-window-start (selected-window) (point)))
1937 (setq enable-local-eval
1938 (y-or-n-p (format "Process `eval' or hook local variables in %s? "
1939 (if buffer-file-name
1940 (concat "file " (file-name-nondirectory buffer-file-name))
1941 (concat "buffer " (buffer-name)))))))))))
1942 (if (eq var 'eval)
1943 (save-excursion (eval val))
1944 (make-local-variable var)
1945 (set var val))
1946 (message "Ignoring `eval:' in the local variables list")))
1947 ;; Ordinary variable, really set it.
1948 (t (make-local-variable var)
1949 (set var val))))
1950
1951 \f
1952 (defcustom change-major-mode-with-file-name t
1953 "*Non-nil means \\[write-file] should set the major mode from the file name.
1954 However, the mode will not be changed if
1955 \(1) a local variables list or the `-*-' line specifies a major mode, or
1956 \(2) the current major mode is a \"special\" mode,
1957 \ not suitable for ordinary files, or
1958 \(3) the new file name does not particularly specify any mode."
1959 :type 'boolean
1960 :group 'editing-basics)
1961
1962 (defun set-visited-file-name (filename &optional no-query along-with-file)
1963 "Change name of file visited in current buffer to FILENAME.
1964 The next time the buffer is saved it will go in the newly specified file.
1965 nil or empty string as argument means make buffer not be visiting any file.
1966 Remember to delete the initial contents of the minibuffer
1967 if you wish to pass an empty string as the argument.
1968
1969 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1970 confirmation in the case where another buffer is already visiting FILENAME.
1971
1972 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1973 the old visited file has been renamed to the new name FILENAME."
1974 (interactive "FSet visited file name: ")
1975 (if (buffer-base-buffer)
1976 (error "An indirect buffer cannot visit a file"))
1977 (let (truename)
1978 (if filename
1979 (setq filename
1980 (if (string-equal filename "")
1981 nil
1982 (expand-file-name filename))))
1983 (if filename
1984 (progn
1985 (setq truename (file-truename filename))
1986 (if find-file-visit-truename
1987 (setq filename truename))))
1988 (let ((buffer (and filename (find-buffer-visiting filename))))
1989 (and buffer (not (eq buffer (current-buffer)))
1990 (not no-query)
1991 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1992 filename)))
1993 (error "Aborted")))
1994 (or (equal filename buffer-file-name)
1995 (progn
1996 (and filename (lock-buffer filename))
1997 (unlock-buffer)))
1998 (setq buffer-file-name filename)
1999 (if filename ; make buffer name reflect filename.
2000 (let ((new-name (file-name-nondirectory buffer-file-name)))
2001 (if (string= new-name "")
2002 (error "Empty file name"))
2003 (if (eq system-type 'vax-vms)
2004 (setq new-name (downcase new-name)))
2005 (setq default-directory (file-name-directory buffer-file-name))
2006 (or (string= new-name (buffer-name))
2007 (rename-buffer new-name t))))
2008 (setq buffer-backed-up nil)
2009 (or along-with-file
2010 (clear-visited-file-modtime))
2011 ;; Abbreviate the file names of the buffer.
2012 (if truename
2013 (progn
2014 (setq buffer-file-truename (abbreviate-file-name truename))
2015 (if find-file-visit-truename
2016 (setq buffer-file-name buffer-file-truename))))
2017 (setq buffer-file-number
2018 (if filename
2019 (nthcdr 10 (file-attributes buffer-file-name))
2020 nil)))
2021 ;; write-file-hooks is normally used for things like ftp-find-file
2022 ;; that visit things that are not local files as if they were files.
2023 ;; Changing to visit an ordinary local file instead should flush the hook.
2024 (kill-local-variable 'write-file-hooks)
2025 (kill-local-variable 'local-write-file-hooks)
2026 (kill-local-variable 'revert-buffer-function)
2027 (kill-local-variable 'backup-inhibited)
2028 ;; If buffer was read-only because of version control,
2029 ;; that reason is gone now, so make it writable.
2030 (if vc-mode
2031 (setq buffer-read-only nil))
2032 (kill-local-variable 'vc-mode)
2033 ;; Turn off backup files for certain file names.
2034 ;; Since this is a permanent local, the major mode won't eliminate it.
2035 (and buffer-file-name
2036 (not (funcall backup-enable-predicate buffer-file-name))
2037 (progn
2038 (make-local-variable 'backup-inhibited)
2039 (setq backup-inhibited t)))
2040 (let ((oauto buffer-auto-save-file-name))
2041 ;; If auto-save was not already on, turn it on if appropriate.
2042 (if (not buffer-auto-save-file-name)
2043 (and buffer-file-name auto-save-default
2044 (auto-save-mode t))
2045 ;; If auto save is on, start using a new name.
2046 ;; We deliberately don't rename or delete the old auto save
2047 ;; for the old visited file name. This is because perhaps
2048 ;; the user wants to save the new state and then compare with the
2049 ;; previous state from the auto save file.
2050 (setq buffer-auto-save-file-name
2051 (make-auto-save-file-name)))
2052 ;; Rename the old auto save file if any.
2053 (and oauto buffer-auto-save-file-name
2054 (file-exists-p oauto)
2055 (rename-file oauto buffer-auto-save-file-name t)))
2056 (and buffer-file-name
2057 (not along-with-file)
2058 (set-buffer-modified-p t))
2059 ;; Update the major mode, if the file name determines it.
2060 (condition-case nil
2061 ;; Don't change the mode if it is special.
2062 (or (not change-major-mode-with-file-name)
2063 (get major-mode 'mode-class)
2064 ;; Don't change the mode if the local variable list specifies it.
2065 (hack-local-variables t)
2066 (set-auto-mode t))
2067 (error nil)))
2068
2069 (defun write-file (filename &optional confirm)
2070 "Write current buffer into file FILENAME.
2071 This makes the buffer visit that file, and marks it as not modified.
2072
2073 If you specify just a directory name as FILENAME, that means to use
2074 the default file name but in that directory. You can also yank
2075 the default file name into the minibuffer to edit it, using M-n.
2076
2077 If the buffer is not already visiting a file, the default file name
2078 for the output file is the buffer name.
2079
2080 If optional second arg CONFIRM is non-nil, this function
2081 asks for confirmation before overwriting an existing file.
2082 Interactively, confirmation is required unless you supply a prefix argument."
2083 ;; (interactive "FWrite file: ")
2084 (interactive
2085 (list (if buffer-file-name
2086 (read-file-name "Write file: "
2087 nil nil nil nil)
2088 (read-file-name "Write file: " default-directory
2089 (expand-file-name
2090 (file-name-nondirectory (buffer-name))
2091 default-directory)
2092 nil nil))
2093 (not current-prefix-arg)))
2094 (or (null filename) (string-equal filename "")
2095 (progn
2096 ;; If arg is just a directory,
2097 ;; use the default file name, but in that directory.
2098 (if (file-directory-p filename)
2099 (setq filename (concat (file-name-as-directory filename)
2100 (file-name-nondirectory
2101 (or buffer-file-name (buffer-name))))))
2102 (and confirm
2103 (file-exists-p filename)
2104 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2105 (error "Canceled")))
2106 (set-visited-file-name filename (not confirm))))
2107 (set-buffer-modified-p t)
2108 ;; Make buffer writable if file is writable.
2109 (and buffer-file-name
2110 (file-writable-p buffer-file-name)
2111 (setq buffer-read-only nil))
2112 (save-buffer))
2113 \f
2114 (defun backup-buffer ()
2115 "Make a backup of the disk file visited by the current buffer, if appropriate.
2116 This is normally done before saving the buffer the first time.
2117 If the value is non-nil, it is the result of `file-modes' on the original
2118 file; this means that the caller, after saving the buffer, should change
2119 the modes of the new file to agree with the old modes.
2120
2121 A backup may be done by renaming or by copying; see documentation of
2122 variable `make-backup-files'. If it's done by renaming, then the file is
2123 no longer accessible under its old name."
2124 (if (and make-backup-files (not backup-inhibited)
2125 (not buffer-backed-up)
2126 (file-exists-p buffer-file-name)
2127 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2128 '(?- ?l)))
2129 (let ((real-file-name buffer-file-name)
2130 backup-info backupname targets setmodes)
2131 ;; If specified name is a symbolic link, chase it to the target.
2132 ;; Thus we make the backups in the directory where the real file is.
2133 (setq real-file-name (file-chase-links real-file-name))
2134 (setq backup-info (find-backup-file-name real-file-name)
2135 backupname (car backup-info)
2136 targets (cdr backup-info))
2137 ;; (if (file-directory-p buffer-file-name)
2138 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2139 (if backup-info
2140 (condition-case ()
2141 (let ((delete-old-versions
2142 ;; If have old versions to maybe delete,
2143 ;; ask the user to confirm now, before doing anything.
2144 ;; But don't actually delete til later.
2145 (and targets
2146 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2147 (or delete-old-versions
2148 (y-or-n-p (format "Delete excess backup versions of %s? "
2149 real-file-name))))))
2150 ;; Actually write the back up file.
2151 (condition-case ()
2152 (if (or file-precious-flag
2153 ; (file-symlink-p buffer-file-name)
2154 backup-by-copying
2155 (and backup-by-copying-when-linked
2156 (> (file-nlinks real-file-name) 1))
2157 (and (or backup-by-copying-when-mismatch
2158 (integerp backup-by-copying-when-privileged-mismatch))
2159 (let ((attr (file-attributes real-file-name)))
2160 (and (or backup-by-copying-when-mismatch
2161 (and (integerp (nth 2 attr))
2162 (integerp backup-by-copying-when-privileged-mismatch)
2163 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2164 (or (nth 9 attr)
2165 (not (file-ownership-preserved-p real-file-name)))))))
2166 (condition-case ()
2167 (copy-file real-file-name backupname t t)
2168 (file-error
2169 ;; If copying fails because file BACKUPNAME
2170 ;; is not writable, delete that file and try again.
2171 (if (and (file-exists-p backupname)
2172 (not (file-writable-p backupname)))
2173 (delete-file backupname))
2174 (copy-file real-file-name backupname t t)))
2175 ;; rename-file should delete old backup.
2176 (rename-file real-file-name backupname t)
2177 (setq setmodes (file-modes backupname)))
2178 (file-error
2179 ;; If trouble writing the backup, write it in ~.
2180 (setq backupname (expand-file-name
2181 (convert-standard-filename
2182 "~/%backup%~")))
2183 (message "Cannot write backup file; backing up in %s"
2184 (file-name-nondirectory backupname))
2185 (sleep-for 1)
2186 (condition-case ()
2187 (copy-file real-file-name backupname t t)
2188 (file-error
2189 ;; If copying fails because file BACKUPNAME
2190 ;; is not writable, delete that file and try again.
2191 (if (and (file-exists-p backupname)
2192 (not (file-writable-p backupname)))
2193 (delete-file backupname))
2194 (copy-file real-file-name backupname t t)))))
2195 (setq buffer-backed-up t)
2196 ;; Now delete the old versions, if desired.
2197 (if delete-old-versions
2198 (while targets
2199 (condition-case ()
2200 (delete-file (car targets))
2201 (file-error nil))
2202 (setq targets (cdr targets))))
2203 setmodes)
2204 (file-error nil))))))
2205
2206 (defun file-name-sans-versions (name &optional keep-backup-version)
2207 "Return file NAME sans backup versions or strings.
2208 This is a separate procedure so your site-init or startup file can
2209 redefine it.
2210 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2211 we do not remove backup version numbers, only true file version numbers."
2212 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
2213 (if handler
2214 (funcall handler 'file-name-sans-versions name keep-backup-version)
2215 (substring name 0
2216 (if (eq system-type 'vax-vms)
2217 ;; VMS version number is (a) semicolon, optional
2218 ;; sign, zero or more digits or (b) period, option
2219 ;; sign, zero or more digits, provided this is the
2220 ;; second period encountered outside of the
2221 ;; device/directory part of the file name.
2222 (or (string-match ";[-+]?[0-9]*\\'" name)
2223 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
2224 name)
2225 (match-beginning 1))
2226 (length name))
2227 (if keep-backup-version
2228 (length name)
2229 (or (string-match "\\.~[0-9.]+~\\'" name)
2230 (string-match "~\\'" name)
2231 (length name))))))))
2232
2233 (defun file-ownership-preserved-p (file)
2234 "Return t if deleting FILE and rewriting it would preserve the owner."
2235 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2236 (if handler
2237 (funcall handler 'file-ownership-preserved-p file)
2238 (let ((attributes (file-attributes file)))
2239 ;; Return t if the file doesn't exist, since it's true that no
2240 ;; information would be lost by an (attempted) delete and create.
2241 (or (null attributes)
2242 (= (nth 2 attributes) (user-uid)))))))
2243
2244 (defun file-name-sans-extension (filename)
2245 "Return FILENAME sans final \"extension\".
2246 The extension, in a file name, is the part that follows the last `.',
2247 except that a leading `.', if any, doesn't count."
2248 (save-match-data
2249 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2250 directory)
2251 (if (and (string-match "\\.[^.]*\\'" file)
2252 (not (eq 0 (match-beginning 0))))
2253 (if (setq directory (file-name-directory filename))
2254 (expand-file-name (substring file 0 (match-beginning 0))
2255 directory)
2256 (substring file 0 (match-beginning 0)))
2257 filename))))
2258
2259 (defun file-name-extension (filename &optional period)
2260 "Return FILENAME's final \"extension\".
2261 The extension, in a file name, is the part that follows the last `.',
2262 except that a leading `.', if any, doesn't count.
2263 Return nil for extensionless file names such as `foo'.
2264 Return the empty string for file names such as `foo.'.
2265
2266 If PERIOD is non-nil, then the returned value includes the period
2267 that delimits the extension, and if FILENAME has no extension,
2268 the value is \"\"."
2269 (save-match-data
2270 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2271 (if (and (string-match "\\.[^.]*\\'" file)
2272 (not (eq 0 (match-beginning 0))))
2273 (substring file (+ (match-beginning 0) (if period 0 1)))
2274 (if period
2275 "")))))
2276
2277 (defcustom make-backup-file-name-function nil
2278 "A function to use instead of the default `make-backup-file-name'.
2279 A value of nil gives the default `make-backup-file-name' behaviour.
2280
2281 This could be buffer-local to do something special for specific
2282 files. If you define it, you may need to change `backup-file-name-p'
2283 and `file-name-sans-versions' too.
2284
2285 See also `backup-directory-alist'."
2286 :group 'backup
2287 :type '(choice (const :tag "Default" nil)
2288 (function :tag "Your function")))
2289
2290 (defcustom backup-directory-alist nil
2291 "Alist of filename patterns and backup directory names.
2292 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2293 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2294 relative or absolute. If it is absolute, so that all matching files
2295 are backed up into the same directory, the file names in this
2296 directory will be the full name of the file backed up with all
2297 directory separators changed to `!' to prevent clashes. This will not
2298 work correctly if your filesystem truncates the resulting name.
2299
2300 For the common case of all backups going into one directory, the alist
2301 should contain a single element pairing \".\" with the appropriate
2302 directory name.
2303
2304 If this variable is nil, or it fails to match a filename, the backup
2305 is made in the original file's directory.
2306
2307 On MS-DOS filesystems without long names this variable is always
2308 ignored."
2309 :group 'backup
2310 :type '(repeat (cons (regexp :tag "Regexp matching filename")
2311 (directory :tag "Backup directory name"))))
2312
2313 (defun normal-backup-enable-predicate (name)
2314 "Default `backup-enable-predicate' function.
2315 Checks for files in `temporary-file-directory' or
2316 `small-temporary-file-directory'."
2317 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2318 name 0 nil)))
2319 ;; Directory is under temporary-file-directory.
2320 (and (not (eq comp t))
2321 (< comp (- (length temporary-file-directory)))))
2322 (if small-temporary-file-directory
2323 (let ((comp (compare-strings small-temporary-file-directory
2324 0 nil
2325 name 0 nil)))
2326 ;; Directory is under small-temporary-file-directory.
2327 (and (not (eq comp t))
2328 (< comp (- (length small-temporary-file-directory)))))))))
2329
2330 (defun make-backup-file-name (file)
2331 "Create the non-numeric backup file name for FILE.
2332 Normally this will just be the file's name with `~' appended.
2333 Customization hooks are provided as follows.
2334
2335 If the variable `make-backup-file-name-function' is non-nil, its value
2336 should be a function which will be called with FILE as its argument;
2337 the resulting name is used.
2338
2339 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2340 the documentation of that variable. If the directory for the backup
2341 doesn't exist, it is created."
2342 (if make-backup-file-name-function
2343 (funcall make-backup-file-name-function file)
2344 (if (and (eq system-type 'ms-dos)
2345 (not (msdos-long-file-names)))
2346 (let ((fn (file-name-nondirectory file)))
2347 (concat (file-name-directory file)
2348 (or (and (string-match "\\`[^.]+\\'" fn)
2349 (concat (match-string 0 fn) ".~"))
2350 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2351 (concat (match-string 0 fn) "~")))))
2352 (concat (make-backup-file-name-1 file) "~"))))
2353
2354 (defun make-backup-file-name-1 (file)
2355 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2356 (let ((alist backup-directory-alist)
2357 elt backup-directory dir-sep-string)
2358 (while alist
2359 (setq elt (pop alist))
2360 (if (string-match (car elt) file)
2361 (setq backup-directory (cdr elt)
2362 alist nil)))
2363 (if (null backup-directory)
2364 file
2365 (unless (file-exists-p backup-directory)
2366 (condition-case nil
2367 (make-directory backup-directory 'parents)
2368 (file-error file)))
2369 (if (file-name-absolute-p backup-directory)
2370 (progn
2371 (when (memq system-type '(windows-nt ms-dos))
2372 ;; Normalize DOSish file names: convert all slashes to
2373 ;; directory-sep-char, downcase the drive letter, if any,
2374 ;; and replace the leading "x:" with "/drive_x".
2375 (or (file-name-absolute-p file)
2376 (setq file (expand-file-name file))) ; make defaults explicit
2377 ;; Replace any invalid file-name characters (for the
2378 ;; case of backing up remote files).
2379 (setq file (expand-file-name (convert-standard-filename file)))
2380 (setq dir-sep-string (char-to-string directory-sep-char))
2381 (if (eq (aref file 1) ?:)
2382 (setq file (concat dir-sep-string
2383 "drive_"
2384 (char-to-string (downcase (aref file 0)))
2385 (if (eq (aref file 2) directory-sep-char)
2386 ""
2387 dir-sep-string)
2388 (substring file 2)))))
2389 ;; Make the name unique by substituting directory
2390 ;; separators. It may not really be worth bothering about
2391 ;; doubling `!'s in the original name...
2392 (expand-file-name
2393 (subst-char-in-string
2394 directory-sep-char ?!
2395 (replace-regexp-in-string "!" "!!" file))
2396 backup-directory))
2397 (expand-file-name (file-name-nondirectory file)
2398 (file-name-as-directory
2399 (expand-file-name backup-directory
2400 (file-name-directory file))))))))
2401
2402 (defun backup-file-name-p (file)
2403 "Return non-nil if FILE is a backup file name (numeric or not).
2404 This is a separate function so you can redefine it for customization.
2405 You may need to redefine `file-name-sans-versions' as well."
2406 (string-match "~\\'" file))
2407
2408 (defvar backup-extract-version-start)
2409
2410 ;; This is used in various files.
2411 ;; The usage of backup-extract-version-start is not very clean,
2412 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2413 (defun backup-extract-version (fn)
2414 "Given the name of a numeric backup file, FN, return the backup number.
2415 Uses the free variable `backup-extract-version-start', whose value should be
2416 the index in the name where the version number begins."
2417 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2418 (= (match-beginning 0) backup-extract-version-start))
2419 (string-to-int (substring fn backup-extract-version-start -1))
2420 0))
2421
2422 ;; I believe there is no need to alter this behavior for VMS;
2423 ;; since backup files are not made on VMS, it should not get called.
2424 (defun find-backup-file-name (fn)
2425 "Find a file name for a backup file FN, and suggestions for deletions.
2426 Value is a list whose car is the name for the backup file
2427 and whose cdr is a list of old versions to consider deleting now.
2428 If the value is nil, don't make a backup.
2429 Uses `backup-directory-alist' in the same way as does
2430 `make-backup-file-name'."
2431 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2432 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2433 (if handler
2434 (funcall handler 'find-backup-file-name fn)
2435 (if (or (eq version-control 'never)
2436 ;; We don't support numbered backups on plain MS-DOS
2437 ;; when long file names are unavailable.
2438 (and (eq system-type 'ms-dos)
2439 (not (msdos-long-file-names))))
2440 (list (make-backup-file-name fn))
2441 (let* ((basic-name (make-backup-file-name-1 fn))
2442 (base-versions (concat (file-name-nondirectory basic-name)
2443 ".~"))
2444 (backup-extract-version-start (length base-versions))
2445 (high-water-mark 0)
2446 (number-to-delete 0)
2447 possibilities deserve-versions-p versions)
2448 (condition-case ()
2449 (setq possibilities (file-name-all-completions
2450 base-versions
2451 (file-name-directory basic-name))
2452 versions (sort (mapcar #'backup-extract-version
2453 possibilities)
2454 #'<)
2455 high-water-mark (apply 'max 0 versions)
2456 deserve-versions-p (or version-control
2457 (> high-water-mark 0))
2458 number-to-delete (- (length versions)
2459 kept-old-versions
2460 kept-new-versions
2461 -1))
2462 (file-error (setq possibilities nil)))
2463 (if (not deserve-versions-p)
2464 (list (make-backup-file-name fn))
2465 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
2466 (if (and (> number-to-delete 0)
2467 ;; Delete nothing if there is overflow
2468 ;; in the number of versions to keep.
2469 (>= (+ kept-new-versions kept-old-versions -1) 0))
2470 (mapcar (lambda (n)
2471 (format "%s.~%d~" basic-name n))
2472 (let ((v (nthcdr kept-old-versions versions)))
2473 (rplacd (nthcdr (1- number-to-delete) v) ())
2474 v))))))))))
2475
2476 (defun file-nlinks (filename)
2477 "Return number of names file FILENAME has."
2478 (car (cdr (file-attributes filename))))
2479
2480 (defun file-relative-name (filename &optional directory)
2481 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2482 This function returns a relative file name which is equivalent to FILENAME
2483 when used with that default directory as the default.
2484 If this is impossible (which can happen on MSDOS and Windows
2485 when the file name and directory use different drive names)
2486 then it returns FILENAME."
2487 (save-match-data
2488 (let ((fname (expand-file-name filename)))
2489 (setq directory (file-name-as-directory
2490 (expand-file-name (or directory default-directory))))
2491 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2492 ;; drive names, they can't be relative, so return the absolute name.
2493 (if (and (or (eq system-type 'ms-dos)
2494 (eq system-type 'windows-nt))
2495 (not (string-equal (substring fname 0 2)
2496 (substring directory 0 2))))
2497 filename
2498 (let ((ancestor ".")
2499 (fname-dir (file-name-as-directory fname)))
2500 (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2501 (not (string-match (concat "^" (regexp-quote directory)) fname)))
2502 (setq directory (file-name-directory (substring directory 0 -1))
2503 ancestor (if (equal ancestor ".")
2504 ".."
2505 (concat "../" ancestor))))
2506 ;; Now ancestor is empty, or .., or ../.., etc.
2507 (if (string-match (concat "^" (regexp-quote directory)) fname)
2508 ;; We matched within FNAME's directory part.
2509 ;; Add the rest of FNAME onto ANCESTOR.
2510 (let ((rest (substring fname (match-end 0))))
2511 (if (and (equal ancestor ".")
2512 (not (equal rest "")))
2513 ;; But don't bother with ANCESTOR if it would give us `./'.
2514 rest
2515 (concat (file-name-as-directory ancestor) rest)))
2516 ;; We matched FNAME's directory equivalent.
2517 ancestor))))))
2518 \f
2519 (defun save-buffer (&optional args)
2520 "Save current buffer in visited file if modified. Versions described below.
2521 By default, makes the previous version into a backup file
2522 if previously requested or if this is the first save.
2523 With 1 \\[universal-argument], marks this version
2524 to become a backup when the next save is done.
2525 With 2 \\[universal-argument]'s,
2526 unconditionally makes the previous version into a backup file.
2527 With 3 \\[universal-argument]'s, marks this version
2528 to become a backup when the next save is done,
2529 and unconditionally makes the previous version into a backup file.
2530
2531 With argument of 0, never make the previous version into a backup file.
2532
2533 If a file's name is FOO, the names of its numbered backup versions are
2534 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2535 Numeric backups (rather than FOO~) will be made if value of
2536 `version-control' is not the atom `never' and either there are already
2537 numeric versions of the file being backed up, or `version-control' is
2538 non-nil.
2539 We don't want excessive versions piling up, so there are variables
2540 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2541 and `kept-new-versions', which tells how many newest versions to keep.
2542 Defaults are 2 old versions and 2 new.
2543 `dired-kept-versions' controls dired's clean-directory (.) command.
2544 If `delete-old-versions' is nil, system will query user
2545 before trimming versions. Otherwise it does it silently.
2546
2547 If `vc-make-backup-files' is nil, which is the default,
2548 no backup files are made for files managed by version control.
2549 (This is because the version control system itself records previous versions.)
2550
2551 See the subroutine `basic-save-buffer' for more information."
2552 (interactive "p")
2553 (let ((modp (buffer-modified-p))
2554 (large (> (buffer-size) 50000))
2555 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2556 (memq args '(16 64)))))
2557 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2558 (if (and modp large (buffer-file-name))
2559 (message "Saving file %s..." (buffer-file-name)))
2560 (basic-save-buffer)
2561 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2562
2563 (defun delete-auto-save-file-if-necessary (&optional force)
2564 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2565 Normally delete only if the file was written by this Emacs since
2566 the last real save, but optional arg FORCE non-nil means delete anyway."
2567 (and buffer-auto-save-file-name delete-auto-save-files
2568 (not (string= buffer-file-name buffer-auto-save-file-name))
2569 (or force (recent-auto-save-p))
2570 (progn
2571 (condition-case ()
2572 (delete-file buffer-auto-save-file-name)
2573 (file-error nil))
2574 (set-buffer-auto-saved))))
2575
2576 (defvar auto-save-hook nil
2577 "Normal hook run just before auto-saving.")
2578
2579 (defcustom after-save-hook nil
2580 "Normal hook that is run after a buffer is saved to its file."
2581 :options '(executable-make-buffer-file-executable-if-script-p)
2582 :type 'hook
2583 :group 'files)
2584
2585 (defvar save-buffer-coding-system nil
2586 "If non-nil, use this coding system for saving the buffer.
2587 More precisely, use this coding system in place of the
2588 value of `buffer-file-coding-system', when saving the buffer.
2589 Calling `write-region' for any purpose other than saving the buffer
2590 will still use `buffer-file-coding-system'; this variable has no effect
2591 in such cases.")
2592
2593 (make-variable-buffer-local 'save-buffer-coding-system)
2594 (put 'save-buffer-coding-system 'permanent-local t)
2595
2596 (defun basic-save-buffer ()
2597 "Save the current buffer in its visited file, if it has been modified.
2598 The hooks `write-contents-hooks', `local-write-file-hooks' and
2599 `write-file-hooks' get a chance to do the job of saving; if they do not,
2600 then the buffer is saved in the visited file file in the usual way.
2601 After saving the buffer, this function runs `after-save-hook'."
2602 (interactive)
2603 (save-current-buffer
2604 ;; In an indirect buffer, save its base buffer instead.
2605 (if (buffer-base-buffer)
2606 (set-buffer (buffer-base-buffer)))
2607 (if (buffer-modified-p)
2608 (let ((recent-save (recent-auto-save-p))
2609 msg
2610 setmodes tempsetmodes)
2611 ;; On VMS, rename file and buffer to get rid of version number.
2612 (if (and (eq system-type 'vax-vms)
2613 (not (string= buffer-file-name
2614 (file-name-sans-versions buffer-file-name))))
2615 (let (buffer-new-name)
2616 ;; Strip VMS version number before save.
2617 (setq buffer-file-name
2618 (file-name-sans-versions buffer-file-name))
2619 ;; Construct a (unique) buffer name to correspond.
2620 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2621 (setq buffer-new-name (buffer-name buf))
2622 (kill-buffer buf))
2623 (rename-buffer buffer-new-name)))
2624 ;; If buffer has no file name, ask user for one.
2625 (or buffer-file-name
2626 (let ((filename
2627 (expand-file-name
2628 (read-file-name "File to save in: ") nil)))
2629 (and (file-exists-p filename)
2630 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2631 filename))
2632 (error "Canceled")))
2633 (set-visited-file-name filename)))
2634 (or (verify-visited-file-modtime (current-buffer))
2635 (not (file-exists-p buffer-file-name))
2636 (yes-or-no-p
2637 (format "%s has changed since visited or saved. Save anyway? "
2638 (file-name-nondirectory buffer-file-name)))
2639 (error "Save not confirmed"))
2640 (save-restriction
2641 (widen)
2642 (save-excursion
2643 (and (> (point-max) 1)
2644 (not find-file-literally)
2645 (/= (char-after (1- (point-max))) ?\n)
2646 (not (and (eq selective-display t)
2647 (= (char-after (1- (point-max))) ?\r)))
2648 (or (eq require-final-newline t)
2649 (and require-final-newline
2650 (y-or-n-p
2651 (format "Buffer %s does not end in newline. Add one? "
2652 (buffer-name)))))
2653 (save-excursion
2654 (goto-char (point-max))
2655 (insert ?\n))))
2656 (setq msg (current-message))
2657 ;; Support VC version backups.
2658 (vc-before-save)
2659 (or (run-hook-with-args-until-success 'write-contents-hooks)
2660 (run-hook-with-args-until-success 'local-write-file-hooks)
2661 (run-hook-with-args-until-success 'write-file-hooks)
2662 (progn
2663 (unless (equal msg (current-message))
2664 (sit-for 2))
2665 ;; If a hook returned t, file is already "written".
2666 ;; Otherwise, write it the usual way now.
2667 (setq setmodes (basic-save-buffer-1))))
2668 ;; Now we have saved the current buffer. Let's make sure
2669 ;; that buffer-file-coding-system is fixed to what
2670 ;; actually used for saving by binding it locally.
2671 (if save-buffer-coding-system
2672 (setq save-buffer-coding-system last-coding-system-used)
2673 (setq buffer-file-coding-system last-coding-system-used))
2674 (setq buffer-file-number
2675 (nthcdr 10 (file-attributes buffer-file-name)))
2676 (if setmodes
2677 (condition-case ()
2678 (set-file-modes buffer-file-name setmodes)
2679 (error nil))))
2680 ;; If the auto-save file was recent before this command,
2681 ;; delete it now.
2682 (delete-auto-save-file-if-necessary recent-save)
2683 ;; Support VC `implicit' locking.
2684 (vc-after-save)
2685 (run-hooks 'after-save-hook))
2686 (message "(No changes need to be saved)"))))
2687
2688 ;; This does the "real job" of writing a buffer into its visited file
2689 ;; and making a backup file. This is what is normally done
2690 ;; but inhibited if one of write-file-hooks returns non-nil.
2691 ;; It returns a value to store in setmodes.
2692 (defun basic-save-buffer-1 ()
2693 (if save-buffer-coding-system
2694 (let ((coding-system-for-write save-buffer-coding-system))
2695 (basic-save-buffer-2))
2696 (basic-save-buffer-2)))
2697
2698 (defun basic-save-buffer-2 ()
2699 (let (tempsetmodes setmodes)
2700 (if (not (file-writable-p buffer-file-name))
2701 (let ((dir (file-name-directory buffer-file-name)))
2702 (if (not (file-directory-p dir))
2703 (if (file-exists-p dir)
2704 (error "%s is not a directory" dir)
2705 (error "%s: no such directory" buffer-file-name))
2706 (if (not (file-exists-p buffer-file-name))
2707 (error "Directory %s write-protected" dir)
2708 (if (yes-or-no-p
2709 (format "File %s is write-protected; try to save anyway? "
2710 (file-name-nondirectory
2711 buffer-file-name)))
2712 (setq tempsetmodes t)
2713 (error "Attempt to save to a file which you aren't allowed to write"))))))
2714 (or buffer-backed-up
2715 (setq setmodes (backup-buffer)))
2716 (let ((dir (file-name-directory buffer-file-name)))
2717 (if (and file-precious-flag
2718 (file-writable-p dir))
2719 ;; If file is precious, write temp name, then rename it.
2720 ;; This requires write access to the containing dir,
2721 ;; which is why we don't try it if we don't have that access.
2722 (let ((realname buffer-file-name)
2723 tempname temp nogood i succeed
2724 (old-modtime (visited-file-modtime)))
2725 (setq i 0)
2726 (setq nogood t)
2727 ;; Find the temporary name to write under.
2728 (while nogood
2729 (setq tempname (format
2730 (if (and (eq system-type 'ms-dos)
2731 (not (msdos-long-file-names)))
2732 "%s#%d.tm#" ; MSDOS limits files to 8+3
2733 (if (memq system-type '(vax-vms axp-vms))
2734 "%s$tmp$%d"
2735 "%s#tmp#%d"))
2736 dir i))
2737 (setq nogood (file-exists-p tempname))
2738 (setq i (1+ i)))
2739 (unwind-protect
2740 (progn (clear-visited-file-modtime)
2741 (write-region (point-min) (point-max)
2742 tempname nil realname
2743 buffer-file-truename)
2744 (setq succeed t))
2745 ;; If writing the temp file fails,
2746 ;; delete the temp file.
2747 (or succeed
2748 (progn
2749 (delete-file tempname)
2750 (set-visited-file-modtime old-modtime))))
2751 ;; Since we have created an entirely new file
2752 ;; and renamed it, make sure it gets the
2753 ;; right permission bits set.
2754 (setq setmodes (file-modes buffer-file-name))
2755 ;; We succeeded in writing the temp file,
2756 ;; so rename it.
2757 (rename-file tempname buffer-file-name t))
2758 ;; If file not writable, see if we can make it writable
2759 ;; temporarily while we write it.
2760 ;; But no need to do so if we have just backed it up
2761 ;; (setmodes is set) because that says we're superseding.
2762 (cond ((and tempsetmodes (not setmodes))
2763 ;; Change the mode back, after writing.
2764 (setq setmodes (file-modes buffer-file-name))
2765 (set-file-modes buffer-file-name (logior setmodes 128))))
2766 (write-region (point-min) (point-max)
2767 buffer-file-name nil t buffer-file-truename)))
2768 setmodes))
2769
2770 (defun save-some-buffers (&optional arg pred)
2771 "Save some modified file-visiting buffers. Asks user about each one.
2772 Optional argument (the prefix) non-nil means save all with no questions.
2773 Optional second argument PRED determines which buffers are considered:
2774 If PRED is nil, all the file-visiting buffers are considered.
2775 If PRED is t, then certain non-file buffers will also be considered.
2776 If PRED is a zero-argument function, it indicates for each buffer whether
2777 to consider it or not when called with that buffer current."
2778 (interactive "P")
2779 (save-window-excursion
2780 (let* ((queried nil)
2781 (files-done
2782 (map-y-or-n-p
2783 (function
2784 (lambda (buffer)
2785 (and (buffer-modified-p buffer)
2786 (not (buffer-base-buffer buffer))
2787 (or
2788 (buffer-file-name buffer)
2789 (and pred
2790 (progn
2791 (set-buffer buffer)
2792 (and buffer-offer-save (> (buffer-size) 0)))))
2793 (or (not (functionp pred))
2794 (with-current-buffer buffer (funcall pred)))
2795 (if arg
2796 t
2797 (setq queried t)
2798 (if (buffer-file-name buffer)
2799 (format "Save file %s? "
2800 (buffer-file-name buffer))
2801 (format "Save buffer %s? "
2802 (buffer-name buffer)))))))
2803 (function
2804 (lambda (buffer)
2805 (set-buffer buffer)
2806 (save-buffer)))
2807 (buffer-list)
2808 '("buffer" "buffers" "save")
2809 (list (list ?\C-r (lambda (buf)
2810 (view-buffer buf
2811 (function
2812 (lambda (ignore)
2813 (exit-recursive-edit))))
2814 (recursive-edit)
2815 ;; Return nil to ask about BUF again.
2816 nil)
2817 "display the current buffer"))))
2818 (abbrevs-done
2819 (and save-abbrevs abbrevs-changed
2820 (progn
2821 (if (or arg
2822 (eq save-abbrevs 'silently)
2823 (y-or-n-p (format "Save abbrevs in %s? "
2824 abbrev-file-name)))
2825 (write-abbrev-file nil))
2826 ;; Don't keep bothering user if he says no.
2827 (setq abbrevs-changed nil)
2828 t))))
2829 (or queried (> files-done 0) abbrevs-done
2830 (message "(No files need saving)")))))
2831 \f
2832 (defun not-modified (&optional arg)
2833 "Mark current buffer as unmodified, not needing to be saved.
2834 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2835
2836 It is not a good idea to use this function in Lisp programs, because it
2837 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2838 (interactive "P")
2839 (message (if arg "Modification-flag set"
2840 "Modification-flag cleared"))
2841 (set-buffer-modified-p arg))
2842
2843 (defun toggle-read-only (&optional arg)
2844 "Change whether this buffer is visiting its file read-only.
2845 With arg, set read-only iff arg is positive.
2846 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2847 (interactive "P")
2848 (cond
2849 ((and arg (if (> (prefix-numeric-value arg) 0) buffer-read-only
2850 (not buffer-read-only))) ; If buffer-read-only is set correctly,
2851 nil) ; do nothing.
2852 ;; Toggle.
2853 ((and buffer-read-only view-mode)
2854 (View-exit-and-edit)
2855 (make-local-variable 'view-read-only)
2856 (setq view-read-only t)) ; Must leave view mode.
2857 ((and (not buffer-read-only) view-read-only
2858 (not (eq (get major-mode 'mode-class) 'special)))
2859 (view-mode-enter))
2860 (t (setq buffer-read-only (not buffer-read-only))
2861 (force-mode-line-update))))
2862
2863 (defun insert-file (filename)
2864 "Insert contents of file FILENAME into buffer after point.
2865 Set mark after the inserted text.
2866
2867 This function is meant for the user to run interactively.
2868 Don't call it from programs! Use `insert-file-contents' instead.
2869 \(Its calling sequence is different; see its documentation)."
2870 (interactive "*fInsert file: ")
2871 (if (file-directory-p filename)
2872 (signal 'file-error (list "Opening input file" "file is a directory"
2873 filename)))
2874 (let ((tem (insert-file-contents filename)))
2875 (push-mark (+ (point) (car (cdr tem))))))
2876
2877 (defun append-to-file (start end filename)
2878 "Append the contents of the region to the end of file FILENAME.
2879 When called from a function, expects three arguments,
2880 START, END and FILENAME. START and END are buffer positions
2881 saying what text to write."
2882 (interactive "r\nFAppend to file: ")
2883 (write-region start end filename t))
2884
2885 (defun file-newest-backup (filename)
2886 "Return most recent backup file for FILENAME or nil if no backups exist."
2887 ;; `make-backup-file-name' will get us the right directory for
2888 ;; ordinary or numeric backups. It might create a directory for
2889 ;; backups as a side-effect, according to `backup-directory-alist'.
2890 (let* ((filename (make-backup-file-name filename))
2891 (file (file-name-nondirectory filename))
2892 (dir (file-name-directory filename))
2893 (comp (file-name-all-completions file dir))
2894 (newest nil)
2895 tem)
2896 (while comp
2897 (setq tem (pop comp))
2898 (cond ((and (backup-file-name-p tem)
2899 (string= (file-name-sans-versions tem) file))
2900 (setq tem (concat dir tem))
2901 (if (or (null newest)
2902 (file-newer-than-file-p tem newest))
2903 (setq newest tem)))))
2904 newest))
2905
2906 (defun rename-uniquely ()
2907 "Rename current buffer to a similar name not already taken.
2908 This function is useful for creating multiple shell process buffers
2909 or multiple mail buffers, etc."
2910 (interactive)
2911 (save-match-data
2912 (let ((base-name (buffer-name)))
2913 (and (string-match "<[0-9]+>\\'" base-name)
2914 (not (and buffer-file-name
2915 (string= base-name
2916 (file-name-nondirectory buffer-file-name))))
2917 ;; If the existing buffer name has a <NNN>,
2918 ;; which isn't part of the file name (if any),
2919 ;; then get rid of that.
2920 (setq base-name (substring base-name 0 (match-beginning 0))))
2921 (rename-buffer (generate-new-buffer-name base-name))
2922 (force-mode-line-update))))
2923
2924 (defun make-directory (dir &optional parents)
2925 "Create the directory DIR and any nonexistent parent dirs.
2926 Interactively, the default choice of directory to create
2927 is the current default directory for file names.
2928 That is useful when you have visited a file in a nonexistent directory.
2929
2930 Noninteractively, the second (optional) argument PARENTS says whether
2931 to create parent directories if they don't exist."
2932 (interactive
2933 (list (read-file-name "Make directory: " default-directory default-directory
2934 nil nil)
2935 t))
2936 (let ((handler (find-file-name-handler dir 'make-directory)))
2937 (if handler
2938 (funcall handler 'make-directory dir parents)
2939 (if (not parents)
2940 (make-directory-internal dir)
2941 (let ((dir (directory-file-name (expand-file-name dir)))
2942 create-list)
2943 (while (not (file-exists-p dir))
2944 (setq create-list (cons dir create-list)
2945 dir (directory-file-name (file-name-directory dir))))
2946 (while create-list
2947 (make-directory-internal (car create-list))
2948 (setq create-list (cdr create-list))))))))
2949 \f
2950 (put 'revert-buffer-function 'permanent-local t)
2951 (defvar revert-buffer-function nil
2952 "Function to use to revert this buffer, or nil to do the default.
2953 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2954 which are the arguments that `revert-buffer' received.")
2955
2956 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2957 (defvar revert-buffer-insert-file-contents-function nil
2958 "Function to use to insert contents when reverting this buffer.
2959 Gets two args, first the nominal file name to use,
2960 and second, t if reading the auto-save file.
2961
2962 The function you specify is responsible for updating (or preserving) point.")
2963
2964 (defvar before-revert-hook nil
2965 "Normal hook for `revert-buffer' to run before reverting.
2966 If `revert-buffer-function' is used to override the normal revert
2967 mechanism, this hook is not used.")
2968
2969 (defvar after-revert-hook nil
2970 "Normal hook for `revert-buffer' to run after reverting.
2971 Note that the hook value that it runs is the value that was in effect
2972 before reverting; that makes a difference if you have buffer-local
2973 hook functions.
2974
2975 If `revert-buffer-function' is used to override the normal revert
2976 mechanism, this hook is not used.")
2977
2978 (defvar revert-buffer-internal-hook)
2979
2980 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
2981 "Replace current buffer text with the text of the visited file on disk.
2982 This undoes all changes since the file was visited or saved.
2983 With a prefix argument, offer to revert from latest auto-save file, if
2984 that is more recent than the visited file.
2985
2986 This command also works for special buffers that contain text which
2987 doesn't come from a file, but reflects some other data base instead:
2988 for example, Dired buffers and buffer-list buffers. In these cases,
2989 it reconstructs the buffer contents from the appropriate data base.
2990
2991 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2992 to revert from the auto-save file when this is nil. Note that the
2993 sense of this argument is the reverse of the prefix argument, for the
2994 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2995 to nil.
2996
2997 Optional second argument NOCONFIRM means don't ask for confirmation at
2998 all. (The local variable `revert-without-query', if non-nil, prevents
2999 confirmation.)
3000
3001 Optional third argument PRESERVE-MODES non-nil means don't alter
3002 the files modes. Normally we reinitialize them using `normal-mode'.
3003
3004 If the value of `revert-buffer-function' is non-nil, it is called to
3005 do all the work for this command. Otherwise, the hooks
3006 `before-revert-hook' and `after-revert-hook' are run at the beginning
3007 and the end, and if `revert-buffer-insert-file-contents-function' is
3008 non-nil, it is called instead of rereading visited file contents."
3009
3010 ;; I admit it's odd to reverse the sense of the prefix argument, but
3011 ;; there is a lot of code out there which assumes that the first
3012 ;; argument should be t to avoid consulting the auto-save file, and
3013 ;; there's no straightforward way to encourage authors to notice a
3014 ;; reversal of the argument sense. So I'm just changing the user
3015 ;; interface, but leaving the programmatic interface the same.
3016 (interactive (list (not current-prefix-arg)))
3017 (if revert-buffer-function
3018 (funcall revert-buffer-function ignore-auto noconfirm)
3019 (let* ((auto-save-p (and (not ignore-auto)
3020 (recent-auto-save-p)
3021 buffer-auto-save-file-name
3022 (file-readable-p buffer-auto-save-file-name)
3023 (y-or-n-p
3024 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3025 (file-name (if auto-save-p
3026 buffer-auto-save-file-name
3027 buffer-file-name)))
3028 (cond ((null file-name)
3029 (error "Buffer does not seem to be associated with any file"))
3030 ((or noconfirm
3031 (and (not (buffer-modified-p))
3032 (let ((tail revert-without-query)
3033 (found nil))
3034 (while tail
3035 (if (string-match (car tail) file-name)
3036 (setq found t))
3037 (setq tail (cdr tail)))
3038 found))
3039 (yes-or-no-p (format "Revert buffer from file %s? "
3040 file-name)))
3041 (run-hooks 'before-revert-hook)
3042 ;; If file was backed up but has changed since,
3043 ;; we shd make another backup.
3044 (and (not auto-save-p)
3045 (not (verify-visited-file-modtime (current-buffer)))
3046 (setq buffer-backed-up nil))
3047 ;; Get rid of all undo records for this buffer.
3048 (or (eq buffer-undo-list t)
3049 (setq buffer-undo-list nil))
3050 ;; Effectively copy the after-revert-hook status,
3051 ;; since after-find-file will clobber it.
3052 (let ((global-hook (default-value 'after-revert-hook))
3053 (local-hook-p (local-variable-p 'after-revert-hook))
3054 (local-hook (and (local-variable-p 'after-revert-hook)
3055 after-revert-hook)))
3056 (let (buffer-read-only
3057 ;; Don't make undo records for the reversion.
3058 (buffer-undo-list t))
3059 (if revert-buffer-insert-file-contents-function
3060 (funcall revert-buffer-insert-file-contents-function
3061 file-name auto-save-p)
3062 (if (not (file-exists-p file-name))
3063 (error "File %s no longer exists!" file-name))
3064 ;; Bind buffer-file-name to nil
3065 ;; so that we don't try to lock the file.
3066 (let ((buffer-file-name nil))
3067 (or auto-save-p
3068 (unlock-buffer)))
3069 (widen)
3070 (let ((coding-system-for-read
3071 ;; Auto-saved file shoule be read without
3072 ;; any code conversion.
3073 (if auto-save-p 'emacs-mule-unix
3074 coding-system-for-read)))
3075 ;; Note that this preserves point in an intelligent way.
3076 (insert-file-contents file-name (not auto-save-p)
3077 nil nil t))))
3078 ;; Recompute the truename in case changes in symlinks
3079 ;; have changed the truename.
3080 (setq buffer-file-truename
3081 (abbreviate-file-name (file-truename buffer-file-name)))
3082 (after-find-file nil nil t t preserve-modes)
3083 ;; Run after-revert-hook as it was before we reverted.
3084 (setq-default revert-buffer-internal-hook global-hook)
3085 (if local-hook-p
3086 (progn
3087 (make-local-variable 'revert-buffer-internal-hook)
3088 (setq revert-buffer-internal-hook local-hook))
3089 (kill-local-variable 'revert-buffer-internal-hook))
3090 (run-hooks 'revert-buffer-internal-hook))
3091 t)))))
3092
3093 (defun recover-file (file)
3094 "Visit file FILE, but get contents from its last auto-save file."
3095 ;; Actually putting the file name in the minibuffer should be used
3096 ;; only rarely.
3097 ;; Not just because users often use the default.
3098 (interactive "FRecover file: ")
3099 (setq file (expand-file-name file))
3100 (if (auto-save-file-name-p (file-name-nondirectory file))
3101 (error "%s is an auto-save file" file))
3102 (let ((file-name (let ((buffer-file-name file))
3103 (make-auto-save-file-name))))
3104 (cond ((if (file-exists-p file)
3105 (not (file-newer-than-file-p file-name file))
3106 (not (file-exists-p file-name)))
3107 (error "Auto-save file %s not current" file-name))
3108 ((save-window-excursion
3109 (with-output-to-temp-buffer "*Directory*"
3110 (buffer-disable-undo standard-output)
3111 (save-excursion
3112 (let ((switches dired-listing-switches))
3113 (if (file-symlink-p file)
3114 (setq switches (concat switches "L")))
3115 (set-buffer standard-output)
3116 ;; Use insert-directory-safely, not insert-directory,
3117 ;; because these files might not exist. In particular,
3118 ;; FILE might not exist if the auto-save file was for
3119 ;; a buffer that didn't visit a file, such as "*mail*".
3120 ;; The code in v20.x called `ls' directly, so we need
3121 ;; to emulate what `ls' did in that case.
3122 (insert-directory-safely file switches)
3123 (insert-directory-safely file-name switches))))
3124 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3125 (switch-to-buffer (find-file-noselect file t))
3126 (let ((buffer-read-only nil)
3127 ;; Keep the current buffer-file-coding-system.
3128 (coding-system buffer-file-coding-system)
3129 ;; Auto-saved file shoule be read without any code conversion.
3130 (coding-system-for-read 'emacs-mule-unix))
3131 (erase-buffer)
3132 (insert-file-contents file-name nil)
3133 (set-buffer-file-coding-system coding-system))
3134 (after-find-file nil nil t))
3135 (t (error "Recover-file cancelled")))))
3136
3137 (defun recover-session ()
3138 "Recover auto save files from a previous Emacs session.
3139 This command first displays a Dired buffer showing you the
3140 previous sessions that you could recover from.
3141 To choose one, move point to the proper line and then type C-c C-c.
3142 Then you'll be asked about a number of files to recover."
3143 (interactive)
3144 (if (null auto-save-list-file-prefix)
3145 (error "You set `auto-save-list-file-prefix' to disable making session files"))
3146 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3147 (unless (file-directory-p dir)
3148 (make-directory dir t)))
3149 (let ((ls-lisp-support-shell-wildcards t))
3150 (dired (concat auto-save-list-file-prefix "*")
3151 (concat dired-listing-switches "t")))
3152 (save-excursion
3153 (goto-char (point-min))
3154 (or (looking-at " Move to the session you want to recover,")
3155 (let ((inhibit-read-only t))
3156 ;; Each line starts with a space
3157 ;; so that Font Lock mode won't highlight the first character.
3158 (insert " Move to the session you want to recover,\n"
3159 " then type C-c C-c to select it.\n\n"
3160 " You can also delete some of these files;\n"
3161 " type d on a line to mark that file for deletion.\n\n"))))
3162 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
3163 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
3164
3165 (defun recover-session-finish ()
3166 "Choose one saved session to recover auto-save files from.
3167 This command is used in the special Dired buffer created by
3168 \\[recover-session]."
3169 (interactive)
3170 ;; Get the name of the session file to recover from.
3171 (let ((file (dired-get-filename))
3172 files
3173 (buffer (get-buffer-create " *recover*")))
3174 (dired-unmark 1)
3175 (dired-do-flagged-delete t)
3176 (unwind-protect
3177 (save-excursion
3178 ;; Read in the auto-save-list file.
3179 (set-buffer buffer)
3180 (erase-buffer)
3181 (insert-file-contents file)
3182 ;; Loop thru the text of that file
3183 ;; and get out the names of the files to recover.
3184 (while (not (eobp))
3185 (let (thisfile autofile)
3186 (if (eolp)
3187 ;; This is a pair of lines for a non-file-visiting buffer.
3188 ;; Get the auto-save file name and manufacture
3189 ;; a "visited file name" from that.
3190 (progn
3191 (forward-line 1)
3192 (setq autofile
3193 (buffer-substring-no-properties
3194 (point)
3195 (save-excursion
3196 (end-of-line)
3197 (point))))
3198 (setq thisfile
3199 (expand-file-name
3200 (substring
3201 (file-name-nondirectory autofile)
3202 1 -1)
3203 (file-name-directory autofile)))
3204 (forward-line 1))
3205 ;; This pair of lines is a file-visiting
3206 ;; buffer. Use the visited file name.
3207 (progn
3208 (setq thisfile
3209 (buffer-substring-no-properties
3210 (point) (progn (end-of-line) (point))))
3211 (forward-line 1)
3212 (setq autofile
3213 (buffer-substring-no-properties
3214 (point) (progn (end-of-line) (point))))
3215 (forward-line 1)))
3216 ;; Ignore a file if its auto-save file does not exist now.
3217 (if (file-exists-p autofile)
3218 (setq files (cons thisfile files)))))
3219 (setq files (nreverse files))
3220 ;; The file contains a pair of line for each auto-saved buffer.
3221 ;; The first line of the pair contains the visited file name
3222 ;; or is empty if the buffer was not visiting a file.
3223 ;; The second line is the auto-save file name.
3224 (if files
3225 (map-y-or-n-p "Recover %s? "
3226 (lambda (file)
3227 (condition-case nil
3228 (save-excursion (recover-file file))
3229 (error
3230 "Failed to recover `%s'" file)))
3231 files
3232 '("file" "files" "recover"))
3233 (message "No files can be recovered from this session now")))
3234 (kill-buffer buffer))))
3235
3236 (defun kill-some-buffers (&optional list)
3237 "For each buffer in LIST, ask whether to kill it.
3238 LIST defaults to all existing live buffers."
3239 (interactive)
3240 (if (null list)
3241 (setq list (buffer-list)))
3242 (while list
3243 (let* ((buffer (car list))
3244 (name (buffer-name buffer)))
3245 (and (not (string-equal name ""))
3246 (/= (aref name 0) ? )
3247 (yes-or-no-p
3248 (format "Buffer %s %s. Kill? "
3249 name
3250 (if (buffer-modified-p buffer)
3251 "HAS BEEN EDITED" "is unmodified")))
3252 (kill-buffer buffer)))
3253 (setq list (cdr list))))
3254 \f
3255 (defun auto-save-mode (arg)
3256 "Toggle auto-saving of contents of current buffer.
3257 With prefix argument ARG, turn auto-saving on if positive, else off."
3258 (interactive "P")
3259 (setq buffer-auto-save-file-name
3260 (and (if (null arg)
3261 (or (not buffer-auto-save-file-name)
3262 ;; If auto-save is off because buffer has shrunk,
3263 ;; then toggling should turn it on.
3264 (< buffer-saved-size 0))
3265 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
3266 (if (and buffer-file-name auto-save-visited-file-name
3267 (not buffer-read-only))
3268 buffer-file-name
3269 (make-auto-save-file-name))))
3270 ;; If -1 was stored here, to temporarily turn off saving,
3271 ;; turn it back on.
3272 (and (< buffer-saved-size 0)
3273 (setq buffer-saved-size 0))
3274 (if (interactive-p)
3275 (message "Auto-save %s (in this buffer)"
3276 (if buffer-auto-save-file-name "on" "off")))
3277 buffer-auto-save-file-name)
3278
3279 (defun rename-auto-save-file ()
3280 "Adjust current buffer's auto save file name for current conditions.
3281 Also rename any existing auto save file, if it was made in this session."
3282 (let ((osave buffer-auto-save-file-name))
3283 (setq buffer-auto-save-file-name
3284 (make-auto-save-file-name))
3285 (if (and osave buffer-auto-save-file-name
3286 (not (string= buffer-auto-save-file-name buffer-file-name))
3287 (not (string= buffer-auto-save-file-name osave))
3288 (file-exists-p osave)
3289 (recent-auto-save-p))
3290 (rename-file osave buffer-auto-save-file-name t))))
3291
3292 (defun make-auto-save-file-name ()
3293 "Return file name to use for auto-saves of current buffer.
3294 Does not consider `auto-save-visited-file-name' as that variable is checked
3295 before calling this function. You can redefine this for customization.
3296 See also `auto-save-file-name-p'."
3297 (if buffer-file-name
3298 (let ((list auto-save-file-name-transforms)
3299 (filename buffer-file-name)
3300 result)
3301 ;; Apply user-specified translations
3302 ;; to the file name.
3303 (while (and list (not result))
3304 (if (string-match (car (car list)) filename)
3305 (setq result (replace-match (cadr (car list)) t nil
3306 filename)))
3307 (setq list (cdr list)))
3308 (if result (setq filename result))
3309
3310 (if (and (eq system-type 'ms-dos)
3311 (not (msdos-long-file-names)))
3312 ;; We truncate the file name to DOS 8+3 limits before
3313 ;; doing anything else, because the regexp passed to
3314 ;; string-match below cannot handle extensions longer than
3315 ;; 3 characters, multiple dots, and other atrocities.
3316 (let ((fn (dos-8+3-filename
3317 (file-name-nondirectory buffer-file-name))))
3318 (string-match "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" fn)
3319 (concat (file-name-directory buffer-file-name)
3320 "#" (match-string 1 fn)
3321 "." (match-string 3 fn) "#"))
3322 (concat (file-name-directory filename)
3323 "#"
3324 (file-name-nondirectory filename)
3325 "#")))
3326
3327 ;; Deal with buffers that don't have any associated files. (Mail
3328 ;; mode tends to create a good number of these.)
3329
3330 (let ((buffer-name (buffer-name))
3331 (limit 0))
3332 ;; Eliminate all slashes and backslashes by
3333 ;; replacing them with sequences that start with %.
3334 ;; Quote % also, to keep distinct names distinct.
3335 (while (string-match "[/\\%]" buffer-name limit)
3336 (let* ((character (aref buffer-name (match-beginning 0)))
3337 (replacement
3338 (cond ((eq character ?%) "%%")
3339 ((eq character ?/) "%+")
3340 ((eq character ?\\) "%-"))))
3341 (setq buffer-name (replace-match replacement t t buffer-name))
3342 (setq limit (1+ (match-end 0)))))
3343 ;; Generate the file name.
3344 (expand-file-name
3345 (format "#%s#%s#" buffer-name (make-temp-name ""))
3346 ;; Try a few alternative directories, to get one we can write it.
3347 (cond
3348 ((file-writable-p default-directory) default-directory)
3349 ((file-writable-p "/var/tmp/") "/var/tmp/")
3350 ("~/"))))))
3351
3352 (defun auto-save-file-name-p (filename)
3353 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3354 FILENAME should lack slashes. You can redefine this for customization."
3355 (string-match "^#.*#$" filename))
3356 \f
3357 (defun wildcard-to-regexp (wildcard)
3358 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3359 The generated regexp will match a filename iff the filename
3360 matches that wildcard according to shell rules. Only wildcards known
3361 by `sh' are supported."
3362 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3363 ;; Copy the initial run of non-special characters.
3364 (result (substring wildcard 0 i))
3365 (len (length wildcard)))
3366 ;; If no special characters, we're almost done.
3367 (if i
3368 (while (< i len)
3369 (let ((ch (aref wildcard i))
3370 j)
3371 (setq
3372 result
3373 (concat result
3374 (cond
3375 ((and (eq ch ?\[)
3376 (< (1+ i) len)
3377 (eq (aref wildcard (1+ i)) ?\]))
3378 "\\[")
3379 ((eq ch ?\[) ; [...] maps to regexp char class
3380 (progn
3381 (setq i (1+ i))
3382 (concat
3383 (cond
3384 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3385 (progn
3386 (setq i (1+ i))
3387 (if (eq (aref wildcard i) ?\])
3388 (progn
3389 (setq i (1+ i))
3390 "[^]")
3391 "[^")))
3392 ((eq (aref wildcard i) ?^)
3393 ;; Found "[^". Insert a `\0' character
3394 ;; (which cannot happen in a filename)
3395 ;; into the character class, so that `^'
3396 ;; is not the first character after `[',
3397 ;; and thus non-special in a regexp.
3398 (progn
3399 (setq i (1+ i))
3400 "[\000^"))
3401 ((eq (aref wildcard i) ?\])
3402 ;; I don't think `]' can appear in a
3403 ;; character class in a wildcard, but
3404 ;; let's be general here.
3405 (progn
3406 (setq i (1+ i))
3407 "[]"))
3408 (t "["))
3409 (prog1 ; copy everything upto next `]'.
3410 (substring wildcard
3411 i
3412 (setq j (string-match
3413 "]" wildcard i)))
3414 (setq i (if j (1- j) (1- len)))))))
3415 ((eq ch ?.) "\\.")
3416 ((eq ch ?*) "[^\000]*")
3417 ((eq ch ?+) "\\+")
3418 ((eq ch ?^) "\\^")
3419 ((eq ch ?$) "\\$")
3420 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3421 ((eq ch ??) "[^\000]")
3422 (t (char-to-string ch)))))
3423 (setq i (1+ i)))))
3424 ;; Shell wildcards should match the entire filename,
3425 ;; not its part. Make the regexp say so.
3426 (concat "\\`" result "\\'")))
3427 \f
3428 (defcustom list-directory-brief-switches
3429 (if (eq system-type 'vax-vms) "" "-CF")
3430 "*Switches for `list-directory' to pass to `ls' for brief listing."
3431 :type 'string
3432 :group 'dired)
3433
3434 (defcustom list-directory-verbose-switches
3435 (if (eq system-type 'vax-vms)
3436 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3437 "-l")
3438 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3439 :type 'string
3440 :group 'dired)
3441
3442 (defun file-expand-wildcards (pattern &optional full)
3443 "Expand wildcard pattern PATTERN.
3444 This returns a list of file names which match the pattern.
3445
3446 If PATTERN is written as an absolute relative file name,
3447 the values are absolute also.
3448
3449 If PATTERN is written as a relative file name, it is interpreted
3450 relative to the current default directory, `default-directory'.
3451 The file names returned are normally also relative to the current
3452 default directory. However, if FULL is non-nil, they are absolute."
3453 (let* ((nondir (file-name-nondirectory pattern))
3454 (dirpart (file-name-directory pattern))
3455 ;; A list of all dirs that DIRPART specifies.
3456 ;; This can be more than one dir
3457 ;; if DIRPART contains wildcards.
3458 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
3459 (mapcar 'file-name-as-directory
3460 (file-expand-wildcards (directory-file-name dirpart)))
3461 (list dirpart)))
3462 contents)
3463 (while dirs
3464 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
3465 (file-directory-p (directory-file-name (car dirs))))
3466 (let ((this-dir-contents
3467 ;; Filter out "." and ".."
3468 (delq nil
3469 (mapcar #'(lambda (name)
3470 (unless (string-match "\\`\\.\\.?\\'"
3471 (file-name-nondirectory name))
3472 name))
3473 (directory-files (or (car dirs) ".") full
3474 (wildcard-to-regexp nondir))))))
3475 (setq contents
3476 (nconc
3477 (if (and (car dirs) (not full))
3478 (mapcar (function (lambda (name) (concat (car dirs) name)))
3479 this-dir-contents)
3480 this-dir-contents)
3481 contents))))
3482 (setq dirs (cdr dirs)))
3483 contents))
3484
3485 (defun list-directory (dirname &optional verbose)
3486 "Display a list of files in or matching DIRNAME, a la `ls'.
3487 DIRNAME is globbed by the shell if necessary.
3488 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3489 Actions controlled by variables `list-directory-brief-switches'
3490 and `list-directory-verbose-switches'."
3491 (interactive (let ((pfx current-prefix-arg))
3492 (list (read-file-name (if pfx "List directory (verbose): "
3493 "List directory (brief): ")
3494 nil default-directory nil)
3495 pfx)))
3496 (let ((switches (if verbose list-directory-verbose-switches
3497 list-directory-brief-switches)))
3498 (or dirname (setq dirname default-directory))
3499 (setq dirname (expand-file-name dirname))
3500 (with-output-to-temp-buffer "*Directory*"
3501 (buffer-disable-undo standard-output)
3502 (princ "Directory ")
3503 (princ dirname)
3504 (terpri)
3505 (save-excursion
3506 (set-buffer "*Directory*")
3507 (setq default-directory
3508 (if (file-directory-p dirname)
3509 (file-name-as-directory dirname)
3510 (file-name-directory dirname)))
3511 (let ((wildcard (not (file-directory-p dirname))))
3512 (insert-directory dirname switches wildcard (not wildcard)))))))
3513
3514 (defun shell-quote-wildcard-pattern (pattern)
3515 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3516
3517 PATTERN is assumed to represent a file-name wildcard suitable for the
3518 underlying filesystem. For Unix and GNU/Linux, the characters from the
3519 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
3520 the parts of the pattern which don't include wildcard characters are
3521 quoted with double quotes.
3522 Existing quote characters in PATTERN are left alone, so you can pass
3523 PATTERN that already quotes some of the special characters."
3524 (save-match-data
3525 (cond
3526 ((memq system-type '(ms-dos windows-nt))
3527 ;; DOS/Windows don't allow `"' in file names. So if the
3528 ;; argument has quotes, we can safely assume it is already
3529 ;; quoted by the caller.
3530 (if (or (string-match "[\"]" pattern)
3531 ;; We quote [&()#$'] in case their shell is a port of a
3532 ;; Unixy shell. We quote [,=+] because stock DOS and
3533 ;; Windows shells require that in some cases, such as
3534 ;; passing arguments to batch files that use positional
3535 ;; arguments like %1.
3536 (not (string-match "[ \t;&()#$',=+]" pattern)))
3537 pattern
3538 (let ((result "\"")
3539 (beg 0)
3540 end)
3541 (while (string-match "[*?]+" pattern beg)
3542 (setq end (match-beginning 0)
3543 result (concat result (substring pattern beg end)
3544 "\""
3545 (substring pattern end (match-end 0))
3546 "\"")
3547 beg (match-end 0)))
3548 (concat result (substring pattern beg) "\""))))
3549 (t
3550 (let ((beg 0))
3551 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3552 (setq pattern
3553 (concat (substring pattern 0 (match-beginning 0))
3554 "\\"
3555 (substring pattern (match-beginning 0)))
3556 beg (1+ (match-end 0)))))
3557 pattern))))
3558
3559
3560 (defvar insert-directory-program "ls"
3561 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3562
3563 (defcustom directory-free-space-program "df"
3564 "*Program to get the amount of free space on a file system.
3565 We assume the output has the format of `df'.
3566 The value of this variable must be just a command name or file name;
3567 if you want to specify options, use `directory-free-space-args'.
3568
3569 A value of nil disables this feature.
3570
3571 If the function `file-system-info' is defined, it is always used in
3572 preference to the program given by this variable."
3573 :type '(choice (string :tag "Program") (const :tag "None" nil))
3574 :group 'dired)
3575
3576 (defcustom directory-free-space-args "-Pk"
3577 "*Options to use when running `directory-free-space-program'."
3578 :type 'string
3579 :group 'dired)
3580
3581 (defun get-free-disk-space (dir)
3582 "Return the mount of free space on directory DIR's file system.
3583 The result is a string that gives the number of free 1KB blocks,
3584 or nil if the system call or the program which retrieve the infornmation
3585 fail.
3586
3587 This function calls `file-system-info' if it is available, or invokes the
3588 program specified by `directory-free-space-program' if that is non-nil."
3589 ;; Try to find the number of free blocks. Non-Posix systems don't
3590 ;; always have df, but might have an equivalent system call.
3591 (if (fboundp 'file-system-info)
3592 (let ((fsinfo (file-system-info dir)))
3593 (if fsinfo
3594 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
3595 (save-match-data
3596 (with-temp-buffer
3597 (when (and directory-free-space-program
3598 (zerop (call-process directory-free-space-program
3599 nil t nil
3600 directory-free-space-args
3601 dir)))
3602 ;; Usual format is a header line followed by a line of
3603 ;; numbers.
3604 (goto-char (point-min))
3605 (forward-line 1)
3606 (if (not (eobp))
3607 (progn
3608 ;; Move to the end of the "available blocks" number.
3609 (skip-chars-forward "^ \t")
3610 (forward-word 3)
3611 ;; Copy it into AVAILABLE.
3612 (let ((end (point)))
3613 (forward-word -1)
3614 (buffer-substring (point) end)))))))))
3615
3616
3617 ;; insert-directory
3618 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3619 ;; FULL-DIRECTORY-P is nil.
3620 ;; The single line of output must display FILE's name as it was
3621 ;; given, namely, an absolute path name.
3622 ;; - must insert exactly one line for each file if WILDCARD or
3623 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3624 ;; before the file lines, plus optional text after the file lines.
3625 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3626 ;; allowed.
3627 ;; File lines should display the basename.
3628 ;; - must be consistent with
3629 ;; - functions dired-move-to-filename, (these two define what a file line is)
3630 ;; dired-move-to-end-of-filename,
3631 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3632 ;; dired-insert-headerline
3633 ;; dired-after-subdir-garbage (defines what a "total" line is)
3634 ;; - variable dired-subdir-regexp
3635 (defun insert-directory (file switches &optional wildcard full-directory-p)
3636 "Insert directory listing for FILE, formatted according to SWITCHES.
3637 Leaves point after the inserted text.
3638 SWITCHES may be a string of options, or a list of strings.
3639 Optional third arg WILDCARD means treat FILE as shell wildcard.
3640 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3641 switches do not contain `d', so that a full listing is expected.
3642
3643 This works by running a directory listing program
3644 whose name is in the variable `insert-directory-program'.
3645 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3646 ;; We need the directory in order to find the right handler.
3647 (let ((handler (find-file-name-handler (expand-file-name file)
3648 'insert-directory)))
3649 (if handler
3650 (funcall handler 'insert-directory file switches
3651 wildcard full-directory-p)
3652 (if (eq system-type 'vax-vms)
3653 (vms-read-directory file switches (current-buffer))
3654 (let (result available)
3655
3656 ;; Read the actual directory using `insert-directory-program'.
3657 ;; RESULT gets the status code.
3658 (let ((coding-system-for-read
3659 (and enable-multibyte-characters
3660 (or file-name-coding-system
3661 default-file-name-coding-system)))
3662 ;; This is to control encoding the arguments in call-process.
3663 (coding-system-for-write coding-system-for-read))
3664 (setq result
3665 (if wildcard
3666 ;; Run ls in the directory part of the file pattern
3667 ;; using the last component as argument.
3668 (let ((default-directory
3669 (if (file-name-absolute-p file)
3670 (file-name-directory file)
3671 (file-name-directory (expand-file-name file))))
3672 (pattern (file-name-nondirectory file)))
3673 (call-process
3674 shell-file-name nil t nil
3675 "-c"
3676 (concat (if (memq system-type '(ms-dos windows-nt))
3677 ""
3678 "\\") ; Disregard Unix shell aliases!
3679 insert-directory-program
3680 " -d "
3681 (if (stringp switches)
3682 switches
3683 (mapconcat 'identity switches " "))
3684 " -- "
3685 ;; Quote some characters that have
3686 ;; special meanings in shells; but
3687 ;; don't quote the wildcards--we want
3688 ;; them to be special. We also
3689 ;; currently don't quote the quoting
3690 ;; characters in case people want to
3691 ;; use them explicitly to quote
3692 ;; wildcard characters.
3693 (shell-quote-wildcard-pattern pattern))))
3694 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3695 ;; directory if FILE is a symbolic link.
3696 (apply 'call-process
3697 insert-directory-program nil t nil
3698 (append
3699 (if (listp switches) switches
3700 (unless (equal switches "")
3701 ;; Split the switches at any spaces so we can
3702 ;; pass separate options as separate args.
3703 (split-string switches)))
3704 ;; Avoid lossage if FILE starts with `-'.
3705 '("--")
3706 (progn
3707 (if (string-match "\\`~" file)
3708 (setq file (expand-file-name file)))
3709 (list
3710 (if full-directory-p
3711 (concat (file-name-as-directory file) ".")
3712 file))))))))
3713
3714 ;; If `insert-directory-program' failed, signal an error.
3715 (if (/= result 0)
3716 ;; On non-Posix systems, we cannot open a directory, so
3717 ;; don't even try, because that will always result in
3718 ;; the ubiquitous "Access denied". Instead, show the
3719 ;; command line so the user can try to guess what went wrong.
3720 (if (and (file-directory-p file)
3721 (memq system-type '(ms-dos windows-nt)))
3722 (error
3723 "Reading directory: \"%s %s -- %s\" exited with status %s"
3724 insert-directory-program
3725 (if (listp switches) (concat switches) switches)
3726 file result)
3727 ;; Unix. Access the file to get a suitable error.
3728 (access-file file "Reading directory")
3729 (error "Listing directory failed but `access-file' worked")))
3730
3731 ;; Try to insert the amount of free space.
3732 (save-excursion
3733 (goto-char (point-min))
3734 ;; First find the line to put it on.
3735 (when (re-search-forward "^total" nil t)
3736 (let ((available (get-free-disk-space ".")))
3737 (when available
3738 ;; Replace "total" with "used", to avoid confusion.
3739 (replace-match "total used in directory")
3740 (end-of-line)
3741 (insert " available " available))))))))))
3742
3743 (defun insert-directory-safely (file switches
3744 &optional wildcard full-directory-p)
3745 "Insert directory listing for FILE, formatted according to SWITCHES.
3746
3747 Like `insert-directory', but if FILE does not exist, it inserts a
3748 message to that effect instead of signaling an error."
3749 (if (file-exists-p file)
3750 (insert-directory file switches wildcard full-directory-p)
3751 ;; Simulate the message printed by `ls'.
3752 (insert (format "%s: No such file or directory\n" file))))
3753
3754 (defvar kill-emacs-query-functions nil
3755 "Functions to call with no arguments to query about killing Emacs.
3756 If any of these functions returns nil, killing Emacs is cancelled.
3757 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3758 but `kill-emacs', the low level primitive, does not.
3759 See also `kill-emacs-hook'.")
3760
3761 (defcustom confirm-kill-emacs nil
3762 "How to ask for confirmation when leaving Emacs.
3763 If nil, the default, don't ask at all. If the value is non-nil, it should
3764 be a predicate function such as `yes-or-no-p'."
3765 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
3766 (const :tag "Ask with y-or-n-p" y-or-n-p)
3767 (const :tag "Don't confirm" nil))
3768 :group 'emacs
3769 :version "21.1")
3770
3771 (defun save-buffers-kill-emacs (&optional arg)
3772 "Offer to save each buffer, then kill this Emacs process.
3773 With prefix arg, silently save all file-visiting buffers, then kill."
3774 (interactive "P")
3775 (save-some-buffers arg t)
3776 (and (or (not (memq t (mapcar (function
3777 (lambda (buf) (and (buffer-file-name buf)
3778 (buffer-modified-p buf))))
3779 (buffer-list))))
3780 (yes-or-no-p "Modified buffers exist; exit anyway? "))
3781 (or (not (fboundp 'process-list))
3782 ;; process-list is not defined on VMS.
3783 (let ((processes (process-list))
3784 active)
3785 (while processes
3786 (and (memq (process-status (car processes)) '(run stop open))
3787 (let ((val (process-kill-without-query (car processes))))
3788 (process-kill-without-query (car processes) val)
3789 val)
3790 (setq active t))
3791 (setq processes (cdr processes)))
3792 (or (not active)
3793 (list-processes)
3794 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
3795 ;; Query the user for other things, perhaps.
3796 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
3797 (or (null confirm-kill-emacs)
3798 (funcall confirm-kill-emacs "Really exit Emacs? "))
3799 (kill-emacs)))
3800 \f
3801 ;; We use /: as a prefix to "quote" a file name
3802 ;; so that magic file name handlers will not apply to it.
3803
3804 (setq file-name-handler-alist
3805 (cons '("\\`/:" . file-name-non-special)
3806 file-name-handler-alist))
3807
3808 ;; We depend on being the last handler on the list,
3809 ;; so that anything else which does need handling
3810 ;; has been handled already.
3811 ;; So it is safe for us to inhibit *all* magic file name handlers.
3812
3813 (defun file-name-non-special (operation &rest arguments)
3814 (let ((file-name-handler-alist nil)
3815 (default-directory
3816 (if (eq operation 'insert-directory)
3817 (directory-file-name
3818 (expand-file-name
3819 (unhandled-file-name-directory default-directory)))
3820 default-directory))
3821 ;; Get a list of the indices of the args which are file names.
3822 (file-arg-indices
3823 (cdr (or (assq operation
3824 ;; The first four are special because they
3825 ;; return a file name. We want to include the /:
3826 ;; in the return value.
3827 ;; So just avoid stripping it in the first place.
3828 '((expand-file-name . nil)
3829 ;; `identity' means just return the first arg
3830 ;; as stripped of its quoting.
3831 (substitute-in-file-name . identity)
3832 (file-name-directory . nil)
3833 (file-name-as-directory . nil)
3834 (directory-file-name . nil)
3835 (file-name-completion 0 1)
3836 (file-name-all-completions 0 1)
3837 (rename-file 0 1)
3838 (copy-file 0 1)
3839 (make-symbolic-link 0 1)
3840 (add-name-to-file 0 1)))
3841 ;; For all other operations, treat the first argument only
3842 ;; as the file name.
3843 '(nil 0))))
3844 ;; Copy ARGUMENTS so we can replace elements in it.
3845 (arguments (copy-sequence arguments)))
3846 ;; Strip off the /: from the file names that have this handler.
3847 (save-match-data
3848 (while (consp file-arg-indices)
3849 (let ((pair (nthcdr (car file-arg-indices) arguments)))
3850 (and (car pair)
3851 (string-match "\\`/:" (car pair))
3852 (setcar pair
3853 (if (= (length (car pair)) 2)
3854 "/"
3855 (substring (car pair) 2)))))
3856 (setq file-arg-indices (cdr file-arg-indices))))
3857 (if (eq file-arg-indices 'identity)
3858 (car arguments)
3859 (apply operation arguments))))
3860 \f
3861 (define-key ctl-x-map "\C-f" 'find-file)
3862 (define-key ctl-x-map "\C-r" 'find-file-read-only)
3863 (define-key ctl-x-map "\C-v" 'find-alternate-file)
3864 (define-key ctl-x-map "\C-s" 'save-buffer)
3865 (define-key ctl-x-map "s" 'save-some-buffers)
3866 (define-key ctl-x-map "\C-w" 'write-file)
3867 (define-key ctl-x-map "i" 'insert-file)
3868 (define-key esc-map "~" 'not-modified)
3869 (define-key ctl-x-map "\C-d" 'list-directory)
3870 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
3871
3872 (define-key ctl-x-4-map "f" 'find-file-other-window)
3873 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
3874 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
3875 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
3876 (define-key ctl-x-4-map "\C-o" 'display-buffer)
3877
3878 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
3879 (define-key ctl-x-5-map "f" 'find-file-other-frame)
3880 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
3881 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
3882
3883 ;;; files.el ends here