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