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

3 4
;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
;;   1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
5
;;   2006, 2007, 2008 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
6

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

Roland McGrath's avatar
Roland McGrath committed
9 10 11 12
;; 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
13
;; the Free Software Foundation; either version 3, or (at your option)
Roland McGrath's avatar
Roland McGrath committed
14 15 16 17 18 19 20 21
;; 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
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Roland McGrath's avatar
Roland McGrath committed
25

26 27 28 29 30 31
;;; 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
32 33
;;; Code:

34 35 36
(defvar font-lock-keywords)


37 38
(defgroup backup nil
  "Backups of edited data files."
39
  :group 'files)
Roland McGrath's avatar
Roland McGrath committed
40

41
(defgroup find-file nil
42 43
  "Finding files."
  :group 'files)
44 45 46


(defcustom delete-auto-save-files t
47
  "Non-nil means delete auto-save file when a buffer is saved or killed.
48

Dave Love's avatar
Dave Love committed
49
Note that the auto-save file will not be deleted if the buffer is killed
50
when it has unsaved changes."
51 52 53 54
  :type 'boolean
  :group 'auto-save)

(defcustom directory-abbrev-alist
Roland McGrath's avatar
Roland McGrath committed
55
  nil
56
  "Alist of abbreviations for file directories.
Roland McGrath's avatar
Roland McGrath committed
57 58 59 60 61
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 `^'.

62 63 64
FROM and TO should be equivalent names, which refer to the
same directory.  Do not use `~' in the TO strings;
they should be ordinary absolute directory names.
65

Roland McGrath's avatar
Roland McGrath committed
66 67
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
68 69 70 71 72 73 74
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
75

76
;; Turn off backup files on VMS since it has version numbers.
77
(defcustom make-backup-files (not (eq system-type 'vax-vms))
78
  "Non-nil means make a backup of a file the first time it is saved.
Roland McGrath's avatar
Roland McGrath committed
79 80 81 82 83 84 85 86 87 88 89 90 91
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
André Spiegel's avatar
André Spiegel committed
92 93 94
`backup-by-copying', `backup-by-copying-when-linked',
`backup-by-copying-when-mismatch' and
`backup-by-copying-when-privileged-mismatch'.  See also `backup-inhibited'."
95 96
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
97 98 99 100

;; Do this so that local variables based on the file name
;; are not overridden by the major mode.
(defvar backup-inhibited nil
101 102 103
  "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
104 105
(put 'backup-inhibited 'permanent-local t)

106
(defcustom backup-by-copying nil
107
 "Non-nil means always use copying to create backup files.
108 109 110
See documentation of variable `make-backup-files'."
 :type 'boolean
 :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
111

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

119
(defcustom backup-by-copying-when-mismatch nil
120
  "Non-nil means create backups by copying if this preserves owner or group.
Roland McGrath's avatar
Roland McGrath committed
121 122 123 124
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.
125 126 127
This variable is relevant only if `backup-by-copying' is nil."
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
128

André Spiegel's avatar
André Spiegel committed
129
(defcustom backup-by-copying-when-privileged-mismatch 200
130
  "Non-nil means create backups by copying to preserve a privileged owner.
André Spiegel's avatar
André Spiegel committed
131 132 133 134 135 136 137 138 139 140 141
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)

(defvar backup-enable-predicate 'normal-backup-enable-predicate
Roland McGrath's avatar
Roland McGrath committed
142
  "Predicate that looks at a file name and decides whether to make backups.
143
Called with an absolute file name as argument, it returns t to enable backup.")
Roland McGrath's avatar
Roland McGrath committed
144

145
(defcustom buffer-offer-save nil
146
  "Non-nil in a buffer means always offer to save buffer on exit.
André Spiegel's avatar
André Spiegel committed
147
Do so even if the buffer is not visiting a file.
148 149 150
Automatically local in all buffers."
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
151 152
(make-variable-buffer-local 'buffer-offer-save)

153
(defcustom find-file-existing-other-name t
154
  "Non-nil means find a file under alternative names, in existing buffers.
155
This means if any existing buffer is visiting the file you want
156 157 158
under another name, you get the existing buffer instead of a new buffer."
  :type 'boolean
  :group 'find-file)
159

160
(defcustom find-file-visit-truename nil
161 162
  "*Non-nil means visit a file under its truename.
The truename of a file is found by chasing all links
163 164 165
both at the file level and at the levels of the containing directories."
  :type 'boolean
  :group 'find-file)
166
(put 'find-file-visit-truename 'safe-local-variable 'booleanp)
167

168
(defcustom revert-without-query nil
169
  "Specify which files should be reverted without query.
170 171
The value is a list of regular expressions.
If the file name matches one of these regular expressions,
172
then `revert-buffer' reverts the file without querying
173
if the file has changed on disk and you have not edited the buffer."
174
  :type '(repeat regexp)
175
  :group 'find-file)
176

177 178 179 180 181 182 183 184
(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)

185
(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
186
  "Non-nil means that `buffer-file-number' uniquely identifies files.")
187

188 189 190 191
(defvar buffer-file-read-only nil
  "Non-nil if visited file was read-only when visited.")
(make-variable-buffer-local 'buffer-file-read-only)

192
(defcustom temporary-file-directory
193 194 195 196 197 198 199
  (file-name-as-directory
   (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"))))
200 201 202
  "The directory for writing temporary files."
  :group 'files
  :type 'directory)
203

204
(defcustom small-temporary-file-directory
205 206 207 208
  (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
  "The directory for writing small temporary files.
If non-nil, this directory is used instead of `temporary-file-directory'
by programs that create small temporary files.  This is for systems that
209 210
have fast storage with limited space, such as a RAM disk."
  :group 'files
211
  :type '(choice (const nil) directory))
212 213 214 215

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

216 217
(defvar file-name-invalid-regexp
  (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
218
	 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
219
		 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|"  ; invalid characters
220
		 "[\000-\031]\\|"		  ; control characters
221 222
		 "\\(/\\.\\.?[^/]\\)\\|"	  ; leading dots
		 "\\(/[^/.]+\\.[^/.]*\\.\\)"))	  ; more than a single dot
Juanma Barranquero's avatar
Juanma Barranquero committed
223
	((memq system-type '(ms-dos windows-nt cygwin))
224
	 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
225
		 "[|<>\"?*\000-\031]"))		  ; invalid characters
226 227 228
	(t "[\000]"))
  "Regexp recognizing file names which aren't allowed by the filesystem.")

229
(defcustom file-precious-flag nil
230
  "Non-nil means protect against I/O errors while saving files.
Karl Heuer's avatar
Karl Heuer committed
231
Some modes set this non-nil in particular buffers.
232 233 234 235 236 237 238

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
239
Yet, at the same time, saving a precious file
240 241 242
breaks any hard links between it and other files."
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
243

244
(defcustom version-control nil
245
  "Control use of version numbers for backup files.
246 247 248
When t, make numeric backup versions unconditionally.
When nil, make them for files that have some already.
The value `never' means do not make them."
249 250 251
  :type '(choice (const :tag "Never" never)
		 (const :tag "If existing" nil)
		 (other :tag "Always" t))
252 253
  :group 'backup
  :group 'vc)
254 255
(put 'version-control 'safe-local-variable
     '(lambda (x) (or (booleanp x) (equal x 'never))))
256 257

(defcustom dired-kept-versions 2
258
  "When cleaning directory, number of versions to keep."
259 260 261 262 263
  :type 'integer
  :group 'backup
  :group 'dired)

(defcustom delete-old-versions nil
264
  "If t, delete excess backup versions silently.
265 266 267
If nil, ask confirmation.  Any other value prevents any trimming."
  :type '(choice (const :tag "Delete" t)
		 (const :tag "Ask" nil)
268
		 (other :tag "Leave" other))
269 270 271
  :group 'backup)

(defcustom kept-old-versions 2
272
  "Number of oldest versions to keep when a new numbered backup is made."
273 274
  :type 'integer
  :group 'backup)
275
(put 'kept-old-versions 'safe-local-variable 'integerp)
276 277

(defcustom kept-new-versions 2
278
  "Number of newest versions to keep when a new numbered backup is made.
279 280 281
Includes the new backup.  Must be > 0"
  :type 'integer
  :group 'backup)
282
(put 'kept-new-versions 'safe-local-variable 'integerp)
Roland McGrath's avatar
Roland McGrath committed
283

284
(defcustom require-final-newline nil
285
  "Whether to add a newline automatically at the end of the file.
286 287 288 289 290

A value of t means do this only when the file is about to be saved.
A value of `visit' means do this right after the file is visited.
A value of `visit-save' means do it at both of those times.
Any other non-nil value means ask user whether to add a newline, when saving.
291
A value of nil means don't add newlines.
292 293 294 295 296 297

Certain major modes set this locally to the value obtained
from `mode-require-final-newline'."
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
298
		 (const :tag "Don't add newlines" nil)
299
		 (other :tag "Ask each time" ask))
300
  :group 'editing-basics)
Roland McGrath's avatar
Roland McGrath committed
301

302
(defcustom mode-require-final-newline t
303
  "Whether to add a newline at end of file, in certain major modes.
304
Those modes set `require-final-newline' to this value when you enable them.
305
They do so because they are often used for files that are supposed
306 307 308 309 310
to end in newlines, and the question is how to arrange that.

A value of t means do this only when the file is about to be saved.
A value of `visit' means do this right after the file is visited.
A value of `visit-save' means do it at both of those times.
311 312
Any other non-nil value means ask user whether to add a newline, when saving.

313 314 315 316
A value of nil means do not add newlines.  That is a risky choice in this
variable since this value is used for modes for files that ought to have
final newlines.  So if you set this to nil, you must explicitly check and
add a final newline, whenever you save a file that really needs one."
317 318 319
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
320 321
		 (const :tag "Don't add newlines" nil)
		 (other :tag "Ask each time" ask))
322
  :group 'editing-basics
323
  :version "22.1")
324

325
(defcustom auto-save-default t
326
  "Non-nil says by default do auto-saving of every file-visiting buffer."
327 328
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
329

330
(defcustom auto-save-visited-file-name nil
331
  "Non-nil says auto-save a buffer in the file it is visiting, when practical.
332 333 334
Normally auto-save files are written under other names."
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
335

André Spiegel's avatar
André Spiegel committed
336
(defcustom auto-save-file-name-transforms
337
  `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
338 339
     ;; Don't put "\\2" inside expand-file-name, since it will be
     ;; transformed to "/2" on DOS/Windows.
340
     ,(concat temporary-file-directory "\\2") t))
341
  "Transforms to apply to buffer file name before making auto-save file name.
342
Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
André Spiegel's avatar
André Spiegel committed
343 344 345
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.
346
If the optional element UNIQUIFY is non-nil, the auto-save file name is
347
constructed by taking the directory part of the replaced file-name,
348 349 350 351
concatenated with the buffer file name with all directory separators
changed to `!' to prevent clashes.  This will not work
correctly if your filesystem truncates the resulting name.

André Spiegel's avatar
André Spiegel committed
352 353 354 355
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.

356 357
The default value is set up to put the auto-save file into the
temporary directory (see the variable `temporary-file-directory') for
358 359 360 361
editing a remote file.

On MS-DOS filesystems without long names this variable is always
ignored."
André Spiegel's avatar
André Spiegel committed
362
  :group 'auto-save
363 364
  :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
					   (boolean :tag "Uniquify")))
André Spiegel's avatar
André Spiegel committed
365 366
  :version "21.1")

367
(defcustom save-abbrevs t
368
  "Non-nil means save word abbrevs too when files are saved.
369 370
If `silently', don't ask the user before saving."
  :type '(choice (const t) (const nil) (const silently))
371
  :group 'abbrev)
Roland McGrath's avatar
Roland McGrath committed
372

373
(defcustom find-file-run-dired t
374
  "Non-nil means allow `find-file' to visit directories.
André Spiegel's avatar
André Spiegel committed
375
To visit the directory, `find-file' runs `find-directory-functions'."
376 377
  :type 'boolean
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
378

André Spiegel's avatar
André Spiegel committed
379
(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
380
  "List of functions to try in sequence to visit a directory.
André Spiegel's avatar
André Spiegel committed
381 382 383 384 385
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)

386 387
;;;It is not useful to make this a local variable.
;;;(put 'find-file-not-found-hooks 'permanent-local t)
Stefan Monnier's avatar
Stefan Monnier committed
388
(defvar find-file-not-found-functions nil
Roland McGrath's avatar
Roland McGrath committed
389 390
  "List of functions to be called for `find-file' on nonexistent file.
These functions are called as soon as the error is detected.
André Spiegel's avatar
André Spiegel committed
391
Variable `buffer-file-name' is already set up.
Roland McGrath's avatar
Roland McGrath committed
392
The functions are called in the order given until one of them returns non-nil.")
393 394
(define-obsolete-variable-alias 'find-file-not-found-hooks
    'find-file-not-found-functions "22.1")
Roland McGrath's avatar
Roland McGrath committed
395

396 397
;;;It is not useful to make this a local variable.
;;;(put 'find-file-hooks 'permanent-local t)
Dave Love's avatar
Dave Love committed
398
(defcustom find-file-hook nil
Roland McGrath's avatar
Roland McGrath committed
399 400
  "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
Dave Love's avatar
Dave Love committed
401 402 403 404
functions are called."
  :group 'find-file
  :type 'hook
  :options '(auto-insert)
405
  :version "22.1")
406
(define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
Roland McGrath's avatar
Roland McGrath committed
407

Stefan Monnier's avatar
Stefan Monnier committed
408
(defvar write-file-functions nil
Roland McGrath's avatar
Roland McGrath committed
409 410
  "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
411 412
and the rest are not called.
These hooks are considered to pertain to the visited file.
Stefan Monnier's avatar
Stefan Monnier committed
413 414 415 416
So any buffer-local binding of this variable is discarded if you change
the visited file name with \\[set-visited-file-name], but not when you
change the major mode.

417 418 419 420 421
This hook is not run if any of the functions in
`write-contents-functions' returns non-nil.  Both hooks pertain
to how to save a buffer to file, for instance, choosing a suitable
coding system and setting mode bits.  (See Info
node `(elisp)Saving Buffers'.)  To perform various checks or
422
updates before the buffer is saved, use `before-save-hook'.")
Stefan Monnier's avatar
Stefan Monnier committed
423
(put 'write-file-functions 'permanent-local t)
424
(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
425 426

(defvar local-write-file-hooks nil)
427 428
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
429
(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
Jim Blandy's avatar
Jim Blandy committed
430

Stefan Monnier's avatar
Stefan Monnier committed
431
(defvar write-contents-functions nil
Jim Blandy's avatar
Jim Blandy committed
432 433
  "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
434 435
and the rest are not called and neither are the functions in
`write-file-functions'.
436 437 438 439

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
440 441
major mode does clear it.

442 443 444 445 446
For hooks that _do_ pertain to the particular visited file, use
`write-file-functions'.  Both this variable and
`write-file-functions' relate to how a buffer is saved to file.
To perform various checks or updates before the buffer is saved,
use `before-save-hook'.")
Stefan Monnier's avatar
Stefan Monnier committed
447
(make-variable-buffer-local 'write-contents-functions)
448 449
(define-obsolete-variable-alias 'write-contents-hooks
    'write-contents-functions "22.1")
Roland McGrath's avatar
Roland McGrath committed
450

451
(defcustom enable-local-variables t
452
  "Control use of local variables in files you visit.
453
The value can be t, nil, :safe, :all or something else.
454 455

A value of t means file local variables specifications are obeyed
456 457
if all the specified variable values are safe; if any values are
not safe, Emacs queries you, once, whether to set them all.
458 459 460
\(When you say yes to certain values, they are remembered as safe.)

:safe means set the safe variables, and ignore the rest.
461 462
:all means set all variables, whether safe or not.
 (Don't set it permanently to :all.)
463
A value of nil means always ignore the file local variables.
464 465

Any other value means always query you once whether to set them all.
466 467
\(When you say yes to certain values, they are remembered as safe, but
this has no effect when `enable-local-variables' is \"something else\".)
468

469 470
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
471

472 473 474
The command \\[normal-mode], when used interactively,
always obeys file local variable specifications and the -*- line,
and ignores this variable."
475
  :type '(choice (const :tag "Query Unsafe" t)
476
		 (const :tag "Safe Only" :safe)
477
		 (const :tag "Do all" :all)
478
		 (const :tag "Ignore" nil)
479
		 (other :tag "Query" other))
480
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
481

482 483
(defvar local-enable-local-variables t
  "Like `enable-local-variables' but meant for buffer-local bindings.
484
The meaningful values are nil and non-nil.  The default is non-nil.
485
If a major mode sets this to nil, buffer-locally, then any local
486 487 488 489
variables list in the file will be ignored.

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

491
(defcustom enable-local-eval 'maybe
492
  "Control processing of the \"variable\" `eval' in a file's local variables.
493 494
The value can be t, nil or something else.
A value of t means obey `eval' variables;
495
A value of nil means ignore them; anything else means query."
496 497
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
498
		 (other :tag "Query" other))
499
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
500 501 502

;; Avoid losing in versions where CLASH_DETECTION is disabled.
(or (fboundp 'lock-buffer)
503
    (defalias 'lock-buffer 'ignore))
Roland McGrath's avatar
Roland McGrath committed
504
(or (fboundp 'unlock-buffer)
505
    (defalias 'unlock-buffer 'ignore))
506 507
(or (fboundp 'file-locked-p)
    (defalias 'file-locked-p 'ignore))
508

509
(defcustom view-read-only nil
510
  "Non-nil means buffers visiting files read-only do so in view mode.
511 512 513 514
In fact, this means that all read-only buffers normally have
View mode enabled, including buffers that are read-only because
you visit a file you cannot alter, and buffers you make read-only
using \\[toggle-read-only]."
515 516
  :type 'boolean
  :group 'view)
517

518
(defvar file-name-history nil
519 520 521 522
  "History list of file names entered in the minibuffer.

Maximum length of the history list is determined by the value
of `history-length', which see.")
523

524
(put 'ange-ftp-completion-hook-function 'safe-magic t)
525
(defun ange-ftp-completion-hook-function (op &rest args)
André Spiegel's avatar
André Spiegel committed
526 527 528 529
  "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.
530 531
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
532 533 534 535 536
    (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))
537
      (apply op args))))
538 539

(defun convert-standard-filename (filename)
540
  "Convert a standard file's name to something suitable for the OS.
541 542 543
This means to guarantee valid names and perhaps to canonicalize
certain patterns.

544 545 546 547
FILENAME should be an absolute file name since the conversion rules
sometimes vary depending on the position in the file name.  E.g. c:/foo
is a valid DOS file name, but c:/bar/c:/foo is not.

548 549
This function's standard definition is trivial; it just returns
the argument.  However, on Windows and DOS, replace invalid
550 551 552
characters.  On DOS, make sure to obey the 8.3 limitations.
In the native Windows build, turn Cygwin names into native names,
and also turn slashes into backslashes if the shell requires it (see
553 554 555
`w32-shell-dos-semantics').

See Info node `(elisp)Standard File Names' for more details."
556 557 558 559 560
  (if (eq system-type 'cygwin)
      (let ((name (copy-sequence filename))
	    (start 0))
	;; Replace invalid filename characters with !
	(while (string-match "[?*:<>|\"\000-\037]" name start)
561
	       (aset name (match-beginning 0) ?!)
562 563 564
	  (setq start (match-end 0)))
	name)
    filename))
565 566 567 568

(defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
  "Read directory name, prompting with PROMPT and completing in directory DIR.
Value is not expanded---you must call `expand-file-name' yourself.
569 570
Default name to DEFAULT-DIRNAME if user exits with the same
non-empty string that was inserted by this function.
571 572
 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
  or just DIR if INITIAL is nil.)
573 574 575
If the user exits with an empty minibuffer, this function returns
an empty string.  (This can only happen if the user erased the
pre-inserted contents or if `insert-default-directory' is nil.)
576 577 578
Fourth arg MUSTMATCH non-nil means require existing directory's name.
 Non-nil and non-t means also require confirmation after completion.
Fifth arg INITIAL specifies text to start with.
579 580
DIR should be an absolute directory name.  It defaults to
the value of `default-directory'."
581 582
  (unless dir
    (setq dir default-directory))
583
  (read-file-name prompt dir (or default-dirname
584 585 586
				 (if initial (expand-file-name initial dir)
				   dir))
		  mustmatch initial
587 588
		  'file-directory-p))

Roland McGrath's avatar
Roland McGrath committed
589 590 591 592 593 594

(defun pwd ()
  "Show the current default directory."
  (interactive nil)
  (message "Directory %s" default-directory))

595 596
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
597
Not actually set up until the first time you use it.")
598 599

(defun parse-colon-path (cd-path)
600
  "Explode a search path into a list of directory names.
601 602
Directories are separated by occurrences of `path-separator'
\(which is colon in GNU and GNU-like systems)."
André Spiegel's avatar
André Spiegel committed
603
  ;; We could use split-string here.
604
  (and cd-path
605
       (let (cd-list (cd-start 0) cd-colon)
606 607
	 (setq cd-path (concat cd-path path-separator))
	 (while (setq cd-colon (string-match path-separator cd-path cd-start))
608
	   (setq cd-list
609
		 (nconc cd-list
610 611 612
			(list (if (= cd-start cd-colon)
				   nil
				(substitute-in-file-name
613 614
				 (file-name-as-directory
				  (substring cd-path cd-start cd-colon)))))))
615 616 617 618
	   (setq cd-start (+ cd-colon 1)))
	 cd-list)))

(defun cd-absolute (dir)
619
  "Change current directory to given absolute file name DIR."
620 621
  ;; Put the name into directory syntax now,
  ;; because otherwise expand-file-name may give some bad results.
Roland McGrath's avatar
Roland McGrath committed
622 623
  (if (not (eq system-type 'vax-vms))
      (setq dir (file-name-as-directory dir)))
624
  (setq dir (abbreviate-file-name (expand-file-name dir)))
Roland McGrath's avatar
Roland McGrath committed
625
  (if (not (file-directory-p dir))
626 627
      (if (file-exists-p dir)
	  (error "%s is not a directory" dir)
628
	(error "%s: no such directory" dir))
Roland McGrath's avatar
Roland McGrath committed
629 630
    (if (file-executable-p dir)
	(setq default-directory dir)
631
      (error "Cannot cd to %s:  Permission denied" dir))))
Roland McGrath's avatar
Roland McGrath committed
632

633 634
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
635 636
If your environment includes a `CDPATH' variable, try each one of
that list of directories (separated by occurrences of
637 638
`path-separator') when resolving a relative directory name.
The path separator is colon in GNU and GNU-like systems."
639
  (interactive
640
   (list (read-directory-name "Change default directory: "
641 642 643
			 default-directory default-directory
			 (and (member cd-path '(nil ("./")))
			      (null (getenv "CDPATH"))))))
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
  (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"))))
660

Roland McGrath's avatar
Roland McGrath committed
661 662
(defun load-file (file)
  "Load the Lisp file named FILE."
663 664
  ;; This is a case where .elc makes a lot of sense.
  (interactive (list (let ((completion-ignored-extensions
Dave Love's avatar
Dave Love committed
665
			    (remove ".elc" completion-ignored-extensions)))
666 667
		       (read-file-name "Load file: "))))
  (load (expand-file-name file) nil nil t))
Roland McGrath's avatar
Roland McGrath committed
668

Stefan Monnier's avatar
Stefan Monnier committed
669 670
(defun locate-file (filename path &optional suffixes predicate)
  "Search for FILENAME through PATH.
Eli Zaretskii's avatar
Eli Zaretskii committed
671 672 673 674
If found, return the absolute file name of FILENAME, with its suffixes;
otherwise return nil.
PATH should be a list of directories to look in, like the lists in
`exec-path' or `load-path'.
Stefan Monnier's avatar
Stefan Monnier committed
675 676
If SUFFIXES is non-nil, it should be a list of suffixes to append to
file name when searching.  If SUFFIXES is nil, it is equivalent to '(\"\").
Eli Zaretskii's avatar
Eli Zaretskii committed
677
Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
Stefan Monnier's avatar
Stefan Monnier committed
678
If non-nil, PREDICATE is used instead of `file-readable-p'.
Richard M. Stallman's avatar
Richard M. Stallman committed
679 680 681 682 683 684
PREDICATE can also be an integer to pass to the `access' system call,
in which case file-name handlers are ignored.  This usage is deprecated.

For compatibility, PREDICATE can also be one of the symbols
`executable', `readable', `writable', or `exists', or a list of
one or more of those symbols."
Stefan Monnier's avatar
Stefan Monnier committed
685 686 687 688 689 690 691 692 693 694 695
  (if (and predicate (symbolp predicate) (not (functionp predicate)))
      (setq predicate (list predicate)))
  (when (and (consp predicate) (not (functionp predicate)))
    (setq predicate
	  (logior (if (memq 'executable predicate) 1 0)
		  (if (memq 'writable predicate) 2 0)
		  (if (memq 'readable predicate) 4 0))))
  (locate-file-internal filename path suffixes predicate))

(defun locate-file-completion (string path-and-suffixes action)
  "Do completion for file names passed to `locate-file'.
696
PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
697
  (if (file-name-absolute-p string)
Stefan Monnier's avatar
Stefan Monnier committed
698
      (read-file-name-internal string nil action)
699
    (let ((names nil)
Stefan Monnier's avatar
Stefan Monnier committed
700
	  (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
701
	  (string-dir (file-name-directory string)))
Stefan Monnier's avatar
Stefan Monnier committed
702
      (dolist (dir (car path-and-suffixes))
703 704
	(unless dir
	  (setq dir default-directory))
705 706 707 708
	(if string-dir (setq dir (expand-file-name string-dir dir)))
	(when (file-directory-p dir)
	  (dolist (file (file-name-all-completions
			 (file-name-nondirectory string) dir))
709
	    (add-to-list 'names (if string-dir (concat string-dir file) file))
710 711 712
	    (when (string-match suffix file)
	      (setq file (substring file 0 (match-beginning 0)))
	      (push (if string-dir (concat string-dir file) file) names)))))
Stefan Monnier's avatar
Stefan Monnier committed
713 714 715 716
      (cond
       ((eq action t) (all-completions string names))
       ((null action) (try-completion string names))
       (t (test-completion string names))))))
717

718 719 720 721 722 723 724
(defun executable-find (command)
  "Search for COMMAND in `exec-path' and return the absolute file name.
Return nil if COMMAND is not found anywhere in `exec-path'."
  ;; Use 1 rather than file-executable-p to better match the behavior of
  ;; call-process.
  (locate-file command exec-path exec-suffixes 1))

Roland McGrath's avatar
Roland McGrath committed
725 726 727
(defun load-library (library)
  "Load the library named LIBRARY.
This is an interface to the function `load'."
Stefan Monnier's avatar
Stefan Monnier committed
728 729 730
  (interactive
   (list (completing-read "Load library: "
			  'locate-file-completion
731
			  (cons load-path (get-load-suffixes)))))
Roland McGrath's avatar
Roland McGrath committed
732
  (load library))
733

734
(defun file-remote-p (file)
735 736 737 738 739 740 741
  "Test whether FILE specifies a location on a remote system.
Return an identification of the system if the location is indeed
remote.  The identification of the system may comprise a method
to access the system and its hostname, amongst other things.

For example, the filename \"/user@host:/foo\" specifies a location
on the system \"/user@host:\"."
742
  (let ((handler (find-file-name-handler file 'file-remote-p)))
743
    (if handler
744 745
	(funcall handler 'file-remote-p file)
      nil)))
746

André Spiegel's avatar
André Spiegel committed
747
(defun file-local-copy (file)
748 749 750
  "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."
André Spiegel's avatar
André Spiegel committed
751 752
  ;; This formerly had an optional BUFFER argument that wasn't used by
  ;; anything.
753
  (let ((handler (find-file-name-handler file 'file-local-copy)))
754 755 756
    (if handler
	(funcall handler 'file-local-copy file)
      nil)))
757

758
(defun file-truename (filename &optional counter prev-dirs)
759 760 761
  "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
762 763
containing it, until no links are left at any level.

Richard M. Stallman's avatar
Richard M. Stallman committed
764
\(fn FILENAME)"  ;; Don't document the optional arguments.
765 766 767
  ;; COUNTER and PREV-DIRS are only used in recursive calls.
  ;; COUNTER can be a cons cell whose car is the count of how many
  ;; more links to chase before getting an error.
768 769
  ;; PREV-DIRS can be a cons cell whose car is an alist
  ;; of truenames we've just recently computed.
770 771 772 773 774 775 776 777 778 779 780
  (cond ((or (string= filename "") (string= filename "~"))
	 (setq filename (expand-file-name filename))
	 (if (string= filename "")
	     (setq filename "/")))
	((and (string= (substring filename 0 1) "~")
	      (string-match "~[^/]*/?" filename))
	 (let ((first-part
		(substring filename 0 (match-end 0)))
	       (rest (substring filename (match-end 0))))
	   (setq filename (concat (expand-file-name first-part) rest)))))

781
  (or counter (setq counter (list 100)))
782 783 784 785 786 787 788 789 790
  (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)))
791 792 793 794 795 796 797 798 799 800 801 802 803

    ;; 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)
804
      (let ((handler (find-file-name-handler filename 'file-truename)))
805 806 807 808 809
	;; 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.
810
	  (unless (string-match "[[*?]" filename)
811 812
	    ;; If filename exists, use the long name
	    (setq filename (or (w32-long-file-name filename) filename))))
813 814
	(setq done t)))

815 816 817 818 819 820 821 822 823 824 825 826
    ;; 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)
827
	  (let ((dir (or (file-name-directory filename) default-directory))
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
		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))
866

867
(defun file-chase-links (filename &optional limit)
868
  "Chase links in FILENAME until a name that is not a link.
869 870 871 872 873
Unlike `file-truename', this does not check whether a parent
directory name is a symbolic link.
If the optional argument LIMIT is a number,
it means chase no more than that many links and then stop."
  (let (tem (newname filename)