files.el 295 KB
Newer Older
1
;;; files.el --- file input and output commands for Emacs  -*- lexical-binding:t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

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

5
;; Maintainer: emacs-devel@gnu.org
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

FROM is matched against directory names anchored at the first
58
character, so it should start with a \"\\\\\\=`\", or, if directory
Glenn Morris's avatar
Glenn Morris committed
59
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
  "If non-nil, backups will be inhibited.
This variable is intended for use by making it local to a buffer,
but it is not an automatically buffer-local variable.")
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 163 164 165 166
  "Non-nil means visiting a file uses its truename as the visited-file name.
That is, the buffer visiting the file has the truename as the
value of `buffer-file-name'.  The truename of a file is found by
chasing all links both at the file level and at the levels of the
containing directories."
167 168
  :type 'boolean
  :group 'find-file)
169
(put 'find-file-visit-truename 'safe-local-variable 'booleanp)
170

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

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

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

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

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

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

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

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

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

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
241
Yet, at the same time, saving a precious file
242 243 244
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
245
file is being saved is not writable, Emacs may ignore a non-nil value
Karl Fogel's avatar
Karl Fogel committed
246 247 248
of `file-precious-flag' and write directly into the file.

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

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

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
264
itself writable, then error instead of saving in some
Karl Fogel's avatar
Karl Fogel committed
265 266 267 268
hardlink-nonbreaking way.

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

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

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

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

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

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

312
(defcustom require-final-newline nil
313
  "Whether to add a newline automatically at the end of the file.
314 315 316 317 318

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

Certain major modes set this locally to the value obtained
from `mode-require-final-newline'."
323
  :safe #'symbolp
324 325 326
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
327
		 (const :tag "Don't add newlines" nil)
328
		 (other :tag "Ask each time" ask))
329
  :group 'editing-basics)
Roland McGrath's avatar
Roland McGrath committed
330

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

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

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

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

379 380
The default value is set up to put the auto-save file into the
temporary directory (see the variable `temporary-file-directory') for
381 382 383 384
editing a remote file.

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

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

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

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

410 411 412 413 414 415 416 417
;; 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)

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

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

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

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

(defvar local-write-file-hooks nil)
459 460
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
461
(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
Jim Blandy's avatar
Jim Blandy committed
462

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

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
474 475
major mode does clear it.

476 477 478 479 480
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
481
(make-variable-buffer-local 'write-contents-functions)
Roland McGrath's avatar
Roland McGrath committed
482

483
(defcustom enable-local-variables t
484
  "Control use of local variables in files you visit.
485
The value can be t, nil, :safe, :all, or something else.
486 487

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

:safe means set the safe variables, and ignore the rest.
493 494
:all means set all variables, whether safe or not.
 (Don't set it permanently to :all.)
495
A value of nil means always ignore the file local variables.
496 497

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

501 502
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
503

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

515 516 517 518 519
(defvar enable-dir-local-variables t
  "Non-nil means enable use of directory-local variables.
Some modes may wish to set this to nil to prevent directory-local
settings being applied, but still respect file-local ones.")

Glenn Morris's avatar
Glenn Morris committed
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
;; 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.
542 543
(defvar local-enable-local-variables t
  "Like `enable-local-variables' but meant for buffer-local bindings.
544
The meaningful values are nil and non-nil.  The default is non-nil.
545
If a major mode sets this to nil, buffer-locally, then any local
Glenn Morris's avatar
Glenn Morris committed
546
variables list in a file visited in that mode will be ignored.
547

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

551
(defcustom enable-local-eval 'maybe
552
  "Control processing of the \"variable\" `eval' in a file's local variables.
553
The value can be t, nil or something else.
554
A value of t means obey `eval' variables.
555
A value of nil means ignore them; anything else means query."
556
  :risky t
557 558
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
559
		 (other :tag "Query" other))
560
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
561

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

571
(defvar file-name-history nil
572 573 574 575
  "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.")
576 577 578 579 580 581

(defvar save-silently nil
  "If non-nil, avoid messages when saving files.
Error-related messages will still be printed, but all other
messages will not.")

582

583
(put 'ange-ftp-completion-hook-function 'safe-magic t)
584
(defun ange-ftp-completion-hook-function (op &rest args)
André Spiegel's avatar
André Spiegel committed
585 586 587 588
  "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.
589 590
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
591 592 593 594 595
    (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))
596
      (apply op args))))
597

598 599 600
(declare-function dos-convert-standard-filename "dos-fns.el" (filename))
(declare-function w32-convert-standard-filename "w32-fns.el" (filename))

601
(defun convert-standard-filename (filename)
602
  "Convert a standard file's name to something suitable for the OS.
603 604 605
This means to guarantee valid names and perhaps to canonicalize
certain patterns.

606 607 608 609
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.

610 611
This function's standard definition is trivial; it just returns
the argument.  However, on Windows and DOS, replace invalid
612 613 614
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
615 616 617
`w32-shell-dos-semantics').

See Info node `(elisp)Standard File Names' for more details."
618 619 620 621 622 623 624 625 626 627 628 629 630 631
  (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)))
632 633 634 635

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

Roland McGrath's avatar
Roland McGrath committed
656

Simen Heggestøyl's avatar
Simen Heggestøyl committed
657 658 659 660 661 662 663 664
(defun pwd (&optional insert)
  "Show the current default directory.
With prefix argument INSERT, insert the current default directory
at point instead."
  (interactive "P")
  (if insert
      (insert default-directory)
    (message "Directory %s" default-directory)))
Roland McGrath's avatar
Roland McGrath committed
665

666 667
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
668
Not actually set up until the first time you use it.")
669

670
(defun parse-colon-path (search-path)
671
  "Explode a search path into a list of directory names.
672 673
Directories are separated by `path-separator' (which is colon in
GNU and Unix systems).  Substitute environment variables into the
674 675 676
resulting list of directory names.  For an empty path element (i.e.,
a leading or trailing separator, or two adjacent separators), return
nil (meaning `default-directory') as the associated list element."
677 678
  (when (stringp search-path)
    (mapcar (lambda (f)
679 680 681
	      (if (equal "" f) nil
		(substitute-in-file-name (file-name-as-directory f))))
	    (split-string search-path path-separator))))
682 683

(defun cd-absolute (dir)
684
  "Change current directory to given absolute file name DIR."
685 686
  ;; Put the name into directory syntax now,
  ;; because otherwise expand-file-name may give some bad results.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
687
  (setq dir (file-name-as-directory dir))
688 689 690 691 692 693
  ;; 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
694
  (if (not (file-directory-p dir))
695 696
      (if (file-exists-p dir)
	  (error "%s is not a directory" dir)
697
	(error "%s: no such directory" dir))
698
    (unless (file-accessible-directory-p dir)
699 700
      (error "Cannot cd to %s:  Permission denied" dir))
    (setq default-directory dir)
701
    (setq list-buffers-directory dir)))
Roland McGrath's avatar
Roland McGrath committed
702

703 704
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
705 706
If your environment includes a `CDPATH' variable, try each one of
that list of directories (separated by occurrences of
707 708
`path-separator') when resolving a relative directory name.
The path separator is colon in GNU and GNU-like systems."
709
  (interactive
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
   (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"))))
741

742
(defsubst directory-name-p (name)
743 744 745 746 747 748 749 750
  "Return non-nil if NAME ends with a directory separator character."
  (let ((len (length name))
        (lastc ?.))
    (if (> len 0)
        (setq lastc (aref name (1- len))))
    (or (= lastc ?/)
        (and (memq system-type '(windows-nt ms-dos))
             (= lastc ?\\)))))
751

752 753
(defun directory-files-recursively (dir regexp &optional include-directories)
  "Return list of all files under DIR that have file names matching REGEXP.
754
This function works recursively.  Files are returned in \"depth first\"
755 756 757 758
order, and files from each directory are sorted in alphabetical order.
Each file name appears in the returned list in its absolute form.
Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
output directories whose names match REGEXP."
759
  (let ((result nil)
760 761 762
	(files nil)
	;; When DIR is "/", remote file names like "/method:" could
	;; also be offered.  We shall suppress them.
763
	(tramp-mode (and tramp-mode (file-remote-p (expand-file-name dir)))))
764 765 766
    (dolist (file (sort (file-name-all-completions "" dir)
			'string<))
      (unless (member file '("./" "../"))
767
	(if (directory-name-p file)
768
	    (let* ((leaf (substring file 0 (1- (length file))))
769
		   (full-file (expand-file-name leaf dir)))
770
	      ;; Don't follow symlinks to other directories.
771 772 773
	      (unless (file-symlink-p full-file)
		(setq result
		      (nconc result (directory-files-recursively
774
				     full-file regexp include-directories))))
775
	      (when (and include-directories
776
			 (string-match regexp leaf))
777
		(setq result (nconc result (list full-file)))))
778
	  (when (string-match regexp file)
779
	    (push (expand-file-name file dir) files)))))
780 781
    (nconc result (nreverse files))))

782 783
(defvar module-file-suffix)

Roland McGrath's avatar
Roland McGrath committed
784 785
(defun load-file (file)
  "Load the Lisp file named FILE."
786
  ;; This is a case where .elc and .so/.dll make a lot of sense.
787
  (interactive (list (let ((completion-ignored-extensions
788 789 790
                            (remove module-file-suffix
                                    (remove ".elc"
                                            completion-ignored-extensions))))
791
		       (read-file-name "Load file: " nil nil 'lambda))))
792
  (load (expand-file-name file) nil nil t))
Roland McGrath's avatar
Roland McGrath committed
793

Stefan Monnier's avatar
Stefan Monnier committed
794 795
(defun locate-file (filename path &optional suffixes predicate)
  "Search for FILENAME through PATH.
796 797
If found, return the absolute file name of FILENAME; otherwise
return nil.
Eli Zaretskii's avatar
Eli Zaretskii committed
798 799
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
800
If SUFFIXES is non-nil, it should be a list of suffixes to append to
801 802
file name when searching.  If SUFFIXES is nil, it is equivalent to (\"\").
Use (\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
Stefan Monnier's avatar
Stefan Monnier committed
803
If non-nil, PREDICATE is used instead of `file-readable-p'.
804 805 806 807

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
808 809 810 811 812
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
813 814 815 816 817 818 819 820 821
  (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))

822 823
(defun locate-file-completion-table (dirs suffixes string pred action)
  "Do completion for file names passed to `locate-file'."
824 825
  (cond
   ((file-name-absolute-p string)
826 827 828 829
    ;; 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))
830 831
   ((eq (car-safe action) 'boundaries)
    (let ((suffix (cdr action)))
832 833 834 835
      `(boundaries
        ,(length (file-name-directory string))
        ,@(let ((x (file-name-directory suffix)))
            (if x (1-