files.el 191 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,86,87,92,93,94,95,96,97,98,99,2000,01,02,03,2004
4
;;;   Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
5

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

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

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

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

;; You should have received a copy of the GNU General Public License
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
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
(defgroup backup nil
  "Backups of edited data files."
35
  :group 'files)
Roland McGrath's avatar
Roland McGrath committed
36

37
(defgroup find-file nil
38 39
  "Finding files."
  :group 'files)
40 41 42


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

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

(defcustom directory-abbrev-alist
Roland McGrath's avatar
Roland McGrath committed
51 52 53 54 55 56 57
  nil
  "*Alist of abbreviations for file directories.
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 `^'.

58 59 60
Do not use `~' in the TO strings.
They should be ordinary absolute directory names.

Roland McGrath's avatar
Roland McGrath committed
61 62
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
63 64 65 66 67 68 69
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
70

71
;; Turn off backup files on VMS since it has version numbers.
72
(defcustom make-backup-files (not (eq system-type 'vax-vms))
73
  "*Non-nil means make a backup of a file the first time it is saved.
Roland McGrath's avatar
Roland McGrath committed
74 75 76 77 78 79 80 81 82 83 84 85 86
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
87 88 89
`backup-by-copying', `backup-by-copying-when-linked',
`backup-by-copying-when-mismatch' and
`backup-by-copying-when-privileged-mismatch'.  See also `backup-inhibited'."
90 91
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
92 93 94 95

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

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

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

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

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

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

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

155
(defcustom find-file-visit-truename nil
156 157
  "*Non-nil means visit a file under its truename.
The truename of a file is found by chasing all links
158 159 160
both at the file level and at the levels of the containing directories."
  :type 'boolean
  :group 'find-file)
161

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

172 173 174 175 176 177 178 179
(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)

180 181 182
(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
  "Non-nil means that buffer-file-number uniquely identifies files.")

183 184 185 186
(defvar buffer-file-read-only nil
  "Non-nil if visited file was read-only when visited.")
(make-variable-buffer-local 'buffer-file-read-only)

187
(defcustom temporary-file-directory
188 189 190 191 192 193 194
  (file-name-as-directory
   (cond ((memq system-type '(ms-dos windows-nt))
	  (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
	 ((memq system-type '(vax-vms axp-vms))
	  (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
	 (t
	  (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
195 196 197
  "The directory for writing temporary files."
  :group 'files
  :type 'directory)
198

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

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

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

224
(defcustom file-precious-flag nil
Roland McGrath's avatar
Roland McGrath committed
225
  "*Non-nil means protect against I/O errors while saving files.
Karl Heuer's avatar
Karl Heuer committed
226
Some modes set this non-nil in particular buffers.
227 228 229 230 231 232 233

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
234
Yet, at the same time, saving a precious file
235 236 237
breaks any hard links between it and other files."
  :type 'boolean
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
238

239
(defcustom version-control nil
Roland McGrath's avatar
Roland McGrath committed
240 241 242
  "*Control use of version numbers for backup files.
t means make numeric backup versions unconditionally.
nil means make them for files that have some already.
243
`never' means do not make them."
244 245 246
  :type '(choice (const :tag "Never" never)
		 (const :tag "If existing" nil)
		 (other :tag "Always" t))
247 248 249 250 251 252 253 254 255 256
  :group 'backup
  :group 'vc)

(defcustom dired-kept-versions 2
  "*When cleaning directory, number of versions to keep."
  :type 'integer
  :group 'backup
  :group 'dired)

(defcustom delete-old-versions nil
257
  "*If t, delete excess backup versions silently.
258 259 260
If nil, ask confirmation.  Any other value prevents any trimming."
  :type '(choice (const :tag "Delete" t)
		 (const :tag "Ask" nil)
261
		 (other :tag "Leave" other))
262 263 264 265 266 267 268 269
  :group 'backup)

(defcustom kept-old-versions 2
  "*Number of oldest versions to keep when a new numbered backup is made."
  :type 'integer
  :group 'backup)

(defcustom kept-new-versions 2
Roland McGrath's avatar
Roland McGrath committed
270
  "*Number of newest versions to keep when a new numbered backup is made.
271 272 273
Includes the new backup.  Must be > 0"
  :type 'integer
  :group 'backup)
Roland McGrath's avatar
Roland McGrath committed
274

275
(defcustom require-final-newline nil
276 277 278 279 280 281 282 283 284 285 286 287 288 289
  "*Whether to add a newline automatically at the end of the file.

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.
nil means don't add newlines.

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)
		 (const :tag "Never" nil)
290
		 (other :tag "Ask" ask))
291
  :group 'editing-basics)
Roland McGrath's avatar
Roland McGrath committed
292

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
(defcustom mode-require-final-newline t
  "*Whether to add a newline at the end of the file, in certain major modes.
Those modes set `require-final-newline' to this value when you enable them.
They do so because they are used for files that are supposed
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.
Any other non-nil value means ask user whether to add a newline, when saving."
  :type '(choice (const :tag "When visiting" visit)
		 (const :tag "When saving" t)
		 (const :tag "When visiting or saving" visit-save)
		 (other :tag "Ask" ask))
  :group 'editing-basics
  :version "21.4")

310 311 312 313
(defcustom auto-save-default t
  "*Non-nil says by default do auto-saving of every file-visiting buffer."
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
314

315
(defcustom auto-save-visited-file-name nil
Roland McGrath's avatar
Roland McGrath committed
316
  "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
317 318 319
Normally auto-save files are written under other names."
  :type 'boolean
  :group 'auto-save)
Roland McGrath's avatar
Roland McGrath committed
320

André Spiegel's avatar
André Spiegel committed
321
(defcustom auto-save-file-name-transforms
322
  `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
323 324
     ;; Don't put "\\2" inside expand-file-name, since it will be
     ;; transformed to "/2" on DOS/Windows.
325
     ,(concat temporary-file-directory "\\2") t))
André Spiegel's avatar
André Spiegel committed
326
  "*Transforms to apply to buffer file name before making auto-save file name.
327
Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
André Spiegel's avatar
André Spiegel committed
328 329 330
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.
331
If the optional element UNIQUIFY is non-nil, the auto-save file name is
332
constructed by taking the directory part of the replaced file-name,
333 334 335 336
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
337 338 339 340
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.

341 342
The default value is set up to put the auto-save file into the
temporary directory (see the variable `temporary-file-directory') for
343 344 345 346
editing a remote file.

On MS-DOS filesystems without long names this variable is always
ignored."
André Spiegel's avatar
André Spiegel committed
347
  :group 'auto-save
348 349
  :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
					   (boolean :tag "Uniquify")))
André Spiegel's avatar
André Spiegel committed
350 351
  :version "21.1")

352
(defcustom save-abbrevs t
353 354 355
  "*Non-nil means save word abbrevs too when files are saved.
If `silently', don't ask the user before saving."
  :type '(choice (const t) (const nil) (const silently))
356
  :group 'abbrev)
Roland McGrath's avatar
Roland McGrath committed
357

358
(defcustom find-file-run-dired t
André Spiegel's avatar
André Spiegel committed
359 360
  "*Non-nil means allow `find-file' to visit directories.
To visit the directory, `find-file' runs `find-directory-functions'."
361 362
  :type 'boolean
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
363

André Spiegel's avatar
André Spiegel committed
364 365 366 367 368 369 370
(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
  "*List of functions to try in sequence to visit a directory.
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)

371 372
;;;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
373
(defvar find-file-not-found-functions nil
Roland McGrath's avatar
Roland McGrath committed
374 375
  "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
376
Variable `buffer-file-name' is already set up.
Roland McGrath's avatar
Roland McGrath committed
377
The functions are called in the order given until one of them returns non-nil.")
Stefan Monnier's avatar
Stefan Monnier committed
378 379 380
(defvaralias 'find-file-not-found-hooks 'find-file-not-found-functions)
(make-obsolete-variable
 'find-file-not-found-hooks 'find-file-not-found-functions "21.4")
Roland McGrath's avatar
Roland McGrath committed
381

382 383
;;;It is not useful to make this a local variable.
;;;(put 'find-file-hooks 'permanent-local t)
Dave Love's avatar
Dave Love committed
384
(defcustom find-file-hook nil
Roland McGrath's avatar
Roland McGrath committed
385 386
  "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
387 388 389 390 391
functions are called."
  :group 'find-file
  :type 'hook
  :options '(auto-insert)
  :version "21.4")
Stefan Monnier's avatar
Stefan Monnier committed
392 393
(defvaralias 'find-file-hooks 'find-file-hook)
(make-obsolete-variable 'find-file-hooks 'find-file-hook "21.4")
Roland McGrath's avatar
Roland McGrath committed
394

Stefan Monnier's avatar
Stefan Monnier committed
395
(defvar write-file-functions nil
Roland McGrath's avatar
Roland McGrath committed
396 397
  "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
398 399
and the rest are not called.
These hooks are considered to pertain to the visited file.
Stefan Monnier's avatar
Stefan Monnier committed
400 401 402 403
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.

404 405 406 407 408 409
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
updates before the buffer is saved, use `before-save-hook' .")
Stefan Monnier's avatar
Stefan Monnier committed
410 411 412 413 414
(put 'write-file-functions 'permanent-local t)
(defvaralias 'write-file-hooks 'write-file-functions)
(make-obsolete-variable 'write-file-hooks 'write-file-functions "21.4")

(defvar local-write-file-hooks nil)
415 416
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
Stefan Monnier's avatar
Stefan Monnier committed
417
(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "21.4")
Jim Blandy's avatar
Jim Blandy committed
418

Stefan Monnier's avatar
Stefan Monnier committed
419
(defvar write-contents-functions nil
Jim Blandy's avatar
Jim Blandy committed
420 421
  "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
422 423
and the rest are not called and neither are the functions in
`write-file-functions'.
424 425 426 427

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
428 429
major mode does clear it.

430 431 432 433 434
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
435 436 437
(make-variable-buffer-local 'write-contents-functions)
(defvaralias 'write-contents-hooks 'write-contents-functions)
(make-obsolete-variable 'write-contents-hooks 'write-contents-functions "21.4")
Roland McGrath's avatar
Roland McGrath committed
438

439
(defcustom enable-local-variables t
440
  "*Control use of local variables in files you visit.
Roland McGrath's avatar
Roland McGrath committed
441
The value can be t, nil or something else.
442
A value of t means file local variables specifications are obeyed;
Roland McGrath's avatar
Roland McGrath committed
443
nil means they are ignored; anything else means query.
444 445
This variable also controls use of major modes specified in
a -*- line.
Roland McGrath's avatar
Roland McGrath committed
446

447 448 449
The command \\[normal-mode], when used interactively,
always obeys file local variable specifications and the -*- line,
and ignores this variable."
450 451
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
452
		 (other :tag "Query" other))
453
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
454

455 456
(defvar local-enable-local-variables t
  "Like `enable-local-variables' but meant for buffer-local bindings.
457
The meaningful values are nil and non-nil.  The default is non-nil.
458
If a major mode sets this to nil, buffer-locally, then any local
459 460 461 462
variables list in the file will be ignored.

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

464
(defcustom enable-local-eval 'maybe
465 466 467
  "*Control processing of the \"variable\" `eval' in a file's local variables.
The value can be t, nil or something else.
A value of t means obey `eval' variables;
468
nil means ignore them; anything else means query."
469 470
  :type '(choice (const :tag "Obey" t)
		 (const :tag "Ignore" nil)
471
		 (other :tag "Query" other))
472
  :group 'find-file)
Roland McGrath's avatar
Roland McGrath committed
473 474 475

;; Avoid losing in versions where CLASH_DETECTION is disabled.
(or (fboundp 'lock-buffer)
476
    (defalias 'lock-buffer 'ignore))
Roland McGrath's avatar
Roland McGrath committed
477
(or (fboundp 'unlock-buffer)
478
    (defalias 'unlock-buffer 'ignore))
479 480
(or (fboundp 'file-locked-p)
    (defalias 'file-locked-p 'ignore))
481

482
(defcustom view-read-only nil
483 484 485 486 487
  "*Non-nil means buffers visiting files read-only do so in view mode.
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]."
488 489
  :type 'boolean
  :group 'view)
490

491
(put 'ange-ftp-completion-hook-function 'safe-magic t)
492
(defun ange-ftp-completion-hook-function (op &rest args)
André Spiegel's avatar
André Spiegel committed
493 494 495 496
  "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.
497 498
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
499 500 501 502 503
    (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))
504
      (apply op args))))
505 506

(defun convert-standard-filename (filename)
507
  "Convert a standard file's name to something suitable for the OS.
508 509 510 511 512 513 514 515
This means to guarantee valid names and perhaps to canonicalize
certain patterns.

This function's standard definition is trivial; it just returns
the argument.  However, on Windows and DOS, replace invalid
characters.  On DOS, make sure to obey the 8.3 limitations.  On
Windows, turn Cygwin names into native names, and also turn
slashes into backslashes if the shell requires it (see
516 517 518
`w32-shell-dos-semantics').

See Info node `(elisp)Standard File Names' for more details."
519
  filename)
520 521 522 523

(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.
524 525
Default name to DEFAULT-DIRNAME if user exits with the same
non-empty string that was inserted by this function.
526 527
 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
  except that if INITIAL is specified, that combined with DIR is used.)
528 529 530
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.)
531 532 533
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.
534 535
DIR should be an absolute directory name.  It defaults to
the value of `default-directory'."
536 537 538
  (unless dir
    (setq dir default-directory))
  (unless default-dirname
539
    (setq default-dirname
540 541 542 543
	  (if initial (concat dir initial) default-directory)))
  (read-file-name prompt dir default-dirname mustmatch initial
		  'file-directory-p))

Roland McGrath's avatar
Roland McGrath committed
544 545 546 547 548 549

(defun pwd ()
  "Show the current default directory."
  (interactive nil)
  (message "Directory %s" default-directory))

550 551
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
552
Not actually set up until the first time you use it.")
553 554

(defun parse-colon-path (cd-path)
555
  "Explode a search path into a list of directory names.
556 557
Directories are separated by occurrences of `path-separator'
\(which is colon in GNU and GNU-like systems)."
André Spiegel's avatar
André Spiegel committed
558
  ;; We could use split-string here.
559
  (and cd-path
560
       (let (cd-list (cd-start 0) cd-colon)
561 562
	 (setq cd-path (concat cd-path path-separator))
	 (while (setq cd-colon (string-match path-separator cd-path cd-start))
563
	   (setq cd-list
564
		 (nconc cd-list
565 566 567
			(list (if (= cd-start cd-colon)
				   nil
				(substitute-in-file-name
568 569
				 (file-name-as-directory
				  (substring cd-path cd-start cd-colon)))))))
570 571 572 573
	   (setq cd-start (+ cd-colon 1)))
	 cd-list)))

(defun cd-absolute (dir)
574
  "Change current directory to given absolute file name DIR."
575 576
  ;; Put the name into directory syntax now,
  ;; because otherwise expand-file-name may give some bad results.
Roland McGrath's avatar
Roland McGrath committed
577 578
  (if (not (eq system-type 'vax-vms))
      (setq dir (file-name-as-directory dir)))
579
  (setq dir (abbreviate-file-name (expand-file-name dir)))
Roland McGrath's avatar
Roland McGrath committed
580
  (if (not (file-directory-p dir))
581 582
      (if (file-exists-p dir)
	  (error "%s is not a directory" dir)
583
	(error "%s: no such directory" dir))
Roland McGrath's avatar
Roland McGrath committed
584 585
    (if (file-executable-p dir)
	(setq default-directory dir)
586
      (error "Cannot cd to %s:  Permission denied" dir))))
Roland McGrath's avatar
Roland McGrath committed
587

588 589
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
590 591
If your environment includes a `CDPATH' variable, try each one of
that list of directories (separated by occurrences of
592 593
`path-separator') when resolving a relative directory name.
The path separator is colon in GNU and GNU-like systems."
594
  (interactive
595
   (list (read-directory-name "Change default directory: "
596 597 598
			 default-directory default-directory
			 (and (member cd-path '(nil ("./")))
			      (null (getenv "CDPATH"))))))
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
  (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
	       (mapcar
		(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"))))
615

Roland McGrath's avatar
Roland McGrath committed
616 617
(defun load-file (file)
  "Load the Lisp file named FILE."
618 619
  ;; This is a case where .elc makes a lot of sense.
  (interactive (list (let ((completion-ignored-extensions
Dave Love's avatar
Dave Love committed
620
			    (remove ".elc" completion-ignored-extensions)))
621 622
		       (read-file-name "Load file: "))))
  (load (expand-file-name file) nil nil t))
Roland McGrath's avatar
Roland McGrath committed
623

Stefan Monnier's avatar
Stefan Monnier committed
624 625 626 627 628
(defun locate-file (filename path &optional suffixes predicate)
  "Search for FILENAME through PATH.
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 '(\"\").
If non-nil, PREDICATE is used instead of `file-readable-p'.
Richard M. Stallman's avatar
Richard M. Stallman committed
629 630 631 632 633 634
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
635 636 637 638 639 640 641 642 643 644 645 646
  (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))

(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)."
647
  (if (file-name-absolute-p string)
Stefan Monnier's avatar
Stefan Monnier committed
648
      (read-file-name-internal string nil action)
649
    (let ((names nil)
Stefan Monnier's avatar
Stefan Monnier committed
650
	  (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
651
	  (string-dir (file-name-directory string)))
Stefan Monnier's avatar
Stefan Monnier committed
652
      (dolist (dir (car path-and-suffixes))
653 654
	(unless dir
	  (setq dir default-directory))
655 656 657 658 659 660 661 662
	(if string-dir (setq dir (expand-file-name string-dir dir)))
	(when (file-directory-p dir)
	  (dolist (file (file-name-all-completions
			 (file-name-nondirectory string) dir))
	    (push (if string-dir (concat string-dir file) file) names)
	    (when (string-match suffix file)
	      (setq file (substring file 0 (match-beginning 0)))
	      (push (if string-dir (concat string-dir file) file) names)))))
Stefan Monnier's avatar
Stefan Monnier committed
663 664 665 666
      (cond
       ((eq action t) (all-completions string names))
       ((null action) (try-completion string names))
       (t (test-completion string names))))))
667

Roland McGrath's avatar
Roland McGrath committed
668 669 670
(defun load-library (library)
  "Load the library named LIBRARY.
This is an interface to the function `load'."
Stefan Monnier's avatar
Stefan Monnier committed
671 672 673 674
  (interactive
   (list (completing-read "Load library: "
			  'locate-file-completion
			  (cons load-path load-suffixes))))
Roland McGrath's avatar
Roland McGrath committed
675
  (load library))
676

677
(defun file-remote-p (file)
678 679 680 681 682 683 684
  "Test whether FILE specifies a location on a remote system.
Return an identification of the system if the location is indeed
remote.  The identification of the system may comprise a method
to access the system and its hostname, amongst other things.

For example, the filename \"/user@host:/foo\" specifies a location
on the system \"/user@host:\"."
685
  (let ((handler (find-file-name-handler file 'file-remote-p)))
686
    (if handler
687 688
	(funcall handler 'file-remote-p file)
      nil)))
689

André Spiegel's avatar
André Spiegel committed
690
(defun file-local-copy (file)
691 692 693
  "Copy the file FILE into a temporary file on this machine.
Returns the name of the local copy, or nil, if FILE is directly
accessible."
André Spiegel's avatar
André Spiegel committed
694 695
  ;; This formerly had an optional BUFFER argument that wasn't used by
  ;; anything.
696
  (let ((handler (find-file-name-handler file 'file-local-copy)))
697 698 699
    (if handler
	(funcall handler 'file-local-copy file)
      nil)))
700

701
(defun file-truename (filename &optional counter prev-dirs)
702 703 704
  "Return the truename of FILENAME, which should be absolute.
The truename of a file name is found by chasing symbolic links
both at the level of the file and at the level of the directories
705 706
containing it, until no links are left at any level.

Richard M. Stallman's avatar
Richard M. Stallman committed
707
\(fn FILENAME)"  ;; Don't document the optional arguments.
708 709 710
  ;; COUNTER and PREV-DIRS are only used in recursive calls.
  ;; COUNTER can be a cons cell whose car is the count of how many
  ;; more links to chase before getting an error.
711 712
  ;; PREV-DIRS can be a cons cell whose car is an alist
  ;; of truenames we've just recently computed.
713 714 715 716 717 718 719 720 721 722 723
  (cond ((or (string= filename "") (string= filename "~"))
	 (setq filename (expand-file-name filename))
	 (if (string= filename "")
	     (setq filename "/")))
	((and (string= (substring filename 0 1) "~")
	      (string-match "~[^/]*/?" filename))
	 (let ((first-part
		(substring filename 0 (match-end 0)))
	       (rest (substring filename (match-end 0))))
	   (setq filename (concat (expand-file-name first-part) rest)))))

724
  (or counter (setq counter (list 100)))
725 726 727 728 729 730 731 732 733
  (let (done
	;; For speed, remove the ange-ftp completion handler from the list.
	;; We know it's not needed here.
	;; For even more speed, do this only on the outermost call.
	(file-name-handler-alist
	 (if prev-dirs file-name-handler-alist
	   (let ((tem (copy-sequence file-name-handler-alist)))
	     (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
    (or prev-dirs (setq prev-dirs (list nil)))
734 735 736 737 738 739 740 741 742 743 744 745 746

    ;; andrewi@harlequin.co.uk - none of the following code (except for
    ;; invoking the file-name handler) currently applies on Windows
    ;; (ie. there are no native symlinks), but there is an issue with
    ;; case differences being ignored by the OS, and short "8.3 DOS"
    ;; name aliases existing for all files.  (The short names are not
    ;; reported by directory-files, but can be used to refer to files.)
    ;; It seems appropriate for file-truename to resolve these issues in
    ;; the most natural way, which on Windows is to call the function
    ;; `w32-long-file-name' - this returns the exact name of a file as
    ;; it is stored on disk (expanding short name aliases with the full
    ;; name in the process).
    (if (eq system-type 'windows-nt)
747
      (let ((handler (find-file-name-handler filename 'file-truename)))
748 749 750 751 752
	;; For file name that has a special handler, call handler.
	;; This is so that ange-ftp can save time by doing a no-op.
	(if handler
	    (setq filename (funcall handler 'file-truename filename))
	  ;; If filename contains a wildcard, newname will be the old name.
753
	  (unless (string-match "[[*?]" filename)
754 755
	    ;; If filename exists, use the long name
	    (setq filename (or (w32-long-file-name filename) filename))))
756 757
	(setq done t)))

758 759 760 761 762 763 764 765 766 767 768 769
    ;; If this file directly leads to a link, process that iteratively
    ;; so that we don't use lots of stack.
    (while (not done)
      (setcar counter (1- (car counter)))
      (if (< (car counter) 0)
	  (error "Apparent cycle of symbolic links for %s" filename))
      (let ((handler (find-file-name-handler filename 'file-truename)))
	;; For file name that has a special handler, call handler.
	;; This is so that ange-ftp can save time by doing a no-op.
	(if handler
	    (setq filename (funcall handler 'file-truename filename)
		  done t)
770
	  (let ((dir (or (file-name-directory filename) default-directory))
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 800 801 802 803 804 805 806 807 808
		target dirfile)
	    ;; Get the truename of the directory.
	    (setq dirfile (directory-file-name dir))
	    ;; If these are equal, we have the (or a) root directory.
	    (or (string= dir dirfile)
		;; If this is the same dir we last got the truename for,
		;; save time--don't recalculate.
		(if (assoc dir (car prev-dirs))
		    (setq dir (cdr (assoc dir (car prev-dirs))))
		  (let ((old dir)
			(new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
		    (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
		    (setq dir new))))
	    (if (equal ".." (file-name-nondirectory filename))
		(setq filename
		      (directory-file-name (file-name-directory (directory-file-name dir)))
		      done t)
	      (if (equal "." (file-name-nondirectory filename))
		  (setq filename (directory-file-name dir)
			done t)
		;; Put it back on the file name.
		(setq filename (concat dir (file-name-nondirectory filename)))
		;; Is the file name the name of a link?
		(setq target (file-symlink-p filename))
		(if target
		    ;; Yes => chase that link, then start all over
		    ;; since the link may point to a directory name that uses links.
		    ;; We can't safely use expand-file-name here
		    ;; since target might look like foo/../bar where foo
		    ;; is itself a link.  Instead, we handle . and .. above.
		    (setq filename
			  (if (file-name-absolute-p target)
			      target
			    (concat dir target))
			  done nil)
		  ;; No, we are done!
		  (setq done t))))))))
    filename))
809

810
(defun file-chase-links (filename &optional limit)
811
  "Chase links in FILENAME until a name that is not a link.
812 813 814 815 816
Unlike `file-truename', this does not check whether a parent
directory name is a symbolic link.
If the optional argument LIMIT is a number,
it means chase no more than that many links and then stop."
  (let (tem (newname filename)
817
	    (count 0))
818 819
    (while (and (or (null limit) (< count limit))
		(setq tem (file-symlink-p newname)))
820
      (save-match-data
821
	(if (and (null limit) (= count 100))
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
	    (error "Apparent cycle of symbolic links for %s" filename))
	;; In the context of a link, `//' doesn't mean what Emacs thinks.
	(while (string-match "//+" tem)
	  (setq tem (replace-match "/" nil nil tem)))
	;; Handle `..' by hand, since it needs to work in the
	;; target of any directory symlink.
	;; This code is not quite complete; it does not handle
	;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
	(while (string-match "\\`\\.\\./" tem)
	  (setq tem (substring tem 3))
	  (setq newname (expand-file-name newname))
	  ;; Chase links in the default dir of the symlink.
	  (setq newname
		(file-chase-links
		 (directory-file-name (file-name-directory newname))))
	  ;; Now find the parent of that dir.
	  (setq newname (file-name-directory newname)))
	(setq newname (expand-file-name tem (file-name-directory newname)))
840
	(setq count (1+ count))))
841
    newname))
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868

(defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
  "Change the encoding of FILE's name from CODING to NEW-CODING.
The value is a new name of FILE.
Signals a `file-already-exists' error if a file of the new name
already exists unless optional third argument OK-IF-ALREADY-EXISTS
is non-nil.  A number as third arg means request confirmation if
the new name already exists.  This is what happens in interactive
use with M-x."
  (interactive
   (let ((default-coding (or file-name-coding-system
			     default-file-name-coding-system))
	 (filename (read-file-name "Recode filename: " nil nil t))
	 from-coding to-coding)
     (if (and default-coding
	      ;; We provide the default coding only when it seems that
	      ;; the filename is correctly decoded by the default
	      ;; coding.
	      (let ((charsets (find-charset-string filename)))
		(and (not (memq 'eight-bit-control charsets))
		     (not (memq 'eight-bit-graphic charsets)))))
	 (setq from-coding (read-coding-system
			    (format "Recode filename %s from (default %s): "
				    filename default-coding)
			    default-coding))
       (setq from-coding (read-coding-system
			  (format "Recode filename %s from: " filename))))
869

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
     ;; We provide the default coding only when a user is going to
     ;; change the encoding not from the default coding.
     (if (eq from-coding default-coding)
	 (setq to-coding (read-coding-system
			  (format "Recode filename %s from %s to: "
				  filename from-coding)))
       (setq to-coding (read-coding-system
			(format "Recode filename %s from %s to (default %s): "
				filename from-coding default-coding)
			default-coding)))
     (list filename from-coding to-coding)))

  (let* ((default-coding (or file-name-coding-system
			     default-file-name-coding-system))
	 ;; FILE should have been decoded by DEFAULT-CODING.
	 (encoded (encode-coding-string file default-coding))
	 (newname (decode-coding-string encoded coding))
	 (new-encoded (encode-coding-string newname new-coding))
	 ;; Suppress further encoding.
	 (file-name-coding-system nil)
	 (default-file-name-coding-system nil)
	 (locale-coding-system nil))
    (rename-file encoded new-encoded ok-if-already-exists)
    newname))
Roland McGrath's avatar
Roland McGrath committed
894

895 896
(defun switch-to-buffer-other-window (buffer &optional norecord)
  "Select buffer BUFFER in another window.
897 898 899 900 901 902
If BUFFER does not identify an existing buffer, then this function
creates a buffer with that name.

When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
or nil.  If BUFFER is nil, then this function chooses a buffer
using `other-buffer'.
903
Optional second arg NORECORD non-nil means
904
do not put this buffer at the front of the list of recently selected ones.
905
This function returns the buffer it switched to.
906 907 908

This uses the function `display-buffer' as a subroutine; see its
documentation for additional customization information."
Roland McGrath's avatar
Roland McGrath committed
909
  (interactive "BSwitch to buffer in other window: ")
910 911 912
  (let ((pop-up-windows t)
	;; Don't let these interfere.
	same-window-buffer-names same-window-regexps)
913
    (pop-to-buffer buffer t norecord)))
Roland McGrath's avatar
Roland McGrath committed
914

915 916 917
(defun switch-to-buffer-other-frame (buffer &optional norecord)
  "Switch to buffer BUFFER in another frame.
Optional second arg NORECORD non-nil means
918 919 920 921
do not put this buffer at the front of the list of recently selected ones.

This uses the function `display-buffer' as a subroutine; see its
documentation for additional customization information."
Jim Blandy's avatar
Jim Blandy committed
922
  (interactive "BSwitch to buffer in other frame: ")
923 924
  (let ((pop-up-frames t)
	same-window-buffer-names same-window-regexps)
925
    (pop-to-buffer buffer t norecord)
926
    (raise-frame (window-frame (selected-window)))))
Jim Blandy's avatar
Jim Blandy committed
927

928 929 930
(defvar find-file-default nil
  "Used within `find-file-read-args'.")

931
(defun find-file-read-args (prompt mustmatch)
Richard M. Stallman's avatar
Richard M. Stallman committed
932 933 934
  (list (let ((find-file-default
	       (and buffer-file-name
		    (abbreviate-file-name buffer-file-name)))
935 936 937 938 939 940
	      (munge-default-fun
	       (lambda ()
		 (setq minibuffer-default find-file-default)
		 ;; Clear out this hook so it does not interfere
		 ;; with any recursive minibuffer usage.
		 (pop minibuffer-setup-hook)))
Richard M. Stallman's avatar
Richard M. Stallman committed
941
	      (minibuffer-setup-hook
942 943
	       minibuffer-setup-hook))
	  (add-hook 'minibuffer-setup-hook munge-default-fun)
944
	  (read-file-name prompt nil default-directory mustmatch))
945
	t))
Richard M. Stallman's avatar
Richard M. Stallman committed
946

947
(defun find-file (filename &optional wildcards)
Roland McGrath's avatar
Roland McGrath committed
948 949
  "Edit file FILENAME.
Switch to a buffer visiting file FILENAME,
950
creating one if none already exists.
Richard M. Stallman's avatar
Richard M. Stallman committed
951 952 953 954
Interactively, the default if you just type RET is the current directory,
but the visited file name is available through the minibuffer history:
type M-n to pull it into the minibuffer.

955
Interactively, or if WILDCARDS is non-nil in a call from Lisp,
Richard M. Stallman's avatar
Richard M. Stallman committed
956 957 958 959 960
expand wildcards (if any) and visit multiple files.  You can
suppress wildcard expansion by setting `find-file-wildcards'.

To visit a file without any kind of conversion and without
automatically choosing a major mode, use \\[find-file-literally]."
961
  (interactive (find-file-read-args "Find file: " nil))
962 963 964 965
  (let ((value (find-file-noselect filename nil nil wildcards)))
    (if (listp value)
	(mapcar 'switch-to-buffer (nreverse value))
      (switch-to-buffer value))))
966

967
(defun find-file-other-window (filename &optional wildcards)
Roland McGrath's avatar
Roland McGrath committed
968 969
  "Edit file FILENAME, in another window.
May create a new window, or reuse an existing one.
970
See the function `display-buffer'.