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

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

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

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

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

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

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Roland McGrath's avatar
Roland McGrath committed
23

24 25 26 27 28 29
;;; Commentary:

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

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

32 33
(eval-when-compile (require 'cl))

34 35
(defvar font-lock-keywords)

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

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


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

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

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

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
63

64 65 66
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.
67

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

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

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

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

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

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

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

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

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

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

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

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

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

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

194
(defcustom temporary-file-directory
195 196 197 198 199
  (file-name-as-directory
   (cond ((memq system-type '(ms-dos windows-nt))
	  (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
	 (t
	  (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
200 201
  "The directory for writing temporary files."
  :group 'files
202
  :initialize 'custom-initialize-delay
203
  :type 'directory)
204

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

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

218 219
(declare-function msdos-long-file-names "msdos.c")
(declare-function w32-long-file-name "w32proc.c")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
220 221 222 223 224
(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
225
(declare-function dosified-file-name "dos-fns" (file-name))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
226

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

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

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

See also: `break-hardlink-on-save'."
260 261
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
262

Karl Fogel's avatar
Karl Fogel committed
263 264
(defcustom break-hardlink-on-save nil
  "Non-nil means when saving a file that exists under several names
265
\(i.e., has multiple hardlinks), break the hardlink associated with
Karl Fogel's avatar
Karl Fogel committed
266 267 268 269 270 271 272
`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
273
itself writable, then error instead of saving in some
Karl Fogel's avatar
Karl Fogel committed
274 275 276 277
hardlink-nonbreaking way.

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

281
(defcustom version-control nil
282
  "Control use of version numbers for backup files.
283 284 285
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."
286 287 288
  :type '(choice (const :tag "Never" never)
		 (const :tag "If existing" nil)
		 (other :tag "Always" t))
289 290
  :group 'backup
  :group 'vc)
291 292
(put 'version-control 'safe-local-variable
     '(lambda (x) (or (booleanp x) (equal x 'never))))
293 294

(defcustom dired-kept-versions 2
295
  "When cleaning directory, number of versions to keep."
296 297 298 299 300
  :type 'integer
  :group 'backup
  :group 'dired)

(defcustom delete-old-versions nil
301
  "If t, delete excess backup versions silently.
302 303 304
If nil, ask confirmation.  Any other value prevents any trimming."
  :type '(choice (const :tag "Delete" t)
		 (const :tag "Ask" nil)
305
		 (other :tag "Leave" other))
306 307 308
  :group 'backup)

(defcustom kept-old-versions 2
309
  "Number of oldest versions to keep when a new numbered backup is made."
310 311
  :type 'integer
  :group 'backup)
312
(put 'kept-old-versions 'safe-local-variable 'integerp)
313 314

(defcustom kept-new-versions 2
315
  "Number of newest versions to keep when a new numbered backup is made.
316 317 318
Includes the new backup.  Must be > 0"
  :type 'integer
  :group 'backup)
319
(put 'kept-new-versions 'safe-local-variable 'integerp)
Roland McGrath's avatar
Roland McGrath committed
320

321
(defcustom require-final-newline nil
322
  "Whether to add a newline automatically at the end of the file.
323 324 325 326 327

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.
328
A value of nil means don't add newlines.
329 330 331 332 333 334

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

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

350 351 352 353
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."
354 355 356
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
357 358
		 (const :tag "Don't add newlines" nil)
		 (other :tag "Ask each time" ask))
359
  :group 'editing-basics
360
  :version "22.1")
361

362
(defcustom auto-save-default t
363
  "Non-nil says by default do auto-saving of every file-visiting buffer."
364 365
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
366

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

387 388
The default value is set up to put the auto-save file into the
temporary directory (see the variable `temporary-file-directory') for
389 390 391 392
editing a remote file.

On MS-DOS filesystems without long names this variable is always
ignored."
André Spiegel's avatar
André Spiegel committed
393
  :group 'auto-save
394 395
  :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
					   (boolean :tag "Uniquify")))
396
  :initialize 'custom-initialize-delay
André Spiegel's avatar
André Spiegel committed
397 398
  :version "21.1")

399
(defcustom save-abbrevs t
400
  "Non-nil means save word abbrevs too when files are saved.
401 402
If `silently', don't ask the user before saving."
  :type '(choice (const t) (const nil) (const silently))
403
  :group 'abbrev)
Roland McGrath's avatar
Roland McGrath committed
404

405
(defcustom find-file-run-dired t
406
  "Non-nil means allow `find-file' to visit directories.
André Spiegel's avatar
André Spiegel committed
407
To visit the directory, `find-file' runs `find-directory-functions'."
408 409
  :type 'boolean
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
410

André Spiegel's avatar
André Spiegel committed
411
(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
412
  "List of functions to try in sequence to visit a directory.
André Spiegel's avatar
André Spiegel committed
413 414 415 416 417
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)

418 419 420 421 422 423 424 425
;; 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)

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

436 437
;;;It is not useful to make this a local variable.
;;;(put 'find-file-hooks 'permanent-local t)
438
(define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
Dave Love's avatar
Dave Love committed
439
(defcustom find-file-hook nil
Roland McGrath's avatar
Roland McGrath committed
440 441
  "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
442 443 444 445
functions are called."
  :group 'find-file
  :type 'hook
  :options '(auto-insert)
446
  :version "22.1")
Roland McGrath's avatar
Roland McGrath committed
447

Stefan Monnier's avatar
Stefan Monnier committed
448
(defvar write-file-functions nil
Roland McGrath's avatar
Roland McGrath committed
449 450
  "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
451 452
and the rest are not called.
These hooks are considered to pertain to the visited file.
Stefan Monnier's avatar
Stefan Monnier committed
453 454 455 456
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.

457 458 459 460 461
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
462
updates before the buffer is saved, use `before-save-hook'.")
Stefan Monnier's avatar
Stefan Monnier committed
463
(put 'write-file-functions 'permanent-local t)
464
(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
465 466

(defvar local-write-file-hooks nil)
467 468
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
469
(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
Jim Blandy's avatar
Jim Blandy committed
470

Stefan Monnier's avatar
Stefan Monnier committed
471
(defvar write-contents-functions nil
Jim Blandy's avatar
Jim Blandy committed
472 473
  "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
474 475
and the rest are not called and neither are the functions in
`write-file-functions'.
476 477 478 479

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
480 481
major mode does clear it.

482 483 484 485 486
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
487
(make-variable-buffer-local 'write-contents-functions)
488 489
(define-obsolete-variable-alias 'write-contents-hooks
    'write-contents-functions "22.1")
Roland McGrath's avatar
Roland McGrath committed
490

491
(defcustom enable-local-variables t
492
  "Control use of local variables in files you visit.
493
The value can be t, nil, :safe, :all, or something else.
494 495

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

:safe means set the safe variables, and ignore the rest.
501 502
:all means set all variables, whether safe or not.
 (Don't set it permanently to :all.)
503
A value of nil means always ignore the file local variables.
504 505

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

509 510
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
511

512 513 514
The command \\[normal-mode], when used interactively,
always obeys file local variable specifications and the -*- line,
and ignores this variable."
515
  :risky t
516
  :type '(choice (const :tag "Query Unsafe" t)
517
		 (const :tag "Safe Only" :safe)
518
		 (const :tag "Do all" :all)
519
		 (const :tag "Ignore" nil)
520
		 (other :tag "Query" other))
521
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
522

523 524
(defvar local-enable-local-variables t
  "Like `enable-local-variables' but meant for buffer-local bindings.
525
The meaningful values are nil and non-nil.  The default is non-nil.
526
If a major mode sets this to nil, buffer-locally, then any local
527 528 529 530
variables list in the file will be ignored.

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

532
(defcustom enable-local-eval 'maybe
533
  "Control processing of the \"variable\" `eval' in a file's local variables.
534
The value can be t, nil or something else.
535
A value of t means obey `eval' variables.
536
A value of nil means ignore them; anything else means query."
537
  :risky t
538 539
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
540
		 (other :tag "Query" other))
541
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
542 543 544

;; Avoid losing in versions where CLASH_DETECTION is disabled.
(or (fboundp 'lock-buffer)
545
    (defalias 'lock-buffer 'ignore))
Roland McGrath's avatar
Roland McGrath committed
546
(or (fboundp 'unlock-buffer)
547
    (defalias 'unlock-buffer 'ignore))
548 549
(or (fboundp 'file-locked-p)
    (defalias 'file-locked-p 'ignore))
550

551
(defcustom view-read-only nil
552
  "Non-nil means buffers visiting files read-only do so in view mode.
553 554 555 556
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]."
557 558
  :type 'boolean
  :group 'view)
559

560
(defvar file-name-history nil
561 562 563 564
  "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.")
565

566
(put 'ange-ftp-completion-hook-function 'safe-magic t)
567
(defun ange-ftp-completion-hook-function (op &rest args)
André Spiegel's avatar
André Spiegel committed
568 569 570 571
  "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.
572 573
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
574 575 576 577 578
    (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))
579
      (apply op args))))
580 581

(defun convert-standard-filename (filename)
582
  "Convert a standard file's name to something suitable for the OS.
583 584 585
This means to guarantee valid names and perhaps to canonicalize
certain patterns.

586 587 588 589
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.

590 591
This function's standard definition is trivial; it just returns
the argument.  However, on Windows and DOS, replace invalid
592 593 594
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
595 596 597
`w32-shell-dos-semantics').

See Info node `(elisp)Standard File Names' for more details."
598 599 600 601 602
  (if (eq system-type 'cygwin)
      (let ((name (copy-sequence filename))
	    (start 0))
	;; Replace invalid filename characters with !
	(while (string-match "[?*:<>|\"\000-\037]" name start)
603
	       (aset name (match-beginning 0) ?!)
604 605 606
	  (setq start (match-end 0)))
	name)
    filename))
607 608 609 610

(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.
611 612
Default name to DEFAULT-DIRNAME if user exits with the same
non-empty string that was inserted by this function.
613 614
 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
  or just DIR if INITIAL is nil.)
615 616 617
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.)
618 619 620
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.
621 622
DIR should be an absolute directory name.  It defaults to
the value of `default-directory'."
623 624
  (unless dir
    (setq dir default-directory))
625
  (read-file-name prompt dir (or default-dirname
626 627 628
				 (if initial (expand-file-name initial dir)
				   dir))
		  mustmatch initial
629 630
		  'file-directory-p))

Roland McGrath's avatar
Roland McGrath committed
631 632 633 634 635 636

(defun pwd ()
  "Show the current default directory."
  (interactive nil)
  (message "Directory %s" default-directory))

637 638
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
639
Not actually set up until the first time you use it.")
640 641

(defun parse-colon-path (cd-path)
642
  "Explode a search path into a list of directory names.
643 644
Directories are separated by occurrences of `path-separator'
\(which is colon in GNU and GNU-like systems)."
André Spiegel's avatar
André Spiegel committed
645
  ;; We could use split-string here.
646
  (and cd-path
647
       (let (cd-list (cd-start 0) cd-colon)
648 649
	 (setq cd-path (concat cd-path path-separator))
	 (while (setq cd-colon (string-match path-separator cd-path cd-start))
650
	   (setq cd-list
651
		 (nconc cd-list
652 653 654
			(list (if (= cd-start cd-colon)
				   nil
				(substitute-in-file-name
655 656
				 (file-name-as-directory
				  (substring cd-path cd-start cd-colon)))))))
657 658 659 660
	   (setq cd-start (+ cd-colon 1)))
	 cd-list)))

(defun cd-absolute (dir)
661
  "Change current directory to given absolute file name DIR."
662 663
  ;; Put the name into directory syntax now,
  ;; because otherwise expand-file-name may give some bad results.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
664
  (setq dir (file-name-as-directory dir))
665 666 667 668 669 670
  ;; 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
671
  (if (not (file-directory-p dir))
672 673
      (if (file-exists-p dir)
	  (error "%s is not a directory" dir)
674
	(error "%s: no such directory" dir))
675 676 677
    (unless (file-executable-p dir)
      (error "Cannot cd to %s:  Permission denied" dir))
    (setq default-directory dir)
678
    (setq list-buffers-directory dir)))
Roland McGrath's avatar
Roland McGrath committed
679

680 681
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
682 683
If your environment includes a `CDPATH' variable, try each one of
that list of directories (separated by occurrences of
684 685
`path-separator') when resolving a relative directory name.
The path separator is colon in GNU and GNU-like systems."
686
  (interactive
687
   (list (read-directory-name "Change default directory: "
688 689 690
			 default-directory default-directory
			 (and (member cd-path '(nil ("./")))
			      (null (getenv "CDPATH"))))))
691 692 693 694 695 696
  (if (file-name-absolute-p dir)
      (cd-absolute (expand-file-name dir))
    (if (null cd-path)
	(let ((trypath (parse-colon-path (getenv "CDPATH"))))
	  (setq cd-path (or trypath (list "./")))))
    (if (not (catch 'found
697
	       (mapc
698 699 700 701 702 703 704 705 706
		(function (lambda (x)
			    (let ((f (expand-file-name (concat x dir))))
			      (if (file-directory-p f)
				  (progn
				    (cd-absolute f)
				    (throw 'found t))))))
		cd-path)
	       nil))
	(error "No such directory found via CDPATH environment variable"))))
707

Roland McGrath's avatar
Roland McGrath committed
708 709
(defun load-file (file)
  "Load the Lisp file named FILE."
710 711
  ;; This is a case where .elc makes a lot of sense.
  (interactive (list (let ((completion-ignored-extensions
Dave Love's avatar
Dave Love committed
712
			    (remove ".elc" completion-ignored-extensions)))
713 714
		       (read-file-name "Load file: "))))
  (load (expand-file-name file) nil nil t))
Roland McGrath's avatar
Roland McGrath committed
715

Stefan Monnier's avatar
Stefan Monnier committed
716 717
(defun locate-file (filename path &optional suffixes predicate)
  "Search for FILENAME through PATH.
Eli Zaretskii's avatar
Eli Zaretskii committed
718 719 720 721
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
722 723
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
724
Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
Stefan Monnier's avatar
Stefan Monnier committed
725
If non-nil, PREDICATE is used instead of `file-readable-p'.
Richard M. Stallman's avatar
Richard M. Stallman committed
726 727 728 729 730 731
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
732 733 734 735 736 737 738 739 740
  (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))

741 742
(defun locate-file-completion-table (dirs suffixes string pred action)
  "Do completion for file names passed to `locate-file'."
743 744
  (cond
   ((file-name-absolute-p string)
745 746 747 748
    ;; 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))
749 750
   ((eq (car-safe action) 'boundaries)
    (let ((suffix (cdr action)))
751
      (list* 'boundaries
752 753 754 755
             (length (file-name-directory string))
             (let ((x (file-name-directory suffix)))
               (if x (1- (length x)) (length suffix))))))
   (t
756
    (let ((names nil)
757
	  (suffix (concat (regexp-opt suffixes t) "\\'"))
758 759
	  (string-dir (file-name-directory string))
          (string-file (file-name-nondirectory string)))
760
      (dolist (dir dirs)
761 762
	(unless dir
	  (setq dir default-directory))
763 764 765
	(if string-dir (setq dir (expand-file-name string-dir dir)))
	(when (file-directory-p dir)
	  (dolist (file (file-name-all-completions
766 767
			 string-file dir))
	    (push file names)
768 769
	    (when (string-match suffix file)
	      (setq file (substring file 0 (match-beginning 0)))
770 771 772
              (push file names)))))
      (completion-table-with-context
       string-dir names string-file pred action)))))
773 774 775 776 777 778 779 780

(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)."
  (locate-file-completion-table (car path-and-suffixes)
                                (cdr path-and-suffixes)
                                string nil action))
(make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
781

782
(defvar locate-dominating-stop-dir-regexp
783
  (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
784 785 786 787 788
  "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
789 790
special files in directories in which filenames are interpreted as hostnames,
or mount points potentially requiring authentication as a different user.")
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823

;; (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)))

(defun locate-dominating-file (file name)
  "Look up the directory hierarchy from FILE for a file named NAME.
824 825
Stop at the first parent directory containing a file NAME,
and return the directory.  Return nil if not found."
826 827 828
  ;; We used to use the above locate-dominating-files code, but the
  ;; directory-files call is very costly, so we're much better off doing
  ;; multiple calls using the code in here.
829
  ;;
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
  ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
  ;; `name' in /home or in /.
  (setq file (abbreviate-file-name file))
  (let ((root nil)
        (prev-file file)
        ;; `user' is not initialized outside the loop because
        ;; `file' may not exist, so we may have to walk up part of the
        ;; hierarchy before we find the "initial UID".
        (user nil)
        try)
    (while (not (or root
                    (null file)
                    ;; FIXME: Disabled this heuristic because it is sometimes
                    ;; inappropriate.
                    ;; 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 file)))
                    ;;   (and prev-user (not (equal user prev-user))))
                    (string-match locate-dominating-stop-dir-regexp file)))
      (setq try (file-exists-p (expand-file-name name file)))