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

3
;; Copyright (C) 1985-1987, 1992-2012 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
4

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

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

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

;; 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
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Roland McGrath's avatar
Roland McGrath committed
22

23 24
;;; Commentary:

Glenn Morris's avatar
Glenn Morris committed
25
;; Defines most of Emacs's file- and directory-handling functions,
26 27 28
;; 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
29 30
;;; Code:

31 32
(defvar font-lock-keywords)

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
  "Non-nil means delete auto-save file when a buffer is saved or killed.
44

Dave Love's avatar
Dave Love committed
45
Note that the auto-save file will not be deleted if the buffer is killed
46
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
  nil
52
  "Alist of abbreviations for file directories.
Roland McGrath's avatar
Roland McGrath committed
53 54 55
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.
Glenn Morris's avatar
Glenn Morris committed
56 57 58 59

FROM is matched against directory names anchored at the first
character, so it should start with a \"\\\\`\", or, if directory
names cannot have embedded newlines, with a \"^\".
Roland McGrath's avatar
Roland McGrath committed
60

61 62 63
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.
64

Roland McGrath's avatar
Roland McGrath committed
65 66
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
67 68
the name it is linked to."
  :type '(repeat (cons :format "%v"
69
		       :value ("\\`" . "")
70
		       (regexp :tag "From")
71
		       (string :tag "To")))
72 73
  :group 'abbrev
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
74

Dan Nicolaescu's avatar
Dan Nicolaescu committed
75
(defcustom make-backup-files t
76
  "Non-nil means make a backup of a file the first time it is saved.
Roland McGrath's avatar
Roland McGrath committed
77 78 79 80 81 82 83 84 85 86 87 88 89
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
90 91 92
`backup-by-copying', `backup-by-copying-when-linked',
`backup-by-copying-when-mismatch' and
`backup-by-copying-when-privileged-mismatch'.  See also `backup-inhibited'."
93 94
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
95 96 97 98

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

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

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

117
(defcustom backup-by-copying-when-mismatch t
118
  "Non-nil means create backups by copying if this preserves owner or group.
Roland McGrath's avatar
Roland McGrath committed
119 120 121 122
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.
123
This variable is relevant only if `backup-by-copying' is nil."
124
  :version "24.1"
125 126
  :type 'boolean
  :group 'backup)
127
(put 'backup-by-copying-when-mismatch 'permanent-local t)
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
(make-variable-buffer-local 'buffer-offer-save)
152
(put 'buffer-offer-save 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
153

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

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

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

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

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

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

193
(defcustom small-temporary-file-directory
194 195 196 197
  (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
198 199
have fast storage with limited space, such as a RAM disk."
  :group 'files
200
  :initialize 'custom-initialize-delay
201
  :type '(choice (const nil) directory))
202 203

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

206 207
(declare-function msdos-long-file-names "msdos.c")
(declare-function w32-long-file-name "w32proc.c")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
208 209 210 211 212
(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
(declare-function dired-unmark "dired" (arg))
(declare-function dired-do-flagged-delete "dired" (&optional nomessage))
(declare-function dos-8+3-filename "dos-fns" (filename))
(declare-function view-mode-disable "view" ())
Eli Zaretskii's avatar
Eli Zaretskii committed
213
(declare-function dosified-file-name "dos-fns" (file-name))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
214

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

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

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
240
Yet, at the same time, saving a precious file
241 242 243
breaks any hard links between it and other files.

This feature is advisory: for example, if the directory in which the
Chong Yidong's avatar
Chong Yidong committed
244
file is being saved is not writable, Emacs may ignore a non-nil value
Karl Fogel's avatar
Karl Fogel committed
245 246 247
of `file-precious-flag' and write directly into the file.

See also: `break-hardlink-on-save'."
248 249
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
250

Karl Fogel's avatar
Karl Fogel committed
251 252
(defcustom break-hardlink-on-save nil
  "Non-nil means when saving a file that exists under several names
253
\(i.e., has multiple hardlinks), break the hardlink associated with
Karl Fogel's avatar
Karl Fogel committed
254 255 256 257 258 259 260
`buffer-file-name' and write to a new file, so that the other
instances of the file are not affected by the save.

If `buffer-file-name' refers to a symlink, do not break the symlink.

Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
For example, if the directory in which a file is being saved is not
Chong Yidong's avatar
Chong Yidong committed
261
itself writable, then error instead of saving in some
Karl Fogel's avatar
Karl Fogel committed
262 263 264 265
hardlink-nonbreaking way.

See also `backup-by-copying' and `backup-by-copying-when-linked'."
  :type 'boolean
266 267
  :group 'files
  :version "23.1")
Karl Fogel's avatar
Karl Fogel committed
268

269
(defcustom version-control nil
270
  "Control use of version numbers for backup files.
271 272 273
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."
274 275 276
  :type '(choice (const :tag "Never" never)
		 (const :tag "If existing" nil)
		 (other :tag "Always" t))
277 278
  :group 'backup
  :group 'vc)
279
(put 'version-control 'safe-local-variable
280
     (lambda (x) (or (booleanp x) (equal x 'never))))
281 282

(defcustom dired-kept-versions 2
283
  "When cleaning directory, number of versions to keep."
284 285 286 287 288
  :type 'integer
  :group 'backup
  :group 'dired)

(defcustom delete-old-versions nil
289
  "If t, delete excess backup versions silently.
290 291 292
If nil, ask confirmation.  Any other value prevents any trimming."
  :type '(choice (const :tag "Delete" t)
		 (const :tag "Ask" nil)
293
		 (other :tag "Leave" other))
294 295 296
  :group 'backup)

(defcustom kept-old-versions 2
297
  "Number of oldest versions to keep when a new numbered backup is made."
298 299
  :type 'integer
  :group 'backup)
300
(put 'kept-old-versions 'safe-local-variable 'integerp)
301 302

(defcustom kept-new-versions 2
303
  "Number of newest versions to keep when a new numbered backup is made.
304 305 306
Includes the new backup.  Must be > 0"
  :type 'integer
  :group 'backup)
307
(put 'kept-new-versions 'safe-local-variable 'integerp)
Roland McGrath's avatar
Roland McGrath committed
308

309
(defcustom require-final-newline nil
310
  "Whether to add a newline automatically at the end of the file.
311 312 313 314 315

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.
316
A value of nil means don't add newlines.
317 318 319 320 321 322

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)
323
		 (const :tag "Don't add newlines" nil)
324
		 (other :tag "Ask each time" ask))
325
  :group 'editing-basics)
Roland McGrath's avatar
Roland McGrath committed
326

327
(defcustom mode-require-final-newline t
328
  "Whether to add a newline at end of file, in certain major modes.
329
Those modes set `require-final-newline' to this value when you enable them.
330
They do so because they are often used for files that are supposed
331 332 333 334 335
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.
336 337
Any other non-nil value means ask user whether to add a newline, when saving.

338 339 340 341
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."
342 343 344
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
345 346
		 (const :tag "Don't add newlines" nil)
		 (other :tag "Ask each time" ask))
347
  :group 'editing-basics
348
  :version "22.1")
349

350
(defcustom auto-save-default t
351
  "Non-nil says by default do auto-saving of every file-visiting buffer."
352 353
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
354

André Spiegel's avatar
André Spiegel committed
355
(defcustom auto-save-file-name-transforms
356
  `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
357 358
     ;; Don't put "\\2" inside expand-file-name, since it will be
     ;; transformed to "/2" on DOS/Windows.
359
     ,(concat temporary-file-directory "\\2") t))
360
  "Transforms to apply to buffer file name before making auto-save file name.
361
Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
André Spiegel's avatar
André Spiegel committed
362 363 364
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.
365
If the optional element UNIQUIFY is non-nil, the auto-save file name is
366
constructed by taking the directory part of the replaced file-name,
367 368 369 370
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
371 372 373 374
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.

375 376
The default value is set up to put the auto-save file into the
temporary directory (see the variable `temporary-file-directory') for
377 378 379 380
editing a remote file.

On MS-DOS filesystems without long names this variable is always
ignored."
André Spiegel's avatar
André Spiegel committed
381
  :group 'auto-save
382 383
  :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
					   (boolean :tag "Uniquify")))
384
  :initialize 'custom-initialize-delay
André Spiegel's avatar
André Spiegel committed
385 386
  :version "21.1")

387
(defcustom save-abbrevs t
388
  "Non-nil means save word abbrevs too when files are saved.
389 390
If `silently', don't ask the user before saving."
  :type '(choice (const t) (const nil) (const silently))
391
  :group 'abbrev)
Roland McGrath's avatar
Roland McGrath committed
392

393
(defcustom find-file-run-dired t
394
  "Non-nil means allow `find-file' to visit directories.
André Spiegel's avatar
André Spiegel committed
395
To visit the directory, `find-file' runs `find-directory-functions'."
396 397
  :type 'boolean
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
398

André Spiegel's avatar
André Spiegel committed
399
(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
400
  "List of functions to try in sequence to visit a directory.
André Spiegel's avatar
André Spiegel committed
401 402 403 404 405
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)

406 407 408 409 410 411 412 413
;; FIXME: also add a hook for `(thing-at-point 'filename)'
(defcustom file-name-at-point-functions '(ffap-guess-file-name-at-point)
  "List of functions to try in sequence to get a file name at point.
Each function should return either nil or a file name found at the
location of point in the current buffer."
  :type '(hook :options (ffap-guess-file-name-at-point))
  :group 'find-file)

414 415
;;;It is not useful to make this a local variable.
;;;(put 'find-file-not-found-hooks 'permanent-local t)
416 417
(define-obsolete-variable-alias 'find-file-not-found-hooks
    'find-file-not-found-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
418
(defvar find-file-not-found-functions nil
Roland McGrath's avatar
Roland McGrath committed
419 420
  "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
421
Variable `buffer-file-name' is already set up.
Roland McGrath's avatar
Roland McGrath committed
422 423
The functions are called in the order given until one of them returns non-nil.")

424 425
;;;It is not useful to make this a local variable.
;;;(put 'find-file-hooks 'permanent-local t)
426
(define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
Dave Love's avatar
Dave Love committed
427
(defcustom find-file-hook nil
Roland McGrath's avatar
Roland McGrath committed
428 429
  "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
430 431 432 433
functions are called."
  :group 'find-file
  :type 'hook
  :options '(auto-insert)
434
  :version "22.1")
Roland McGrath's avatar
Roland McGrath committed
435

436
(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
437
(defvar write-file-functions nil
Roland McGrath's avatar
Roland McGrath committed
438 439
  "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
440 441
and the rest are not called.
These hooks are considered to pertain to the visited file.
Stefan Monnier's avatar
Stefan Monnier committed
442 443 444 445
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.

446 447 448 449 450
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
451
updates before the buffer is saved, use `before-save-hook'.")
Stefan Monnier's avatar
Stefan Monnier committed
452 453 454
(put 'write-file-functions 'permanent-local t)

(defvar local-write-file-hooks nil)
455 456
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
457
(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
Jim Blandy's avatar
Jim Blandy committed
458

459 460
(define-obsolete-variable-alias 'write-contents-hooks
    'write-contents-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
461
(defvar write-contents-functions nil
Jim Blandy's avatar
Jim Blandy committed
462 463
  "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
464 465
and the rest are not called and neither are the functions in
`write-file-functions'.
466 467 468 469

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
470 471
major mode does clear it.

472 473 474 475 476
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
477
(make-variable-buffer-local 'write-contents-functions)
Roland McGrath's avatar
Roland McGrath committed
478

479
(defcustom enable-local-variables t
480
  "Control use of local variables in files you visit.
481
The value can be t, nil, :safe, :all, or something else.
482 483

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

:safe means set the safe variables, and ignore the rest.
489 490
:all means set all variables, whether safe or not.
 (Don't set it permanently to :all.)
491
A value of nil means always ignore the file local variables.
492 493

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

497 498
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
499

500 501 502
The command \\[normal-mode], when used interactively,
always obeys file local variable specifications and the -*- line,
and ignores this variable."
503
  :risky t
504
  :type '(choice (const :tag "Query Unsafe" t)
505
		 (const :tag "Safe Only" :safe)
506
		 (const :tag "Do all" :all)
507
		 (const :tag "Ignore" nil)
508
		 (other :tag "Query" other))
509
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
510

Glenn Morris's avatar
Glenn Morris committed
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
;; This is an odd variable IMO.
;; You might wonder why it is needed, when we could just do:
;; (set (make-local-variable 'enable-local-variables) nil)
;; These two are not precisely the same.
;; Setting this variable does not cause -*- mode settings to be
;; ignored, whereas setting enable-local-variables does.
;; Only three places in Emacs use this variable: tar and arc modes,
;; and rmail.  The first two don't need it.  They already use
;; inhibit-local-variables-regexps, which is probably enough, and
;; could also just set enable-local-variables locally to nil.
;; Them setting it has the side-effect that dir-locals cannot apply to
;; eg tar files (?).  FIXME Is this appropriate?
;; AFAICS, rmail is the only thing that needs this, and the only
;; reason it uses it is for BABYL files (which are obsolete).
;; These contain "-*- rmail -*-" in the first line, which rmail wants
;; to respect, so that find-file on a BABYL file will switch to
;; rmail-mode automatically (this is nice, but hardly essential,
;; since most people are used to explicitly running a command to
;; access their mail; M-x gnus etc).  Rmail files may happen to
;; contain Local Variables sections in messages, which Rmail wants to
;; ignore.  So AFAICS the only reason this variable exists is for a
;; minor convenience feature for handling of an obsolete Rmail file format.
533 534
(defvar local-enable-local-variables t
  "Like `enable-local-variables' but meant for buffer-local bindings.
535
The meaningful values are nil and non-nil.  The default is non-nil.
536
If a major mode sets this to nil, buffer-locally, then any local
Glenn Morris's avatar
Glenn Morris committed
537
variables list in a file visited in that mode will be ignored.
538

Glenn Morris's avatar
Glenn Morris committed
539 540
This variable does not affect the use of major modes specified
in a -*- line.")
541

542
(defcustom enable-local-eval 'maybe
543
  "Control processing of the \"variable\" `eval' in a file's local variables.
544
The value can be t, nil or something else.
545
A value of t means obey `eval' variables.
546
A value of nil means ignore them; anything else means query."
547
  :risky t
548 549
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
550
		 (other :tag "Query" other))
551
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
552 553 554

;; Avoid losing in versions where CLASH_DETECTION is disabled.
(or (fboundp 'lock-buffer)
555
    (defalias 'lock-buffer 'ignore))
Roland McGrath's avatar
Roland McGrath committed
556
(or (fboundp 'unlock-buffer)
557
    (defalias 'unlock-buffer 'ignore))
558 559
(or (fboundp 'file-locked-p)
    (defalias 'file-locked-p 'ignore))
560

561
(defcustom view-read-only nil
562
  "Non-nil means buffers visiting files read-only do so in view mode.
563 564 565 566
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]."
567 568
  :type 'boolean
  :group 'view)
569

570
(defvar file-name-history nil
571 572 573 574
  "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.")
575

576
(put 'ange-ftp-completion-hook-function 'safe-magic t)
577
(defun ange-ftp-completion-hook-function (op &rest args)
André Spiegel's avatar
André Spiegel committed
578 579 580 581
  "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.
582 583
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
584 585 586 587 588
    (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))
589
      (apply op args))))
590

591 592 593
(declare-function dos-convert-standard-filename "dos-fns.el" (filename))
(declare-function w32-convert-standard-filename "w32-fns.el" (filename))

594
(defun convert-standard-filename (filename)
595
  "Convert a standard file's name to something suitable for the OS.
596 597 598
This means to guarantee valid names and perhaps to canonicalize
certain patterns.

599 600 601 602
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.

603 604
This function's standard definition is trivial; it just returns
the argument.  However, on Windows and DOS, replace invalid
605 606 607
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
608 609 610
`w32-shell-dos-semantics').

See Info node `(elisp)Standard File Names' for more details."
611 612 613 614 615 616 617 618 619 620 621 622 623 624
  (cond
   ((eq system-type 'cygwin)
    (let ((name (copy-sequence filename))
	  (start 0))
      ;; Replace invalid filename characters with !
      (while (string-match "[?*:<>|\"\000-\037]" name start)
	(aset name (match-beginning 0) ?!)
	(setq start (match-end 0)))
      name))
   ((eq system-type 'windows-nt)
    (w32-convert-standard-filename filename))
   ((eq system-type 'ms-dos)
    (dos-convert-standard-filename filename))
   (t filename)))
625 626 627 628

(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.
629 630
Default name to DEFAULT-DIRNAME if user exits with the same
non-empty string that was inserted by this function.
631 632
 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
  or just DIR if INITIAL is nil.)
633 634 635
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.)
636 637 638
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.
639 640
DIR should be an absolute directory name.  It defaults to
the value of `default-directory'."
641 642
  (unless dir
    (setq dir default-directory))
643
  (read-file-name prompt dir (or default-dirname
644 645 646
				 (if initial (expand-file-name initial dir)
				   dir))
		  mustmatch initial
647 648
		  'file-directory-p))

Roland McGrath's avatar
Roland McGrath committed
649 650 651 652 653 654

(defun pwd ()
  "Show the current default directory."
  (interactive nil)
  (message "Directory %s" default-directory))

655 656
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
657
Not actually set up until the first time you use it.")
658

659
(defun parse-colon-path (search-path)
660
  "Explode a search path into a list of directory names.
661 662 663 664 665 666 667
Directories are separated by `path-separator' (which is colon in
GNU and Unix systems).  Substitute environment variables into the
resulting list of directory names."
  (when (stringp search-path)
    (mapcar (lambda (f)
	      (substitute-in-file-name (file-name-as-directory f)))
	    (split-string search-path path-separator t))))
668 669

(defun cd-absolute (dir)
670
  "Change current directory to given absolute file name DIR."
671 672
  ;; Put the name into directory syntax now,
  ;; because otherwise expand-file-name may give some bad results.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
673
  (setq dir (file-name-as-directory dir))
674 675 676 677 678 679
  ;; We used to additionally call abbreviate-file-name here, for an
  ;; unknown reason.  Problem is that most buffers are setup
  ;; without going through cd-absolute and don't call
  ;; abbreviate-file-name on their default-directory, so the few that
  ;; do end up using a superficially different directory.
  (setq dir (expand-file-name dir))
Roland McGrath's avatar
Roland McGrath committed
680
  (if (not (file-directory-p dir))
681 682
      (if (file-exists-p dir)
	  (error "%s is not a directory" dir)
683
	(error "%s: no such directory" dir))
684 685 686
    (unless (file-executable-p dir)
      (error "Cannot cd to %s:  Permission denied" dir))
    (setq default-directory dir)
687
    (setq list-buffers-directory dir)))
Roland McGrath's avatar
Roland McGrath committed
688

689 690
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
691 692
If your environment includes a `CDPATH' variable, try each one of
that list of directories (separated by occurrences of
693 694
`path-separator') when resolving a relative directory name.
The path separator is colon in GNU and GNU-like systems."
695
  (interactive
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
   (list
    ;; FIXME: There's a subtle bug in the completion below.  Seems linked
    ;; to a fundamental difficulty of implementing `predicate' correctly.
    ;; The manifestation is that TAB may list non-directories in the case where
    ;; those files also correspond to valid directories (if your cd-path is (A/
    ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
    ;; will be listed as valid completions).
    ;; This is because `a' (listed because of A/a) is indeed a valid choice
    ;; (which will lead to the use of B/a).
    (minibuffer-with-setup-hook
        (lambda ()
          (setq minibuffer-completion-table
                (apply-partially #'locate-file-completion-table
                                 cd-path nil))
          (setq minibuffer-completion-predicate
                (lambda (dir)
                  (locate-file dir cd-path nil
                               (lambda (f) (and (file-directory-p f) 'dir-ok))))))
      (unless cd-path
        (setq cd-path (or (parse-colon-path (getenv "CDPATH"))
                          (list "./"))))
      (read-directory-name "Change default directory: "
                           default-directory default-directory
                           t))))
  (unless cd-path
    (setq cd-path (or (parse-colon-path (getenv "CDPATH"))
                      (list "./"))))
  (cd-absolute
   (or (locate-file dir cd-path nil
                    (lambda (f) (and (file-directory-p f) 'dir-ok)))
       (error "No such directory found via CDPATH environment variable"))))
727

Roland McGrath's avatar
Roland McGrath committed
728 729
(defun load-file (file)
  "Load the Lisp file named FILE."
730 731
  ;; This is a case where .elc makes a lot of sense.
  (interactive (list (let ((completion-ignored-extensions
Dave Love's avatar
Dave Love committed
732
			    (remove ".elc" completion-ignored-extensions)))
733 734
		       (read-file-name "Load file: "))))
  (load (expand-file-name file) nil nil t))
Roland McGrath's avatar
Roland McGrath committed
735

Stefan Monnier's avatar
Stefan Monnier committed
736 737
(defun locate-file (filename path &optional suffixes predicate)
  "Search for FILENAME through PATH.
Eli Zaretskii's avatar
Eli Zaretskii committed
738 739 740 741
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
742 743
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
744
Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
Stefan Monnier's avatar
Stefan Monnier committed
745
If non-nil, PREDICATE is used instead of `file-readable-p'.
746 747 748 749

This function will normally skip directories, so if you want it to find
directories, make sure the PREDICATE function returns `dir-ok' for them.

Richard M. Stallman's avatar
Richard M. Stallman committed
750 751 752 753 754
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
755 756 757 758 759 760 761 762 763
  (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))

764 765
(defun locate-file-completion-table (dirs suffixes string pred action)
  "Do completion for file names passed to `locate-file'."
766 767
  (cond
   ((file-name-absolute-p string)
768 769 770 771
    ;; FIXME: maybe we should use completion-file-name-table instead,
    ;; tho at least for `load', the arg is passed through
    ;; substitute-in-file-name for historical reasons.
    (read-file-name-internal string pred action))
772 773
   ((eq (car-safe action) 'boundaries)
    (let ((suffix (cdr action)))
774 775 776 777
      `(boundaries
        ,(length (file-name-directory string))
        ,@(let ((x (file-name-directory suffix)))
            (if x (1- (length x)) (length suffix))))))
778
   (t
779 780 781 782 783 784 785 786 787 788 789
    (let ((names '())
          ;; If we have files like "foo.el" and "foo.elc", we could load one of
          ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
          ;; preferred way.  So if we list all 3, that gives a lot of redundant
          ;; entries for the poor soul looking just for "foo".  OTOH, sometimes
          ;; the user does want to pay attention to the extension.  We try to
          ;; diffuse this tension by stripping the suffix, except when the
          ;; result is a single element (i.e. usually we only list "foo" unless
          ;; it's the only remaining element in the list, in which case we do
          ;; list "foo", "foo.elc" and "foo.el").
          (fullnames '())
790
	  (suffix (concat (regexp-opt suffixes t) "\\'"))
791 792
	  (string-dir (file-name-directory string))
          (string-file (file-name-nondirectory string)))
793
      (dolist (dir dirs)
794 795 796 797 798 799 800 801 802 803 804 805 806
        (unless dir
          (setq dir default-directory))
        (if string-dir (setq dir (expand-file-name string-dir dir)))
        (when (file-directory-p dir)
          (dolist (file (file-name-all-completions
                         string-file dir))
            (if (not (string-match suffix file))
                (push file names)
              (push file fullnames)
              (push (substring file 0 (match-beginning 0)) names)))))
      ;; Switching from names to names+fullnames creates a non-monotonicity
      ;; which can cause problems with things like partial-completion.
      ;; To minimize the problem, filter out completion-regexp-list, so that
807 808 809 810
      ;; M-x load-library RET t/x.e TAB finds some files.  Also remove elements
      ;; from `names' which only matched `string' when they still had
      ;; their suffix.
      (setq names (all-completions string names))
811 812 813 814 815 816 817
      ;; Remove duplicates of the first element, so that we can easily check
      ;; if `names' really only contains a single element.
      (when (cdr names) (setcdr names (delete (car names) (cdr names))))
      (unless (cdr names)
        ;; There's no more than one matching non-suffixed element, so expand
        ;; the list by adding the suffixed elements as well.
        (setq names (nconc names fullnames)))
818 819
      (completion-table-with-context
       string-dir names string-file pred action)))))
820 821 822 823

(defun locate-file-completion (string path-and-suffixes action)
  "Do completion for file names passed to `locate-file'.
PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
824
  (declare (obsolete locate-file-completion-table "23.1"))
825 826 827
  (locate-file-completion-table (car path-and-suffixes)
                                (cdr path-and-suffixes)
                                string nil action))
828

829
(defvar locate-dominating-stop-dir-regexp
830
  (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
831 832 833 834 835
  "Regexp of directory names which stop the search in `locate-dominating-file'.
Any directory whose name matches this regexp will be treated like
a kind of root directory by `locate-dominating-file' which will stop its search
when it bumps into it.
The default regexp prevents fruitless and time-consuming attempts to find
836 837
special files in directories in which filenames are interpreted as hostnames,
or mount points potentially requiring authentication as a different user.")
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 866 867 868

;; (defun locate-dominating-files (file regexp)
;;   "Look up the directory hierarchy from FILE for a file matching REGEXP.
;; Stop at the first parent where a matching file is found and return the list
;; of files that that match in this directory."
;;   (catch 'found
;;     ;; `user' is not initialized yet because `file' may not exist, so we may
;;     ;; have to walk up part of the hierarchy before we find the "initial UID".
;;     (let ((user nil)
;;           ;; Abbreviate, so as to stop when we cross ~/.
;;           (dir (abbreviate-file-name (file-name-as-directory file)))
;;           files)
;;       (while (and dir
;;                   ;; As a heuristic, we stop looking up the hierarchy of
;;                   ;; directories as soon as we find a directory belonging to
;;                   ;; another user.  This should save us from looking in
;;                   ;; things like /net and /afs.  This assumes that all the
;;                   ;; files inside a project belong to the same user.
;;                   (let ((prev-user user))
;;                     (setq user (nth 2 (file-attributes dir)))
;;                     (or (null prev-user) (equal user prev-user))))
;;         (if (setq files (condition-case nil
;; 			    (directory-files dir 'full regexp 'nosort)
;; 			  (error nil)))
;;             (throw 'found files)
;;           (if (equal dir
;;                      (setq dir (file-name-directory
;;                                 (directory-file-name dir))))
;;               (setq dir nil))))
;;       nil)))

869
(defun locate-dominating-file (file name)
870
  "Look up the directory hierarchy from FILE for a directory containing NAME.
871
Stop at the first parent directory containing a file NAME,
872
and return the directory.  Return nil if not found.
873 874 875
Instead of a string, NAME can also be a predicate taking one argument
\(a directory) and returning a non-nil value if that directory is the one for
which we're looking."