files.el 248 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,
Glenn Morris's avatar
Glenn Morris committed
5
;;   2006, 2007, 2008, 2009 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 59 60
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.
*Every* FROM string should start with `^'.

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

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

Dan Nicolaescu's avatar
Dan Nicolaescu committed
75
(defcustom make-backup-files t
76
  "Non-nil means make a backup of a file the first time it is saved.
Roland McGrath's avatar
Roland McGrath committed
77 78 79 80 81 82 83 84 85 86 87 88 89
This can be done by renaming the file or by copying.

Renaming means that Emacs renames the existing file so that it is a
backup file, then writes the buffer into a new file.  Any other names
that the old file had will now refer to the backup file.  The new file
is owned by you and its group is defaulted.

Copying means that Emacs copies the existing file into the backup
file, then writes the buffer on top of the existing file.  Any other
names that the old file had will now refer to the new (edited) file.
The file's owner and group are unchanged.

The choice of renaming or copying is controlled by the variables
André Spiegel's avatar
André Spiegel committed
90 91 92
`backup-by-copying', `backup-by-copying-when-linked',
`backup-by-copying-when-mismatch' and
`backup-by-copying-when-privileged-mismatch'.  See also `backup-inhibited'."
93 94
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
95 96 97 98

;; Do this so that local variables based on the file name
;; are not overridden by the major mode.
(defvar backup-inhibited nil
99 100 101
  "Non-nil means don't make a backup, regardless of the other parameters.
This variable is intended for use by making it local to a buffer.
But it is local only if you make it local.")
Roland McGrath's avatar
Roland McGrath committed
102 103
(put 'backup-inhibited 'permanent-local t)

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

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

117
(defcustom backup-by-copying-when-mismatch nil
118
  "Non-nil means create backups by copying if this preserves owner or group.
Roland McGrath's avatar
Roland McGrath committed
119 120 121 122
Renaming may still be used (subject to control of other variables)
when it would not result in changing the owner or group of the file;
that is, for files which are owned by you and whose group matches
the default for a new file created there by you.
123 124 125
This variable is relevant only if `backup-by-copying' is nil."
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
126

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

See also: `break-hardlink-on-save'."
252 253
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
254

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

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

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

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

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

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

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

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

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

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

331
(defcustom mode-require-final-newline t
332
  "Whether to add a newline at end of file, in certain major modes.
333
Those modes set `require-final-newline' to this value when you enable them.
334
They do so because they are often used for files that are supposed
335 336 337 338 339
to end in newlines, and the question is how to arrange that.

A value of t means do this only when the file is about to be saved.
A value of `visit' means do this right after the file is visited.
A value of `visit-save' means do it at both of those times.
340 341
Any other non-nil value means ask user whether to add a newline, when saving.

342 343 344 345
A value of nil means do not add newlines.  That is a risky choice in this
variable since this value is used for modes for files that ought to have
final newlines.  So if you set this to nil, you must explicitly check and
add a final newline, whenever you save a file that really needs one."
346 347 348
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
349 350
		 (const :tag "Don't add newlines" nil)
		 (other :tag "Ask each time" ask))
351
  :group 'editing-basics
352
  :version "22.1")
353

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

André Spiegel's avatar
André Spiegel committed
359
(defcustom auto-save-file-name-transforms
360
  `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
361 362
     ;; Don't put "\\2" inside expand-file-name, since it will be
     ;; transformed to "/2" on DOS/Windows.
363
     ,(concat temporary-file-directory "\\2") t))
364
  "Transforms to apply to buffer file name before making auto-save file name.
365
Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
André Spiegel's avatar
André Spiegel committed
366 367 368
REGEXP is a regular expression to match against the file name.
If it matches, `replace-match' is used to replace the
matching part with REPLACEMENT.
369
If the optional element UNIQUIFY is non-nil, the auto-save file name is
370
constructed by taking the directory part of the replaced file-name,
371 372 373 374
concatenated with the buffer file name with all directory separators
changed to `!' to prevent clashes.  This will not work
correctly if your filesystem truncates the resulting name.

André Spiegel's avatar
André Spiegel committed
375 376 377 378
All the transforms in the list are tried, in the order they are listed.
When one transform applies, its result is final;
no further transforms are tried.

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

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

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

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

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

409 410
;;;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
411
(defvar find-file-not-found-functions nil
Roland McGrath's avatar
Roland McGrath committed
412 413
  "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
414
Variable `buffer-file-name' is already set up.
Roland McGrath's avatar
Roland McGrath committed
415
The functions are called in the order given until one of them returns non-nil.")
416 417
(define-obsolete-variable-alias 'find-file-not-found-hooks
    'find-file-not-found-functions "22.1")
Roland McGrath's avatar
Roland McGrath committed
418

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

Stefan Monnier's avatar
Stefan Monnier committed
431
(defvar write-file-functions nil
Roland McGrath's avatar
Roland McGrath committed
432 433
  "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
434 435
and the rest are not called.
These hooks are considered to pertain to the visited file.
Stefan Monnier's avatar
Stefan Monnier committed
436 437 438 439
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.

440 441 442 443 444
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
445
updates before the buffer is saved, use `before-save-hook'.")
Stefan Monnier's avatar
Stefan Monnier committed
446
(put 'write-file-functions 'permanent-local t)
447
(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
Stefan Monnier's avatar
Stefan Monnier committed
448 449

(defvar local-write-file-hooks nil)
450 451
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
452
(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
Jim Blandy's avatar
Jim Blandy committed
453

Stefan Monnier's avatar
Stefan Monnier committed
454
(defvar write-contents-functions nil
Jim Blandy's avatar
Jim Blandy committed
455 456
  "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
457 458
and the rest are not called and neither are the functions in
`write-file-functions'.
459 460 461 462

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
463 464
major mode does clear it.

465 466 467 468 469
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
470
(make-variable-buffer-local 'write-contents-functions)
471 472
(define-obsolete-variable-alias 'write-contents-hooks
    'write-contents-functions "22.1")
Roland McGrath's avatar
Roland McGrath committed
473

474
(defcustom enable-local-variables t
475
  "Control use of local variables in files you visit.
476
The value can be t, nil, :safe, :all, or something else.
477 478

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

:safe means set the safe variables, and ignore the rest.
484 485
:all means set all variables, whether safe or not.
 (Don't set it permanently to :all.)
486
A value of nil means always ignore the file local variables.
487 488

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

492 493
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
494

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

506 507
(defvar local-enable-local-variables t
  "Like `enable-local-variables' but meant for buffer-local bindings.
508
The meaningful values are nil and non-nil.  The default is non-nil.
509
If a major mode sets this to nil, buffer-locally, then any local
510 511 512 513
variables list in the file will be ignored.

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

515
(defcustom enable-local-eval 'maybe
516
  "Control processing of the \"variable\" `eval' in a file's local variables.
517
The value can be t, nil or something else.
518
A value of t means obey `eval' variables.
519
A value of nil means ignore them; anything else means query."
520
  :risky t
521 522
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
523
		 (other :tag "Query" other))
524
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
525 526 527

;; Avoid losing in versions where CLASH_DETECTION is disabled.
(or (fboundp 'lock-buffer)
528
    (defalias 'lock-buffer 'ignore))
Roland McGrath's avatar
Roland McGrath committed
529
(or (fboundp 'unlock-buffer)
530
    (defalias 'unlock-buffer 'ignore))
531 532
(or (fboundp 'file-locked-p)
    (defalias 'file-locked-p 'ignore))
533

534
(defcustom view-read-only nil
535
  "Non-nil means buffers visiting files read-only do so in view mode.
536 537 538 539
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]."
540 541
  :type 'boolean
  :group 'view)
542

543
(defvar file-name-history nil
544 545 546 547
  "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.")
548

549
(put 'ange-ftp-completion-hook-function 'safe-magic t)
550
(defun ange-ftp-completion-hook-function (op &rest args)
André Spiegel's avatar
André Spiegel committed
551 552 553 554
  "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.
555 556
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
557 558 559 560 561
    (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))
562
      (apply op args))))
563 564

(defun convert-standard-filename (filename)
565
  "Convert a standard file's name to something suitable for the OS.
566 567 568
This means to guarantee valid names and perhaps to canonicalize
certain patterns.

569 570 571 572
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.

573 574
This function's standard definition is trivial; it just returns
the argument.  However, on Windows and DOS, replace invalid
575 576 577
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
578 579 580
`w32-shell-dos-semantics').

See Info node `(elisp)Standard File Names' for more details."
581 582 583 584 585
  (if (eq system-type 'cygwin)
      (let ((name (copy-sequence filename))
	    (start 0))
	;; Replace invalid filename characters with !
	(while (string-match "[?*:<>|\"\000-\037]" name start)
586
	       (aset name (match-beginning 0) ?!)
587 588 589
	  (setq start (match-end 0)))
	name)
    filename))
590 591 592 593

(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.
594 595
Default name to DEFAULT-DIRNAME if user exits with the same
non-empty string that was inserted by this function.
596 597
 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
  or just DIR if INITIAL is nil.)
598 599 600
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.)
601 602 603
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.
604 605
DIR should be an absolute directory name.  It defaults to
the value of `default-directory'."
606 607
  (unless dir
    (setq dir default-directory))
608
  (read-file-name prompt dir (or default-dirname
609 610 611
				 (if initial (expand-file-name initial dir)
				   dir))
		  mustmatch initial
612 613
		  'file-directory-p))

Roland McGrath's avatar
Roland McGrath committed
614 615 616 617 618 619

(defun pwd ()
  "Show the current default directory."
  (interactive nil)
  (message "Directory %s" default-directory))

620 621
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
622
Not actually set up until the first time you use it.")
623 624

(defun parse-colon-path (cd-path)
625
  "Explode a search path into a list of directory names.
626 627
Directories are separated by occurrences of `path-separator'
\(which is colon in GNU and GNU-like systems)."
André Spiegel's avatar
André Spiegel committed
628
  ;; We could use split-string here.
629
  (and cd-path
630
       (let (cd-list (cd-start 0) cd-colon)
631 632
	 (setq cd-path (concat cd-path path-separator))
	 (while (setq cd-colon (string-match path-separator cd-path cd-start))
633
	   (setq cd-list
634
		 (nconc cd-list
635 636 637
			(list (if (= cd-start cd-colon)
				   nil
				(substitute-in-file-name
638 639
				 (file-name-as-directory
				  (substring cd-path cd-start cd-colon)))))))
640 641 642 643
	   (setq cd-start (+ cd-colon 1)))
	 cd-list)))

(defun cd-absolute (dir)
644
  "Change current directory to given absolute file name DIR."
645 646
  ;; Put the name into directory syntax now,
  ;; because otherwise expand-file-name may give some bad results.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
647
  (setq dir (file-name-as-directory dir))
648
  (setq dir (abbreviate-file-name (expand-file-name dir)))
Roland McGrath's avatar
Roland McGrath committed
649
  (if (not (file-directory-p dir))
650 651
      (if (file-exists-p dir)
	  (error "%s is not a directory" dir)
652
	(error "%s: no such directory" dir))
653 654 655 656
    (unless (file-executable-p dir)
      (error "Cannot cd to %s:  Permission denied" dir))
    (setq default-directory dir)
    (set (make-local-variable 'list-buffers-directory) dir)))
Roland McGrath's avatar
Roland McGrath committed
657

658 659
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
660 661
If your environment includes a `CDPATH' variable, try each one of
that list of directories (separated by occurrences of
662 663
`path-separator') when resolving a relative directory name.
The path separator is colon in GNU and GNU-like systems."
664
  (interactive
665
   (list (read-directory-name "Change default directory: "
666 667 668
			 default-directory default-directory
			 (and (member cd-path '(nil ("./")))
			      (null (getenv "CDPATH"))))))
669 670 671 672 673 674
  (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
675
	       (mapc
676 677 678 679 680 681 682 683 684
		(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"))))
685

Roland McGrath's avatar
Roland McGrath committed
686 687
(defun load-file (file)
  "Load the Lisp file named FILE."
688 689
  ;; This is a case where .elc makes a lot of sense.
  (interactive (list (let ((completion-ignored-extensions
Dave Love's avatar
Dave Love committed
690
			    (remove ".elc" completion-ignored-extensions)))
691 692
		       (read-file-name "Load file: "))))
  (load (expand-file-name file) nil nil t))
Roland McGrath's avatar
Roland McGrath committed
693

Stefan Monnier's avatar
Stefan Monnier committed
694 695
(defun locate-file (filename path &optional suffixes predicate)
  "Search for FILENAME through PATH.
Eli Zaretskii's avatar
Eli Zaretskii committed
696 697 698 699
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
700 701
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
702
Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
Stefan Monnier's avatar
Stefan Monnier committed
703
If non-nil, PREDICATE is used instead of `file-readable-p'.
Richard M. Stallman's avatar
Richard M. Stallman committed
704 705 706 707 708 709
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
710 711 712 713 714 715 716 717 718
  (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))

719 720
(defun locate-file-completion-table (dirs suffixes string pred action)
  "Do completion for file names passed to `locate-file'."
721 722 723 724 725 726
  (cond
   ((file-name-absolute-p string)
    (let ((read-file-name-predicate pred))
      (read-file-name-internal string nil action)))
   ((eq (car-safe action) 'boundaries)
    (let ((suffix (cdr action)))
727
      (list* 'boundaries
728 729 730 731
             (length (file-name-directory string))
             (let ((x (file-name-directory suffix)))
               (if x (1- (length x)) (length suffix))))))
   (t
732
    (let ((names nil)
733
	  (suffix (concat (regexp-opt suffixes t) "\\'"))
734 735
	  (string-dir (file-name-directory string))
          (string-file (file-name-nondirectory string)))
736
      (dolist (dir dirs)
737 738
	(unless dir
	  (setq dir default-directory))
739 740 741
	(if string-dir (setq dir (expand-file-name string-dir dir)))
	(when (file-directory-p dir)
	  (dolist (file (file-name-all-completions
742 743
			 string-file dir))
	    (push file names)
744 745
	    (when (string-match suffix file)
	      (setq file (substring file 0 (match-beginning 0)))
746 747 748
              (push file names)))))
      (completion-table-with-context
       string-dir names string-file pred action)))))
749 750 751 752 753 754 755 756

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

758
(defvar locate-dominating-stop-dir-regexp
759
  "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
760 761 762 763 764
  "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
765 766
special files in directories in which filenames are interpreted as hostnames,
or mount points potentially requiring authentication as a different user.")
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799

;; (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.
800 801
Stop at the first parent directory containing a file NAME,
and return the directory.  Return nil if not found."
802 803 804
  ;; 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.
805
  ;;
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
  ;; 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)))
      (cond (try (setq root file))
            ((equal file (setq prev-file file
                               file (file-name-directory
                                     (directory-file-name file))))
             (setq file nil))))
    root))

837

838 839 840 841 842 843 844
(defun executable-find (command)
  "Search for COMMAND in `exec-path' and return the absolute file name.
Return nil if COMMAND is not found anywhere in `exec-path'."
  ;; Use 1 rather than file-executable-p to better match the behavior of
  ;; call-process.
  (locate-file command exec-path exec-suffixes 1))

Roland McGrath's avatar
Roland McGrath committed
845
(defun load-library (library)
846
  "Load the Emacs Lisp library named LIBRARY.
847 848 849 850 851 852
This is an interface to the function `load'.  LIBRARY is searched
for in `load-path', both with and without `load-suffixes' (as
well as `load-file-rep-suffixes').

See Info node `(emacs)Lisp Libraries' for more details.
See `load-file' for a different interface to `load'."
Stefan Monnier's avatar
Stefan Monnier committed
853 854
  (interactive
   (list (completing-read "Load library: "
855 856 857
			  (apply-partially 'locate-file-completion-table
                                           load-path
                                           (get-load-suffixes)))))
Roland McGrath's avatar
Roland McGrath committed
858
  (load library))
859

860
(defun file-remote-p (file &optional identification connected)
861
  "Test whether FILE specifies a location on a remote system.
862 863 864 865 866 867
Returns nil or a string identifying the remote connection (ideally
a prefix of FILE).  For example, the remote identification for filename
\"/user@host:/foo\" could be \"/user@host:\".
A file is considered \"remote\" if accessing it is likely to be slower or
less reliable than accessing local files.
Furthermore, relative file names do not work across remote connections.
868

869 870
IDENTIFICATION specifies which part of the identification shall
be returned as string.  IDENTIFICATION can be the symbol
871 872 873
`method', `user', `host' or `localname'; any other value is
handled like nil and means to return the complete identification
string.
Michael Albinus's avatar