files.el 318 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-2019 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 <https://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 33 34
(eval-when-compile
  (require 'pcase)
  (require 'easy-mmode)) ; For `define-minor-mode'.

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
A list of elements of the form (FROM . TO), each meaning to replace
58 59 60
a match for FROM with TO when a directory name matches FROM.  This
replacement is done when setting up the default directory of a
newly visited file buffer.
Glenn Morris's avatar
Glenn Morris committed
61

62 63 64
FROM is a regexp that 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
65

66
FROM and TO should be equivalent names, which refer to the
67 68
same directory.  TO should be an absolute directory name.
Do not use `~' in the TO strings.
69

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

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

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

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

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

122
(defcustom backup-by-copying-when-mismatch t
123
  "Non-nil means create backups by copying if this preserves owner or group.
Roland McGrath's avatar
Roland McGrath committed
124 125 126 127
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.
128
This variable is relevant only if `backup-by-copying' is nil."
129
  :version "24.1"
130 131
  :type 'boolean
  :group 'backup)
132
(put 'backup-by-copying-when-mismatch 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
133

André Spiegel's avatar
André Spiegel committed
134
(defcustom backup-by-copying-when-privileged-mismatch 200
135
  "Non-nil means create backups by copying to preserve a privileged owner.
André Spiegel's avatar
André Spiegel committed
136 137 138 139 140 141 142 143 144 145 146
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
147
  "Predicate that looks at a file name and decides whether to make backups.
148
Called with an absolute file name as argument, it returns t to enable backup.")
Roland McGrath's avatar
Roland McGrath committed
149

150
(defcustom buffer-offer-save nil
151
  "Non-nil in a buffer means always offer to save buffer on exiting Emacs.
André Spiegel's avatar
André Spiegel committed
152
Do so even if the buffer is not visiting a file.
153 154 155
Automatically local in all buffers.

Set to the symbol `always' to offer to save buffer whenever
156 157 158 159 160
`save-some-buffers' is called.

Note that this option has no effect on `kill-buffer';
if you want to control what happens when a buffer is killed,
use `kill-buffer-query-functions'."
161 162 163
  :type '(choice (const :tag "Never" nil)
                 (const :tag "On Emacs exit" t)
                 (const :tag "Whenever save-some-buffers is called" always))
164
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
165
(make-variable-buffer-local 'buffer-offer-save)
166
(put 'buffer-offer-save 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
167

168
(defcustom find-file-existing-other-name t
169
  "Non-nil means find a file under alternative names, in existing buffers.
170
This means if any existing buffer is visiting the file you want
171 172 173
under another name, you get the existing buffer instead of a new buffer."
  :type 'boolean
  :group 'find-file)
174

175
(defcustom find-file-visit-truename nil
176 177 178 179 180
  "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."
181 182
  :type 'boolean
  :group 'find-file)
183
(put 'find-file-visit-truename 'safe-local-variable 'booleanp)
184

185
(defcustom revert-without-query nil
186
  "Specify which files should be reverted without query.
187 188
The value is a list of regular expressions.
If the file name matches one of these regular expressions,
189
then `revert-buffer' reverts the file without querying
190
if the file has changed on disk and you have not edited the buffer."
191
  :type '(repeat regexp)
192
  :group 'find-file)
193

194 195 196 197 198 199 200 201
(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)

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

205 206 207 208
(defvar buffer-file-read-only nil
  "Non-nil if visited file was read-only when visited.")
(make-variable-buffer-local 'buffer-file-read-only)

209
(defcustom small-temporary-file-directory
210 211 212 213
  (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
214 215
have fast storage with limited space, such as a RAM disk."
  :group 'files
216
  :initialize 'custom-initialize-delay
217
  :type '(choice (const nil) directory))
218 219

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

222 223
(declare-function msdos-long-file-names "msdos.c")
(declare-function w32-long-file-name "w32proc.c")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
224
(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
Glenn Morris's avatar
Glenn Morris committed
225
(declare-function dired-unmark "dired" (arg &optional interactive))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
226 227
(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
228
(declare-function dosified-file-name "dos-fns" (file-name))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
229

230 231
(defvar file-name-invalid-regexp
  (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
232
	 (purecopy
233
	 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
234
		 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|"  ; invalid characters
235
		 "[\000-\037]\\|"		  ; control characters
236
		 "\\(/\\.\\.?[^/]\\)\\|"	  ; leading dots
237
		 "\\(/[^/.]+\\.[^/.]*\\.\\)")))	  ; more than a single dot
Juanma Barranquero's avatar
Juanma Barranquero committed
238
	((memq system-type '(ms-dos windows-nt cygwin))
239
	 (purecopy
240
	 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
241 242
		 "[|<>\"?*\000-\037]")))		  ; invalid characters
	(t (purecopy "[\000]")))
243 244
  "Regexp recognizing file names which aren't allowed by the filesystem.")

245
(defcustom file-precious-flag nil
246
  "Non-nil means protect against I/O errors while saving files.
Karl Heuer's avatar
Karl Heuer committed
247
Some modes set this non-nil in particular buffers.
248 249 250 251 252 253 254

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
255
Yet, at the same time, saving a precious file
256 257 258
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
259
file is being saved is not writable, Emacs may ignore a non-nil value
Karl Fogel's avatar
Karl Fogel committed
260 261 262
of `file-precious-flag' and write directly into the file.

See also: `break-hardlink-on-save'."
263 264
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
265

Karl Fogel's avatar
Karl Fogel committed
266
(defcustom break-hardlink-on-save nil
267 268 269 270 271 272
  "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
273 274 275 276 277

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
278
itself writable, then error instead of saving in some
Karl Fogel's avatar
Karl Fogel committed
279 280 281 282
hardlink-nonbreaking way.

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

286
(defcustom version-control nil
287
  "Control use of version numbers for backup files.
288 289 290
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."
291 292 293
  :type '(choice (const :tag "Never" never)
		 (const :tag "If existing" nil)
		 (other :tag "Always" t))
294
  :group 'backup)
295 296 297 298 299

(defun version-control-safe-local-p (x)
  "Return whether X is safe as local value for `version-control'."
  (or (booleanp x) (equal x 'never)))

300
(put 'version-control 'safe-local-variable
301
     #'version-control-safe-local-p)
302 303

(defcustom dired-kept-versions 2
304
  "When cleaning directory, number of versions to keep."
305 306 307 308 309
  :type 'integer
  :group 'backup
  :group 'dired)

(defcustom delete-old-versions nil
310
  "If t, delete excess backup versions silently.
311 312 313
If nil, ask confirmation.  Any other value prevents any trimming."
  :type '(choice (const :tag "Delete" t)
		 (const :tag "Ask" nil)
314
		 (other :tag "Leave" other))
315 316 317
  :group 'backup)

(defcustom kept-old-versions 2
318
  "Number of oldest versions to keep when a new numbered backup is made."
319 320
  :type 'integer
  :group 'backup)
321
(put 'kept-old-versions 'safe-local-variable 'integerp)
322 323

(defcustom kept-new-versions 2
324
  "Number of newest versions to keep when a new numbered backup is made.
325
Includes the new backup.  Must be greater than 0."
326 327
  :type 'integer
  :group 'backup)
328
(put 'kept-new-versions 'safe-local-variable 'integerp)
Roland McGrath's avatar
Roland McGrath committed
329

330
(defcustom require-final-newline nil
331
  "Whether to add a newline automatically at the end of the file.
332 333 334 335 336

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.
337
A value of nil means don't add newlines.
338 339 340

Certain major modes set this locally to the value obtained
from `mode-require-final-newline'."
341
  :safe #'symbolp
342 343 344
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
345
		 (const :tag "Don't add newlines" nil)
346
		 (other :tag "Ask each time" ask))
347
  :group 'editing-basics)
Roland McGrath's avatar
Roland McGrath committed
348

349
(defcustom mode-require-final-newline t
350
  "Whether to add a newline at end of file, in certain major modes.
351
Those modes set `require-final-newline' to this value when you enable them.
352
They do so because they are often used for files that are supposed
353 354 355 356 357
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.
358 359
Any other non-nil value means ask user whether to add a newline, when saving.

360 361 362 363
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."
364 365 366
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
367 368
		 (const :tag "Don't add newlines" nil)
		 (other :tag "Ask each time" ask))
369
  :group 'editing-basics
370
  :version "22.1")
371

372
(defcustom auto-save-default t
373
  "Non-nil says by default do auto-saving of every file-visiting buffer."
374 375
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
376

André Spiegel's avatar
André Spiegel committed
377
(defcustom auto-save-file-name-transforms
378
  `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
379 380
     ;; Don't put "\\2" inside expand-file-name, since it will be
     ;; transformed to "/2" on DOS/Windows.
381
     ,(concat temporary-file-directory "\\2") t))
382
  "Transforms to apply to buffer file name before making auto-save file name.
383
Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
André Spiegel's avatar
André Spiegel committed
384 385 386
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.
387
If the optional element UNIQUIFY is non-nil, the auto-save file name is
388
constructed by taking the directory part of the replaced file-name,
389 390 391 392
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
393 394 395 396
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.

397 398
The default value is set up to put the auto-save file into the
temporary directory (see the variable `temporary-file-directory') for
399 400 401 402
editing a remote file.

On MS-DOS filesystems without long names this variable is always
ignored."
André Spiegel's avatar
André Spiegel committed
403
  :group 'auto-save
404 405
  :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
					   (boolean :tag "Uniquify")))
406
  :initialize 'custom-initialize-delay
André Spiegel's avatar
André Spiegel committed
407 408
  :version "21.1")

409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
(defvar auto-save--timer nil "Timer for `auto-save-visited-mode'.")

(defcustom auto-save-visited-interval 5
  "Interval in seconds for `auto-save-visited-mode'.
If `auto-save-visited-mode' is enabled, Emacs will save all
buffers visiting a file to the visited file after it has been
idle for `auto-save-visited-interval' seconds."
  :group 'auto-save
  :type 'number
  :version "26.1"
  :set (lambda (symbol value)
         (set-default symbol value)
         (when auto-save--timer
           (timer-set-idle-time auto-save--timer value :repeat))))

(define-minor-mode auto-save-visited-mode
  "Toggle automatic saving to file-visiting buffers on or off.
426

427 428
Unlike `auto-save-mode', this mode will auto-save buffer contents
to the visited files directly and will also run all save-related
429
hooks.  See Info node `Saving' for details of the save process."
430 431
  :group 'auto-save
  :global t
Philipp Stephani's avatar
Philipp Stephani committed
432
  (when auto-save--timer (cancel-timer auto-save--timer))
433 434 435 436 437 438
  (setq auto-save--timer
        (when auto-save-visited-mode
          (run-with-idle-timer
           auto-save-visited-interval :repeat
           #'save-some-buffers :no-prompt
           (lambda ()
439 440 441
             (and buffer-file-name
                  (not (and buffer-auto-save-file-name
                            auto-save-visited-file-name))))))))
442

443 444 445
;; The 'set' part is so we don't get a warning for using this variable
;; above, while still catching code that _sets_ the variable to get
;; the same effect as the new auto-save-visited-mode.
446
(make-obsolete-variable 'auto-save-visited-file-name 'auto-save-visited-mode
447
                        "Emacs 26.1" 'set)
448

449
(defcustom save-abbrevs t
450
  "Non-nil means save word abbrevs too when files are saved.
451 452
If `silently', don't ask the user before saving."
  :type '(choice (const t) (const nil) (const silently))
453
  :group 'abbrev)
Roland McGrath's avatar
Roland McGrath committed
454

455
(defcustom find-file-run-dired t
456
  "Non-nil means allow `find-file' to visit directories.
André Spiegel's avatar
André Spiegel committed
457
To visit the directory, `find-file' runs `find-directory-functions'."
458 459
  :type 'boolean
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
460

André Spiegel's avatar
André Spiegel committed
461
(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
462
  "List of functions to try in sequence to visit a directory.
André Spiegel's avatar
André Spiegel committed
463 464 465 466 467
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)

468 469 470 471 472 473 474 475
;; 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)

476
;;;It is not useful to make this a local variable.
477
;;;(put 'find-file-not-found-functions 'permanent-local t)
478 479
(define-obsolete-variable-alias 'find-file-not-found-hooks
    'find-file-not-found-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
480
(defvar find-file-not-found-functions nil
Roland McGrath's avatar
Roland McGrath committed
481 482
  "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
483
Variable `buffer-file-name' is already set up.
Roland McGrath's avatar
Roland McGrath committed
484 485
The functions are called in the order given until one of them returns non-nil.")

486
;;;It is not useful to make this a local variable.
487 488
;;;(put 'find-file-hook 'permanent-local t)
;; I found some external files still using the obsolete form in 2018.
489
(define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
Dave Love's avatar
Dave Love committed
490
(defcustom find-file-hook nil
Roland McGrath's avatar
Roland McGrath committed
491 492
  "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
493 494
functions are called.  This includes directory-local variables, if any,
for the file's directory."
Dave Love's avatar
Dave Love committed
495 496 497
  :group 'find-file
  :type 'hook
  :options '(auto-insert)
498
  :version "22.1")
Roland McGrath's avatar
Roland McGrath committed
499

500
;; I found some external files still using the obsolete form in 2018.
501
(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
502
(defvar write-file-functions nil
503 504
  "List of functions to be called before saving a buffer to a file.
Only used by `save-buffer'.
Roland McGrath's avatar
Roland McGrath committed
505
If one of them returns non-nil, the file is considered already written
Jim Blandy's avatar
Jim Blandy committed
506 507
and the rest are not called.
These hooks are considered to pertain to the visited file.
Stefan Monnier's avatar
Stefan Monnier committed
508 509 510 511
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.

512 513 514 515 516
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
517
updates before the buffer is saved, use `before-save-hook'.")
Stefan Monnier's avatar
Stefan Monnier committed
518 519
(put 'write-file-functions 'permanent-local t)

520
;; I found some files still using the obsolete form in 2018.
Stefan Monnier's avatar
Stefan Monnier committed
521
(defvar local-write-file-hooks nil)
522 523
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
524
(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
Jim Blandy's avatar
Jim Blandy committed
525

526
;; I found some files still using the obsolete form in 2018.
527 528
(define-obsolete-variable-alias 'write-contents-hooks
    'write-contents-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
529
(defvar write-contents-functions nil
Jim Blandy's avatar
Jim Blandy committed
530
  "List of functions to be called before writing out a buffer to a file.
531 532 533 534 535 536

Only used by `save-buffer'.  If one of them returns non-nil, the
file is considered already written and the rest are not called
and neither are the functions in `write-file-functions'.  This
hook can thus be used to create save behavior for buffers that
are not visiting a file at all.
537 538 539 540

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
541 542
major mode does clear it.

543 544 545 546 547
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
548
(make-variable-buffer-local 'write-contents-functions)
Roland McGrath's avatar
Roland McGrath committed
549

550
(defcustom enable-local-variables t
551
  "Control use of local variables in files you visit.
552
The value can be t, nil, :safe, :all, or something else.
553 554

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

:safe means set the safe variables, and ignore the rest.
560 561
:all means set all variables, whether safe or not.
 (Don't set it permanently to :all.)
562
A value of nil means always ignore the file local variables.
563 564

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

568 569
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
570

571 572 573
The command \\[normal-mode], when used interactively,
always obeys file local variable specifications and the -*- line,
and ignores this variable."
574
  :risky t
575
  :type '(choice (const :tag "Query Unsafe" t)
576
		 (const :tag "Safe Only" :safe)
577
		 (const :tag "Do all" :all)
578
		 (const :tag "Ignore" nil)
579
		 (other :tag "Query" other))
580
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
581

582 583 584 585 586
(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
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
;; 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.
609
(defvar local-enable-local-variables t
610
  "Like `enable-local-variables', except for major mode in a -*- line.
611
The meaningful values are nil and non-nil.  The default is non-nil.
612
It should be set in a buffer-local fashion.
613

614 615 616 617
Setting this to nil has the same effect as setting `enable-local-variables'
to nil, except that it does not ignore any mode: setting in a -*- line.
Unless this difference matters to you, you should set `enable-local-variables'
instead of this variable.")
618

619
(defcustom enable-local-eval 'maybe
620
  "Control processing of the \"variable\" `eval' in a file's local variables.
621
The value can be t, nil or something else.
622
A value of t means obey `eval' variables.
623
A value of nil means ignore them; anything else means query."
624
  :risky t
625 626
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
627
		 (other :tag "Query" other))
628
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
629

630
(defcustom view-read-only nil
631
  "Non-nil means buffers visiting files read-only do so in view mode.
632 633 634
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
635
using \\[read-only-mode]."
636 637
  :type 'boolean
  :group 'view)
638

639
(defvar file-name-history nil
640 641 642 643
  "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.")
644 645 646 647 648 649

(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.")

650

651
(put 'ange-ftp-completion-hook-function 'safe-magic t)
652
(defun ange-ftp-completion-hook-function (op &rest args)
André Spiegel's avatar
André Spiegel committed
653 654 655 656
  "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.
657 658
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
659 660 661 662 663
    (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))
664
      (apply op args))))
665

666 667 668
(declare-function dos-convert-standard-filename "dos-fns.el" (filename))
(declare-function w32-convert-standard-filename "w32-fns.el" (filename))

669
(defun convert-standard-filename (filename)
670
  "Convert a standard file's name to something suitable for the OS.
671 672 673
This means to guarantee valid names and perhaps to canonicalize
certain patterns.

674 675 676 677
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.

678 679
This function's standard definition is trivial; it just returns
the argument.  However, on Windows and DOS, replace invalid
680
characters.  On DOS, make sure to obey the 8.3 limitations.
681
In the native Windows build, turn Cygwin names into native names.
682 683

See Info node `(elisp)Standard File Names' for more details."
684 685 686 687 688 689 690 691 692 693 694 695 696 697
  (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)))
698 699 700 701

(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.
702 703
Default name to DEFAULT-DIRNAME if user exits with the same
non-empty string that was inserted by this function.
704 705
 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
  or just DIR if INITIAL is nil.)
706 707 708
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.)
709 710 711
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.
712 713
DIR should be an absolute directory name.  It defaults to
the value of `default-directory'."
714 715
  (unless dir
    (setq dir default-directory))
716
  (read-file-name prompt dir (or default-dirname
717 718 719
				 (if initial (expand-file-name initial dir)
				   dir))
		  mustmatch initial
720 721
		  'file-directory-p))

Roland McGrath's avatar
Roland McGrath committed
722

Simen Heggestøyl's avatar
Simen Heggestøyl committed
723 724 725 726 727 728 729 730
(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
731

732 733
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
734
Not actually set up until the first time you use it.")
735

736
(defun parse-colon-path (search-path)
737
  "Explode a search path into a list of directory names.
738 739
Directories are separated by `path-separator' (which is colon in
GNU and Unix systems).  Substitute environment variables into the
740 741 742
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."
743 744
  (when (stringp search-path)
    (mapcar (lambda (f)
745 746 747
	      (if (equal "" f) nil
		(substitute-in-file-name (file-name-as-directory f))))
	    (split-string search-path path-separator))))
748 749

(defun cd-absolute (dir)
750
  "Change current directory to given absolute file name DIR."
751 752
  ;; Put the name into directory syntax now,
  ;; because otherwise expand-file-name may give some bad results.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
753
  (setq dir (file-name-as-directory dir))
754 755 756 757 758 759
  ;; 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
760
  (if (not (file-directory-p dir))
761 762 763 764
      (error (if (file-exists-p dir)
	         "%s is not a directory"
               "%s: no such directory")
             dir)
765
    (unless (file-accessible-directory-p dir)
766 767
      (error "Cannot cd to %s:  Permission denied" dir))
    (setq default-directory dir)
768
    (setq list-buffers-directory dir)))
Roland McGrath's avatar
Roland McGrath committed
769

770 771
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
772 773
If your environment includes a `CDPATH' variable, try each one of
that list of directories (separated by occurrences of
774 775
`path-separator') when resolving a relative directory name.
The path separator is colon in GNU and GNU-like systems."
776
  (interactive
777 778 779 780 781 782 783 784 785 786 787
   (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 ()
788 789 790 791 792 793 794
          (setq-local minibuffer-completion-table
		      (apply-partially #'locate-file-completion-table
				       cd-path nil))
          (setq-local minibuffer-completion-predicate
		      (lambda (dir)
			(locate-file dir cd-path nil
				     (lambda (f) (and (file-directory-p f) 'dir-ok))))))
795 796 797 798 799 800 801 802 803 804
      (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
805 806 807 808 809 810 811 812 813
   (or
    ;; locate-file doesn't support remote file names, so detect them
    ;; and support them here by hand.
    (and (file-remote-p (expand-file-name dir))
         (file-accessible-directory-p (expand-file-name dir))
         (expand-file-name dir))
    (locate-file dir cd-path nil
                 (lambda (f) (and (file-directory-p f) 'dir-ok)))
    (error "No such directory found via CDPATH environment variable"))))
814

815 816
(defun directory-files-recursively (dir regexp &optional include-directories)
  "Return list of all files under DIR that have file names matching REGEXP.
817
This function works recursively.  Files are returned in \"depth first\"
818 819 820 821
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."
822
  (let ((result nil)
823 824 825
	(files nil)
	;; When DIR is "/", remote file names like "/method:" could
	;; also be offered.  We shall suppress them.
826
	(tramp-mode (and tramp-mode (file-remote-p (expand-file-name dir)))))
827 828 829
    (dolist (file (sort (file-name-all-completions "" dir)
			'string<))
      (unless (member file '("./" "../"))
830
	(if (directory-name-p file)
831
	    (let* ((leaf (substring file 0 (1- (length file))))
832
		   (full-file (expand-file-name leaf dir)))
833
	      ;; Don't follow symlinks to other directories.
834 835 836
	      (unless (file-symlink-p full-file)
		(setq result
		      (nconc result (directory-files-recursively
837
				     full-file regexp include-directories))))
838
	      (when (and include-directories
839
			 (string-match regexp leaf))
840
		(setq result (nconc result (list full-file)))))
841
	  (when (string-match regexp file)
842
	    (push (expand-file-name file dir) files)))))
843 844
    (nconc result (nreverse files))))

845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
(defun path-files (path &optional pred)
  "Return a list of all files matching PRED in PATH.
PATH is flat; no subdirectories of entries in PATH are
visited (unless they are also in PATH).  PRED is a function
taking one argument; an absolute file name."
  (let (visited ;; list of already visited directories, to avoid duplication
        result)
    (dolist (dir path)
      (while (member dir visited)
	(setq dir (pop path)))
      (when (and dir
                 (file-directory-p dir))
	(push dir visited)
        (mapc
         (lambda (rel-file)
           (let ((absfile (concat (file-name-as-directory dir) rel-file)))
	     (when (and (not (string-equal "." (substring absfile -1)))
		        (not (string-equal ".." (substring absfile -2)))
		        (not (file-directory-p absfile))
                        (or (null pred)
                            (funcall pred absfile)))
	       (push absfile result))))
	 (file-name-all-completions "" dir));; uses completion-regexp-list
        ))
    result))

871 872
(defvar module-file-suffix)

Roland McGrath's avatar
Roland McGrath committed
873 874
(defun load-file (file)
  "Load the Lisp file named FILE."
875
  ;; This is a case where .elc and .so/.dll make a lot of sense.
876
  (interactive (list (let ((completion-ignored-extensions
877 878 879
                            (remove module-file-suffix
                                    (remove ".elc"
                                            completion-ignored-extensions))))
880
		       (read-file-name "Load file: " nil nil 'lambda))))
881
  (load (expand-file-name file) nil nil t))
Roland McGrath's avatar
Roland McGrath committed
882

Stefan Monnier's avatar
Stefan Monnier committed
883 884
(defun locate-file (filename path &optional suffixes predicate)
  "Search for FILENAME through PATH.
885 886
If found, return the absolute file name of FILENAME; otherwise
return nil.
Eli Zaretskii's avatar
Eli Zaretskii committed
887 888
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
889
If SUFFIXES is non-nil, it should be a list of suffixes to append to
890 891
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
892
If non-nil, PREDICATE is used instead of `file-readable-p'.
893 894 895 896

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
897
PREDICATE can also be an integer to pass to the `access' system call,
898
in which case file name handlers are ignored.  This usage is deprecated.
Richard M. Stallman's avatar
Richard M. Stallman committed
899 900 901
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
902 903 904 905 906 907 908 909 910
  (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))