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

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

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

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

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

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

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

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

35 36
(defvar font-lock-keywords)

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

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


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

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

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

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

Roland McGrath's avatar
Roland McGrath committed
66 67
Use this feature when you have directories which you normally refer to
via absolute symbolic links.  Make TO the name of the link, and FROM
68 69
the name it is linked to."
  :type '(repeat (cons :format "%v"
70
		       :value ("\\`" . "")
71
		       (regexp :tag "From")
72
		       (string :tag "To")))
73 74
  :group 'abbrev
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
75

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

See also: `break-hardlink-on-save'."
257 258
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
259

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

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

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

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

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

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

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

318
(defcustom require-final-newline nil
319
  "Whether to add a newline automatically at the end of the file.
320 321 322 323 324

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.
325
A value of nil means don't add newlines.
326 327 328 329 330 331

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

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

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

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

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

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

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

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

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

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

415 416 417 418 419 420 421 422
;; 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)

423 424
;;;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
425
(defvar find-file-not-found-functions nil
Roland McGrath's avatar
Roland McGrath committed
426 427
  "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
428
Variable `buffer-file-name' is already set up.
Roland McGrath's avatar
Roland McGrath committed
429
The functions are called in the order given until one of them returns non-nil.")
430 431
(define-obsolete-variable-alias 'find-file-not-found-hooks
    'find-file-not-found-functions "22.1")
Roland McGrath's avatar
Roland McGrath committed
432

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

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

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

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

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

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
477 478
major mode does clear it.

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

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

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

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

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

506 507
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
508

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

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

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

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

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

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

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

578 579 580
(declare-function dos-convert-standard-filename "dos-fns.el" (filename))
(declare-function w32-convert-standard-filename "w32-fns.el" (filename))

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 603 604 605 606 607 608 609 610 611
  (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)))
612 613 614 615

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

Roland McGrath's avatar
Roland McGrath committed
636 637 638 639 640 641

(defun pwd ()
  "Show the current default directory."
  (interactive nil)
  (message "Directory %s" default-directory))

642 643
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
644
Not actually set up until the first time you use it.")
645 646

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

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

685 686
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
687 688
If your environment includes a `CDPATH' variable, try each one of
that list of directories (separated by occurrences of
689 690
`path-separator') when resolving a relative directory name.
The path separator is colon in GNU and GNU-like systems."
691
  (interactive
692
   (list (read-directory-name "Change default directory: "
693 694 695
			 default-directory default-directory
			 (and (member cd-path '(nil ("./")))
			      (null (getenv "CDPATH"))))))
696 697 698 699 700 701
  (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
702
	       (mapc
703 704 705 706 707 708 709 710 711
		(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"))))
712

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

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

746 747
(defun locate-file-completion-table (dirs suffixes string pred action)
  "Do completion for file names passed to `locate-file'."
748 749
  (cond
   ((file-name-absolute-p string)
750 751 752 753
    ;; 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))
754 755
   ((eq (car-safe action) 'boundaries)
    (let ((suffix (cdr action)))
756
      (list* 'boundaries
757 758 759 760
             (length (file-name-directory string))
             (let ((x (file-name-directory suffix)))
               (if x (1- (length x)) (length suffix))))))
   (t
761 762 763 764 765 766 767 768 769 770 771
    (let ((names '())
          ;; If we have files like "foo.el" and "foo.elc", we could load one of
          ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
          ;; preferred way.  So if we list all 3, that gives a lot of redundant
          ;; entries for the poor soul looking just for "foo".  OTOH, sometimes
          ;; the user does want to pay attention to the extension.  We try to
          ;; diffuse this tension by stripping the suffix, except when the
          ;; result is a single element (i.e. usually we only list "foo" unless
          ;; it's the only remaining element in the list, in which case we do
          ;; list "foo", "foo.elc" and "foo.el").
          (fullnames '())
772
	  (suffix (concat (regexp-opt suffixes t) "\\'"))
773 774
	  (string-dir (file-name-directory string))
          (string-file (file-name-nondirectory string)))
775
      (dolist (dir dirs)
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
        (unless dir
          (setq dir default-directory))
        (if string-dir (setq dir (expand-file-name string-dir dir)))
        (when (file-directory-p dir)
          (dolist (file (file-name-all-completions
                         string-file dir))
            (if (not (string-match suffix file))
                (push file names)
              (push file fullnames)
              (push (substring file 0 (match-beginning 0)) names)))))
      ;; Switching from names to names+fullnames creates a non-monotonicity
      ;; which can cause problems with things like partial-completion.
      ;; To minimize the problem, filter out completion-regexp-list, so that
      ;; M-x load-library RET t/x.e TAB finds some files.
      (if completion-regexp-list
          (setq names (all-completions "" names)))
      ;; Remove duplicates of the first element, so that we can easily check
      ;; if `names' really only contains a single element.
      (when (cdr names) (setcdr names (delete (car names) (cdr names))))
      (unless (cdr names)
        ;; There's no more than one matching non-suffixed element, so expand
        ;; the list by adding the suffixed elements as well.
        (setq names (nconc names fullnames)))
799 800
      (completion-table-with-context
       string-dir names string-file pred action)))))
801 802 803 804 805 806 807 808

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

810
(defvar locate-dominating-stop-dir-regexp
811
  (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
812 813 814 815 816
  "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
817 818
special files in directories in which filenames are interpreted as hostnames,
or mount points potentially requiring authentication as a different user.")
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851

;; (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.
852 853
Stop at the first parent directory containing a file NAME,
and return the directory.  Return nil if not found."
854 855 856
  ;; 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.
857
  ;;
858 859 860 861 862 863 864 865