files.el 141 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; files.el --- file input and output commands for Emacs

Richard M. Stallman's avatar
Richard M. Stallman committed
3
;; Copyright (C) 1985, 86, 87, 92, 93,
Dave Love's avatar
Dave Love committed
4
;;		 94, 95, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6 7
;; Maintainer: FSF

Roland McGrath's avatar
Roland McGrath committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Roland McGrath's avatar
Roland McGrath committed
13 14 15 16 17 18 19 20
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Roland McGrath's avatar
Roland McGrath committed
24

25 26 27 28 29 30
;;; Commentary:

;; Defines most of Emacs's file- and directory-handling functions,
;; including basic file visiting, backup generation, link handling,
;; ITS-id version control, load- and write-hook handling, and the like.

Eric S. Raymond's avatar
Eric S. Raymond committed
31 32
;;; Code:

33 34
(defgroup backup nil
  "Backups of edited data files."
35
  :group 'files)
Roland McGrath's avatar
Roland McGrath committed
36

37
(defgroup find-file nil
38 39
  "Finding files."
  :group 'files)
40 41 42


(defcustom delete-auto-save-files t
43 44 45 46
  "*Non-nil means delete auto-save file when a buffer is saved or killed.

Note that auto-save file will not be deleted if the buffer is killed
when it has unsaved changes."
47 48 49 50
  :type 'boolean
  :group 'auto-save)

(defcustom directory-abbrev-alist
Roland McGrath's avatar
Roland McGrath committed
51 52 53 54 55 56 57
  nil
  "*Alist of abbreviations for file directories.
A list of elements of the form (FROM . TO), each meaning to replace
FROM with TO when it appears in a directory name.  This replacement is
done when setting up the default directory of a newly visited file.
*Every* FROM string should start with `^'.

58 59 60
Do not use `~' in the TO strings.
They should be ordinary absolute directory names.

Roland McGrath's avatar
Roland McGrath committed
61 62
Use this feature when you have directories which you normally refer to
via absolute symbolic links.  Make TO the name of the link, and FROM
63 64 65 66 67 68 69
the name it is linked to."
  :type '(repeat (cons :format "%v"
		       :value ("" . "")
		       (regexp :tag "From")
		       (regexp :tag "To")))
  :group 'abbrev
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
70 71

;;; Turn off backup files on VMS since it has version numbers.
72
(defcustom make-backup-files (not (eq system-type 'vax-vms))
73
  "*Non-nil means make a backup of a file the first time it is saved.
Roland McGrath's avatar
Roland McGrath committed
74 75 76 77 78 79 80 81 82 83 84 85 86
This can be done by renaming the file or by copying.

Renaming means that Emacs renames the existing file so that it is a
backup file, then writes the buffer into a new file.  Any other names
that the old file had will now refer to the backup file.  The new file
is owned by you and its group is defaulted.

Copying means that Emacs copies the existing file into the backup
file, then writes the buffer on top of the existing file.  Any other
names that the old file had will now refer to the new (edited) file.
The file's owner and group are unchanged.

The choice of renaming or copying is controlled by the variables
87 88 89
`backup-by-copying', `backup-by-copying-when-linked',
`backup-by-copying-when-mismatch' and
`backup-by-copying-when-privileged-mismatch'.  See also `backup-inhibited'."
90 91
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
92 93 94 95

;; Do this so that local variables based on the file name
;; are not overridden by the major mode.
(defvar backup-inhibited nil
96 97 98
  "Non-nil means don't make a backup, regardless of the other parameters.
This variable is intended for use by making it local to a buffer.
But it is local only if you make it local.")
Roland McGrath's avatar
Roland McGrath committed
99 100
(put 'backup-inhibited 'permanent-local t)

101
(defcustom backup-by-copying nil
Roland McGrath's avatar
Roland McGrath committed
102
 "*Non-nil means always use copying to create backup files.
103 104 105
See documentation of variable `make-backup-files'."
 :type 'boolean
 :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
106

107
(defcustom backup-by-copying-when-linked nil
Roland McGrath's avatar
Roland McGrath committed
108 109
 "*Non-nil means use copying to create backups for files with multiple names.
This causes the alternate names to refer to the latest version as edited.
110 111 112
This variable is relevant only if `backup-by-copying' is nil."
 :type 'boolean
 :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
113

114
(defcustom backup-by-copying-when-mismatch nil
Roland McGrath's avatar
Roland McGrath committed
115 116 117 118 119
  "*Non-nil means create backups by copying if this preserves owner or group.
Renaming may still be used (subject to control of other variables)
when it would not result in changing the owner or group of the file;
that is, for files which are owned by you and whose group matches
the default for a new file created there by you.
120 121 122
This variable is relevant only if `backup-by-copying' is nil."
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
123

124 125 126 127 128 129 130 131 132 133 134 135
(defcustom backup-by-copying-when-privileged-mismatch 200
  "*Non-nil means create backups by copying to preserve a privileged owner.
Renaming may still be used (subject to control of other variables)
when it would not result in changing the owner of the file or if the owner
has a user id greater than the value of this variable.  This is useful
when low-numbered uid's are used for special system users (such as root)
that must maintain ownership of certain files.
This variable is relevant only if `backup-by-copying' and
`backup-by-copying-when-mismatch' are nil."
  :type '(choice (const nil) integer)
  :group 'backup)

Roland McGrath's avatar
Roland McGrath committed
136
(defvar backup-enable-predicate
137
  (lambda (name)
Gerd Moellmann's avatar
Gerd Moellmann committed
138 139 140 141 142 143 144 145 146 147 148 149
    (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
				      name 0 nil)))
	       ;; Directory is under temporary-file-directory.
	       (and (not (eq comp t))
		    (< comp -1)))
	     (if small-temporary-file-directory
		 (let ((comp (compare-strings small-temporary-file-directory
					      0 nil
					      name 0 nil)))
		   ;; Directory is under small-temporary-file-directory.
		   (and (not (eq comp t))
			(< comp -1)))))))
Roland McGrath's avatar
Roland McGrath committed
150
  "Predicate that looks at a file name and decides whether to make backups.
151 152 153
Called with an absolute file name as argument, it returns t to enable backup.
The default version checks for files in `temporary-file-directory' or
`small-temporary-file-directory'.")
Roland McGrath's avatar
Roland McGrath committed
154

155
(defcustom buffer-offer-save nil
Dave Love's avatar
Dave Love committed
156 157
  "*Non-nil in a buffer means always offer to save buffer on exit.
Do so even if the buffer is not visiting a file.
158 159 160
Automatically local in all buffers."
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
161 162
(make-variable-buffer-local 'buffer-offer-save)

163
(defcustom find-file-existing-other-name t
164 165
  "*Non-nil means find a file under alternative names, in existing buffers.
This means if any existing buffer is visiting the file you want
166 167 168
under another name, you get the existing buffer instead of a new buffer."
  :type 'boolean
  :group 'find-file)
169

170
(defcustom find-file-visit-truename nil
171 172
  "*Non-nil means visit a file under its truename.
The truename of a file is found by chasing all links
173 174 175
both at the file level and at the levels of the containing directories."
  :type 'boolean
  :group 'find-file)
176

177
(defcustom revert-without-query
178
  nil
179 180 181
  "*Specify which files should be reverted without query.
The value is a list of regular expressions.
If the file name matches one of these regular expressions,
182
then `revert-buffer' reverts the file without querying
183
if the file has changed on disk and you have not edited the buffer."
184
  :type '(repeat regexp)
185
  :group 'find-file)
186

187 188 189 190 191 192 193 194
(defvar buffer-file-number nil
  "The device number and file number of the file visited in the current buffer.
The value is a list of the form (FILENUM DEVNUM).
This pair of numbers uniquely identifies the file.
If the buffer is visiting a new file, the value is nil.")
(make-variable-buffer-local 'buffer-file-number)
(put 'buffer-file-number 'permanent-local t)

195 196 197
(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
  "Non-nil means that buffer-file-number uniquely identifies files.")

198 199
(defvar file-name-invalid-regexp
  (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
200
	 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
201
		 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|"  ; invalid characters
202
		 "[\000-\031]\\|"		  ; control characters
203 204 205
		 "\\(/\\.\\.?[^/]\\)\\|"	  ; leading dots
		 "\\(/[^/.]+\\.[^/.]*\\.\\)"))	  ; more than a single dot
	((memq system-type '(ms-dos windows-nt))
206
	 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
207
		 "[|<>\"?*\000-\031]"))		  ; invalid characters
208 209 210
	(t "[\000]"))
  "Regexp recognizing file names which aren't allowed by the filesystem.")

211
(defcustom file-precious-flag nil
Roland McGrath's avatar
Roland McGrath committed
212
  "*Non-nil means protect against I/O errors while saving files.
Karl Heuer's avatar
Karl Heuer committed
213
Some modes set this non-nil in particular buffers.
214 215 216 217 218 219 220

This feature works by writing the new contents into a temporary file
and then renaming the temporary file to replace the original.
In this way, any I/O error in writing leaves the original untouched,
and there is never any instant where the file is nonexistent.

Note that this feature forces backups to be made by copying.
Karl Heuer's avatar
Karl Heuer committed
221
Yet, at the same time, saving a precious file
222 223 224
breaks any hard links between it and other files."
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
225

226
(defcustom version-control nil
Roland McGrath's avatar
Roland McGrath committed
227 228 229
  "*Control use of version numbers for backup files.
t means make numeric backup versions unconditionally.
nil means make them for files that have some already.
230
`never' means do not make them."
231 232 233
  :type '(choice (const :tag "Never" never)
		 (const :tag "If existing" nil)
		 (other :tag "Always" t))
234 235 236 237 238 239 240 241 242 243
  :group 'backup
  :group 'vc)

(defcustom dired-kept-versions 2
  "*When cleaning directory, number of versions to keep."
  :type 'integer
  :group 'backup
  :group 'dired)

(defcustom delete-old-versions nil
244
  "*If t, delete excess backup versions silently.
245 246 247
If nil, ask confirmation.  Any other value prevents any trimming."
  :type '(choice (const :tag "Delete" t)
		 (const :tag "Ask" nil)
248
		 (other :tag "Leave" other))
249 250 251 252 253 254 255 256
  :group 'backup)

(defcustom kept-old-versions 2
  "*Number of oldest versions to keep when a new numbered backup is made."
  :type 'integer
  :group 'backup)

(defcustom kept-new-versions 2
Roland McGrath's avatar
Roland McGrath committed
257
  "*Number of newest versions to keep when a new numbered backup is made.
258 259 260
Includes the new backup.  Must be > 0"
  :type 'integer
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
261

262
(defcustom require-final-newline nil
Roland McGrath's avatar
Roland McGrath committed
263 264
  "*Value of t says silently ensure a file ends in a newline when it is saved.
Non-nil but not t says ask user whether to add a newline when there isn't one.
265
nil means don't add newlines."
266 267
  :type '(choice (const :tag "Off" nil)
		 (const :tag "Add" t)
268
		 (other :tag "Ask" ask))
269
  :group 'editing-basics)
Roland McGrath's avatar
Roland McGrath committed
270

271 272 273 274
(defcustom auto-save-default t
  "*Non-nil says by default do auto-saving of every file-visiting buffer."
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
275

276
(defcustom auto-save-visited-file-name nil
Roland McGrath's avatar
Roland McGrath committed
277
  "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
278 279 280
Normally auto-save files are written under other names."
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
281

Gerd Moellmann's avatar
Gerd Moellmann committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
(defcustom auto-save-file-name-transforms
  '(("\\`/[^/]*:\\(.+/\\)*\\(.*\\)" "/tmp/\\2"))
  "*Transforms to apply to buffer file name before making auto-save file name.
Each transform is a list (REGEXP REPLACEMENT):
REGEXP is a regular expression to match against the file name.
If it matches, `replace-match' is used to replace the
matching part with REPLACEMENT.
All the transforms in the list are tried, in the order they are listed.
When one transform applies, its result is final;
no further transforms are tried.

The default value is set up to put the auto-save file into `/tmp'
for editing a remote file."
  :group 'auto-save
  :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")))
  :version "21.1")

299
(defcustom save-abbrevs nil
Roland McGrath's avatar
Roland McGrath committed
300
  "*Non-nil means save word abbrevs too when files are saved.
301 302 303
Loading an abbrev file sets this to t."
  :type 'boolean
  :group 'abbrev)
Roland McGrath's avatar
Roland McGrath committed
304

305
(defcustom find-file-run-dired t
306 307
  "*Non-nil means allow `find-file' to visit directories.
To visit the directory, `find-file' runs `find-directory-functions'."
308 309
  :type 'boolean
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
310

311 312 313 314 315 316 317
(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
  "*List of functions to try in sequence to visit a directory.
Each function is called with the directory name as the sole argument
and should return either a buffer or nil."
  :type '(hook :options (cvs-dired-noselect dired-noselect))
  :group 'find-file)

318 319
;;;It is not useful to make this a local variable.
;;;(put 'find-file-not-found-hooks 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
320 321 322
(defvar find-file-not-found-hooks nil
  "List of functions to be called for `find-file' on nonexistent file.
These functions are called as soon as the error is detected.
Dave Love's avatar
Dave Love committed
323
Variable `buffer-file-name' is already set up.
Roland McGrath's avatar
Roland McGrath committed
324 325
The functions are called in the order given until one of them returns non-nil.")

326 327
;;;It is not useful to make this a local variable.
;;;(put 'find-file-hooks 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
328 329 330 331 332 333 334 335
(defvar find-file-hooks nil
  "List of functions to be called after a buffer is loaded from a file.
The buffer's local variables (if any) will have been processed before the
functions are called.")

(defvar write-file-hooks nil
  "List of functions to be called before writing out a buffer to a file.
If one of them returns non-nil, the file is considered already written
Jim Blandy's avatar
Jim Blandy committed
336 337
and the rest are not called.
These hooks are considered to pertain to the visited file.
338 339
So any buffer-local binding of `write-file-hooks' is
discarded if you change the visited file name with \\[set-visited-file-name].
340 341 342

Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
See also `write-contents-hooks'.")
343 344
;;; However, in case someone does make it local...
(put 'write-file-hooks 'permanent-local t)
345 346 347 348

(defvar local-write-file-hooks nil
  "Just like `write-file-hooks', except intended for per-buffer use.
The functions in this list are called before the ones in
349 350 351 352 353 354
`write-file-hooks'.

This variable is meant to be used for hooks that have to do with a
particular visited file.  Therefore, it is a permanent local, so that
changing the major mode does not clear it.  However, calling
`set-visited-file-name' does clear it.")
355 356
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
Jim Blandy's avatar
Jim Blandy committed
357 358 359 360 361

(defvar write-contents-hooks nil
  "List of functions to be called before writing out a buffer to a file.
If one of them returns non-nil, the file is considered already written
and the rest are not called.
362 363 364 365

This variable is meant to be used for hooks that pertain to the
buffer's contents, not to the particular visited file; thus,
`set-visited-file-name' does not clear this variable; but changing the
366 367 368
major mode does clear it.

This variable automatically becomes buffer-local whenever it is set.
Karl Heuer's avatar
Karl Heuer committed
369
If you use `add-hook' to add elements to the list, use nil for the
370
LOCAL argument.
371

Jim Blandy's avatar
Jim Blandy committed
372
See also `write-file-hooks'.")
373
(make-variable-buffer-local 'write-contents-hooks)
Roland McGrath's avatar
Roland McGrath committed
374

375
(defcustom enable-local-variables t
376
  "*Control use of local variables in files you visit.
Roland McGrath's avatar
Roland McGrath committed
377
The value can be t, nil or something else.
378
A value of t means file local variables specifications are obeyed;
Roland McGrath's avatar
Roland McGrath committed
379
nil means they are ignored; anything else means query.
380 381
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
382

383 384 385
The command \\[normal-mode], when used interactively,
always obeys file local variable specifications and the -*- line,
and ignores this variable."
386 387
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
388
		 (other :tag "Query" other))
389
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
390

391 392
(defvar local-enable-local-variables t
  "Like `enable-local-variables' but meant for buffer-local bindings.
393
The meaningful values are nil and non-nil.  The default is non-nil.
394
If a major mode sets this to nil, buffer-locally, then any local
395 396 397 398
variables list in the file will be ignored.

This variable does not affect the use of major modes
specified in a -*- line.")
399

400
(defcustom enable-local-eval 'maybe
401 402 403 404 405 406
  "*Control processing of the \"variable\" `eval' in a file's local variables.
The value can be t, nil or something else.
A value of t means obey `eval' variables;
nil means ignore them; anything else means query.

The command \\[normal-mode] always obeys local-variables lists
407 408 409
and ignores this variable."
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
410
		 (other :tag "Query" other))
411
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
412 413 414

;; Avoid losing in versions where CLASH_DETECTION is disabled.
(or (fboundp 'lock-buffer)
415
    (defalias 'lock-buffer 'ignore))
Roland McGrath's avatar
Roland McGrath committed
416
(or (fboundp 'unlock-buffer)
417
    (defalias 'unlock-buffer 'ignore))
418 419
(or (fboundp 'file-locked-p)
    (defalias 'file-locked-p 'ignore))
420

421 422 423
(defvar view-read-only nil
  "*Non-nil means buffers visiting files read-only, do it in view mode.")

424 425
(defvar temporary-file-directory
  (file-name-as-directory
426 427 428 429 430 431
   (cond ((memq system-type '(ms-dos windows-nt))
	  (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
	 ((memq system-type '(vax-vms axp-vms))
	  (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
	 (t
	  (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
432
  "The directory for writing temporary files.")
433

434
(defvar small-temporary-file-directory
435
  (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
436
  "The directory for writing small temporary files.
437 438 439
If non-nil, this directory is used instead of `temporary-file-directory'
by programs that create small temporary files.  This is for systems that
have fast storage with limited space, such as a RAM disk.")
440

441 442 443
;; The system null device. (Should reference NULL_DEVICE from C.)
(defvar null-device "/dev/null" "The system null device.")

444
(defun ange-ftp-completion-hook-function (op &rest args)
Dave Love's avatar
Dave Love committed
445 446 447 448
  "Provides support for ange-ftp host name completion.
Runs the usual ange-ftp hook, but only for completion operations."
  ;; Having this here avoids the need to load ange-ftp when it's not
  ;; really in use.
449 450
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
451 452 453 454 455
    (let ((inhibit-file-name-handlers
	   (cons 'ange-ftp-completion-hook-function
		 (and (eq inhibit-file-name-operation op)
		      inhibit-file-name-handlers)))
	  (inhibit-file-name-operation op))
456
      (apply op args))))
457 458 459 460 461 462 463

(defun convert-standard-filename (filename)
  "Convert a standard file's name to something suitable for the current OS.
This function's standard definition is trivial; it just returns the argument.
However, on some systems, the function is redefined
with a definition that really does change some file names."
  filename)
Roland McGrath's avatar
Roland McGrath committed
464 465 466 467 468 469

(defun pwd ()
  "Show the current default directory."
  (interactive nil)
  (message "Directory %s" default-directory))

470 471 472 473 474
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
Not actually set up until the first time you you use it.")

(defun parse-colon-path (cd-path)
Dave Love's avatar
Dave Love committed
475 476 477
  "Explode a colon-separated search path into a list of directory names.
\(For values of `colon' equal to `path-separator'.)"
  ;; We could use split-string here.
478 479
  (and cd-path
       (let (cd-prefix cd-list (cd-start 0) cd-colon)
480 481
	 (setq cd-path (concat cd-path path-separator))
	 (while (setq cd-colon (string-match path-separator cd-path cd-start))
482
	   (setq cd-list
483
		 (nconc cd-list
484 485 486
			(list (if (= cd-start cd-colon)
				   nil
				(substitute-in-file-name
487 488
				 (file-name-as-directory
				  (substring cd-path cd-start cd-colon)))))))
489 490 491 492
	   (setq cd-start (+ cd-colon 1)))
	 cd-list)))

(defun cd-absolute (dir)
493
  "Change current directory to given absolute file name DIR."
494 495
  ;; Put the name into directory syntax now,
  ;; because otherwise expand-file-name may give some bad results.
Roland McGrath's avatar
Roland McGrath committed
496 497
  (if (not (eq system-type 'vax-vms))
      (setq dir (file-name-as-directory dir)))
498
  (setq dir (abbreviate-file-name (expand-file-name dir)))
Roland McGrath's avatar
Roland McGrath committed
499
  (if (not (file-directory-p dir))
500 501
      (if (file-exists-p dir)
	  (error "%s is not a directory" dir)
502
	(error "%s: no such directory" dir))
Roland McGrath's avatar
Roland McGrath committed
503 504
    (if (file-executable-p dir)
	(setq default-directory dir)
505
      (error "Cannot cd to %s:  Permission denied" dir))))
Roland McGrath's avatar
Roland McGrath committed
506

507 508
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
509 510
If your environment includes a `CDPATH' variable, try each one of that
colon-separated list of directories when resolving a relative directory name."
511 512
  (interactive
   (list (read-file-name "Change default directory: "
513 514 515
			 default-directory default-directory
			 (and (member cd-path '(nil ("./")))
			      (null (getenv "CDPATH"))))))
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
  (if (file-name-absolute-p dir)
      (cd-absolute (expand-file-name dir))
    (if (null cd-path)
	(let ((trypath (parse-colon-path (getenv "CDPATH"))))
	  (setq cd-path (or trypath (list "./")))))
    (if (not (catch 'found
	       (mapcar
		(function (lambda (x)
			    (let ((f (expand-file-name (concat x dir))))
			      (if (file-directory-p f)
				  (progn
				    (cd-absolute f)
				    (throw 'found t))))))
		cd-path)
	       nil))
	(error "No such directory found via CDPATH environment variable"))))
532

Roland McGrath's avatar
Roland McGrath committed
533 534 535
(defun load-file (file)
  "Load the Lisp file named FILE."
  (interactive "fLoad file: ")
536 537 538
  (let ((completion-ignored-extensions
	 (delete ".elc" completion-ignored-extensions)))
    (load (expand-file-name file) nil nil t)))
Roland McGrath's avatar
Roland McGrath committed
539 540 541 542 543 544

(defun load-library (library)
  "Load the library named LIBRARY.
This is an interface to the function `load'."
  (interactive "sLoad library: ")
  (load library))
545

546
(defun file-local-copy (file)
547 548 549
  "Copy the file FILE into a temporary file on this machine.
Returns the name of the local copy, or nil, if FILE is directly
accessible."
550 551
  ;; This formerly had an optional BUFFER argument that wasn't used by
  ;; anything.
552
  (let ((handler (find-file-name-handler file 'file-local-copy)))
553 554 555
    (if handler
	(funcall handler 'file-local-copy file)
      nil)))
556

557
(defun file-truename (filename &optional counter prev-dirs)
558 559 560
  "Return the truename of FILENAME, which should be absolute.
The truename of a file name is found by chasing symbolic links
both at the level of the file and at the level of the directories
561 562 563 564 565 566 567 568
containing it, until no links are left at any level.

The arguments COUNTER and PREV-DIRS are used only in recursive calls.
Do not specify them in other calls."
  ;; COUNTER can be a cons cell whose car is the count of how many more links
  ;; to chase before getting an error.
  ;; PREV-DIRS can be a cons cell whose car is an alist
  ;; of truenames we've just recently computed.
569 570 571

  ;; The last test looks dubious, maybe `+' is meant here?  --simon.
  (if (or (string= filename "") (string= filename "~")
572 573
	  (and (string= (substring filename 0 1) "~")
	       (string-match "~[^/]*" filename)))
574 575 576 577
      (progn
	(setq filename (expand-file-name filename))
	(if (string= filename "")
	    (setq filename "/"))))
578
  (or counter (setq counter (list 100)))
579 580 581 582 583 584 585 586 587
  (let (done
	;; For speed, remove the ange-ftp completion handler from the list.
	;; We know it's not needed here.
	;; For even more speed, do this only on the outermost call.
	(file-name-handler-alist
	 (if prev-dirs file-name-handler-alist
	   (let ((tem (copy-sequence file-name-handler-alist)))
	     (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
    (or prev-dirs (setq prev-dirs (list nil)))
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607

    ;; andrewi@harlequin.co.uk - none of the following code (except for
    ;; invoking the file-name handler) currently applies on Windows
    ;; (ie. there are no native symlinks), but there is an issue with
    ;; case differences being ignored by the OS, and short "8.3 DOS"
    ;; name aliases existing for all files.  (The short names are not
    ;; reported by directory-files, but can be used to refer to files.)
    ;; It seems appropriate for file-truename to resolve these issues in
    ;; the most natural way, which on Windows is to call the function
    ;; `w32-long-file-name' - this returns the exact name of a file as
    ;; it is stored on disk (expanding short name aliases with the full
    ;; name in the process).
    (if (eq system-type 'windows-nt)
      (let ((handler (find-file-name-handler filename 'file-truename))
	    newname)
	;; For file name that has a special handler, call handler.
	;; This is so that ange-ftp can save time by doing a no-op.
	(if handler
	    (setq filename (funcall handler 'file-truename filename))
	  ;; If filename contains a wildcard, newname will be the old name.
Dave Love's avatar
Dave Love committed
608
	  (if (string-match "[[*?]" filename)
609 610 611 612 613 614
	      (setq newname filename)
	    ;; If filename doesn't exist, newname will be nil.
	    (setq newname (w32-long-file-name filename)))
	  (setq filename (or newname filename)))
	(setq done t)))

615 616 617 618 619 620 621 622 623 624 625 626
    ;; If this file directly leads to a link, process that iteratively
    ;; so that we don't use lots of stack.
    (while (not done)
      (setcar counter (1- (car counter)))
      (if (< (car counter) 0)
	  (error "Apparent cycle of symbolic links for %s" filename))
      (let ((handler (find-file-name-handler filename 'file-truename)))
	;; For file name that has a special handler, call handler.
	;; This is so that ange-ftp can save time by doing a no-op.
	(if handler
	    (setq filename (funcall handler 'file-truename filename)
		  done t)
627
	  (let ((dir (or (file-name-directory filename) default-directory))
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
		target dirfile)
	    ;; Get the truename of the directory.
	    (setq dirfile (directory-file-name dir))
	    ;; If these are equal, we have the (or a) root directory.
	    (or (string= dir dirfile)
		;; If this is the same dir we last got the truename for,
		;; save time--don't recalculate.
		(if (assoc dir (car prev-dirs))
		    (setq dir (cdr (assoc dir (car prev-dirs))))
		  (let ((old dir)
			(new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
		    (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
		    (setq dir new))))
	    (if (equal ".." (file-name-nondirectory filename))
		(setq filename
		      (directory-file-name (file-name-directory (directory-file-name dir)))
		      done t)
	      (if (equal "." (file-name-nondirectory filename))
		  (setq filename (directory-file-name dir)
			done t)
		;; Put it back on the file name.
		(setq filename (concat dir (file-name-nondirectory filename)))
		;; Is the file name the name of a link?
		(setq target (file-symlink-p filename))
		(if target
		    ;; Yes => chase that link, then start all over
		    ;; since the link may point to a directory name that uses links.
		    ;; We can't safely use expand-file-name here
		    ;; since target might look like foo/../bar where foo
		    ;; is itself a link.  Instead, we handle . and .. above.
		    (setq filename
			  (if (file-name-absolute-p target)
			      target
			    (concat dir target))
			  done nil)
		  ;; No, we are done!
		  (setq done t))))))))
    filename))
666

667 668 669 670 671 672
(defun file-chase-links (filename)
  "Chase links in FILENAME until a name that is not a link.
Does not examine containing directories for links,
unlike `file-truename'."
  (let (tem (count 100) (newname filename))
    (while (setq tem (file-symlink-p newname))
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
      (save-match-data
	(if (= count 0)
	    (error "Apparent cycle of symbolic links for %s" filename))
	;; In the context of a link, `//' doesn't mean what Emacs thinks.
	(while (string-match "//+" tem)
	  (setq tem (replace-match "/" nil nil tem)))
	;; Handle `..' by hand, since it needs to work in the
	;; target of any directory symlink.
	;; This code is not quite complete; it does not handle
	;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
	(while (string-match "\\`\\.\\./" tem)
	  (setq tem (substring tem 3))
	  (setq newname (expand-file-name newname))
	  ;; Chase links in the default dir of the symlink.
	  (setq newname
		(file-chase-links
		 (directory-file-name (file-name-directory newname))))
	  ;; Now find the parent of that dir.
	  (setq newname (file-name-directory newname)))
	(setq newname (expand-file-name tem (file-name-directory newname)))
	(setq count (1- count))))
694
    newname))
Roland McGrath's avatar
Roland McGrath committed
695

696 697 698 699
(defun switch-to-buffer-other-window (buffer &optional norecord)
  "Select buffer BUFFER in another window.
Optional second arg NORECORD non-nil means
do not put this buffer at the front of the list of recently selected ones."
Roland McGrath's avatar
Roland McGrath committed
700 701
  (interactive "BSwitch to buffer in other window: ")
  (let ((pop-up-windows t))
702
    (pop-to-buffer buffer t norecord)))
Roland McGrath's avatar
Roland McGrath committed
703

704 705 706 707
(defun switch-to-buffer-other-frame (buffer &optional norecord)
  "Switch to buffer BUFFER in another frame.
Optional second arg NORECORD non-nil means
do not put this buffer at the front of the list of recently selected ones."
Jim Blandy's avatar
Jim Blandy committed
708 709
  (interactive "BSwitch to buffer in other frame: ")
  (let ((pop-up-frames t))
710
    (pop-to-buffer buffer t norecord)
711
    (raise-frame (window-frame (selected-window)))))
Jim Blandy's avatar
Jim Blandy committed
712

713
(defun find-file (filename &optional wildcards)
Roland McGrath's avatar
Roland McGrath committed
714 715
  "Edit file FILENAME.
Switch to a buffer visiting file FILENAME,
716 717
creating one if none already exists.
Interactively, or if WILDCARDS is non-nil in a call from Lisp,
718
expand wildcards (if any) and visit multiple files.  Wildcard expansion
Dave Love's avatar
Dave Love committed
719
can be suppressed by setting `find-file-wildcards'."
720
  (interactive "FFind file: \np")
721 722 723 724
  (let ((value (find-file-noselect filename nil nil wildcards)))
    (if (listp value)
	(mapcar 'switch-to-buffer (nreverse value))
      (switch-to-buffer value))))
725

726
(defun find-file-other-window (filename &optional wildcards)
Roland McGrath's avatar
Roland McGrath committed
727 728
  "Edit file FILENAME, in another window.
May create a new window, or reuse an existing one.
729 730 731 732
See the function `display-buffer'.
Interactively, or if WILDCARDS is non-nil in a call from Lisp,
expand wildcards (if any) and visit multiple files."
  (interactive "FFind file in other window: \np")
733 734 735 736 737 738 739
  (let ((value (find-file-noselect filename nil nil wildcards)))
    (if (listp value)
	(progn
	  (setq value (nreverse value))
	  (switch-to-buffer-other-window (car value))
	  (mapcar 'switch-to-buffer (cdr value)))
      (switch-to-buffer-other-window value))))
740 741

(defun find-file-other-frame (filename &optional wildcards)
Jim Blandy's avatar
Jim Blandy committed
742 743
  "Edit file FILENAME, in another frame.
May create a new frame, or reuse an existing one.
744 745 746 747
See the function `display-buffer'.
Interactively, or if WILDCARDS is non-nil in a call from Lisp,
expand wildcards (if any) and visit multiple files."
  (interactive "FFind file in other frame: \np")
748 749 750 751 752 753 754
  (let ((value (find-file-noselect filename nil nil wildcards)))
    (if (listp value)
	(progn
	  (setq value (nreverse value))
	  (switch-to-buffer-other-frame (car value))
	  (mapcar 'switch-to-buffer (cdr value)))
      (switch-to-buffer-other-frame value))))
755 756

(defun find-file-read-only (filename &optional wildcards)
Roland McGrath's avatar
Roland McGrath committed
757
  "Edit file FILENAME but don't allow changes.
758
Like `find-file' but marks buffer as read-only.
Roland McGrath's avatar
Roland McGrath committed
759
Use \\[toggle-read-only] to permit editing."
760 761
  (interactive "fFind file read-only: \np")
  (find-file filename wildcards)
762
  (toggle-read-only 1)
763
  (current-buffer))
Roland McGrath's avatar
Roland McGrath committed
764

765
(defun find-file-read-only-other-window (filename &optional wildcards)
Roland McGrath's avatar
Roland McGrath committed
766 767 768
  "Edit file FILENAME in another window but don't allow changes.
Like \\[find-file-other-window] but marks buffer as read-only.
Use \\[toggle-read-only] to permit editing."
769 770
  (interactive "fFind file read-only other window: \np")
  (find-file-other-window filename wildcards)
771
  (toggle-read-only 1)
772
  (current-buffer))
Roland McGrath's avatar
Roland McGrath committed
773

774
(defun find-file-read-only-other-frame (filename &optional wildcards)
Jim Blandy's avatar
Jim Blandy committed
775 776
  "Edit file FILENAME in another frame but don't allow changes.
Like \\[find-file-other-frame] but marks buffer as read-only.
Jim Blandy's avatar
Jim Blandy committed
777
Use \\[toggle-read-only] to permit editing."
778 779
  (interactive "fFind file read-only other frame: \np")
  (find-file-other-frame filename wildcards)
780
  (toggle-read-only 1)
781
  (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
782

783
(defun find-alternate-file-other-window (filename)
784
  "Find file FILENAME as a replacement for the file in the next window.
785
This command does not select that window."
786 787 788 789 790 791 792 793 794 795
  (interactive
   (save-selected-window
     (other-window 1)
     (let ((file buffer-file-name)
	   (file-name nil)
	   (file-dir nil))
       (and file
	    (setq file-name (file-name-nondirectory file)
		  file-dir (file-name-directory file)))
       (list (read-file-name
796
	      "Find alternate file: " file-dir nil nil file-name)))))
797
  (if (one-window-p)
798
      (find-file-other-window filename)
799 800
    (save-selected-window
      (other-window 1)
801
      (find-alternate-file filename))))
802

803
(defun find-alternate-file (filename)
Roland McGrath's avatar
Roland McGrath committed
804 805
  "Find file FILENAME, select its buffer, kill previous buffer.
If the current buffer now contains an empty file that you just visited
806
\(presumably by mistake), use this command to visit the file you really want."
Roland McGrath's avatar
Roland McGrath committed
807 808 809 810 811 812 813
  (interactive
   (let ((file buffer-file-name)
	 (file-name nil)
	 (file-dir nil))
     (and file
	  (setq file-name (file-name-nondirectory file)
		file-dir (file-name-directory file)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
814
     (list (read-file-name
815
	    "Find alternate file: " file-dir nil nil file-name))))
816
  (and (buffer-modified-p) (buffer-file-name)
Roland McGrath's avatar
Roland McGrath committed
817 818 819 820 821 822
       ;; (not buffer-read-only)
       (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
				 (buffer-name))))
       (error "Aborted"))
  (let ((obuf (current-buffer))
	(ofile buffer-file-name)
823 824
	(onum buffer-file-number)
	(otrue buffer-file-truename)
Roland McGrath's avatar
Roland McGrath committed
825
	(oname (buffer-name)))
826 827
    (if (get-buffer " **lose**")
	(kill-buffer " **lose**"))
Roland McGrath's avatar
Roland McGrath committed
828 829 830 831
    (rename-buffer " **lose**")
    (unwind-protect
	(progn
	  (unlock-buffer)
832 833 834
	  (setq buffer-file-name nil)
	  (setq buffer-file-number nil)
	  (setq buffer-file-truename nil)
835
	  (find-file filename))
Roland McGrath's avatar
Roland McGrath committed
836 837
      (cond ((eq obuf (current-buffer))
	     (setq buffer-file-name ofile)
838 839
	     (setq buffer-file-number onum)
	     (setq buffer-file-truename otrue)
Roland McGrath's avatar
Roland McGrath committed
840 841 842 843
	     (lock-buffer)
	     (rename-buffer oname))))
    (or (eq (current-buffer) obuf)
	(kill-buffer obuf))))
844

Roland McGrath's avatar
Roland McGrath committed
845 846 847 848 849 850 851 852 853
(defun create-file-buffer (filename)
  "Create a suitably named buffer for visiting FILENAME, and return it.
FILENAME (sans directory) is used unchanged if that name is free;
otherwise a string <2> or <3> or ... is appended to get an unused name."
  (let ((lastname (file-name-nondirectory filename)))
    (if (string= lastname "")
	(setq lastname filename))
    (generate-new-buffer lastname)))

Jim Blandy's avatar
Jim Blandy committed
854 855
(defun generate-new-buffer (name)
  "Create and return a buffer with a name based on NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
856
Choose the buffer's name using `generate-new-buffer-name'."
Jim Blandy's avatar
Jim Blandy committed
857 858
  (get-buffer-create (generate-new-buffer-name name)))

Dave Love's avatar
Dave Love committed
859 860 861 862
(defcustom automount-dir-prefix "^/tmp_mnt/"
  "Regexp to match the automounter prefix in a directory name."
  :group 'files
  :type 'regexp)
Jim Blandy's avatar
Jim Blandy committed
863

864
(defvar abbreviated-home-dir nil
Dave Love's avatar
Dave Love committed
865
  "The user's homedir abbreviated according to `directory-abbrev-alist'.")
866

Jim Blandy's avatar
Jim Blandy committed
867
(defun abbreviate-file-name (filename)
Richard M. Stallman's avatar
Richard M. Stallman committed
868
  "Return a version of FILENAME shortened using `directory-abbrev-alist'.
Jim Blandy's avatar
Jim Blandy committed
869
This also substitutes \"~\" for the user's home directory.
Richard M. Stallman's avatar
Richard M. Stallman committed
870
Type \\[describe-variable] directory-abbrev-alist RET for more information."
Jim Blandy's avatar
Jim Blandy committed
871
  ;; Get rid of the prefixes added by the automounter.
872 873
  (if (and automount-dir-prefix
	   (string-match automount-dir-prefix filename)
Jim Blandy's avatar
Jim Blandy committed
874 875 876
	   (file-exists-p (file-name-directory
			   (substring filename (1- (match-end 0))))))
      (setq filename (substring filename (1- (match-end 0)))))
Jim Blandy's avatar
Jim Blandy committed
877
  (let ((tail directory-abbrev-alist))
878 879
    ;; If any elt of directory-abbrev-alist matches this name,
    ;; abbreviate accordingly.
Jim Blandy's avatar
Jim Blandy committed
880 881 882 883 884
    (while tail
      (if (string-match (car (car tail)) filename)
	  (setq filename
		(concat (cdr (car tail)) (substring filename (match-end 0)))))
      (setq tail (cdr tail)))
885 886 887
    ;; Compute and save the abbreviated homedir name.
    ;; We defer computing this until the first time it's needed, to
    ;; give time for directory-abbrev-alist to be set properly.
888 889
    ;; We include a slash at the end, to avoid spurious matches
    ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
890 891 892
    (or abbreviated-home-dir
	(setq abbreviated-home-dir
	      (let ((abbreviated-home-dir "$foo"))
893 894
		(concat "^" (abbreviate-file-name (expand-file-name "~"))
			"\\(/\\|$\\)"))))
895

896 897
    ;; If FILENAME starts with the abbreviated homedir,
    ;; make it start with `~' instead.
898 899 900
    (if (and (string-match abbreviated-home-dir filename)
	     ;; If the home dir is just /, don't change it.
	     (not (and (= (match-end 0) 1)
901
		       (= (aref filename 0) ?/)))
902 903
	     ;; MS-DOS root directories can come with a drive letter;
	     ;; Novell Netware allows drive letters beyond `Z:'.
904
	     (not (and (or (eq system-type 'ms-dos)
905
			   (eq system-type 'windows-nt))
906
		       (save-match-data
907
			 (string-match "^[a-zA-`]:/$" filename)))))
Jim Blandy's avatar
Jim Blandy committed
908
	(setq filename
909
	      (concat "~"
910
		      (substring filename (match-beginning 1) (match-end 1))
911
		      (substring filename (match-end 0)))))
Jim Blandy's avatar
Jim Blandy committed
912 913
    filename))

914
(defcustom find-file-not-true-dirname-list nil
915 916 917 918
  "*List of logical names for which visiting shouldn't save the true dirname.
On VMS, when you visit a file using a logical name that searches a path,
you may or may not want the visited file name to record the specific
directory where the file was found.  If you *do not* want that, add the logical
919 920 921
name to this list as a string."
  :type '(repeat (string :tag "Name"))
  :group 'find-file)
922

923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
(defun find-buffer-visiting (filename)
  "Return the buffer visiting file FILENAME (a string).
This is like `get-file-buffer', except that it checks for any buffer
visiting the same file, possibly under a different name.
If there is no such live buffer, return nil."
  (let ((buf (get-file-buffer filename))
	(truename (abbreviate-file-name (file-truename filename))))
    (or buf
	(let ((list (buffer-list)) found)
	  (while (and (not found) list)
	    (save-excursion
	      (set-buffer (car list))
	      (if (and buffer-file-name
		       (string= buffer-file-truename truename))
		  (setq found (car list))))
	    (setq list (cdr list)))
	  found)
940
	(let ((number (nthcdr 10 (file-attributes truename)))
941
	      (list (buffer-list)) found)
942 943
	  (and buffer-file-numbers-unique
	       number
944 945 946
	       (while (and (not found) list)
		 (save-excursion
		   (set-buffer (car list))
947 948
		   (if (and buffer-file-name
			    (equal buffer-file-number number)
949 950 951 952 953 954 955
			    ;; Verify this buffer's file number
			    ;; still belongs to its file.
			    (file-exists-p buffer-file-name)
			    (equal (nthcdr 10 (file-attributes buffer-file-name))
				   number))
		       (setq found (car list))))
		 (setq list (cdr list))))
956
	  found))))
957

958 959 960 961 962
(defcustom find-file-wildcards t
  "*Non-nil means file-visiting commands should handle wildcards.
For example, if you specify `*.c', that would visit all the files
whose names match the pattern."
  :group 'files
Dave Love's avatar
Dave Love committed
963
  :version "20.4"