* w32-fns.el (w32-shell-dos-semantics):
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
aaef169d
TTN
3;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
409cc4a3 5;; 2006, 2007, 2008 Free Software Foundation, Inc.
b4da00e9 6
3a801d0c
ER
7;; Maintainer: FSF
8
b4da00e9
RM
9;; This file is part of GNU Emacs.
10
eb3fa2cf 11;; GNU Emacs is free software: you can redistribute it and/or modify
b4da00e9 12;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
b4da00e9
RM
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
eb3fa2cf 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
b4da00e9 23
e41b2db1
ER
24;;; Commentary:
25
26;; Defines most of Emacs's file- and directory-handling functions,
27;; including basic file visiting, backup generation, link handling,
28;; ITS-id version control, load- and write-hook handling, and the like.
29
e5167999
ER
30;;; Code:
31
26138670
JB
32(defvar font-lock-keywords)
33
21540597
RS
34(defgroup backup nil
35 "Backups of edited data files."
2a9fe1e2 36 :group 'files)
b4da00e9 37
21540597 38(defgroup find-file nil
2a9fe1e2
RS
39 "Finding files."
40 :group 'files)
21540597
RS
41
42
43(defcustom delete-auto-save-files t
ba83982b 44 "Non-nil means delete auto-save file when a buffer is saved or killed.
92631216 45
564af258 46Note that the auto-save file will not be deleted if the buffer is killed
92631216 47when it has unsaved changes."
21540597
RS
48 :type 'boolean
49 :group 'auto-save)
50
51(defcustom directory-abbrev-alist
b4da00e9 52 nil
ba83982b 53 "Alist of abbreviations for file directories.
b4da00e9
RM
54A list of elements of the form (FROM . TO), each meaning to replace
55FROM with TO when it appears in a directory name. This replacement is
56done when setting up the default directory of a newly visited file.
57*Every* FROM string should start with `^'.
58
4b690a83
RS
59FROM and TO should be equivalent names, which refer to the
60same directory. Do not use `~' in the TO strings;
61they should be ordinary absolute directory names.
65151a1b 62
b4da00e9
RM
63Use this feature when you have directories which you normally refer to
64via absolute symbolic links. Make TO the name of the link, and FROM
21540597
RS
65the name it is linked to."
66 :type '(repeat (cons :format "%v"
67 :value ("" . "")
68 (regexp :tag "From")
69 (regexp :tag "To")))
70 :group 'abbrev
71 :group 'find-file)
b4da00e9 72
7c2fb837 73(defcustom make-backup-files t
ba83982b 74 "Non-nil means make a backup of a file the first time it is saved.
b4da00e9
RM
75This can be done by renaming the file or by copying.
76
77Renaming means that Emacs renames the existing file so that it is a
78backup file, then writes the buffer into a new file. Any other names
79that the old file had will now refer to the backup file. The new file
80is owned by you and its group is defaulted.
81
82Copying means that Emacs copies the existing file into the backup
83file, then writes the buffer on top of the existing file. Any other
84names that the old file had will now refer to the new (edited) file.
85The file's owner and group are unchanged.
86
87The choice of renaming or copying is controlled by the variables
ffc0e1ca
AS
88`backup-by-copying', `backup-by-copying-when-linked',
89`backup-by-copying-when-mismatch' and
90`backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
21540597
RS
91 :type 'boolean
92 :group 'backup)
b4da00e9
RM
93
94;; Do this so that local variables based on the file name
95;; are not overridden by the major mode.
96(defvar backup-inhibited nil
f862241d
RS
97 "Non-nil means don't make a backup, regardless of the other parameters.
98This variable is intended for use by making it local to a buffer.
99But it is local only if you make it local.")
b4da00e9
RM
100(put 'backup-inhibited 'permanent-local t)
101
21540597 102(defcustom backup-by-copying nil
ba83982b 103 "Non-nil means always use copying to create backup files.
21540597 104See documentation of variable `make-backup-files'."
094eabe4
JB
105 :type 'boolean
106 :group 'backup)
b4da00e9 107
21540597 108(defcustom backup-by-copying-when-linked nil
ba83982b 109 "Non-nil means use copying to create backups for files with multiple names.
b4da00e9 110This causes the alternate names to refer to the latest version as edited.
21540597 111This variable is relevant only if `backup-by-copying' is nil."
094eabe4
JB
112 :type 'boolean
113 :group 'backup)
b4da00e9 114
21540597 115(defcustom backup-by-copying-when-mismatch nil
ba83982b 116 "Non-nil means create backups by copying if this preserves owner or group.
b4da00e9
RM
117Renaming may still be used (subject to control of other variables)
118when it would not result in changing the owner or group of the file;
119that is, for files which are owned by you and whose group matches
120the default for a new file created there by you.
21540597
RS
121This variable is relevant only if `backup-by-copying' is nil."
122 :type 'boolean
123 :group 'backup)
b4da00e9 124
ffc0e1ca 125(defcustom backup-by-copying-when-privileged-mismatch 200
ba83982b 126 "Non-nil means create backups by copying to preserve a privileged owner.
ffc0e1ca
AS
127Renaming may still be used (subject to control of other variables)
128when it would not result in changing the owner of the file or if the owner
129has a user id greater than the value of this variable. This is useful
130when low-numbered uid's are used for special system users (such as root)
131that must maintain ownership of certain files.
132This variable is relevant only if `backup-by-copying' and
133`backup-by-copying-when-mismatch' are nil."
134 :type '(choice (const nil) integer)
135 :group 'backup)
136
ffc0e1ca 137(defvar backup-enable-predicate 'normal-backup-enable-predicate
b4da00e9 138 "Predicate that looks at a file name and decides whether to make backups.
37193ee6 139Called with an absolute file name as argument, it returns t to enable backup.")
b4da00e9 140
21540597 141(defcustom buffer-offer-save nil
ba83982b 142 "Non-nil in a buffer means always offer to save buffer on exit.
ffc0e1ca 143Do so even if the buffer is not visiting a file.
21540597
RS
144Automatically local in all buffers."
145 :type 'boolean
146 :group 'backup)
b4da00e9
RM
147(make-variable-buffer-local 'buffer-offer-save)
148
21540597 149(defcustom find-file-existing-other-name t
ba83982b 150 "Non-nil means find a file under alternative names, in existing buffers.
f3e23606 151This means if any existing buffer is visiting the file you want
21540597
RS
152under another name, you get the existing buffer instead of a new buffer."
153 :type 'boolean
154 :group 'find-file)
f3e23606 155
21540597 156(defcustom find-file-visit-truename nil
09949b83 157 "Non-nil means visit a file under its truename.
f3e23606 158The truename of a file is found by chasing all links
21540597
RS
159both at the file level and at the levels of the containing directories."
160 :type 'boolean
161 :group 'find-file)
290c2be5 162(put 'find-file-visit-truename 'safe-local-variable 'booleanp)
f3e23606 163
26b9ecbc 164(defcustom revert-without-query nil
ba83982b 165 "Specify which files should be reverted without query.
ebeb898f
RS
166The value is a list of regular expressions.
167If the file name matches one of these regular expressions,
db8c4866 168then `revert-buffer' reverts the file without querying
21540597 169if the file has changed on disk and you have not edited the buffer."
a0d809f2 170 :type '(repeat regexp)
21540597 171 :group 'find-file)
ebeb898f 172
f3e23606
RS
173(defvar buffer-file-number nil
174 "The device number and file number of the file visited in the current buffer.
175The value is a list of the form (FILENUM DEVNUM).
176This pair of numbers uniquely identifies the file.
177If the buffer is visiting a new file, the value is nil.")
178(make-variable-buffer-local 'buffer-file-number)
179(put 'buffer-file-number 'permanent-local t)
180
de88363f 181(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
26b9ecbc 182 "Non-nil means that `buffer-file-number' uniquely identifies files.")
de88363f 183
e554eeb7
RS
184(defvar buffer-file-read-only nil
185 "Non-nil if visited file was read-only when visited.")
186(make-variable-buffer-local 'buffer-file-read-only)
187
388d6ab5 188(defcustom temporary-file-directory
eb61b61b
RS
189 (file-name-as-directory
190 (cond ((memq system-type '(ms-dos windows-nt))
191 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
eb61b61b
RS
192 (t
193 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
388d6ab5
RS
194 "The directory for writing temporary files."
195 :group 'files
196 :type 'directory)
eb61b61b 197
388d6ab5 198(defcustom small-temporary-file-directory
eb61b61b
RS
199 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
200 "The directory for writing small temporary files.
201If non-nil, this directory is used instead of `temporary-file-directory'
202by programs that create small temporary files. This is for systems that
388d6ab5
RS
203have fast storage with limited space, such as a RAM disk."
204 :group 'files
bab6eadb 205 :type '(choice (const nil) directory))
eb61b61b
RS
206
207;; The system null device. (Should reference NULL_DEVICE from C.)
208(defvar null-device "/dev/null" "The system null device.")
209
73e6adaa
DN
210(declare-function msdos-long-file-names "msdos.c")
211(declare-function w32-long-file-name "w32proc.c")
e8ffb999
DN
212(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
213(declare-function dired-unmark "dired" (arg))
214(declare-function dired-do-flagged-delete "dired" (&optional nomessage))
215(declare-function dos-8+3-filename "dos-fns" (filename))
e8ffb999
DN
216(declare-function view-mode-disable "view" ())
217
30966847
EZ
218(defvar file-name-invalid-regexp
219 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
9959c16e 220 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
30966847 221 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
12f68d3f 222 "[\000-\037]\\|" ; control characters
30966847
EZ
223 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
224 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
c60ee5e7 225 ((memq system-type '(ms-dos windows-nt cygwin))
9959c16e 226 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
12f68d3f 227 "[|<>\"?*\000-\037]")) ; invalid characters
30966847
EZ
228 (t "[\000]"))
229 "Regexp recognizing file names which aren't allowed by the filesystem.")
230
21540597 231(defcustom file-precious-flag nil
ba83982b 232 "Non-nil means protect against I/O errors while saving files.
560f4415 233Some modes set this non-nil in particular buffers.
4b7271c1
KH
234
235This feature works by writing the new contents into a temporary file
236and then renaming the temporary file to replace the original.
237In this way, any I/O error in writing leaves the original untouched,
238and there is never any instant where the file is nonexistent.
239
240Note that this feature forces backups to be made by copying.
560f4415 241Yet, at the same time, saving a precious file
21540597
RS
242breaks any hard links between it and other files."
243 :type 'boolean
244 :group 'backup)
b4da00e9 245
21540597 246(defcustom version-control nil
ba83982b 247 "Control use of version numbers for backup files.
93e7eeb4
JB
248When t, make numeric backup versions unconditionally.
249When nil, make them for files that have some already.
250The value `never' means do not make them."
e48807d1
AS
251 :type '(choice (const :tag "Never" never)
252 (const :tag "If existing" nil)
253 (other :tag "Always" t))
21540597
RS
254 :group 'backup
255 :group 'vc)
e48335de
RS
256(put 'version-control 'safe-local-variable
257 '(lambda (x) (or (booleanp x) (equal x 'never))))
21540597
RS
258
259(defcustom dired-kept-versions 2
ba83982b 260 "When cleaning directory, number of versions to keep."
21540597
RS
261 :type 'integer
262 :group 'backup
263 :group 'dired)
264
265(defcustom delete-old-versions nil
ba83982b 266 "If t, delete excess backup versions silently.
21540597
RS
267If nil, ask confirmation. Any other value prevents any trimming."
268 :type '(choice (const :tag "Delete" t)
269 (const :tag "Ask" nil)
e48807d1 270 (other :tag "Leave" other))
21540597
RS
271 :group 'backup)
272
273(defcustom kept-old-versions 2
ba83982b 274 "Number of oldest versions to keep when a new numbered backup is made."
21540597
RS
275 :type 'integer
276 :group 'backup)
631c8020 277(put 'kept-old-versions 'safe-local-variable 'integerp)
21540597
RS
278
279(defcustom kept-new-versions 2
ba83982b 280 "Number of newest versions to keep when a new numbered backup is made.
21540597
RS
281Includes the new backup. Must be > 0"
282 :type 'integer
283 :group 'backup)
631c8020 284(put 'kept-new-versions 'safe-local-variable 'integerp)
b4da00e9 285
21540597 286(defcustom require-final-newline nil
ba83982b 287 "Whether to add a newline automatically at the end of the file.
f4206092
RS
288
289A value of t means do this only when the file is about to be saved.
290A value of `visit' means do this right after the file is visited.
291A value of `visit-save' means do it at both of those times.
292Any other non-nil value means ask user whether to add a newline, when saving.
756c496f 293A value of nil means don't add newlines.
f4206092
RS
294
295Certain major modes set this locally to the value obtained
296from `mode-require-final-newline'."
297 :type '(choice (const :tag "When visiting" visit)
298 (const :tag "When saving" t)
299 (const :tag "When visiting or saving" visit-save)
93d1963d 300 (const :tag "Don't add newlines" nil)
0776da52 301 (other :tag "Ask each time" ask))
21540597 302 :group 'editing-basics)
b4da00e9 303
f4206092 304(defcustom mode-require-final-newline t
ba83982b 305 "Whether to add a newline at end of file, in certain major modes.
f4206092 306Those modes set `require-final-newline' to this value when you enable them.
0776da52 307They do so because they are often used for files that are supposed
f4206092
RS
308to end in newlines, and the question is how to arrange that.
309
310A value of t means do this only when the file is about to be saved.
311A value of `visit' means do this right after the file is visited.
312A value of `visit-save' means do it at both of those times.
5e9961be 313Any other non-nil value means ask user whether to add a newline, when saving.
5e9961be 314
756c496f
JB
315A value of nil means do not add newlines. That is a risky choice in this
316variable since this value is used for modes for files that ought to have
317final newlines. So if you set this to nil, you must explicitly check and
318add a final newline, whenever you save a file that really needs one."
f4206092
RS
319 :type '(choice (const :tag "When visiting" visit)
320 (const :tag "When saving" t)
321 (const :tag "When visiting or saving" visit-save)
93d1963d
RS
322 (const :tag "Don't add newlines" nil)
323 (other :tag "Ask each time" ask))
f4206092 324 :group 'editing-basics
bf247b6e 325 :version "22.1")
f4206092 326
21540597 327(defcustom auto-save-default t
ba83982b 328 "Non-nil says by default do auto-saving of every file-visiting buffer."
21540597
RS
329 :type 'boolean
330 :group 'auto-save)
b4da00e9 331
ffc0e1ca 332(defcustom auto-save-file-name-transforms
b1e5937c 333 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
747981b0
EZ
334 ;; Don't put "\\2" inside expand-file-name, since it will be
335 ;; transformed to "/2" on DOS/Windows.
a0b60c33 336 ,(concat temporary-file-directory "\\2") t))
ba83982b 337 "Transforms to apply to buffer file name before making auto-save file name.
a0b60c33 338Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
ffc0e1ca
AS
339REGEXP is a regular expression to match against the file name.
340If it matches, `replace-match' is used to replace the
341matching part with REPLACEMENT.
a0b60c33 342If the optional element UNIQUIFY is non-nil, the auto-save file name is
36236b72 343constructed by taking the directory part of the replaced file-name,
a0b60c33
GM
344concatenated with the buffer file name with all directory separators
345changed to `!' to prevent clashes. This will not work
346correctly if your filesystem truncates the resulting name.
347
ffc0e1ca
AS
348All the transforms in the list are tried, in the order they are listed.
349When one transform applies, its result is final;
350no further transforms are tried.
351
a2899d6c
KG
352The default value is set up to put the auto-save file into the
353temporary directory (see the variable `temporary-file-directory') for
a0b60c33
GM
354editing a remote file.
355
356On MS-DOS filesystems without long names this variable is always
357ignored."
ffc0e1ca 358 :group 'auto-save
a0b60c33
GM
359 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
360 (boolean :tag "Uniquify")))
ffc0e1ca
AS
361 :version "21.1")
362
88b36776 363(defcustom save-abbrevs t
ba83982b 364 "Non-nil means save word abbrevs too when files are saved.
02c6a1cc
EZ
365If `silently', don't ask the user before saving."
366 :type '(choice (const t) (const nil) (const silently))
21540597 367 :group 'abbrev)
b4da00e9 368
21540597 369(defcustom find-file-run-dired t
ba83982b 370 "Non-nil means allow `find-file' to visit directories.
ffc0e1ca 371To visit the directory, `find-file' runs `find-directory-functions'."
21540597
RS
372 :type 'boolean
373 :group 'find-file)
b4da00e9 374
ffc0e1ca 375(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
ba83982b 376 "List of functions to try in sequence to visit a directory.
ffc0e1ca
AS
377Each function is called with the directory name as the sole argument
378and should return either a buffer or nil."
379 :type '(hook :options (cvs-dired-noselect dired-noselect))
380 :group 'find-file)
381
92966e6f
RS
382;;;It is not useful to make this a local variable.
383;;;(put 'find-file-not-found-hooks 'permanent-local t)
0370fe77 384(defvar find-file-not-found-functions nil
b4da00e9
RM
385 "List of functions to be called for `find-file' on nonexistent file.
386These functions are called as soon as the error is detected.
ffc0e1ca 387Variable `buffer-file-name' is already set up.
b4da00e9 388The functions are called in the order given until one of them returns non-nil.")
26b9ecbc
JB
389(define-obsolete-variable-alias 'find-file-not-found-hooks
390 'find-file-not-found-functions "22.1")
b4da00e9 391
92966e6f
RS
392;;;It is not useful to make this a local variable.
393;;;(put 'find-file-hooks 'permanent-local t)
cd6ef82d 394(define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
564af258 395(defcustom find-file-hook nil
b4da00e9
RM
396 "List of functions to be called after a buffer is loaded from a file.
397The buffer's local variables (if any) will have been processed before the
564af258
DL
398functions are called."
399 :group 'find-file
400 :type 'hook
401 :options '(auto-insert)
bf247b6e 402 :version "22.1")
b4da00e9 403
0370fe77 404(defvar write-file-functions nil
b4da00e9
RM
405 "List of functions to be called before writing out a buffer to a file.
406If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
407and the rest are not called.
408These hooks are considered to pertain to the visited file.
0370fe77
SM
409So any buffer-local binding of this variable is discarded if you change
410the visited file name with \\[set-visited-file-name], but not when you
411change the major mode.
412
0eb0202f
LT
413This hook is not run if any of the functions in
414`write-contents-functions' returns non-nil. Both hooks pertain
415to how to save a buffer to file, for instance, choosing a suitable
416coding system and setting mode bits. (See Info
417node `(elisp)Saving Buffers'.) To perform various checks or
26b9ecbc 418updates before the buffer is saved, use `before-save-hook'.")
0370fe77 419(put 'write-file-functions 'permanent-local t)
26b9ecbc 420(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
0370fe77
SM
421
422(defvar local-write-file-hooks nil)
b19f1da4
BF
423(make-variable-buffer-local 'local-write-file-hooks)
424(put 'local-write-file-hooks 'permanent-local t)
bf247b6e 425(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
8c0e7b73 426
0370fe77 427(defvar write-contents-functions nil
8c0e7b73
JB
428 "List of functions to be called before writing out a buffer to a file.
429If one of them returns non-nil, the file is considered already written
7dd11b37
LH
430and the rest are not called and neither are the functions in
431`write-file-functions'.
f82966e4
KH
432
433This variable is meant to be used for hooks that pertain to the
434buffer's contents, not to the particular visited file; thus,
435`set-visited-file-name' does not clear this variable; but changing the
693f800d
RS
436major mode does clear it.
437
0eb0202f
LT
438For hooks that _do_ pertain to the particular visited file, use
439`write-file-functions'. Both this variable and
440`write-file-functions' relate to how a buffer is saved to file.
441To perform various checks or updates before the buffer is saved,
442use `before-save-hook'.")
0370fe77 443(make-variable-buffer-local 'write-contents-functions)
26b9ecbc
JB
444(define-obsolete-variable-alias 'write-contents-hooks
445 'write-contents-functions "22.1")
b4da00e9 446
21540597 447(defcustom enable-local-variables t
ba83982b 448 "Control use of local variables in files you visit.
d355b270 449The value can be t, nil, :safe, :all, or something else.
5a6c1d87
CY
450
451A value of t means file local variables specifications are obeyed
a251756e
RS
452if all the specified variable values are safe; if any values are
453not safe, Emacs queries you, once, whether to set them all.
a5ce12c3
RS
454\(When you say yes to certain values, they are remembered as safe.)
455
456:safe means set the safe variables, and ignore the rest.
e58cec15
RS
457:all means set all variables, whether safe or not.
458 (Don't set it permanently to :all.)
756c496f 459A value of nil means always ignore the file local variables.
a251756e 460
a251756e 461Any other value means always query you once whether to set them all.
a5ce12c3
RS
462\(When you say yes to certain values, they are remembered as safe, but
463this has no effect when `enable-local-variables' is \"something else\".)
5a6c1d87 464
aa5fcebf
KH
465This variable also controls use of major modes specified in
466a -*- line.
b4da00e9 467
aa5fcebf
KH
468The command \\[normal-mode], when used interactively,
469always obeys file local variable specifications and the -*- line,
470and ignores this variable."
e58cec15 471 :type '(choice (const :tag "Query Unsafe" t)
a5ce12c3 472 (const :tag "Safe Only" :safe)
e58cec15 473 (const :tag "Do all" :all)
21540597 474 (const :tag "Ignore" nil)
e48807d1 475 (other :tag "Query" other))
21540597 476 :group 'find-file)
b4da00e9 477
da09b92b
RS
478(defvar local-enable-local-variables t
479 "Like `enable-local-variables' but meant for buffer-local bindings.
aa5fcebf 480The meaningful values are nil and non-nil. The default is non-nil.
da09b92b 481If a major mode sets this to nil, buffer-locally, then any local
aa5fcebf
KH
482variables list in the file will be ignored.
483
484This variable does not affect the use of major modes
485specified in a -*- line.")
da09b92b 486
21540597 487(defcustom enable-local-eval 'maybe
e442c62b 488 "Control processing of the \"variable\" `eval' in a file's local variables.
d207b766 489The value can be t, nil or something else.
8fc29035 490A value of t means obey `eval' variables.
756c496f 491A value of nil means ignore them; anything else means query."
21540597
RS
492 :type '(choice (const :tag "Obey" t)
493 (const :tag "Ignore" nil)
e48807d1 494 (other :tag "Query" other))
21540597 495 :group 'find-file)
b4da00e9
RM
496
497;; Avoid losing in versions where CLASH_DETECTION is disabled.
498(or (fboundp 'lock-buffer)
231c4e10 499 (defalias 'lock-buffer 'ignore))
b4da00e9 500(or (fboundp 'unlock-buffer)
231c4e10 501 (defalias 'unlock-buffer 'ignore))
a7305f6e
RS
502(or (fboundp 'file-locked-p)
503 (defalias 'file-locked-p 'ignore))
93fe0a35 504
cb211eb2 505(defcustom view-read-only nil
ba83982b 506 "Non-nil means buffers visiting files read-only do so in view mode.
4c91443d
RS
507In fact, this means that all read-only buffers normally have
508View mode enabled, including buffers that are read-only because
509you visit a file you cannot alter, and buffers you make read-only
510using \\[toggle-read-only]."
cb211eb2
SM
511 :type 'boolean
512 :group 'view)
2a9fe1e2 513
5c471b12 514(defvar file-name-history nil
426aa4f0
EZ
515 "History list of file names entered in the minibuffer.
516
517Maximum length of the history list is determined by the value
518of `history-length', which see.")
5c471b12 519\f
1aa8fe46 520(put 'ange-ftp-completion-hook-function 'safe-magic t)
93fe0a35 521(defun ange-ftp-completion-hook-function (op &rest args)
ffc0e1ca
AS
522 "Provides support for ange-ftp host name completion.
523Runs the usual ange-ftp hook, but only for completion operations."
524 ;; Having this here avoids the need to load ange-ftp when it's not
525 ;; really in use.
93fe0a35
RS
526 (if (memq op '(file-name-completion file-name-all-completions))
527 (apply 'ange-ftp-hook-function op args)
57e81f57
RS
528 (let ((inhibit-file-name-handlers
529 (cons 'ange-ftp-completion-hook-function
530 (and (eq inhibit-file-name-operation op)
531 inhibit-file-name-handlers)))
532 (inhibit-file-name-operation op))
93fe0a35 533 (apply op args))))
567c1ca9
RS
534
535(defun convert-standard-filename (filename)
a576d8e2 536 "Convert a standard file's name to something suitable for the OS.
915b0bf0
JB
537This means to guarantee valid names and perhaps to canonicalize
538certain patterns.
539
f2430a0d
SM
540FILENAME should be an absolute file name since the conversion rules
541sometimes vary depending on the position in the file name. E.g. c:/foo
542is a valid DOS file name, but c:/bar/c:/foo is not.
543
915b0bf0
JB
544This function's standard definition is trivial; it just returns
545the argument. However, on Windows and DOS, replace invalid
18b28ef1
EZ
546characters. On DOS, make sure to obey the 8.3 limitations.
547In the native Windows build, turn Cygwin names into native names,
548and also turn slashes into backslashes if the shell requires it (see
a576d8e2
LT
549`w32-shell-dos-semantics').
550
551See Info node `(elisp)Standard File Names' for more details."
18b28ef1
EZ
552 (if (eq system-type 'cygwin)
553 (let ((name (copy-sequence filename))
554 (start 0))
555 ;; Replace invalid filename characters with !
556 (while (string-match "[?*:<>|\"\000-\037]" name start)
4b690a83 557 (aset name (match-beginning 0) ?!)
18b28ef1
EZ
558 (setq start (match-end 0)))
559 name)
560 filename))
5d4d17b8
KS
561
562(defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
563 "Read directory name, prompting with PROMPT and completing in directory DIR.
564Value is not expanded---you must call `expand-file-name' yourself.
25802eac
LT
565Default name to DEFAULT-DIRNAME if user exits with the same
566non-empty string that was inserted by this function.
44dce0fb
RS
567 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
568 or just DIR if INITIAL is nil.)
25802eac
LT
569If the user exits with an empty minibuffer, this function returns
570an empty string. (This can only happen if the user erased the
571pre-inserted contents or if `insert-default-directory' is nil.)
5d4d17b8
KS
572Fourth arg MUSTMATCH non-nil means require existing directory's name.
573 Non-nil and non-t means also require confirmation after completion.
574Fifth arg INITIAL specifies text to start with.
25802eac
LT
575DIR should be an absolute directory name. It defaults to
576the value of `default-directory'."
5d4d17b8
KS
577 (unless dir
578 (setq dir default-directory))
54005870 579 (read-file-name prompt dir (or default-dirname
44dce0fb
RS
580 (if initial (expand-file-name initial dir)
581 dir))
582 mustmatch initial
5d4d17b8
KS
583 'file-directory-p))
584
b4da00e9
RM
585\f
586(defun pwd ()
587 "Show the current default directory."
588 (interactive nil)
589 (message "Directory %s" default-directory))
590
231c4e10
ER
591(defvar cd-path nil
592 "Value of the CDPATH environment variable, as a list.
9ee45b2c 593Not actually set up until the first time you use it.")
231c4e10
ER
594
595(defun parse-colon-path (cd-path)
ae135939 596 "Explode a search path into a list of directory names.
c5994cfa
JB
597Directories are separated by occurrences of `path-separator'
598\(which is colon in GNU and GNU-like systems)."
ffc0e1ca 599 ;; We could use split-string here.
231c4e10 600 (and cd-path
818286f4 601 (let (cd-list (cd-start 0) cd-colon)
306faa42
RS
602 (setq cd-path (concat cd-path path-separator))
603 (while (setq cd-colon (string-match path-separator cd-path cd-start))
231c4e10 604 (setq cd-list
9daefb36 605 (nconc cd-list
c52e4104
RS
606 (list (if (= cd-start cd-colon)
607 nil
608 (substitute-in-file-name
e33e80e4
RS
609 (file-name-as-directory
610 (substring cd-path cd-start cd-colon)))))))
231c4e10
ER
611 (setq cd-start (+ cd-colon 1)))
612 cd-list)))
613
614(defun cd-absolute (dir)
30c5ce9c 615 "Change current directory to given absolute file name DIR."
f4a0f59b
RS
616 ;; Put the name into directory syntax now,
617 ;; because otherwise expand-file-name may give some bad results.
7c2fb837 618 (setq dir (file-name-as-directory dir))
f4a0f59b 619 (setq dir (abbreviate-file-name (expand-file-name dir)))
b4da00e9 620 (if (not (file-directory-p dir))
83c6f446
RS
621 (if (file-exists-p dir)
622 (error "%s is not a directory" dir)
31c691c1 623 (error "%s: no such directory" dir))
cfef87ad
TTN
624 (unless (file-executable-p dir)
625 (error "Cannot cd to %s: Permission denied" dir))
626 (setq default-directory dir)
627 (set (make-local-variable 'list-buffers-directory) dir)))
b4da00e9 628
231c4e10
ER
629(defun cd (dir)
630 "Make DIR become the current buffer's default directory.
ae135939
JB
631If your environment includes a `CDPATH' variable, try each one of
632that list of directories (separated by occurrences of
c5994cfa
JB
633`path-separator') when resolving a relative directory name.
634The path separator is colon in GNU and GNU-like systems."
dac4ea74 635 (interactive
5d4d17b8 636 (list (read-directory-name "Change default directory: "
2121cd9c
RM
637 default-directory default-directory
638 (and (member cd-path '(nil ("./")))
639 (null (getenv "CDPATH"))))))
30c5ce9c
RS
640 (if (file-name-absolute-p dir)
641 (cd-absolute (expand-file-name dir))
642 (if (null cd-path)
643 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
644 (setq cd-path (or trypath (list "./")))))
645 (if (not (catch 'found
458c46fc 646 (mapc
30c5ce9c
RS
647 (function (lambda (x)
648 (let ((f (expand-file-name (concat x dir))))
649 (if (file-directory-p f)
650 (progn
651 (cd-absolute f)
652 (throw 'found t))))))
653 cd-path)
654 nil))
655 (error "No such directory found via CDPATH environment variable"))))
231c4e10 656
b4da00e9
RM
657(defun load-file (file)
658 "Load the Lisp file named FILE."
58195faa
DL
659 ;; This is a case where .elc makes a lot of sense.
660 (interactive (list (let ((completion-ignored-extensions
9ab80679 661 (remove ".elc" completion-ignored-extensions)))
58195faa
DL
662 (read-file-name "Load file: "))))
663 (load (expand-file-name file) nil nil t))
b4da00e9 664
38eea7c7
SM
665(defun locate-file (filename path &optional suffixes predicate)
666 "Search for FILENAME through PATH.
c7c4bc11
EZ
667If found, return the absolute file name of FILENAME, with its suffixes;
668otherwise return nil.
669PATH should be a list of directories to look in, like the lists in
670`exec-path' or `load-path'.
38eea7c7
SM
671If SUFFIXES is non-nil, it should be a list of suffixes to append to
672file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
c7c4bc11 673Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
38eea7c7 674If non-nil, PREDICATE is used instead of `file-readable-p'.
e6f0ff92
RS
675PREDICATE can also be an integer to pass to the `access' system call,
676in which case file-name handlers are ignored. This usage is deprecated.
677
678For compatibility, PREDICATE can also be one of the symbols
679`executable', `readable', `writable', or `exists', or a list of
680one or more of those symbols."
38eea7c7
SM
681 (if (and predicate (symbolp predicate) (not (functionp predicate)))
682 (setq predicate (list predicate)))
683 (when (and (consp predicate) (not (functionp predicate)))
684 (setq predicate
685 (logior (if (memq 'executable predicate) 1 0)
686 (if (memq 'writable predicate) 2 0)
687 (if (memq 'readable predicate) 4 0))))
688 (locate-file-internal filename path suffixes predicate))
689
e8dab975
SM
690(defun locate-file-completion-table (dirs suffixes string pred action)
691 "Do completion for file names passed to `locate-file'."
2c3d8820 692 (if (file-name-absolute-p string)
e8dab975
SM
693 (let ((read-file-name-predicate pred))
694 (read-file-name-internal string nil action))
2c3d8820 695 (let ((names nil)
e8dab975 696 (suffix (concat (regexp-opt suffixes t) "\\'"))
2c3d8820 697 (string-dir (file-name-directory string)))
e8dab975 698 (dolist (dir dirs)
f2440e42
RS
699 (unless dir
700 (setq dir default-directory))
2c3d8820
SM
701 (if string-dir (setq dir (expand-file-name string-dir dir)))
702 (when (file-directory-p dir)
703 (dolist (file (file-name-all-completions
704 (file-name-nondirectory string) dir))
e1cac570 705 (add-to-list 'names (if string-dir (concat string-dir file) file))
2c3d8820
SM
706 (when (string-match suffix file)
707 (setq file (substring file 0 (match-beginning 0)))
708 (push (if string-dir (concat string-dir file) file) names)))))
e8dab975
SM
709 (complete-with-action action names string pred))))
710
711(defun locate-file-completion (string path-and-suffixes action)
712 "Do completion for file names passed to `locate-file'.
713PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
714 (locate-file-completion-table (car path-and-suffixes)
715 (cdr path-and-suffixes)
716 string nil action))
717(make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
2c3d8820 718
8cd56959 719(defvar locate-dominating-stop-dir-regexp
976556c9 720 "\\`\\(?:[\\/][\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
8cd56959
SM
721 "Regexp of directory names which stop the search in `locate-dominating-file'.
722Any directory whose name matches this regexp will be treated like
723a kind of root directory by `locate-dominating-file' which will stop its search
724when it bumps into it.
725The default regexp prevents fruitless and time-consuming attempts to find
726special files in directories in which filenames are interpreted as hostnames.")
727
728;; (defun locate-dominating-files (file regexp)
729;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
730;; Stop at the first parent where a matching file is found and return the list
731;; of files that that match in this directory."
732;; (catch 'found
733;; ;; `user' is not initialized yet because `file' may not exist, so we may
734;; ;; have to walk up part of the hierarchy before we find the "initial UID".
735;; (let ((user nil)
736;; ;; Abbreviate, so as to stop when we cross ~/.
737;; (dir (abbreviate-file-name (file-name-as-directory file)))
738;; files)
739;; (while (and dir
740;; ;; As a heuristic, we stop looking up the hierarchy of
741;; ;; directories as soon as we find a directory belonging to
742;; ;; another user. This should save us from looking in
743;; ;; things like /net and /afs. This assumes that all the
744;; ;; files inside a project belong to the same user.
745;; (let ((prev-user user))
746;; (setq user (nth 2 (file-attributes dir)))
747;; (or (null prev-user) (equal user prev-user))))
748;; (if (setq files (condition-case nil
749;; (directory-files dir 'full regexp 'nosort)
750;; (error nil)))
751;; (throw 'found files)
752;; (if (equal dir
753;; (setq dir (file-name-directory
754;; (directory-file-name dir))))
755;; (setq dir nil))))
756;; nil)))
757
758(defun locate-dominating-file (file name)
759 "Look up the directory hierarchy from FILE for a file named NAME.
09949b83
JB
760Stop at the first parent directory containing a file NAME,
761and return the directory. Return nil if not found."
8cd56959
SM
762 ;; We used to use the above locate-dominating-files code, but the
763 ;; directory-files call is very costly, so we're much better off doing
764 ;; multiple calls using the code in here.
09949b83 765 ;;
8cd56959
SM
766 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
767 ;; `name' in /home or in /.
768 (setq file (abbreviate-file-name file))
769 (let ((root nil)
770 (prev-file file)
771 ;; `user' is not initialized outside the loop because
772 ;; `file' may not exist, so we may have to walk up part of the
773 ;; hierarchy before we find the "initial UID".
774 (user nil)
775 try)
776 (while (not (or root
777 (null file)
778 ;; FIXME: Disabled this heuristic because it is sometimes
779 ;; inappropriate.
780 ;; As a heuristic, we stop looking up the hierarchy of
781 ;; directories as soon as we find a directory belonging
782 ;; to another user. This should save us from looking in
783 ;; things like /net and /afs. This assumes that all the
784 ;; files inside a project belong to the same user.
785 ;; (let ((prev-user user))
786 ;; (setq user (nth 2 (file-attributes file)))
787 ;; (and prev-user (not (equal user prev-user))))
788 (string-match locate-dominating-stop-dir-regexp file)))
789 (setq try (file-exists-p (expand-file-name name file)))
790 (cond (try (setq root file))
791 ((equal file (setq prev-file file
792 file (file-name-directory
793 (directory-file-name file))))
794 (setq file nil))))
795 root))
796
418fd375 797
c3f6aa20
SM
798(defun executable-find (command)
799 "Search for COMMAND in `exec-path' and return the absolute file name.
800Return nil if COMMAND is not found anywhere in `exec-path'."
801 ;; Use 1 rather than file-executable-p to better match the behavior of
802 ;; call-process.
803 (locate-file command exec-path exec-suffixes 1))
804
b4da00e9
RM
805(defun load-library (library)
806 "Load the library named LIBRARY.
807This is an interface to the function `load'."
38eea7c7
SM
808 (interactive
809 (list (completing-read "Load library: "
e8dab975
SM
810 (apply-partially 'locate-file-completion-table
811 load-path
812 (get-load-suffixes)))))
b4da00e9 813 (load library))
5d68c2c2 814
ac25542d 815(defun file-remote-p (file &optional identification connected)
3f788773 816 "Test whether FILE specifies a location on a remote system.
8299c8a5
SM
817Returns nil or a string identifying the remote connection (ideally
818a prefix of FILE). For example, the remote identification for filename
819\"/user@host:/foo\" could be \"/user@host:\".
820A file is considered \"remote\" if accessing it is likely to be slower or
821less reliable than accessing local files.
822Furthermore, relative file names do not work across remote connections.
00d6fd04 823
ac25542d
MA
824IDENTIFICATION specifies which part of the identification shall
825be returned as string. IDENTIFICATION can be the symbol
9f2f6ad8
MA
826`method', `user', `host' or `localname'; any other value is
827handled like nil and means to return the complete identification
828string.
ac25542d 829
00d6fd04
MA
830If CONNECTED is non-nil, the function returns an identification only
831if FILE is located on a remote system, and a connection is established
832to that remote system.
833
834`file-remote-p' will never open a connection on its own."
04621aaa 835 (let ((handler (find-file-name-handler file 'file-remote-p)))
ff7affeb 836 (if handler
ac25542d 837 (funcall handler 'file-remote-p file identification connected)
04621aaa 838 nil)))
ff7affeb 839
ffc0e1ca 840(defun file-local-copy (file)
5d68c2c2
RS
841 "Copy the file FILE into a temporary file on this machine.
842Returns the name of the local copy, or nil, if FILE is directly
843accessible."
ffc0e1ca
AS
844 ;; This formerly had an optional BUFFER argument that wasn't used by
845 ;; anything.
6eaebaa2 846 (let ((handler (find-file-name-handler file 'file-local-copy)))
5d68c2c2
RS
847 (if handler
848 (funcall handler 'file-local-copy file)
849 nil)))
f3e23606 850
05ef1cda 851(defun file-truename (filename &optional counter prev-dirs)
f3e23606
RS
852 "Return the truename of FILENAME, which should be absolute.
853The truename of a file name is found by chasing symbolic links
854both at the level of the file and at the level of the directories
05ef1cda
RS
855containing it, until no links are left at any level.
856
89bf74f8 857\(fn FILENAME)" ;; Don't document the optional arguments.
b9963e32
JB
858 ;; COUNTER and PREV-DIRS are only used in recursive calls.
859 ;; COUNTER can be a cons cell whose car is the count of how many
860 ;; more links to chase before getting an error.
05ef1cda
RS
861 ;; PREV-DIRS can be a cons cell whose car is an alist
862 ;; of truenames we've just recently computed.
f2440e42
RS
863 (cond ((or (string= filename "") (string= filename "~"))
864 (setq filename (expand-file-name filename))
865 (if (string= filename "")
866 (setq filename "/")))
867 ((and (string= (substring filename 0 1) "~")
868 (string-match "~[^/]*/?" filename))
869 (let ((first-part
870 (substring filename 0 (match-end 0)))
871 (rest (substring filename (match-end 0))))
872 (setq filename (concat (expand-file-name first-part) rest)))))
873
05ef1cda 874 (or counter (setq counter (list 100)))
b505828b
RS
875 (let (done
876 ;; For speed, remove the ange-ftp completion handler from the list.
877 ;; We know it's not needed here.
878 ;; For even more speed, do this only on the outermost call.
879 (file-name-handler-alist
880 (if prev-dirs file-name-handler-alist
881 (let ((tem (copy-sequence file-name-handler-alist)))
882 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
883 (or prev-dirs (setq prev-dirs (list nil)))
b1667e6c
GV
884
885 ;; andrewi@harlequin.co.uk - none of the following code (except for
886 ;; invoking the file-name handler) currently applies on Windows
887 ;; (ie. there are no native symlinks), but there is an issue with
888 ;; case differences being ignored by the OS, and short "8.3 DOS"
889 ;; name aliases existing for all files. (The short names are not
890 ;; reported by directory-files, but can be used to refer to files.)
891 ;; It seems appropriate for file-truename to resolve these issues in
892 ;; the most natural way, which on Windows is to call the function
893 ;; `w32-long-file-name' - this returns the exact name of a file as
894 ;; it is stored on disk (expanding short name aliases with the full
895 ;; name in the process).
896 (if (eq system-type 'windows-nt)
06dd5ef7 897 (let ((handler (find-file-name-handler filename 'file-truename)))
b1667e6c
GV
898 ;; For file name that has a special handler, call handler.
899 ;; This is so that ange-ftp can save time by doing a no-op.
900 (if handler
901 (setq filename (funcall handler 'file-truename filename))
902 ;; If filename contains a wildcard, newname will be the old name.
06dd5ef7 903 (unless (string-match "[[*?]" filename)
85d181e1
JR
904 ;; If filename exists, use the long name. If it doesn't exist,
905 ;; drill down until we find a directory that exists, and use
906 ;; the long name of that, with the extra non-existent path
907 ;; components concatenated.
908 (let ((longname (w32-long-file-name filename))
909 missing rest)
910 (if longname
911 (setq filename longname)
35e3abe5 912 ;; Include the preceding directory separator in the missing
85d181e1
JR
913 ;; part so subsequent recursion on the rest works.
914 (setq missing (concat "/" (file-name-nondirectory filename)))
35e3abe5
MR
915 (let ((length (length missing)))
916 (setq rest
917 (if (> length (length filename))
918 ""
919 (substring filename 0 (- length)))))
85d181e1 920 (setq filename (concat (file-truename rest) missing))))))
b1667e6c
GV
921 (setq done t)))
922
05ef1cda
RS
923 ;; If this file directly leads to a link, process that iteratively
924 ;; so that we don't use lots of stack.
925 (while (not done)
926 (setcar counter (1- (car counter)))
927 (if (< (car counter) 0)
928 (error "Apparent cycle of symbolic links for %s" filename))
929 (let ((handler (find-file-name-handler filename 'file-truename)))
930 ;; For file name that has a special handler, call handler.
931 ;; This is so that ange-ftp can save time by doing a no-op.
932 (if handler
933 (setq filename (funcall handler 'file-truename filename)
934 done t)
fb145562 935 (let ((dir (or (file-name-directory filename) default-directory))
05ef1cda
RS
936 target dirfile)
937 ;; Get the truename of the directory.
938 (setq dirfile (directory-file-name dir))
939 ;; If these are equal, we have the (or a) root directory.
940 (or (string= dir dirfile)
941 ;; If this is the same dir we last got the truename for,
942 ;; save time--don't recalculate.
943 (if (assoc dir (car prev-dirs))
944 (setq dir (cdr (assoc dir (car prev-dirs))))
945 (let ((old dir)
946 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
947 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
948 (setq dir new))))
949 (if (equal ".." (file-name-nondirectory filename))
950 (setq filename
951 (directory-file-name (file-name-directory (directory-file-name dir)))
952 done t)
953 (if (equal "." (file-name-nondirectory filename))
954 (setq filename (directory-file-name dir)
955 done t)
956 ;; Put it back on the file name.
957 (setq filename (concat dir (file-name-nondirectory filename)))
958 ;; Is the file name the name of a link?
959 (setq target (file-symlink-p filename))
960 (if target
961 ;; Yes => chase that link, then start all over
962 ;; since the link may point to a directory name that uses links.
963 ;; We can't safely use expand-file-name here
964 ;; since target might look like foo/../bar where foo
965 ;; is itself a link. Instead, we handle . and .. above.
966 (setq filename
967 (if (file-name-absolute-p target)
968 target
969 (concat dir target))
970 done nil)
971 ;; No, we are done!
972 (setq done t))))))))
973 filename))
5dbfdacd 974
302fcc98 975(defun file-chase-links (filename &optional limit)
5dadeb29 976 "Chase links in FILENAME until a name that is not a link.
302fcc98
RS
977Unlike `file-truename', this does not check whether a parent
978directory name is a symbolic link.
979If the optional argument LIMIT is a number,
980it means chase no more than that many links and then stop."
981 (let (tem (newname filename)
92464ae6 982 (count 0))
302fcc98
RS
983 (while (and (or (null limit) (< count limit))
984 (setq tem (file-symlink-p newname)))
9695aac6 985 (save-match-data
92464ae6 986 (if (and (null limit) (= count 100))
9695aac6
RS
987 (error "Apparent cycle of symbolic links for %s" filename))
988 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
989 (while (string-match "//+" tem)
990 (setq tem (replace-match "/" nil nil tem)))
991 ;; Handle `..' by hand, since it needs to work in the
992 ;; target of any directory symlink.
993 ;; This code is not quite complete; it does not handle
994 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
995 (while (string-match "\\`\\.\\./" tem)
996 (setq tem (substring tem 3))
997 (setq newname (expand-file-name newname))
998 ;; Chase links in the default dir of the symlink.
999 (setq newname
1000 (file-chase-links
1001 (directory-file-name (file-name-directory newname))))
1002 ;; Now find the parent of that dir.
1003 (setq newname (file-name-directory newname)))
1004 (setq newname (expand-file-name tem (file-name-directory newname)))
92464ae6 1005 (setq count (1+ count))))
5dadeb29 1006 newname))
9bdbd98e 1007
9e8bb7f7
RS
1008(defun make-temp-file (prefix &optional dir-flag suffix)
1009 "Create a temporary file.
1010The returned file name (created by appending some random characters at the end
1011of PREFIX, and expanding against `temporary-file-directory' if necessary),
1012is guaranteed to point to a newly created empty file.
1013You can then use `write-region' to write new data into the file.
1014
1015If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1016
1017If SUFFIX is non-nil, add that at the end of the file name."
1018 (let ((umask (default-file-modes))
1019 file)
1020 (unwind-protect
1021 (progn
1022 ;; Create temp files with strict access rights. It's easy to
1023 ;; loosen them later, whereas it's impossible to close the
1024 ;; time-window of loose permissions otherwise.
1025 (set-default-file-modes ?\700)
1026 (while (condition-case ()
1027 (progn
1028 (setq file
1029 (make-temp-name
f8dce815
GM
1030 (if (zerop (length prefix))
1031 (file-name-as-directory
1032 temporary-file-directory)
1033 (expand-file-name prefix
1034 temporary-file-directory))))
9e8bb7f7
RS
1035 (if suffix
1036 (setq file (concat file suffix)))
1037 (if dir-flag
1038 (make-directory file)
1039 (write-region "" nil file nil 'silent nil 'excl))
1040 nil)
1041 (file-already-exists t))
1042 ;; the file was somehow created by someone else between
1043 ;; `make-temp-name' and `write-region', let's try again.
1044 nil)
1045 file)
1046 ;; Reset the umask.
1047 (set-default-file-modes umask))))
1048
9bdbd98e
KH
1049(defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1050 "Change the encoding of FILE's name from CODING to NEW-CODING.
1051The value is a new name of FILE.
1052Signals a `file-already-exists' error if a file of the new name
26b9ecbc
JB
1053already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1054is non-nil. A number as fourth arg means request confirmation if
9bdbd98e
KH
1055the new name already exists. This is what happens in interactive
1056use with M-x."
1057 (interactive
1058 (let ((default-coding (or file-name-coding-system
1059 default-file-name-coding-system))
1060 (filename (read-file-name "Recode filename: " nil nil t))
1061 from-coding to-coding)
1062 (if (and default-coding
1063 ;; We provide the default coding only when it seems that
1064 ;; the filename is correctly decoded by the default
1065 ;; coding.
1066 (let ((charsets (find-charset-string filename)))
1067 (and (not (memq 'eight-bit-control charsets))
1068 (not (memq 'eight-bit-graphic charsets)))))
1069 (setq from-coding (read-coding-system
1070 (format "Recode filename %s from (default %s): "
1071 filename default-coding)
1072 default-coding))
1073 (setq from-coding (read-coding-system
1074 (format "Recode filename %s from: " filename))))
cdec2ad7 1075
9bdbd98e
KH
1076 ;; We provide the default coding only when a user is going to
1077 ;; change the encoding not from the default coding.
1078 (if (eq from-coding default-coding)
1079 (setq to-coding (read-coding-system
1080 (format "Recode filename %s from %s to: "
1081 filename from-coding)))
1082 (setq to-coding (read-coding-system
1083 (format "Recode filename %s from %s to (default %s): "
1084 filename from-coding default-coding)
1085 default-coding)))
1086 (list filename from-coding to-coding)))
1087
1088 (let* ((default-coding (or file-name-coding-system
1089 default-file-name-coding-system))
1090 ;; FILE should have been decoded by DEFAULT-CODING.
1091 (encoded (encode-coding-string file default-coding))
1092 (newname (decode-coding-string encoded coding))
1093 (new-encoded (encode-coding-string newname new-coding))
1094 ;; Suppress further encoding.
1095 (file-name-coding-system nil)
1096 (default-file-name-coding-system nil)
1097 (locale-coding-system nil))
1098 (rename-file encoded new-encoded ok-if-already-exists)
1099 newname))
b4da00e9 1100\f
e4c0cccf
JL
1101(defun read-buffer-to-switch (prompt)
1102 "Read the name of a buffer to switch to and return as a string.
1103It is intended for `switch-to-buffer' family of commands since they
28bb43e1 1104need to omit the name of current buffer from the list of completions
e4c0cccf 1105and default values."
28bb43e1
SM
1106 (let ((rbts-completion-table (internal-complete-buffer-except)))
1107 (minibuffer-with-setup-hook
1108 (lambda () (setq minibuffer-completion-table rbts-completion-table))
1109 (read-buffer prompt (other-buffer (current-buffer))))))
e4c0cccf 1110
467ff692
RS
1111(defun switch-to-buffer-other-window (buffer &optional norecord)
1112 "Select buffer BUFFER in another window.
839857c7
LT
1113If BUFFER does not identify an existing buffer, then this function
1114creates a buffer with that name.
1115
1116When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1117or nil. If BUFFER is nil, then this function chooses a buffer
1118using `other-buffer'.
8fc29035
JB
1119Optional second arg NORECORD non-nil means do not put this
1120buffer at the front of the list of recently selected ones.
839857c7 1121This function returns the buffer it switched to.
4c6a4739
EZ
1122
1123This uses the function `display-buffer' as a subroutine; see its
1124documentation for additional customization information."
e4c0cccf
JL
1125 (interactive
1126 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
cf44b9b7
RS
1127 (let ((pop-up-windows t)
1128 ;; Don't let these interfere.
1129 same-window-buffer-names same-window-regexps)
467ff692 1130 (pop-to-buffer buffer t norecord)))
b4da00e9 1131
467ff692
RS
1132(defun switch-to-buffer-other-frame (buffer &optional norecord)
1133 "Switch to buffer BUFFER in another frame.
1676807b
MR
1134Optional second arg NORECORD non-nil means do not put this
1135buffer at the front of the list of recently selected ones.
a769e627 1136This function returns the buffer it switched to.
4c6a4739 1137
1676807b
MR
1138This uses the function `display-buffer' as a subroutine; see
1139its documentation for additional customization information."
e4c0cccf
JL
1140 (interactive
1141 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
cf44b9b7
RS
1142 (let ((pop-up-frames t)
1143 same-window-buffer-names same-window-regexps)
1676807b 1144 (pop-to-buffer buffer t norecord)))
5bbbceb1 1145
ab9b3866 1146(defun display-buffer-other-frame (buffer)
1676807b
MR
1147 "Display buffer BUFFER in another frame.
1148This uses the function `display-buffer' as a subroutine; see
1149its documentation for additional customization information."
ab9b3866
RS
1150 (interactive "BDisplay buffer in other frame: ")
1151 (let ((pop-up-frames t)
1152 same-window-buffer-names same-window-regexps
1153 (old-window (selected-window))
1154 new-window)
1155 (setq new-window (display-buffer buffer t))
38a79e33
SM
1156 ;; This may have been here in order to prevent the new frame from hiding
1157 ;; the old frame. But it does more harm than good.
1158 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1159 ;;(lower-frame (window-frame new-window))
1160
1161 ;; This may have been here in order to make sure the old-frame gets the
1162 ;; focus. But not only can it cause an annoying flicker, with some
1163 ;; window-managers it just makes the window invisible, with no easy
1164 ;; way to recover it. --Stef
1165 ;;(make-frame-invisible (window-frame old-window))
1166 ;;(make-frame-visible (window-frame old-window))
1167 ))
ab9b3866 1168
a49a58f9
RS
1169(defvar find-file-default nil
1170 "Used within `find-file-read-args'.")
1171
a42e7db0
SM
1172(defmacro minibuffer-with-setup-hook (fun &rest body)
1173 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1174BODY should use the minibuffer at most once.
1175Recursive uses of the minibuffer will not be affected."
1176 (declare (indent 1) (debug t))
1177 (let ((hook (make-symbol "setup-hook")))
44dce0fb
RS
1178 `(let (,hook)
1179 (setq ,hook
1180 (lambda ()
1181 ;; Clear out this hook so it does not interfere
1182 ;; with any recursive minibuffer usage.
1183 (remove-hook 'minibuffer-setup-hook ,hook)
2bd49e46 1184 (funcall ,fun)))
a42e7db0
SM
1185 (unwind-protect
1186 (progn
1187 (add-hook 'minibuffer-setup-hook ,hook)
1188 ,@body)
1189 (remove-hook 'minibuffer-setup-hook ,hook)))))
1190
75f6af19 1191(defcustom find-file-confirm-nonexistent-file nil
ad3d50ef
RS
1192 "If non-nil, `find-file' requires confirmation before visiting a new file."
1193 :group 'find-file
1194 :version "23.1"
1195 :type 'boolean)
14fd09e5 1196
05a7cb3d 1197(defun find-file-read-args (prompt mustmatch)
e6f0ff92
RS
1198 (list (let ((find-file-default
1199 (and buffer-file-name
a42e7db0
SM
1200 (abbreviate-file-name buffer-file-name))))
1201 (minibuffer-with-setup-hook
1202 (lambda () (setq minibuffer-default find-file-default))
1203 (read-file-name prompt nil default-directory mustmatch)))
b2a26f4e 1204 t))
e6f0ff92 1205
243ce842 1206(defun find-file (filename &optional wildcards)
b4da00e9
RM
1207 "Edit file FILENAME.
1208Switch to a buffer visiting file FILENAME,
243ce842 1209creating one if none already exists.
e6f0ff92
RS
1210Interactively, the default if you just type RET is the current directory,
1211but the visited file name is available through the minibuffer history:
1212type M-n to pull it into the minibuffer.
1213
4d4efd30
EZ
1214You can visit files on remote machines by specifying something
1215like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1216also visit local files as a different user by specifying
6f174d77
EZ
1217/sudo::FILE for the file name.
1218See the Info node `(tramp)Filename Syntax' in the Tramp Info
1219manual, for more about this.
4d4efd30 1220
243ce842 1221Interactively, or if WILDCARDS is non-nil in a call from Lisp,
91174d63 1222expand wildcards (if any) and visit multiple files. You can
518dc5be 1223suppress wildcard expansion by setting `find-file-wildcards' to nil.
91174d63
RS
1224
1225To visit a file without any kind of conversion and without
1226automatically choosing a major mode, use \\[find-file-literally]."
14fd09e5
SM
1227 (interactive
1228 (find-file-read-args "Find file: "
75f6af19 1229 (if find-file-confirm-nonexistent-file 'confirm-only)))
5b8ed07b
RS
1230 (let ((value (find-file-noselect filename nil nil wildcards)))
1231 (if (listp value)
1232 (mapcar 'switch-to-buffer (nreverse value))
1233 (switch-to-buffer value))))
82d0954a 1234
243ce842 1235(defun find-file-other-window (filename &optional wildcards)
b4da00e9 1236 "Edit file FILENAME, in another window.
4d4efd30
EZ
1237
1238Like \\[find-file] (which see), but creates a new window or reuses
1239an existing one. See the function `display-buffer'.
e6f0ff92
RS
1240
1241Interactively, the default if you just type RET is the current directory,
1242but the visited file name is available through the minibuffer history:
1243type M-n to pull it into the minibuffer.
1244
243ce842
RS
1245Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1246expand wildcards (if any) and visit multiple files."
14fd09e5
SM
1247 (interactive
1248 (find-file-read-args "Find file in other window: "
75f6af19 1249 (if find-file-confirm-nonexistent-file 'confirm-only)))
5b8ed07b
RS
1250 (let ((value (find-file-noselect filename nil nil wildcards)))
1251 (if (listp value)
1252 (progn
1253 (setq value (nreverse value))
a9d6a617
JL
1254 (cons (switch-to-buffer-other-window (car value))
1255 (mapcar 'switch-to-buffer (cdr value))))
5b8ed07b 1256 (switch-to-buffer-other-window value))))
243ce842
RS
1257
1258(defun find-file-other-frame (filename &optional wildcards)
f98955ea 1259 "Edit file FILENAME, in another frame.
4d4efd30
EZ
1260
1261Like \\[find-file] (which see), but creates a new frame or reuses
1262an existing one. See the function `display-buffer'.
e6f0ff92
RS
1263
1264Interactively, the default if you just type RET is the current directory,
1265but the visited file name is available through the minibuffer history:
1266type M-n to pull it into the minibuffer.
1267
243ce842
RS
1268Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1269expand wildcards (if any) and visit multiple files."
14fd09e5
SM
1270 (interactive
1271 (find-file-read-args "Find file in other frame: "
75f6af19 1272 (if find-file-confirm-nonexistent-file 'confirm-only)))
5b8ed07b
RS
1273 (let ((value (find-file-noselect filename nil nil wildcards)))
1274 (if (listp value)
1275 (progn
1276 (setq value (nreverse value))
a9d6a617
JL
1277 (cons (switch-to-buffer-other-frame (car value))
1278 (mapcar 'switch-to-buffer (cdr value))))
5b8ed07b 1279 (switch-to-buffer-other-frame value))))
243ce842 1280
63c8abc4
EZ
1281(defun find-file-existing (filename)
1282 "Edit the existing file FILENAME.
4d4efd30 1283Like \\[find-file], but only allow a file that exists, and do not allow
63c8abc4
EZ
1284file names with wildcards."
1285 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1286 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1287 (error "%s does not exist" filename)
1288 (find-file filename)
1289 (current-buffer)))
46bfc73b 1290
243ce842 1291(defun find-file-read-only (filename &optional wildcards)
b4da00e9 1292 "Edit file FILENAME but don't allow changes.
4d4efd30 1293Like \\[find-file], but marks buffer as read-only.
b4da00e9 1294Use \\[toggle-read-only] to permit editing."
14fd09e5
SM
1295 (interactive
1296 (find-file-read-args "Find file read-only: "
75f6af19 1297 (if find-file-confirm-nonexistent-file 'confirm-only)))
a9d6a617
JL
1298 (unless (or (and wildcards find-file-wildcards
1299 (not (string-match "\\`/:" filename))
1300 (string-match "[[*?]" filename))
1301 (file-exists-p filename))
1302 (error "%s does not exist" filename))
1303 (let ((value (find-file filename wildcards)))
1304 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1305 (if (listp value) value (list value)))
1306 value))
b4da00e9 1307
243ce842 1308(defun find-file-read-only-other-window (filename &optional wildcards)
b4da00e9 1309 "Edit file FILENAME in another window but don't allow changes.
4d4efd30 1310Like \\[find-file-other-window], but marks buffer as read-only.
b4da00e9 1311Use \\[toggle-read-only] to permit editing."
14fd09e5
SM
1312 (interactive
1313 (find-file-read-args "Find file read-only other window: "
75f6af19 1314 (if find-file-confirm-nonexistent-file 'confirm-only)))
a9d6a617
JL
1315 (unless (or (and wildcards find-file-wildcards
1316 (not (string-match "\\`/:" filename))
1317 (string-match "[[*?]" filename))
1318 (file-exists-p filename))
1319 (error "%s does not exist" filename))
1320 (let ((value (find-file-other-window filename wildcards)))
1321 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1322 (if (listp value) value (list value)))
1323 value))
b4da00e9 1324
243ce842 1325(defun find-file-read-only-other-frame (filename &optional wildcards)
f98955ea 1326 "Edit file FILENAME in another frame but don't allow changes.
4d4efd30 1327Like \\[find-file-other-frame], but marks buffer as read-only.
5bbbceb1 1328Use \\[toggle-read-only] to permit editing."
14fd09e5
SM
1329 (interactive
1330 (find-file-read-args "Find file read-only other frame: "
75f6af19 1331 (if find-file-confirm-nonexistent-file 'confirm-only)))
a9d6a617
JL
1332 (unless (or (and wildcards find-file-wildcards
1333 (not (string-match "\\`/:" filename))
1334 (string-match "[[*?]" filename))
1335 (file-exists-p filename))
1336 (error "%s does not exist" filename))
1337 (let ((value (find-file-other-frame filename wildcards)))
1338 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1339 (if (listp value) value (list value)))
1340 value))
1341
1342(defun find-alternate-file-other-window (filename &optional wildcards)
60eaf370 1343 "Find file FILENAME as a replacement for the file in the next window.
a9d6a617
JL
1344This command does not select that window.
1345
4d4efd30
EZ
1346See \\[find-file] for the possible forms of the FILENAME argument.
1347
a9d6a617
JL
1348Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1349expand wildcards (if any) and replace the file with multiple files."
60eaf370
RS
1350 (interactive
1351 (save-selected-window
1352 (other-window 1)
1353 (let ((file buffer-file-name)
1354 (file-name nil)
1355 (file-dir nil))
1356 (and file
1357 (setq file-name (file-name-nondirectory file)
1358 file-dir (file-name-directory file)))
1359 (list (read-file-name
a9d6a617
JL
1360 "Find alternate file: " file-dir nil nil file-name)
1361 t))))
60eaf370 1362 (if (one-window-p)
a9d6a617 1363 (find-file-other-window filename wildcards)
60eaf370
RS
1364 (save-selected-window
1365 (other-window 1)
a9d6a617 1366 (find-alternate-file filename wildcards))))
60eaf370 1367
a9d6a617 1368(defun find-alternate-file (filename &optional wildcards)
b4da00e9
RM
1369 "Find file FILENAME, select its buffer, kill previous buffer.
1370If the current buffer now contains an empty file that you just visited
a9d6a617
JL
1371\(presumably by mistake), use this command to visit the file you really want.
1372
4d4efd30
EZ
1373See \\[find-file] for the possible forms of the FILENAME argument.
1374
a9d6a617 1375Interactively, or if WILDCARDS is non-nil in a call from Lisp,
077f47e2
CY
1376expand wildcards (if any) and replace the file with multiple files.
1377
1378If the current buffer is an indirect buffer, or the base buffer
1379for one or more indirect buffers, the other buffer(s) are not
1380killed."
b4da00e9
RM
1381 (interactive
1382 (let ((file buffer-file-name)
1383 (file-name nil)
1384 (file-dir nil))
1385 (and file
1386 (setq file-name (file-name-nondirectory file)
1387 file-dir (file-name-directory file)))
a61f59b4 1388 (list (read-file-name
a9d6a617
JL
1389 "Find alternate file: " file-dir nil nil file-name)
1390 t)))
63fabbb4
RS
1391 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1392 (error "Aborted"))
1393 (when (and (buffer-modified-p) (buffer-file-name))
38fde45d 1394 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
63fabbb4 1395 (buffer-name)))
38fde45d
CY
1396 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1397 (error "Aborted"))
1398 (save-buffer)))
b4da00e9
RM
1399 (let ((obuf (current-buffer))
1400 (ofile buffer-file-name)
8bb27285 1401 (onum buffer-file-number)
37c58ca6 1402 (odir dired-directory)
8bb27285 1403 (otrue buffer-file-truename)
b4da00e9 1404 (oname (buffer-name)))
baf9b8c4
RS
1405 (if (get-buffer " **lose**")
1406 (kill-buffer " **lose**"))
b4da00e9 1407 (rename-buffer " **lose**")
b4da00e9
RM
1408 (unwind-protect
1409 (progn
1410 (unlock-buffer)
7906c044
RS
1411 ;; This prevents us from finding the same buffer
1412 ;; if we specified the same file again.
a4ad4d96
RS
1413 (setq buffer-file-name nil)
1414 (setq buffer-file-number nil)
1415 (setq buffer-file-truename nil)
7906c044
RS
1416 ;; Likewise for dired buffers.
1417 (setq dired-directory nil)
a9d6a617 1418 (find-file filename wildcards))
63fabbb4
RS
1419 (when (eq obuf (current-buffer))
1420 ;; This executes if find-file gets an error
1421 ;; and does not really find anything.
1422 ;; We put things back as they were.
1423 ;; If find-file actually finds something, we kill obuf below.
1424 (setq buffer-file-name ofile)
1425 (setq buffer-file-number onum)
1426 (setq buffer-file-truename otrue)
7906c044 1427 (setq dired-directory odir)
63fabbb4
RS
1428 (lock-buffer)
1429 (rename-buffer oname)))
1430 (unless (eq (current-buffer) obuf)
d97a9ff3
RS
1431 (with-current-buffer obuf
1432 ;; We already asked; don't ask again.
1433 (let ((kill-buffer-query-functions))
1434 (kill-buffer obuf))))))
9b8ef27d 1435\f
b4da00e9
RM
1436(defun create-file-buffer (filename)
1437 "Create a suitably named buffer for visiting FILENAME, and return it.
1438FILENAME (sans directory) is used unchanged if that name is free;
661e8cd1
MC
1439otherwise a string <2> or <3> or ... is appended to get an unused name.
1440Spaces at the start of FILENAME (sans directory) are removed."
b4da00e9
RM
1441 (let ((lastname (file-name-nondirectory filename)))
1442 (if (string= lastname "")
1443 (setq lastname filename))
661e8cd1
MC
1444 (save-match-data
1445 (string-match "^ *\\(.*\\)" lastname)
1446 (generate-new-buffer (match-string 1 lastname)))))
b4da00e9 1447
5bbbceb1
JB
1448(defun generate-new-buffer (name)
1449 "Create and return a buffer with a name based on NAME.
29165787 1450Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
1451 (get-buffer-create (generate-new-buffer-name name)))
1452
ffc0e1ca
AS
1453(defcustom automount-dir-prefix "^/tmp_mnt/"
1454 "Regexp to match the automounter prefix in a directory name."
1455 :group 'files
1456 :type 'regexp)
e373f201 1457
ffb3a4db 1458(defvar abbreviated-home-dir nil
ffc0e1ca 1459 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
ffb3a4db 1460
5bbbceb1 1461(defun abbreviate-file-name (filename)
29165787 1462 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
fe4e58ec
EZ
1463This also substitutes \"~\" for the user's home directory (unless the
1464home directory is a root directory) and removes automounter prefixes
1465\(see the variable `automount-dir-prefix')."
e373f201 1466 ;; Get rid of the prefixes added by the automounter.
f663a1ce
RS
1467 (save-match-data
1468 (if (and automount-dir-prefix
1469 (string-match automount-dir-prefix filename)
1470 (file-exists-p (file-name-directory
1471 (substring filename (1- (match-end 0))))))
1472 (setq filename (substring filename (1- (match-end 0)))))
20431da9
CY
1473 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1474 ;; To fix this right, we need a `file-name-case-sensitive-p'
1475 ;; function, but we don't have that yet, so just guess.
9f2f6ad8 1476 (let ((case-fold-search
20431da9 1477 (memq system-type '(ms-dos windows-nt darwin cygwin))))
f663a1ce
RS
1478 ;; If any elt of directory-abbrev-alist matches this name,
1479 ;; abbreviate accordingly.
20431da9
CY
1480 (dolist (dir-abbrev directory-abbrev-alist)
1481 (if (string-match (car dir-abbrev) filename)
f663a1ce 1482 (setq filename
20431da9
CY
1483 (concat (cdr dir-abbrev)
1484 (substring filename (match-end 0))))))
f663a1ce
RS
1485 ;; Compute and save the abbreviated homedir name.
1486 ;; We defer computing this until the first time it's needed, to
1487 ;; give time for directory-abbrev-alist to be set properly.
1488 ;; We include a slash at the end, to avoid spurious matches
1489 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1490 (or abbreviated-home-dir
1491 (setq abbreviated-home-dir
1492 (let ((abbreviated-home-dir "$foo"))
1493 (concat "^" (abbreviate-file-name (expand-file-name "~"))
e959542d 1494 "\\(/\\|\\'\\)"))))
f663a1ce
RS
1495
1496 ;; If FILENAME starts with the abbreviated homedir,
1497 ;; make it start with `~' instead.
1498 (if (and (string-match abbreviated-home-dir filename)
1499 ;; If the home dir is just /, don't change it.
1500 (not (and (= (match-end 0) 1)
1501 (= (aref filename 0) ?/)))
1502 ;; MS-DOS root directories can come with a drive letter;
1503 ;; Novell Netware allows drive letters beyond `Z:'.
1504 (not (and (or (eq system-type 'ms-dos)
1505 (eq system-type 'cygwin)
1506 (eq system-type 'windows-nt))
1507 (save-match-data
1508 (string-match "^[a-zA-`]:/$" filename)))))
5bbbceb1 1509 (setq filename
f663a1ce
RS
1510 (concat "~"
1511 (match-string 1 filename)
1512 (substring filename (match-end 0)))))
1513 filename)))
5bbbceb1 1514
21540597 1515(defcustom find-file-not-true-dirname-list nil
7c2fb837 1516 "List of logical names for which visiting shouldn't save the true dirname."
21540597
RS
1517 :type '(repeat (string :tag "Name"))
1518 :group 'find-file)
1770543d 1519
3a64a3cf 1520(defun find-buffer-visiting (filename &optional predicate)
138c44f6
KH
1521 "Return the buffer visiting file FILENAME (a string).
1522This is like `get-file-buffer', except that it checks for any buffer
1523visiting the same file, possibly under a different name.
a1b0c2a7
RS
1524If PREDICATE is non-nil, only buffers satisfying it are eligible,
1525and others are ignored.
138c44f6 1526If there is no such live buffer, return nil."
3a64a3cf
JB
1527 (let ((predicate (or predicate #'identity))
1528 (truename (abbreviate-file-name (file-truename filename))))
1529 (or (let ((buf (get-file-buffer filename)))
1530 (when (and buf (funcall predicate buf)) buf))
1531 (let ((list (buffer-list)) found)
1532 (while (and (not found) list)
1533 (save-excursion
1534 (set-buffer (car list))
1535 (if (and buffer-file-name
1536 (string= buffer-file-truename truename)
1537 (funcall predicate (current-buffer)))
1538 (setq found (car list))))
1539 (setq list (cdr list)))
1540 found)
1541 (let* ((attributes (file-attributes truename))
1542 (number (nthcdr 10 attributes))
1543 (list (buffer-list)) found)
1544 (and buffer-file-numbers-unique
02bb2aab 1545 (car-safe number) ;Make sure the inode is not just nil.
3a64a3cf
JB
1546 (while (and (not found) list)
1547 (with-current-buffer (car list)
1548 (if (and buffer-file-name
1549 (equal buffer-file-number number)
1550 ;; Verify this buffer's file number
1551 ;; still belongs to its file.
1552 (file-exists-p buffer-file-name)
1553 (equal (file-attributes buffer-file-truename)
1554 attributes)
1555 (funcall predicate (current-buffer)))
1556 (setq found (car list))))
1557 (setq list (cdr list))))
1558 found))))
9b8ef27d 1559\f
5de148a2 1560(defcustom find-file-wildcards t
ba83982b 1561 "Non-nil means file-visiting commands should handle wildcards.
5de148a2
RS
1562For example, if you specify `*.c', that would visit all the files
1563whose names match the pattern."
1564 :group 'files
3957c982 1565 :version "20.4"
5de148a2
RS
1566 :type 'boolean)
1567
ffc0e1ca 1568(defcustom find-file-suppress-same-file-warnings nil
ba83982b 1569 "Non-nil means suppress warning messages for symlinked files.
ffc0e1ca
AS
1570When nil, Emacs prints a warning when visiting a file that is already
1571visited, but with a different name. Setting this option to t
1572suppresses this warning."
1573 :group 'files
1574 :version "21.1"
1575 :type 'boolean)
1576
818286f4 1577(defcustom large-file-warning-threshold 10000000
5d648479
JPW
1578 "Maximum size of file above which a confirmation is requested.
1579When nil, never request confirmation."
1580 :group 'files
1581 :group 'find-file
bf247b6e 1582 :version "22.1"
5d648479 1583 :type '(choice integer (const :tag "Never request confirmation" nil)))
818286f4 1584
4954b81b 1585(defun abort-if-file-too-large (size op-type)
afe9998d 1586 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
4954b81b
AR
1587OP-TYPE specifies the file operation being performed (for message to user)."
1588 (when (and large-file-warning-threshold size
1589 (> size large-file-warning-threshold)
1590 (not (y-or-n-p
1591 (format "File %s is large (%dMB), really %s? "
1592 (file-name-nondirectory filename)
1593 (/ size 1048576) op-type))))
1594 (error "Aborted")))
1595
243ce842 1596(defun find-file-noselect (filename &optional nowarn rawfile wildcards)
b4da00e9
RM
1597 "Read file FILENAME into a buffer and return the buffer.
1598If a buffer exists visiting FILENAME, return that one, but
1599verify that the file has not changed since visited or saved.
82d0954a 1600The buffer is not selected, just returned to the caller.
26b9ecbc
JB
1601Optional second arg NOWARN non-nil means suppress any warning messages.
1602Optional third arg RAWFILE non-nil means the file is read literally.
1603Optional fourth arg WILDCARDS non-nil means do wildcard processing
5b8ed07b 1604and visit all the matching files. When wildcards are actually
a9d6a617
JL
1605used and expanded, return a list of buffers that are visiting
1606the various files."
e373f201
JB
1607 (setq filename
1608 (abbreviate-file-name
1609 (expand-file-name filename)))
b4da00e9 1610 (if (file-directory-p filename)
ffc0e1ca
AS
1611 (or (and find-file-run-dired
1612 (run-hook-with-args-until-success
1613 'find-directory-functions
1614 (if find-file-visit-truename
1615 (abbreviate-file-name (file-truename filename))
1616 filename)))
1617 (error "%s is a directory" filename))
243ce842
RS
1618 (if (and wildcards
1619 find-file-wildcards
f91fe604 1620 (not (string-match "\\`/:" filename))
5de148a2 1621 (string-match "[[*?]" filename))
ffc0e1ca
AS
1622 (let ((files (condition-case nil
1623 (file-expand-wildcards filename t)
1624 (error (list filename))))
5de148a2 1625 (find-file-wildcards nil))
f91fe604 1626 (if (null files)
ffc0e1ca 1627 (find-file-noselect filename)
648ec2ff 1628 (mapcar #'find-file-noselect files)))
5de148a2
RS
1629 (let* ((buf (get-file-buffer filename))
1630 (truename (abbreviate-file-name (file-truename filename)))
818286f4
SM
1631 (attributes (file-attributes truename))
1632 (number (nthcdr 10 attributes))
5de148a2
RS
1633 ;; Find any buffer for a file which has same truename.
1634 (other (and (not buf) (find-buffer-visiting filename))))
1635 ;; Let user know if there is a buffer with the same truename.
1636 (if other
1637 (progn
1638 (or nowarn
ffc0e1ca 1639 find-file-suppress-same-file-warnings
5de148a2
RS
1640 (string-equal filename (buffer-file-name other))
1641 (message "%s and %s are the same file"
1642 filename (buffer-file-name other)))
1643 ;; Optionally also find that buffer.
1644 (if (or find-file-existing-other-name find-file-visit-truename)
1645 (setq buf other))))
818286f4 1646 ;; Check to see if the file looks uncommonly large.
4954b81b
AR
1647 (when (not (or buf nowarn))
1648 (abort-if-file-too-large (nth 7 attributes) "open"))
5de148a2
RS
1649 (if buf
1650 ;; We are using an existing buffer.
2c5b1db7 1651 (let (nonexistent)
5de148a2
RS
1652 (or nowarn
1653 (verify-visited-file-modtime buf)
1654 (cond ((not (file-exists-p filename))
2c5b1db7
RS
1655 (setq nonexistent t)
1656 (message "File %s no longer exists!" filename))
5de148a2
RS
1657 ;; Certain files should be reverted automatically
1658 ;; if they have changed on disk and not in the buffer.
1659 ((and (not (buffer-modified-p buf))
1660 (let ((tail revert-without-query)
1661 (found nil))
1662 (while tail
1663 (if (string-match (car tail) filename)
1664 (setq found t))
1665 (setq tail (cdr tail)))
1666 found))
1667 (with-current-buffer buf
1668 (message "Reverting file %s..." filename)
1669 (revert-buffer t t)
1670 (message "Reverting file %s...done" filename)))
1671 ((yes-or-no-p
1672 (if (string= (file-name-nondirectory filename)
1673 (buffer-name buf))
1674 (format
1675 (if (buffer-modified-p buf)
1676 "File %s changed on disk. Discard your edits? "
1677 "File %s changed on disk. Reread from disk? ")
1678 (file-name-nondirectory filename))
ddd64da9
RS
1679 (format
1680 (if (buffer-modified-p buf)
5de148a2
RS
1681 "File %s changed on disk. Discard your edits in %s? "
1682 "File %s changed on disk. Reread from disk into %s? ")
1683 (file-name-nondirectory filename)
1684 (buffer-name buf))))
1685 (with-current-buffer buf
1686 (revert-buffer t t)))))
1687 (with-current-buffer buf
a8d002d2
GM
1688
1689 ;; Check if a formerly read-only file has become
e554eeb7
RS
1690 ;; writable and vice versa, but if the buffer agrees
1691 ;; with the new state of the file, that is ok too.
a8d002d2 1692 (let ((read-only (not (file-writable-p buffer-file-name))))
2c5b1db7
RS
1693 (unless (or nonexistent
1694 (eq read-only buffer-file-read-only)
e554eeb7 1695 (eq read-only buffer-read-only))
a8d002d2 1696 (when (or nowarn
36236b72 1697 (let ((question
a8d002d2
GM
1698 (format "File %s is %s on disk. Change buffer mode? "
1699 buffer-file-name
1700 (if read-only "read-only" "writable"))))
1701 (y-or-n-p question)))
e554eeb7
RS
1702 (setq buffer-read-only read-only)))
1703 (setq buffer-file-read-only read-only))
a8d002d2 1704
ef59dd3b
EZ
1705 (when (and (not (eq (not (null rawfile))
1706 (not (null find-file-literally))))
2c5b1db7 1707 (not nonexistent)
ef59dd3b
EZ
1708 ;; It is confusing to ask whether to visit
1709 ;; non-literally if they have the file in
1710 ;; hexl-mode.
1711 (not (eq major-mode 'hexl-mode)))
5de148a2 1712 (if (buffer-modified-p)
562ca538 1713 (if (y-or-n-p
674b7bae 1714 (format
562ca538
RS
1715 (if rawfile
1716 "The file %s is already visited normally,
1717and you have edited the buffer. Now you have asked to visit it literally,
1718meaning no coding system handling, format conversion, or local variables.
1719Emacs can only visit a file in one way at a time.
1720
1721Do you want to save the file, and visit it literally instead? "
1722 "The file %s is already visited literally,
1723meaning no coding system handling, format conversion, or local variables.
1724You have edited the buffer. Now you have asked to visit the file normally,
1725but Emacs can only visit a file in one way at a time.
1726
1727Do you want to save the file, and visit it normally instead? ")
1728 (file-name-nondirectory filename)))
5de148a2
RS
1729 (progn
1730 (save-buffer)
1731 (find-file-noselect-1 buf filename nowarn
1732 rawfile truename number))
562ca538 1733 (if (y-or-n-p
674b7bae 1734 (format
562ca538
RS
1735 (if rawfile
1736 "\
1737Do you want to discard your changes, and visit the file literally now? "
1738 "\
1739Do you want to discard your changes, and visit the file normally now? ")))
5de148a2
RS
1740 (find-file-noselect-1 buf filename nowarn
1741 rawfile truename number)
1742 (error (if rawfile "File already visited non-literally"
1743 "File already visited literally"))))
674b7bae
JB
1744 (if (y-or-n-p
1745 (format
562ca538
RS
1746 (if rawfile
1747 "The file %s is already visited normally.
1748You have asked to visit it literally,
1749meaning no coding system decoding, format conversion, or local variables.
1750But Emacs can only visit a file in one way at a time.
1751
1752Do you want to revisit the file literally now? "
1753 "The file %s is already visited literally,
1754meaning no coding system decoding, format conversion, or local variables.
1755You have asked to visit it normally,
1756but Emacs can only visit a file in one way at a time.
1757
1758Do you want to revisit the file normally now? ")
1759 (file-name-nondirectory filename)))
5de148a2
RS
1760 (find-file-noselect-1 buf filename nowarn
1761 rawfile truename number)
1762 (error (if rawfile "File already visited non-literally"
1763 "File already visited literally"))))))
1764 ;; Return the buffer we are using.
1765 buf)
1766 ;; Create a new buffer.
1767 (setq buf (create-file-buffer filename))
5de148a2
RS
1768 ;; find-file-noselect-1 may use a different buffer.
1769 (find-file-noselect-1 buf filename nowarn
1770 rawfile truename number))))))
ddd64da9
RS
1771
1772(defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
4edcfd17 1773 (let (error)
ddd64da9
RS
1774 (with-current-buffer buf
1775 (kill-local-variable 'find-file-literally)
b296cbd4
RS
1776 ;; Needed in case we are re-visiting the file with a different
1777 ;; text representation.
e73ec04b 1778 (kill-local-variable 'buffer-file-coding-system)
4ad1689f 1779 (kill-local-variable 'cursor-type)
4edcfd17 1780 (let ((inhibit-read-only t))
0a11c70b
LT
1781 (erase-buffer))
1782 (and (default-value 'enable-multibyte-characters)
1783 (not rawfile)
1784 (set-buffer-multibyte t))
1785 (if rawfile
74dca654 1786 (condition-case ()
0a11c70b
LT
1787 (let ((inhibit-read-only t))
1788 (insert-file-contents-literally filename t))
74dca654
LT
1789 (file-error
1790 (when (and (file-exists-p filename)
1791 (not (file-readable-p filename)))
1792 (kill-buffer buf)
1793 (signal 'file-error (list "File is not readable"
1794 filename)))
0a11c70b
LT
1795 ;; Unconditionally set error
1796 (setq error t)))
1797 (condition-case ()
1798 (let ((inhibit-read-only t))
1799 (insert-file-contents filename t))
1800 (file-error
1801 (when (and (file-exists-p filename)
1802 (not (file-readable-p filename)))
1803 (kill-buffer buf)
1804 (signal 'file-error (list "File is not readable"
1805 filename)))
e0d8fc91 1806 ;; Run find-file-not-found-functions until one returns non-nil.
0a11c70b
LT
1807 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1808 ;; If they fail too, set error.
1809 (setq error t)))))
b120e713
KH
1810 ;; Record the file's truename, and maybe use that as visited name.
1811 (if (equal filename buffer-file-name)
1812 (setq buffer-file-truename truename)
9ab19105
DL
1813 (setq buffer-file-truename
1814 (abbreviate-file-name (file-truename buffer-file-name))))
ddd64da9 1815 (setq buffer-file-number number)
ddd64da9 1816 (if find-file-visit-truename
e442c62b 1817 (setq buffer-file-name (expand-file-name buffer-file-truename)))
ddd64da9 1818 ;; Set buffer's default directory to that of the file.
b120e713 1819 (setq default-directory (file-name-directory buffer-file-name))
ddd64da9
RS
1820 ;; Turn off backup files for certain file names. Since
1821 ;; this is a permanent local, the major mode won't eliminate it.
b98a8e06
RS
1822 (and backup-enable-predicate
1823 (not (funcall backup-enable-predicate buffer-file-name))
ddd64da9
RS
1824 (progn
1825 (make-local-variable 'backup-inhibited)
1826 (setq backup-inhibited t)))
f402ba38
RS
1827 (if rawfile
1828 (progn
1829 (set-buffer-multibyte nil)
1830 (setq buffer-file-coding-system 'no-conversion)
e8f30180 1831 (set-buffer-major-mode buf)
f402ba38
RS
1832 (make-local-variable 'find-file-literally)
1833 (setq find-file-literally t))
1834 (after-find-file error (not nowarn)))
1835 (current-buffer))))
9b8ef27d
RS
1836\f
1837(defun insert-file-contents-literally (filename &optional visit beg end replace)
1838 "Like `insert-file-contents', but only reads in the file literally.
1839A buffer may be modified in several ways after reading into the buffer,
1840to Emacs features such as format decoding, character code
0370fe77 1841conversion, `find-file-hook', automatic uncompression, etc.
9b8ef27d
RS
1842
1843This function ensures that none of these modifications will take place."
1844 (let ((format-alist nil)
1845 (after-insert-file-functions nil)
1846 (coding-system-for-read 'no-conversion)
1847 (coding-system-for-write 'no-conversion)
9b8ef27d 1848 (find-buffer-file-type-function
cdec2ad7
JB
1849 (if (fboundp 'find-buffer-file-type)
1850 (symbol-function 'find-buffer-file-type)
1851 nil))
1852 (inhibit-file-name-handlers
bfeee9d1 1853 (append '(jka-compr-handler image-file-handler epa-file-handler)
cdec2ad7
JB
1854 inhibit-file-name-handlers))
1855 (inhibit-file-name-operation 'insert-file-contents))
9b8ef27d 1856 (unwind-protect
cdec2ad7
JB
1857 (progn
1858 (fset 'find-buffer-file-type (lambda (filename) t))
1859 (insert-file-contents filename visit beg end replace))
9b8ef27d
RS
1860 (if find-buffer-file-type-function
1861 (fset 'find-buffer-file-type find-buffer-file-type-function)
1862 (fmakunbound 'find-buffer-file-type)))))
1863
3a64a3cf
JB
1864(defun insert-file-1 (filename insert-func)
1865 (if (file-directory-p filename)
1866 (signal 'file-error (list "Opening input file" "file is a directory"
1867 filename)))
4954b81b
AR
1868 ;; Check whether the file is uncommonly large
1869 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert")
3a64a3cf
JB
1870 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1871 #'buffer-modified-p))
1872 (tem (funcall insert-func filename)))
1873 (push-mark (+ (point) (car (cdr tem))))
1874 (when buffer
1875 (message "File %s already visited and modified in buffer %s"
1876 filename (buffer-name buffer)))))
1877
9b8ef27d
RS
1878(defun insert-file-literally (filename)
1879 "Insert contents of file FILENAME into buffer after point with no conversion.
1880
1881This function is meant for the user to run interactively.
1882Don't call it from programs! Use `insert-file-contents-literally' instead.
1883\(Its calling sequence is different; see its documentation)."
1884 (interactive "*fInsert file literally: ")
3a64a3cf 1885 (insert-file-1 filename #'insert-file-contents-literally))
9b8ef27d
RS
1886
1887(defvar find-file-literally nil
1888 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1889This is a permanent local.")
1890(put 'find-file-literally 'permanent-local t)
5fc196af 1891
ffc0e1ca 1892(defun find-file-literally (filename)
5fc196af
RS
1893 "Visit file FILENAME with no conversion of any kind.
1894Format conversion and character code conversion are both disabled,
1895and multibyte characters are disabled in the resulting buffer.
e65db7b8
RS
1896The major mode used is Fundamental mode regardless of the file name,
1897and local variable specifications in the file are ignored.
407b4328
GM
1898Automatic uncompression and adding a newline at the end of the
1899file due to `require-final-newline' is also disabled.
9b8ef27d
RS
1900
1901You cannot absolutely rely on this function to result in
b9aa9537 1902visiting the file literally. If Emacs already has a buffer
9b8ef27d
RS
1903which is visiting the file, you get the existing buffer,
1904regardless of whether it was created literally or not.
1905
1906In a Lisp program, if you want to be sure of accessing a file's
1907contents literally, you should create a temporary buffer and then read
1908the file contents into it using `insert-file-contents-literally'."
5fc196af 1909 (interactive "FFind file literally: ")
9b8ef27d 1910 (switch-to-buffer (find-file-noselect filename nil t)))
b4da00e9 1911\f
f7d786d0
RS
1912(defvar after-find-file-from-revert-buffer nil)
1913
e0ab8879 1914(defun after-find-file (&optional error warn noauto
9a30563f
RS
1915 after-find-file-from-revert-buffer
1916 nomodes)
b4da00e9
RM
1917 "Called after finding a file and by the default revert function.
1918Sets buffer mode, parses local variables.
8cfb9d46 1919Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
1920error in reading the file. WARN non-nil means warn if there
1921exists an auto-save file more recent than the visited file.
8cfb9d46 1922NOAUTO means don't mess with auto-save mode.
e0ab8879
RS
1923Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1924 means this call was from `revert-buffer'.
9a30563f 1925Fifth arg NOMODES non-nil means don't alter the file's modes.
0370fe77 1926Finishes by calling the functions in `find-file-hook'
9a30563f 1927unless NOMODES is non-nil."
b4da00e9
RM
1928 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1929 (if noninteractive
1930 nil
1931 (let* (not-serious
1932 (msg
fe50b6ab
GM
1933 (cond
1934 ((not warn) nil)
1935 ((and error (file-attributes buffer-file-name))
1936 (setq buffer-read-only t)
1937 "File exists, but cannot be read")
1938 ((not buffer-read-only)
1939 (if (and warn
1940 ;; No need to warn if buffer is auto-saved
1941 ;; under the name of the visited file.
1942 (not (and buffer-file-name
1943 auto-save-visited-file-name))
1944 (file-newer-than-file-p (or buffer-auto-save-file-name
1945 (make-auto-save-file-name))
1946 buffer-file-name))
64d18e8f 1947 (format "%s has auto save data; consider M-x recover-this-file"
fe50b6ab
GM
1948 (file-name-nondirectory buffer-file-name))
1949 (setq not-serious t)
1950 (if error "(New file)" nil)))
1951 ((not error)
1952 (setq not-serious t)
1953 "Note: file is write protected")
1954 ((file-attributes (directory-file-name default-directory))
1955 "File not found and directory write-protected")
1956 ((file-exists-p (file-name-directory buffer-file-name))
1957 (setq buffer-read-only nil))
1958 (t
1959 (setq buffer-read-only nil)
07703430 1960 "Use M-x make-directory RET RET to create the directory and its parents"))))
fe50b6ab 1961 (when msg
a74357d4 1962 (message "%s" msg)
e09f3bff 1963 (or not-serious (sit-for 1 t))))
fe50b6ab
GM
1964 (when (and auto-save-default (not noauto))
1965 (auto-save-mode t)))
ffc0e1ca
AS
1966 ;; Make people do a little extra work (C-x C-q)
1967 ;; before altering a backup file.
fe50b6ab
GM
1968 (when (backup-file-name-p buffer-file-name)
1969 (setq buffer-read-only t))
8fd9c174
RS
1970 ;; When a file is marked read-only,
1971 ;; make the buffer read-only even if root is looking at it.
879365c6
KS
1972 (when (and (file-modes (buffer-file-name))
1973 (zerop (logand (file-modes (buffer-file-name)) #o222)))
8fd9c174 1974 (setq buffer-read-only t))
fe50b6ab
GM
1975 (unless nomodes
1976 (when (and view-read-only view-mode)
1977 (view-mode-disable))
9a30563f 1978 (normal-mode t)
f4206092
RS
1979 ;; If requested, add a newline at the end of the file.
1980 (and (memq require-final-newline '(visit visit-save))
1981 (> (point-max) (point-min))
1982 (/= (char-after (1- (point-max))) ?\n)
1983 (not (and (eq selective-display t)
1984 (= (char-after (1- (point-max))) ?\r)))
1985 (save-excursion
1986 (goto-char (point-max))
1987 (insert "\n")))
fe50b6ab
GM
1988 (when (and buffer-read-only
1989 view-read-only
1990 (not (eq (get major-mode 'mode-class) 'special)))
1991 (view-mode-enter))
0370fe77 1992 (run-hooks 'find-file-hook)))
b4da00e9 1993
818286f4
SM
1994(defmacro report-errors (format &rest body)
1995 "Eval BODY and turn any error into a FORMAT message.
1996FORMAT can have a %s escape which will be replaced with the actual error.
1997If `debug-on-error' is set, errors are not caught, so that you can
1998debug them.
1999Avoid using a large BODY since it is duplicated."
2000 (declare (debug t) (indent 1))
2001 `(if debug-on-error
2002 (progn . ,body)
2003 (condition-case err
2004 (progn . ,body)
2005 (error (message ,format (prin1-to-string err))))))
2006
b4da00e9
RM
2007(defun normal-mode (&optional find-file)
2008 "Choose the major mode for this buffer automatically.
2009Also sets up any specified local variables of the file.
2010Uses the visited file name, the -*- line, and the local variables spec.
2011
2012This function is called automatically from `find-file'. In that case,
aa5fcebf 2013we may set up the file-specified mode and local variables,
a5ce12c3 2014depending on the value of `enable-local-variables'.
aa5fcebf
KH
2015In addition, if `local-enable-local-variables' is nil, we do
2016not set local variables (though we do notice a mode specified with -*-.)
2017
2018`enable-local-variables' is ignored if you run `normal-mode' interactively,
2019or from Lisp without specifying the optional argument FIND-FILE;
2020in that case, this function acts as if `enable-local-variables' were t."
b4da00e9 2021 (interactive)
e8f30180 2022 (funcall (or default-major-mode 'fundamental-mode))
0fc205c6
LT
2023 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
2024 (report-errors "File mode specification error: %s"
2025 (set-auto-mode))
2026 (report-errors "File local-variables error: %s"
818286f4 2027 (hack-local-variables)))
6e86be0b
RS
2028 ;; Turn font lock off and on, to make sure it takes account of
2029 ;; whatever file local variables are relevant to it.
344f1111
SM
2030 (when (and font-lock-mode
2031 ;; Font-lock-mode (now in font-core.el) can be ON when
2032 ;; font-lock.el still hasn't been loaded.
2033 (boundp 'font-lock-keywords)
2034 (eq (car font-lock-keywords) t))
6e86be0b
RS
2035 (setq font-lock-keywords (cadr font-lock-keywords))
2036 (font-lock-mode 1))
2037
24c9eeeb
DL
2038 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
2039 (ucs-set-table-for-input)))
b4da00e9 2040
94495713
KS
2041(defcustom auto-mode-case-fold nil
2042 "Non-nil means to try second pass through `auto-mode-alist'.
2043This means that if the first case-sensitive search through the alist fails
2044to find a matching major mode, a second case-insensitive search is made.
2045On systems with case-insensitive file names, this variable is ignored,
bb178aaa 2046since only a single case-insensitive search through the alist is made."
94495713
KS
2047 :group 'files
2048 :version "22.1"
2049 :type 'boolean)
2050
f76e0cd0 2051(defvar auto-mode-alist
f209c999
MS
2052 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2053 ;; c++-mode, java-mode and more) are added through autoload
2054 ;; directives in that file. That way is discouraged since it
2055 ;; spreads out the definition of the initial value.
4aaffda1 2056 (mapcar
ffc0e1ca
AS
2057 (lambda (elt)
2058 (cons (purecopy (car elt)) (cdr elt)))
813731b3 2059 `(;; do this first, so that .html.pl is Polish html, not Perl
9e6f5419
DP
2060 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
2061 ("\\.te?xt\\'" . text-mode)
bbc67516 2062 ("\\.[tT]e[xX]\\'" . tex-mode)
4e163715 2063 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
ffc0e1ca 2064 ("\\.ltx\\'" . latex-mode)
4e163715 2065 ("\\.dtx\\'" . doctex-mode)
18d8cb81 2066 ("\\.org\\'" . org-mode)
ffc0e1ca 2067 ("\\.el\\'" . emacs-lisp-mode)
21575d92 2068 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
ffc0e1ca 2069 ("\\.l\\'" . lisp-mode)
bbc67516
DP
2070 ("\\.li?sp\\'" . lisp-mode)
2071 ("\\.[fF]\\'" . fortran-mode)
ffc0e1ca
AS
2072 ("\\.for\\'" . fortran-mode)
2073 ("\\.p\\'" . pascal-mode)
2074 ("\\.pas\\'" . pascal-mode)
2075 ("\\.ad[abs]\\'" . ada-mode)
7defe888 2076 ("\\.ad[bs].dg\\'" . ada-mode)
bbc67516 2077 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
3968c89f 2078 ("Imakefile\\'" . makefile-imake-mode)
8088bb2c
DP
2079 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2080 ("\\.makepp\\'" . makefile-makepp-mode)
813731b3
DP
2081 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
2082 '(("\\.mk\\'" . makefile-bsdmake-mode)
47d4e709 2083 ("GNUmakefile\\'" . makefile-gmake-mode)
813731b3
DP
2084 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2085 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
47d4e709 2086 ("[Mm]akefile\\'" . makefile-gmake-mode)))
27a7c83f 2087 ("\\.am\\'" . makefile-automake-mode)
5c6d31a4
SM
2088 ;; Less common extensions come here
2089 ;; so more common ones above are found faster.
ffc0e1ca
AS
2090 ("\\.texinfo\\'" . texinfo-mode)
2091 ("\\.te?xi\\'" . texinfo-mode)
bbc67516 2092 ("\\.[sS]\\'" . asm-mode)
ffc0e1ca 2093 ("\\.asm\\'" . asm-mode)
bbc67516 2094 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
40656849 2095 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
ffc0e1ca
AS
2096 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2097 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2098 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
b921b596 2099 ("\\.bash\\'" . sh-mode)
ffc0e1ca
AS
2100 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2101 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2102 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
d5798fa7 2103 ("\\.m?spec\\'" . sh-mode)
bbc67516 2104 ("\\.m[mes]\\'" . nroff-mode)
ffc0e1ca 2105 ("\\.man\\'" . nroff-mode)
ffc0e1ca 2106 ("\\.sty\\'" . latex-mode)
bbc67516 2107 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
ffc0e1ca
AS
2108 ("\\.bbl\\'" . latex-mode)
2109 ("\\.bib\\'" . bibtex-mode)
2110 ("\\.sql\\'" . sql-mode)
bbc67516 2111 ("\\.m[4c]\\'" . m4-mode)
ffc0e1ca
AS
2112 ("\\.mf\\'" . metafont-mode)
2113 ("\\.mp\\'" . metapost-mode)
2114 ("\\.vhdl?\\'" . vhdl-mode)
2115 ("\\.article\\'" . text-mode)
2116 ("\\.letter\\'" . text-mode)
bbc67516 2117 ("\\.i?tcl\\'" . tcl-mode)
ffc0e1ca 2118 ("\\.exp\\'" . tcl-mode)
ffc0e1ca
AS
2119 ("\\.itk\\'" . tcl-mode)
2120 ("\\.icn\\'" . icon-mode)
2121 ("\\.sim\\'" . simula-mode)
2122 ("\\.mss\\'" . scribe-mode)
bbc67516 2123 ("\\.f9[05]\\'" . f90-mode)
8f9495e7 2124 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
4998f839 2125 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
ffc0e1ca
AS
2126 ("\\.prolog\\'" . prolog-mode)
2127 ("\\.tar\\'" . tar-mode)
0ee6e7b7
JL
2128 ;; The list of archive file extensions should be in sync with
2129 ;; `auto-coding-alist' with `no-conversion' coding system.
e7988f09
SM
2130 ("\\.\\(\
2131arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2132ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode)
d5040404 2133 ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode) ; OpenOffice.org
ece21937 2134 ("\\.\\(deb\\)\\'" . archive-mode) ; Debian packages.
ffc0e1ca
AS
2135 ;; Mailer puts message to be edited in
2136 ;; /tmp/Re.... or Message
2137 ("\\`/tmp/Re" . text-mode)
2138 ("/Message[0-9]*\\'" . text-mode)
ffc0e1ca
AS
2139 ("\\.zone\\'" . zone-mode)
2140 ;; some news reader is reported to use this
2141 ("\\`/tmp/fol/" . text-mode)
ffc0e1ca
AS
2142 ("\\.oak\\'" . scheme-mode)
2143 ("\\.sgml?\\'" . sgml-mode)
bbc67516 2144 ("\\.x[ms]l\\'" . xml-mode)
ffc0e1ca
AS
2145 ("\\.dtd\\'" . sgml-mode)
2146 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
bbc67516 2147 ("\\.js\\'" . java-mode) ; javascript-mode would be better
c3190aad 2148 ("\\.[ds]?v\\'" . verilog-mode)
709d45e1
KG
2149 ;; .emacs or .gnus or .viper following a directory delimiter in
2150 ;; Unix, MSDOG or VMS syntax.
2151 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
ffc0e1ca
AS
2152 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2153 ;; _emacs following a directory delimiter
2154 ;; in MsDos syntax
2155 ("[:/]_emacs\\'" . emacs-lisp-mode)
2156 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2157 ("\\.ml\\'" . lisp-mode)
ebbcece3
GM
2158 ;; Common Lisp ASDF package system.
2159 ("\\.asd\\'" . lisp-mode)
d5798fa7
SM
2160 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2161 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
ffc0e1ca 2162 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
e854cc22 2163 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
9a905782 2164 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
88a54804 2165 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode)
e55c4863 2166 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
8a28dd0b 2167 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
ffc0e1ca
AS
2168 ("BROWSE\\'" . ebrowse-tree-mode)
2169 ("\\.ebrowse\\'" . ebrowse-tree-mode)
9ee45b2c 2170 ("#\\*mail\\*" . mail-mode)
80174d35
DP
2171 ("\\.g\\'" . antlr-mode)
2172 ("\\.ses\\'" . ses-mode)
2173 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2174 ("\\.docbook\\'" . sgml-mode)
00daa381 2175 ("\\.com\\'" . dcl-mode)
80174d35
DP
2176 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2177 ;; Windows candidates may be opened case sensitively on Unix
2178 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2179 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
08adf84e 2180 ("\\.ppd\\'" . conf-ppd-mode)
80174d35
DP
2181 ("java.+\\.conf\\'" . conf-javaprop-mode)
2182 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2183 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
73936494 2184 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
a35d9075
AS
2185 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2186 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
40656849
CY
2187 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2188 ;; this has lower priority to avoid matching changelog.sgml etc.
2189 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
80174d35
DP
2190 ;; either user's dot-files or under /etc or some such
2191 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2192 ;; alas not all ~/.*rc files are like this
b14f1885 2193 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
80174d35
DP
2194 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2195 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2196 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2197 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2198 ;; this contains everything twice, with space and with colon :-(
2199 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
9ee45b2c
SM
2200 ;; Get rid of any trailing .n.m and try again.
2201 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
5c6d31a4
SM
2202 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2203 ;; Using mode nil rather than `ignore' would let the search continue
2204 ;; through this list (with the shortened name) rather than start over.
bbc67516 2205 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
5c6d31a4
SM
2206 ;; The following should come after the ChangeLog pattern
2207 ;; for the sake of ChangeLog.1, etc.
2208 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
e043664a 2209 ("\\.[1-9]\\'" . nroff-mode)
80174d35 2210 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
ffc0e1ca 2211 "Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
2212Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2213\(NON-NIL stands for anything that is not nil; the value does not matter.)
2214Visiting a file whose name matches REGEXP specifies FUNCTION as the
2215mode function to use. FUNCTION will be called, unless it is nil.
2216
2217If the element has the form (REGEXP FUNCTION NON-NIL), then after
2218calling FUNCTION (if it's not nil), we delete the suffix that matched
969be033 2219REGEXP and search the list again for another match.
7b3f3dc2 2220
969be033
RS
2221If the file name matches `inhibit-first-line-modes-regexps',
2222then `auto-mode-alist' is not processed.
2223
d5040404
EZ
2224The extensions whose FUNCTION is `archive-mode' should also
2225appear in `auto-coding-alist' with `no-conversion' coding system.
2226
969be033
RS
2227See also `interpreter-mode-alist', which detects executable script modes
2228based on the interpreters they specify to run,
2229and `magic-mode-alist', which determines modes based on file contents.")
e13322a0 2230
73936494
RS
2231(defun conf-mode-maybe ()
2232 "Select Conf mode or XML mode according to start of file."
2233 (if (save-excursion
2234 (save-restriction
2235 (widen)
2236 (goto-char (point-min))
2237 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2238 (xml-mode)
2239 (conf-mode)))
2240
d7fa5aa2 2241(defvar interpreter-mode-alist
f209c999
MS
2242 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2243 ;; and pike-mode) are added through autoload directives in that
2244 ;; file. That way is discouraged since it spreads out the
2245 ;; definition of the initial value.
ffc0e1ca
AS
2246 (mapc
2247 (lambda (l)
2248 (cons (purecopy (car l)) (cdr l)))
2249 '(("perl" . perl-mode)
2250 ("perl5" . perl-mode)
2251 ("miniperl" . perl-mode)
2252 ("wish" . tcl-mode)
2253 ("wishx" . tcl-mode)
2254 ("tcl" . tcl-mode)
2255 ("tclsh" . tcl-mode)
ffc0e1ca
AS
2256 ("scm" . scheme-mode)
2257 ("ash" . sh-mode)
2258 ("bash" . sh-mode)
2259 ("bash2" . sh-mode)
2260 ("csh" . sh-mode)
2261 ("dtksh" . sh-mode)
2262 ("es" . sh-mode)
2263 ("itcsh" . sh-mode)
2264 ("jsh" . sh-mode)
2265 ("ksh" . sh-mode)
2266 ("oash" . sh-mode)
2267 ("pdksh" . sh-mode)
2268 ("rc" . sh-mode)
2269 ("rpm" . sh-mode)
2270 ("sh" . sh-mode)
2271 ("sh5" . sh-mode)
2272 ("tcsh" . sh-mode)
2273 ("wksh" . sh-mode)
2274 ("wsh" . sh-mode)
2275 ("zsh" . sh-mode)
2276 ("tail" . text-mode)
2277 ("more" . text-mode)
2278 ("less" . text-mode)
2279 ("pg" . text-mode)
27a7c83f 2280 ("make" . makefile-gmake-mode) ; Debian uses this
ffc0e1ca
AS
2281 ("guile" . scheme-mode)
2282 ("clisp" . lisp-mode)))
c907d156 2283 "Alist mapping interpreter names to major modes.
969be033 2284This is used for files whose first lines match `auto-mode-interpreter-regexp'.
c907d156 2285Each element looks like (INTERPRETER . MODE).
9f01a773
RS
2286If INTERPRETER matches the name of the interpreter specified in the first line
2287of a script, mode MODE is enabled.
969be033
RS
2288
2289See also `auto-mode-alist'.")
c907d156 2290
d7fa5aa2 2291(defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
45fb3bb8 2292 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 2293
d7fa5aa2 2294(defvar inhibit-first-line-modes-suffixes nil
b20ff6d0
RS
2295 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2296When checking `inhibit-first-line-modes-regexps', we first discard
2297from the end of the file name anything that matches one of these regexps.")
2298
ffc0e1ca
AS
2299(defvar auto-mode-interpreter-regexp
2300 "#![ \t]?\\([^ \t\n]*\
2301/bin/env[ \t]\\)?\\([^ \t\n]+\\)"
54005870 2302 "Regexp matching interpreters, for file mode determination.
ffc0e1ca 2303This regular expression is matched against the first line of a file
54005870
LT
2304to determine the file's mode in `set-auto-mode'. If it matches, the file
2305is assumed to be interpreted by the interpreter matched by the second group
2306of the regular expression. The mode is then determined as the mode
2307associated with that interpreter in `interpreter-mode-alist'.")
0720b68b 2308
1a5bfb0e 2309(defvar magic-mode-alist nil
c11781de
SM
2310 "Alist of buffer beginnings vs. corresponding major mode functions.
2311Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2312After visiting a file, if REGEXP matches the text at the beginning of the
2313buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2314call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2315major mode.
2316
2317If FUNCTION is nil, then it is not called. (That is a way of saying
2318\"allow `auto-mode-alist' to decide for these files.\")")
2319(put 'magic-mode-alist 'risky-local-variable t)
2320
2321(defvar magic-fallback-mode-alist
1a5bfb0e
CY
2322 `((image-type-auto-detected-p . image-mode)
2323 ;; The < comes before the groups (but the first) to reduce backtracking.
4ac1d37a 2324 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
efaa82ff 2325 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
32a0479a 2326 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
efaa82ff
GM
2327 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2328 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
32a0479a 2329 comment-re "*"
efaa82ff 2330 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
969be033
RS
2331 "[Hh][Tt][Mm][Ll]"))
2332 . html-mode)
815fde34 2333 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
4ac1d37a
DP
2334 ;; These two must come after html, because they are more general:
2335 ("<\\?xml " . xml-mode)
811cab86 2336 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
e7d313a0
GM
2337 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2338 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
969be033 2339 . sgml-mode)
12333e2b 2340 ("%!PS" . ps-mode)
80174d35 2341 ("# xmcd " . conf-unix-mode))
14774875
RS
2342 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2343Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2344After visiting a file, if REGEXP matches the text at the beginning of the
2345buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2346call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2347have not specified a mode for this file.
2348
2349If FUNCTION is nil, then it is not called.")
92228a10 2350(put 'magic-fallback-mode-alist 'risky-local-variable t)
14774875 2351
5cce080e 2352(defvar magic-mode-regexp-match-limit 4000
14774875 2353 "Upper limit on `magic-mode-alist' regexp matches.
92228a10 2354Also applies to `magic-fallback-mode-alist'.")
5cce080e 2355
9e6f5419 2356(defun set-auto-mode (&optional keep-mode-if-same)
b4da00e9 2357 "Select major mode appropriate for current buffer.
4ac1d37a 2358
c022c4c4
RS
2359To find the right major mode, this function checks for a -*- mode tag,
2360checks if it uses an interpreter listed in `interpreter-mode-alist',
2361matches the buffer beginning against `magic-mode-alist',
2362compares the filename against the entries in `auto-mode-alist',
2363then matches the buffer beginning against `magic-fallback-mode-alist'.
e3998da1
RS
2364
2365It does not check for the `mode:' local variable in the
2366Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 2367
f3e23606 2368If `enable-local-variables' is nil, this function does not check for a
9de9b6a2
RS
2369-*- mode tag.
2370
521cf174 2371If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
c022c4c4
RS
2372set the major mode only if that would change it. In other words
2373we don't actually set it to the same mode the buffer already has."
b4da00e9 2374 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
811cab86 2375 (let (end done mode modes)
9e6f5419 2376 ;; Find a -*- mode tag
b4da00e9
RM
2377 (save-excursion
2378 (goto-char (point-min))
2379 (skip-chars-forward " \t\n")
9fa7bfe5 2380 (and enable-local-variables
e3f9b9c0 2381 (setq end (set-auto-mode-1))
2d2ab9da
RS
2382 (if (save-excursion (search-forward ":" end t))
2383 ;; Find all specifications for the `mode:' variable
2384 ;; and execute them left to right.
2385 (while (let ((case-fold-search t))
2386 (or (and (looking-at "mode:")
2387 (goto-char (match-end 0)))
2388 (re-search-forward "[ \t;]mode:" end t)))
2389 (skip-chars-forward " \t")
2390 (let ((beg (point)))
9fa7bfe5
RS
2391 (if (search-forward ";" end t)
2392 (forward-char -1)
2393 (goto-char end))
2394 (skip-chars-backward " \t")
9ee45b2c 2395 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2d2ab9da
RS
2396 modes)))
2397 ;; Simple -*-MODE-*- case.
2398 (push (intern (concat (downcase (buffer-substring (point) end))
2399 "-mode"))
2400 modes))))
9e6f5419
DP
2401 ;; If we found modes to use, invoke them now, outside the save-excursion.
2402 (if modes
521cf174
DP
2403 (catch 'nop
2404 (dolist (mode (nreverse modes))
2405 (if (not (functionp mode))
2406 (message "Ignoring unknown mode `%s'" mode)
2407 (setq done t)
3467488e 2408 (or (set-auto-mode-0 mode keep-mode-if-same)
df4d0613 2409 ;; continuing would call minor modes again, toggling them off
ec6328a2 2410 (throw 'nop nil))))))
14774875
RS
2411 ;; If we didn't, look for an interpreter specified in the first line.
2412 ;; As a special case, allow for things like "#!/bin/env perl", which
2413 ;; finds the interpreter anywhere in $PATH.
ec6328a2 2414 (unless done
9e6f5419
DP
2415 (setq mode (save-excursion
2416 (goto-char (point-min))
2417 (if (looking-at auto-mode-interpreter-regexp)
2418 (match-string 2)
2419 ""))
2420 ;; Map interpreter name to a mode, signalling we're done at the
2421 ;; same time.
2422 done (assoc (file-name-nondirectory mode)
2423 interpreter-mode-alist))
811cab86 2424 ;; If we found an interpreter mode to use, invoke it now.
df4d0613
DP
2425 (if done
2426 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
14774875 2427 ;; Next try matching the buffer beginning against magic-mode-alist.
df4d0613 2428 (unless done
4ac1d37a
DP
2429 (if (setq done (save-excursion
2430 (goto-char (point-min))
5cce080e
KS
2431 (save-restriction
2432 (narrow-to-region (point-min)
2433 (min (point-max)
2434 (+ (point-min) magic-mode-regexp-match-limit)))
2435 (assoc-default nil magic-mode-alist
2436 (lambda (re dummy)
10ffa2a1
KS
2437 (if (functionp re)
2438 (funcall re)
2439 (looking-at re)))))))
14774875
RS
2440 (set-auto-mode-0 done keep-mode-if-same)))
2441 ;; Next compare the filename against the entries in auto-mode-alist.
2442 (unless done
2443 (if buffer-file-name
f1fa5062
MA
2444 (let ((name buffer-file-name)
2445 (remote-id (file-remote-p buffer-file-name)))
2446 ;; Remove remote file name identification.
2447 (when (and (stringp remote-id)
32650100 2448 (string-match (regexp-quote remote-id) name))
f1fa5062 2449 (setq name (substring name (match-end 0))))
14774875
RS
2450 ;; Remove backup-suffixes from file name.
2451 (setq name (file-name-sans-versions name))
2452 (while name
2453 ;; Find first matching alist entry.
2454 (setq mode
7c2fb837 2455 (if (memq system-type '(windows-nt cygwin))
14774875
RS
2456 ;; System is case-insensitive.
2457 (let ((case-fold-search t))
2458 (assoc-default name auto-mode-alist
2459 'string-match))
2460 ;; System is case-sensitive.
2461 (or
2462 ;; First match case-sensitively.
2463 (let ((case-fold-search nil))
2464 (assoc-default name auto-mode-alist
2465 'string-match))
2466 ;; Fallback to case-insensitive match.
2467 (and auto-mode-case-fold
2468 (let ((case-fold-search t))
2469 (assoc-default name auto-mode-alist
2470 'string-match))))))
2471 (if (and mode
2472 (consp mode)
2473 (cadr mode))
2474 (setq mode (car mode)
2475 name (substring name 0 (match-beginning 0)))
2476 (setq name))
2477 (when mode
2478 (set-auto-mode-0 mode keep-mode-if-same)
2479 (setq done t))))))
92228a10 2480 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
14774875
RS
2481 (unless done
2482 (if (setq done (save-excursion
2483 (goto-char (point-min))
2484 (save-restriction
2485 (narrow-to-region (point-min)
2486 (min (point-max)
2487 (+ (point-min) magic-mode-regexp-match-limit)))
92228a10 2488 (assoc-default nil magic-fallback-mode-alist
14774875
RS
2489 (lambda (re dummy)
2490 (if (functionp re)
2491 (funcall re)
2492 (looking-at re)))))))
2493 (set-auto-mode-0 done keep-mode-if-same)))))
521cf174 2494
521cf174
DP
2495;; When `keep-mode-if-same' is set, we are working on behalf of
2496;; set-visited-file-name. In that case, if the major mode specified is the
2497;; same one we already have, don't actually reset it. We don't want to lose
2498;; minor modes such as Font Lock.
3467488e 2499(defun set-auto-mode-0 (mode &optional keep-mode-if-same)
521cf174 2500 "Apply MODE and return it.
3467488e
KS
2501If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2502any aliases and compared to current major mode. If they are the
2503same, do nothing and return nil."
0c7c413c
CY
2504 (unless (and keep-mode-if-same
2505 (eq (indirect-function mode)
2506 (indirect-function major-mode)))
2507 (when mode
2508 (funcall mode)
2509 mode)))
b4da00e9 2510
e3f9b9c0
RS
2511(defun set-auto-mode-1 ()
2512 "Find the -*- spec in the buffer.
2513Call with point at the place to start searching from.
2514If one is found, set point to the beginning
2515and return the position of the end.
2516Otherwise, return nil; point may be changed."
2517 (let (beg end)
2518 (and
2519 ;; Don't look for -*- if this file name matches any
2520 ;; of the regexps in inhibit-first-line-modes-regexps.
2521 (let ((temp inhibit-first-line-modes-regexps)
2522 (name (if buffer-file-name
2523 (file-name-sans-versions buffer-file-name)
2524 (buffer-name))))
2525 (while (let ((sufs inhibit-first-line-modes-suffixes))
2526 (while (and sufs (not (string-match (car sufs) name)))
2527 (setq sufs (cdr sufs)))
2528 sufs)
2529 (setq name (substring name 0 (match-beginning 0))))
2530 (while (and temp
2531 (not (string-match (car temp) name)))
2532 (setq temp (cdr temp)))
2533 (not temp))
2534
f587e30b
SM
2535 (search-forward "-*-" (line-end-position
2536 ;; If the file begins with "#!"
2537 ;; (exec interpreter magic), look
2538 ;; for mode frobs in the first two
2539 ;; lines. You cannot necessarily
2540 ;; put them in the first line of
2541 ;; such a file without screwing up
2542 ;; the interpreter invocation.
dddb4597
WL
2543 ;; The same holds for
2544 ;; '\"
2545 ;; in man pages (preprocessor
2546 ;; magic for the `man' program).
2547 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
e3f9b9c0
RS
2548 (progn
2549 (skip-chars-forward " \t")
2550 (setq beg (point))
f587e30b 2551 (search-forward "-*-" (line-end-position) t))
e3f9b9c0
RS
2552 (progn
2553 (forward-char -3)
2554 (skip-chars-backward " \t")
2555 (setq end (point))
2556 (goto-char beg)
2557 end))))
b9e1451a
CY
2558\f
2559;;; Handling file local variables
2560
2561(defvar ignored-local-variables
2b8ac025
CY
2562 '(ignored-local-variables safe-local-variable-values
2563 file-local-variables-alist)
b9e1451a
CY
2564 "Variables to be ignored in a file's local variable spec.")
2565
2566(defvar hack-local-variables-hook nil
2567 "Normal hook run after processing a file's local variables specs.
2568Major modes can use this to examine user-specified local variables
2569in order to initialize other data structure based on them.")
2570
2571(defcustom safe-local-variable-values nil
2572 "List variable-value pairs that are considered safe.
2573Each element is a cons cell (VAR . VAL), where VAR is a variable
2574symbol and VAL is a value that is considered safe."
2575 :group 'find-file
094eabe4 2576 :type 'alist)
b9e1451a 2577
146b3daf 2578(defcustom safe-local-eval-forms '((add-hook 'write-file-hooks 'time-stamp))
ba83982b 2579 "Expressions that are considered safe in an `eval:' local variable.
b9e1451a
CY
2580Add expressions to this list if you want Emacs to evaluate them, when
2581they appear in an `eval' local variable specification, without first
2582asking you for confirmation."
2583 :group 'find-file
146b3daf 2584 :version "22.2"
b9e1451a
CY
2585 :type '(repeat sexp))
2586
2587;; Risky local variables:
2588(mapc (lambda (var) (put var 'risky-local-variable t))
2589 '(after-load-alist
2590 auto-mode-alist
2591 buffer-auto-save-file-name
2592 buffer-file-name
2593 buffer-file-truename
2594 buffer-undo-list
2595 dabbrev-case-fold-search
2596 dabbrev-case-replace
2597 debugger
2598 default-text-properties
2599 display-time-string
2600 enable-local-eval
e58cec15 2601 enable-local-variables
b9e1451a
CY
2602 eval
2603 exec-directory
2604 exec-path
2605 file-name-handler-alist
2606 font-lock-defaults
2607 format-alist
2608 frame-title-format
2609 global-mode-string
2610 header-line-format
2611 icon-title-format
2612 ignored-local-variables
2613 imenu--index-alist
2614 imenu-generic-expression
2615 inhibit-quit
2616 input-method-alist
2617 load-path
2618 max-lisp-eval-depth
2619 max-specpdl-size
2620 minor-mode-alist
2621 minor-mode-map-alist
2622 minor-mode-overriding-map-alist
2623 mode-line-buffer-identification
2624 mode-line-format
f2aa3ae4 2625 mode-line-client
b9e1451a
CY
2626 mode-line-modes
2627 mode-line-modified
2628 mode-line-mule-info
2629 mode-line-position
2630 mode-line-process
3650f60e 2631 mode-line-remote
b9e1451a
CY
2632 mode-name
2633 outline-level
2634 overriding-local-map
2635 overriding-terminal-local-map
2636 parse-time-rules
2637 process-environment
2638 rmail-output-file-alist
e58cec15
RS
2639 safe-local-variable-values
2640 safe-local-eval-forms
b9e1451a
CY
2641 save-some-buffers-action-alist
2642 special-display-buffer-names
2643 standard-input
2644 standard-output
2645 unread-command-events
2646 vc-mode))
2647
2648;; Safe local variables:
2649;;
3e457225
RS
2650;; For variables defined by major modes, the safety declarations can go into
2651;; the major mode's file, since that will be loaded before file variables are
2652;; processed.
2653;;
2654;; For variables defined by minor modes, put the safety declarations in the
2655;; file defining the minor mode after the defcustom/defvar using an autoload
2656;; cookie, e.g.:
2657;;
2658;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2659;;
2660;; Otherwise, when Emacs visits a file specifying that local variable, the
2661;; minor mode file may not be loaded yet.
2662;;
2663;; For variables defined in the C source code the declaration should go here:
b9e1451a 2664
0a51c121
JL
2665(mapc (lambda (pair)
2666 (put (car pair) 'safe-local-variable (cdr pair)))
4b025f47
CY
2667 '((buffer-read-only . booleanp) ;; C source code
2668 (default-directory . stringp) ;; C source code
2669 (fill-column . integerp) ;; C source code
2670 (indent-tabs-mode . booleanp) ;; C source code
2671 (left-margin . integerp) ;; C source code
2672 (no-update-autoloads . booleanp)
2673 (tab-width . integerp) ;; C source code
2674 (truncate-lines . booleanp))) ;; C source code
b9e1451a
CY
2675
2676(put 'c-set-style 'safe-local-eval-function t)
e3f9b9c0 2677
2b8ac025
CY
2678(defvar file-local-variables-alist nil
2679 "Alist of file-local variable settings in the current buffer.
2680Each element in this list has the form (VAR . VALUE), where VAR
2681is a file-local variable (a symbol) and VALUE is the value
2682specified. The actual value in the buffer may differ from VALUE,
2683if it is changed by the major or minor modes, or by the user.")
2684(make-variable-buffer-local 'file-local-variables-alist)
2685
2686(defvar before-hack-local-variables-hook nil
2687 "Normal hook run before setting file-local variables.
2688It is called after checking for unsafe/risky variables and
2689setting `file-local-variables-alist', and before applying the
2690variables stored in `file-local-variables-alist'. A hook
2691function is allowed to change the contents of this alist.
2692
2693This hook is called only if there is at least one file-local
2694variable to set.")
2695
1b21ee06 2696(defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars project)
70b49e57
RS
2697 "Get confirmation before setting up local variable values.
2698ALL-VARS is the list of all variables to be set up.
2699UNSAFE-VARS is the list of those that aren't marked as safe or risky.
1b21ee06
MO
2700RISKY-VARS is the list of those that are marked as risky.
2701PROJECT is a directory name if these settings come from directory-local
2b8ac025 2702settings, or nil otherwise."
5a6c1d87
CY
2703 (if noninteractive
2704 nil
2705 (let ((name (if buffer-file-name
2706 (file-name-nondirectory buffer-file-name)
2707 (concat "buffer " (buffer-name))))
af467e28 2708 (offer-save (and (eq enable-local-variables t) unsafe-vars))
0a158521 2709 prompt char)
5a6c1d87 2710 (save-window-excursion
0a158521 2711 (let ((buf (get-buffer-create "*Local Variables*")))
42078bb2
CY
2712 (pop-to-buffer buf)
2713 (set (make-local-variable 'cursor-type) nil)
2714 (erase-buffer)
5a6c1d87 2715 (if unsafe-vars
1b21ee06 2716 (insert "The local variables list in " (or project name)
42078bb2
CY
2717 "\ncontains values that may not be safe (*)"
2718 (if risky-vars
2719 ", and variables that are risky (**)."
2720 "."))
5a6c1d87 2721 (if risky-vars
1b21ee06 2722 (insert "The local variables list in " (or project name)
42078bb2 2723 "\ncontains variables that are risky (**).")
12a28ea3 2724 (insert "A local variables list is specified in "
1b21ee06 2725 (or project name) ".")))
42078bb2 2726 (insert "\n\nDo you want to apply it? You can type
5a6c1d87 2727y -- to apply the local variables list.
af467e28
CY
2728n -- to ignore the local variables list.")
2729 (if offer-save
2730 (insert "
dbcd3ce0
EZ
2731! -- to apply the local variables list, and permanently mark these
2732 values (*) as safe (in the future, they will be set automatically.)\n\n")
af467e28 2733 (insert "\n\n"))
70b49e57 2734 (dolist (elt all-vars)
5a6c1d87 2735 (cond ((member elt unsafe-vars)
42078bb2 2736 (insert " * "))
5a6c1d87 2737 ((member elt risky-vars)
42078bb2 2738 (insert " ** "))
5a6c1d87 2739 (t
42078bb2
CY
2740 (insert " ")))
2741 (princ (car elt) buf)
2742 (insert " : ")
e442c62b
SM
2743 ;; Make strings with embedded whitespace easier to read.
2744 (let ((print-escape-newlines t))
2745 (prin1 (cdr elt) buf))
42078bb2 2746 (insert "\n"))
af467e28
CY
2747 (setq prompt
2748 (format "Please type %s%s: "
2749 (if offer-save "y, n, or !" "y or n")
2750 (if (< (line-number-at-pos) (window-body-height))
2751 ""
2752 ", or C-v to scroll")))
2753 (goto-char (point-min))
a5ce12c3 2754 (let ((cursor-in-echo-area t)
5340648d 2755 (executing-kbd-macro executing-kbd-macro)
af467e28
CY
2756 (exit-chars
2757 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
42078bb2
CY
2758 done)
2759 (while (not done)
f6e7ec02 2760 (message "%s" prompt)
42078bb2
CY
2761 (setq char (read-event))
2762 (if (numberp char)
5340648d
CY
2763 (cond ((eq char ?\C-v)
2764 (condition-case nil
2765 (scroll-up)
2766 (error (goto-char (point-min)))))
2767 ;; read-event returns -1 if we are in a kbd
2768 ;; macro and there are no more events in the
2769 ;; macro. In that case, attempt to get an
2770 ;; event interactively.
2771 ((and executing-kbd-macro (= char -1))
2772 (setq executing-kbd-macro nil))
2773 (t (setq done (memq (downcase char) exit-chars)))))))
42078bb2 2774 (setq char (downcase char))
af467e28 2775 (when (and offer-save (= char ?!) unsafe-vars)
42078bb2
CY
2776 (dolist (elt unsafe-vars)
2777 (add-to-list 'safe-local-variable-values elt))
4299d849
CY
2778 ;; When this is called from desktop-restore-file-buffer,
2779 ;; coding-system-for-read may be non-nil. Reset it before
2780 ;; writing to .emacs.
af467e28
CY
2781 (if (or custom-file user-init-file)
2782 (let ((coding-system-for-read nil))
2783 (customize-save-variable
2784 'safe-local-variable-values
2785 safe-local-variable-values))))
0a158521 2786 (kill-buffer buf)
42078bb2
CY
2787 (or (= char ?!)
2788 (= char ?\s)
2789 (= char ?y)))))))
cc45837e 2790
a0e74e72 2791(defun hack-local-variables-prop-line (&optional mode-only)
5a6c1d87 2792 "Return local variables specified in the -*- line.
ffc0e1ca
AS
2793Ignore any specification for `mode:' and `coding:';
2794`set-auto-mode' should already have handled `mode:',
a0e74e72 2795`set-auto-coding' should already have handled `coding:'.
5a6c1d87
CY
2796
2797If MODE-ONLY is non-nil, all we do is check whether the major
2798mode is specified, returning t if it is specified. Otherwise,
2799return an alist of elements (VAR . VAL), where VAR is a variable
2800and VAL is the specified value."
f3e23606
RS
2801 (save-excursion
2802 (goto-char (point-min))
5a6c1d87
CY
2803 (let ((end (set-auto-mode-1))
2804 result mode-specified)
a0e74e72
RS
2805 ;; Parse the -*- line into the RESULT alist.
2806 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
e3f9b9c0 2807 (cond ((not end)
f3e23606
RS
2808 nil)
2809 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180 2810 ;; Simple form: "-*- MODENAME -*-". Already handled.
a0e74e72 2811 (setq mode-specified t)
13a66180 2812 nil)
f3e23606
RS
2813 (t
2814 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2815 ;; (last ";" is optional).
f3e23606
RS
2816 (while (< (point) end)
2817 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
ffc0e1ca 2818 (error "Malformed -*- line"))
f3e23606 2819 (goto-char (match-end 0))
1c26a6f3
KH
2820 ;; There used to be a downcase here,
2821 ;; but the manual didn't say so,
2822 ;; and people want to set var names that aren't all lc.
e442c62b 2823 (let ((key (intern (match-string 1)))
f3e23606
RS
2824 (val (save-restriction
2825 (narrow-to-region (point) end)
2826 (read (current-buffer)))))
93a2702d
RS
2827 ;; It is traditional to ignore
2828 ;; case when checking for `mode' in set-auto-mode,
2829 ;; so we must do that here as well.
2830 ;; That is inconsistent, but we're stuck with it.
3fa0a9aa 2831 ;; The same can be said for `coding' in set-auto-coding.
5a6c1d87
CY
2832 (or (and (equal (downcase (symbol-name key)) "mode")
2833 (setq mode-specified t))
3fa0a9aa 2834 (equal (downcase (symbol-name key)) "coding")
5a6c1d87
CY
2835 (condition-case nil
2836 (push (cons (if (eq key 'eval)
2837 'eval
2838 (indirect-variable key))
2839 val) result)
2840 (error nil)))
2841 (skip-chars-forward " \t;")))))
2842
2843 (if mode-only
2844 mode-specified
2845 result))))
f3e23606 2846
2b8ac025
CY
2847(defun hack-local-variables-filter (variables project)
2848 "Filter local variable settings, querying the user if necessary.
2849VARIABLES is the alist of variable-value settings. This alist is
2850 filtered based on the values of `ignored-local-variables',
2851 `enable-local-eval', `enable-local-variables', and (if necessary)
2852 user interaction. The results are added to
2853 `file-local-variables-alist', without applying them.
2854PROJECT is a directory name if these settings come from
2855 directory-local settings, or nil otherwise."
2856 ;; Strip any variables that are in `ignored-local-variables'.
1b21ee06 2857 (dolist (ignored ignored-local-variables)
2b8ac025
CY
2858 (setq variables (assq-delete-all ignored variables)))
2859 ;; If `enable-local-eval' is nil, strip eval "variables".
1b21ee06 2860 (if (null enable-local-eval)
2b8ac025
CY
2861 (setq variables (assq-delete-all 'eval variables)))
2862 (setq variables (nreverse variables))
2863 (when variables
1b21ee06
MO
2864 ;; Find those variables that we may want to save to
2865 ;; `safe-local-variable-values'.
2866 (let (risky-vars unsafe-vars)
2b8ac025 2867 (dolist (elt variables)
1b21ee06
MO
2868 (let ((var (car elt))
2869 (val (cdr elt)))
2870 ;; Don't query about the fake variables.
2871 (or (memq var '(mode unibyte coding))
2872 (and (eq var 'eval)
2873 (or (eq enable-local-eval t)
2874 (hack-one-local-variable-eval-safep
2875 (eval (quote val)))))
2876 (safe-local-variable-p var val)
2877 (and (risky-local-variable-p var val)
2878 (push elt risky-vars))
2879 (push elt unsafe-vars))))
2880 (if (eq enable-local-variables :safe)
2b8ac025
CY
2881 ;; If caller wants only safe variables, store only these.
2882 (dolist (elt variables)
1b21ee06
MO
2883 (unless (or (member elt unsafe-vars)
2884 (member elt risky-vars))
2b8ac025
CY
2885 (push elt file-local-variables-alist)))
2886 ;; Query, unless all are known safe or the user wants no
2887 ;; querying.
1b21ee06
MO
2888 (if (or (and (eq enable-local-variables t)
2889 (null unsafe-vars)
2890 (null risky-vars))
2891 (eq enable-local-variables :all)
2892 (hack-local-variables-confirm
2b8ac025
CY
2893 variables unsafe-vars risky-vars project))
2894 (dolist (elt variables)
2895 (push elt file-local-variables-alist)))))))
1b21ee06 2896
9de9b6a2
RS
2897(defun hack-local-variables (&optional mode-only)
2898 "Parse and put into effect this buffer's local variables spec.
2899If MODE-ONLY is non-nil, all we do is check whether the major mode
2900is specified, returning t if it is specified."
5a6c1d87
CY
2901 (let ((enable-local-variables
2902 (and local-enable-local-variables enable-local-variables))
2903 result)
2b8ac025
CY
2904 (unless mode-only
2905 (setq file-local-variables-alist nil)
2906 (report-errors "Project local-variables error: %s"
2907 (hack-project-variables)))
5a6c1d87
CY
2908 (when (or mode-only enable-local-variables)
2909 (setq result (hack-local-variables-prop-line mode-only))
2910 ;; Look for "Local variables:" line in last page.
2911 (save-excursion
2912 (goto-char (point-max))
2913 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2914 'move)
2915 (when (let ((case-fold-search t))
2916 (search-forward "Local Variables:" nil t))
2917 (skip-chars-forward " \t")
2918 ;; suffix is what comes after "local variables:" in its line.
2919 ;; prefix is what comes before "local variables:" in its line.
2920 (let ((suffix
2921 (concat
2922 (regexp-quote (buffer-substring (point)
2923 (line-end-position)))
2924 "$"))
2925 (prefix
2926 (concat "^" (regexp-quote
2927 (buffer-substring (line-beginning-position)
2928 (match-beginning 0)))))
2929 beg)
2930
2931 (forward-line 1)
2932 (let ((startpos (point))
2933 endpos
2934 (thisbuf (current-buffer)))
2935 (save-excursion
2936 (unless (let ((case-fold-search t))
2937 (re-search-forward
2938 (concat prefix "[ \t]*End:[ \t]*" suffix)
2939 nil t))
5ee66afc
SM
2940 ;; This used to be an error, but really all it means is
2941 ;; that this may simply not be a local-variables section,
2942 ;; so just ignore it.
2943 (message "Local variables list is not properly terminated"))
5a6c1d87
CY
2944 (beginning-of-line)
2945 (setq endpos (point)))
2946
2947 (with-temp-buffer
2948 (insert-buffer-substring thisbuf startpos endpos)
2949 (goto-char (point-min))
2950 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2951 (while (not (eobp))
2952 ;; Discard the prefix.
2953 (if (looking-at prefix)
2954 (delete-region (point) (match-end 0))
2955 (error "Local variables entry is missing the prefix"))
2956 (end-of-line)
2957 ;; Discard the suffix.
2958 (if (looking-back suffix)
2959 (delete-region (match-beginning 0) (point))
2960 (error "Local variables entry is missing the suffix"))
2961 (forward-line 1))
2962 (goto-char (point-min))
2963
2964 (while (not (eobp))
2965 ;; Find the variable name; strip whitespace.
2966 (skip-chars-forward " \t")
2967 (setq beg (point))
2968 (skip-chars-forward "^:\n")
2969 (if (eolp) (error "Missing colon in local variables entry"))
2970 (skip-chars-backward " \t")
2971 (let* ((str (buffer-substring beg (point)))
2972 (var (read str))
2973 val)
2974 ;; Read the variable value.
2975 (skip-chars-forward "^:")
2976 (forward-char 1)
2977 (setq val (read (current-buffer)))
2978 (if mode-only
2979 (if (eq var 'mode)
2980 (setq result t))
2981 (unless (eq var 'coding)
2982 (condition-case nil
2983 (push (cons (if (eq var 'eval)
2984 'eval
2985 (indirect-variable var))
2986 val) result)
2987 (error nil)))))
2b8ac025
CY
2988 (forward-line 1))))))))
2989 ;; Now we've read all the local variables.
2990 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
2991 (cond (mode-only result)
2992 ;; Otherwise, set the variables.
2993 (enable-local-variables
2994 (hack-local-variables-filter result nil)
2995 (when file-local-variables-alist
2996 (setq file-local-variables-alist
2997 (nreverse file-local-variables-alist))
2998 (run-hooks 'before-hack-local-variables-hook)
2999 (dolist (elt file-local-variables-alist)
3000 (hack-one-local-variable (car elt) (cdr elt))))
3001 (run-hooks 'hack-local-variables-hook)))))
5a6c1d87 3002
5a6c1d87
CY
3003(defun safe-local-variable-p (sym val)
3004 "Non-nil if SYM is safe as a file-local variable with value VAL.
3005It is safe if any of these conditions are met:
3006
3007 * There is a matching entry (SYM . VAL) in the
3008 `safe-local-variable-values' user option.
3009
5a6c1d87
CY
3010 * The `safe-local-variable' property of SYM is a function that
3011 evaluates to a non-nil value with VAL as an argument."
3012 (or (member (cons sym val) safe-local-variable-values)
3013 (let ((safep (get sym 'safe-local-variable)))
80aa4695 3014 (and (functionp safep) (funcall safep val)))))
5a6c1d87
CY
3015
3016(defun risky-local-variable-p (sym &optional ignored)
3017 "Non-nil if SYM could be dangerous as a file-local variable.
3018It is dangerous if either of these conditions are met:
3019
3020 * Its `risky-local-variable' property is non-nil.
3021
3022 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3023 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
cc5a104d
RS
3024 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3025 \"map-alist\", or \"bindat-spec\"."
f36d46ca
RS
3026 ;; If this is an alias, check the base name.
3027 (condition-case nil
3028 (setq sym (indirect-variable sym))
3029 (error nil))
5a6c1d87
CY
3030 (or (get sym 'risky-local-variable)
3031 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3032-commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3033-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
cc5a104d 3034-map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
7ed9159a 3035
d0bd3513
RS
3036(defun hack-one-local-variable-quotep (exp)
3037 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3038
ff7affeb
RS
3039(defun hack-one-local-variable-constantp (exp)
3040 (or (and (not (symbolp exp)) (not (consp exp)))
3041 (memq exp '(t nil))
3042 (keywordp exp)
3043 (hack-one-local-variable-quotep exp)))
3044
3045(defun hack-one-local-variable-eval-safep (exp)
3046 "Return t if it is safe to eval EXP when it is found in a file."
8fd9c174
RS
3047 (or (not (consp exp))
3048 ;; Detect certain `put' expressions.
3049 (and (eq (car exp) 'put)
3050 (hack-one-local-variable-quotep (nth 1 exp))
3051 (hack-one-local-variable-quotep (nth 2 exp))
9b3e8086
CY
3052 (let ((prop (nth 1 (nth 2 exp)))
3053 (val (nth 3 exp)))
3054 (cond ((memq prop '(lisp-indent-hook
3055 lisp-indent-function
3056 scheme-indent-function))
3057 ;; Only allow safe values (not functions).
3058 (or (numberp val)
3059 (and (hack-one-local-variable-quotep val)
3060 (eq (nth 1 val) 'defun))))
bc5d1dfb
EZ
3061 ((eq prop 'edebug-form-spec)
3062 ;; Only allow indirect form specs.
b486a098
SM
3063 ;; During bootstrapping, edebug-basic-spec might not be
3064 ;; defined yet.
3065 (and (fboundp 'edebug-basic-spec)
f215a02f
AS
3066 (hack-one-local-variable-quotep val)
3067 (edebug-basic-spec (nth 1 val)))))))
8fd9c174
RS
3068 ;; Allow expressions that the user requested.
3069 (member exp safe-local-eval-forms)
3070 ;; Certain functions can be allowed with safe arguments
3071 ;; or can specify verification functions to try.
3072 (and (symbolp (car exp))
3073 (let ((prop (get (car exp) 'safe-local-eval-function)))
3074 (cond ((eq prop t)
3075 (let ((ok t))
3076 (dolist (arg (cdr exp))
3077 (unless (hack-one-local-variable-constantp arg)
3078 (setq ok nil)))
3079 ok))
3080 ((functionp prop)
3081 (funcall prop exp))
3082 ((listp prop)
3083 (let ((ok nil))
3084 (dolist (function prop)
3085 (if (funcall function exp)
3086 (setq ok t)))
3087 ok)))))))
ff7affeb 3088
f3e23606 3089(defun hack-one-local-variable (var val)
0c7c413c
CY
3090 "Set local variable VAR with value VAL.
3091If VAR is `mode', call `VAL-mode' as a function unless it's
3092already the major mode."
f3e23606 3093 (cond ((eq var 'mode)
0c7c413c
CY
3094 (let ((mode (intern (concat (downcase (symbol-name val))
3095 "-mode"))))
3096 (unless (eq (indirect-function mode)
3097 (indirect-function major-mode))
3098 (funcall mode))))
5a6c1d87
CY
3099 ((eq var 'eval)
3100 (save-excursion (eval val)))
e442c62b
SM
3101 (t
3102 ;; Make sure the string has no text properties.
3103 ;; Some text properties can get evaluated in various ways,
3104 ;; so it is risky to put them on with a local variable list.
3105 (if (stringp val)
3106 (set-text-properties 0 (length val) nil val))
3107 (set (make-local-variable var) val))))
1b21ee06
MO
3108\f
3109;;; Handling directory local variables, aka project settings.
3110
3111(defvar project-class-alist '()
3112 "Alist mapping project class names (symbols) to project variable lists.")
3113
3114(defvar project-directory-alist '()
3115 "Alist mapping project directory roots to project classes.")
3116
3117(defsubst project-get-alist (class)
3118 "Return the project variable list for project CLASS."
3119 (cdr (assq class project-class-alist)))
3120
3121(defun project-collect-bindings-from-alist (mode-alist settings)
3122 "Collect local variable settings from MODE-ALIST.
3123SETTINGS is the initial list of bindings.
3124Returns the new list."
3125 (dolist (pair mode-alist settings)
3126 (let* ((variable (car pair))
3127 (value (cdr pair))
3128 (slot (assq variable settings)))
3129 (if slot
3130 (setcdr slot value)
3131 ;; Need a new cons in case we setcdr later.
3132 (push (cons variable value) settings)))))
3133
3134(defun project-collect-binding-list (binding-list root settings)
3135 "Collect entries from BINDING-LIST into SETTINGS.
3136ROOT is the root directory of the project.
3137Return the new settings list."
3138 (let* ((file-name (buffer-file-name))
3139 (sub-file-name (if file-name
3140 (substring file-name (length root)))))
3141 (dolist (entry binding-list settings)
3142 (let ((key (car entry)))
3143 (cond
3144 ((stringp key)
3145 ;; Don't include this in the previous condition, because we
3146 ;; want to filter all strings before the next condition.
3147 (when (and sub-file-name
3148 (>= (length sub-file-name) (length key))
3149 (string= key (substring sub-file-name 0 (length key))))
3150 (setq settings (project-collect-binding-list (cdr entry)
3151 root settings))))
3152 ((or (not key)
3153 (derived-mode-p key))
3154 (setq settings (project-collect-bindings-from-alist (cdr entry)
3155 settings))))))))
3156
3157(defun set-directory-project (directory class)
3158 "Declare that the project rooted at DIRECTORY is an instance of CLASS.
3159DIRECTORY is the name of a directory, a string.
3160CLASS is the name of a project class, a symbol.
3161
3162When a file beneath DIRECTORY is visited, the mode-specific
3163settings from CLASS will be applied to the buffer. The settings
3164for a class are defined using `define-project-bindings'."
3165 (setq directory (file-name-as-directory (expand-file-name directory)))
3166 (unless (assq class project-class-alist)
3167 (error "No such project class `%s'" (symbol-name class)))
3168 (push (cons directory class) project-directory-alist))
3169
8fc29035 3170(defun define-project-bindings (class settings)
1b21ee06
MO
3171 "Map the project type CLASS to a list of variable settings.
3172CLASS is the project class, a symbol.
8fc29035
JB
3173SETTINGS is a list that declares variable settings for the class.
3174An element in SETTINGS is either of the form:
1b21ee06
MO
3175 (MAJOR-MODE . ALIST)
3176or
3177 (DIRECTORY . LIST)
3178
3179In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3180whose elements are of the form (VARIABLE . VALUE).
3181
3182In the second form, DIRECTORY is a directory name (a string), and
3183LIST is a list of the form accepted by the function.
3184
3185When a file is visited, the file's class is found. A directory
3186may be assigned a class using `set-directory-project'. Then
3187variables are set in the file's buffer according to the class'
3188LIST. The list is processed in order.
3189
3190* If the element is of the form (MAJOR-MODE . ALIST), and the
3191 buffer's major mode is derived from MAJOR-MODE (as determined
3192 by `derived-mode-p'), then all the settings in ALIST are
3193 applied. A MAJOR-MODE of nil may be used to match any buffer.
3194 `make-local-variable' is called for each variable before it is
3195 set.
3196
3197* If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3198 is an initial substring of the file's directory, then LIST is
3199 applied by recursively following these rules."
3200 (let ((elt (assq class project-class-alist)))
3201 (if elt
8fc29035
JB
3202 (setcdr elt settings)
3203 (push (cons class settings) project-class-alist))))
1b21ee06 3204
ffe89e76 3205(defcustom project-settings-file ".dir-settings.el"
09949b83
JB
3206 "Settings file for per-project settings.
3207Set this to nil if you don't want to load project-specific settings."
ffe89e76 3208 :type '(choice
09949b83
JB
3209 (const :tag "Ignore" nil)
3210 (file :tag "File"))
3211 :group 'files)
ffe89e76 3212
1b21ee06
MO
3213(defun project-find-settings-file (file)
3214 "Find the settings file for FILE.
3215This searches upward in the directory tree.
3216If a settings file is found, the file name is returned.
3217If the file is in a registered project, a cons from
3218`project-directory-alist' is returned.
3219Otherwise this returns nil."
ffe89e76
CY
3220 (when project-settings-file
3221 (setq file (expand-file-name file))
8fc29035
JB
3222 (let ((settings (locate-dominating-file file project-settings-file))
3223 (pda nil))
ffe89e76 3224 ;; `locate-dominating-file' may have abbreviated the name.
8fc29035
JB
3225 (when settings
3226 (setq settings (expand-file-name project-settings-file settings)))
ffe89e76
CY
3227 (dolist (x project-directory-alist)
3228 (when (and (eq t (compare-strings file nil (length (car x))
3229 (car x) nil nil))
3230 (> (length (car x)) (length (car pda))))
3231 (setq pda x)))
3232 (if (and settings pda)
3233 (if (> (length (file-name-directory settings))
3234 (length (car pda)))
3235 settings pda)
3236 (or settings pda)))))
1b21ee06
MO
3237
3238(defun project-define-from-project-file (settings-file)
3239 "Load a settings file and register a new project class and instance.
3240SETTINGS-FILE is the name of the file holding the settings to apply.
3241The new class name is the same as the directory in which SETTINGS-FILE
3242is found. Returns the new class name."
3243 (with-temp-buffer
3244 ;; We should probably store the modtime of SETTINGS-FILE and then
3245 ;; reload it whenever it changes.
3246 (insert-file-contents settings-file)
3247 (let* ((dir-name (file-name-directory settings-file))
3248 (class-name (intern dir-name))
3249 (list (read (current-buffer))))
3250 (define-project-bindings class-name list)
3251 (set-directory-project dir-name class-name)
3252 class-name)))
3253
361edc85
GM
3254(declare-function c-postprocess-file-styles "cc-mode" ())
3255
1b21ee06 3256(defun hack-project-variables ()
2b8ac025
CY
3257 "Read local variables for the current buffer based on project settings.
3258Store the project variables in `file-local-variables-alist',
3259without applying them."
3260 (when (and enable-local-variables
3261 (buffer-file-name)
3262 (not (file-remote-p (buffer-file-name))))
1b21ee06
MO
3263 ;; Find the settings file.
3264 (let ((settings (project-find-settings-file (buffer-file-name)))
3265 (class nil)
3266 (root-dir nil))
3267 (cond
3268 ((stringp settings)
3269 (setq root-dir (file-name-directory (buffer-file-name)))
3270 (setq class (project-define-from-project-file settings)))
3271 ((consp settings)
3272 (setq root-dir (car settings))
3273 (setq class (cdr settings))))
3274 (when class
3275 (let ((bindings
3276 (project-collect-binding-list (project-get-alist class)
3277 root-dir nil)))
3278 (when bindings
2b8ac025 3279 (hack-local-variables-filter bindings root-dir)))))))
f3e23606 3280
b4da00e9 3281\f
21540597 3282(defcustom change-major-mode-with-file-name t
ba83982b 3283 "Non-nil means \\[write-file] should set the major mode from the file name.
9de9b6a2
RS
3284However, the mode will not be changed if
3285\(1) a local variables list or the `-*-' line specifies a major mode, or
3286\(2) the current major mode is a \"special\" mode,
96e777e1 3287\ not suitable for ordinary files, or
21540597
RS
3288\(3) the new file name does not particularly specify any mode."
3289 :type 'boolean
3290 :group 'editing-basics)
9de9b6a2 3291
f36012a6 3292(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9 3293 "Change name of file visited in current buffer to FILENAME.
1af57101 3294This also renames the buffer to correspond to the new file.
b4da00e9 3295The next time the buffer is saved it will go in the newly specified file.
1af57101 3296FILENAME nil or an empty string means mark buffer as not visiting any file.
b4da00e9 3297Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
3298if you wish to pass an empty string as the argument.
3299
3300The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
3301confirmation in the case where another buffer is already visiting FILENAME.
3302
3303The optional third argument ALONG-WITH-FILE, if non-nil, means that
3304the old visited file has been renamed to the new name FILENAME."
b4da00e9 3305 (interactive "FSet visited file name: ")
c11a94fe
RS
3306 (if (buffer-base-buffer)
3307 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
3308 (let (truename)
3309 (if filename
3310 (setq filename
3311 (if (string-equal filename "")
3312 nil
3313 (expand-file-name filename))))
3314 (if filename
3315 (progn
3316 (setq truename (file-truename filename))
3317 (if find-file-visit-truename
a522e5bf 3318 (setq filename truename))))
cbca0a4b 3319 (if filename
e6d0b67a 3320 (let ((new-name (file-name-nondirectory filename)))
cbca0a4b
RS
3321 (if (string= new-name "")
3322 (error "Empty file name"))))
11e314fa 3323 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 3324 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 3325 (not no-query)
674b7bae
JB
3326 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3327 filename)))
7b89d38e 3328 (error "Aborted")))
a522e5bf
RS
3329 (or (equal filename buffer-file-name)
3330 (progn
3331 (and filename (lock-buffer filename))
3332 (unlock-buffer)))
3333 (setq buffer-file-name filename)
3334 (if filename ; make buffer name reflect filename.
3335 (let ((new-name (file-name-nondirectory buffer-file-name)))
a522e5bf 3336 (setq default-directory (file-name-directory buffer-file-name))
67b6fd1c
SM
3337 ;; If new-name == old-name, renaming would add a spurious <2>
3338 ;; and it's considered as a feature in rename-buffer.
a522e5bf
RS
3339 (or (string= new-name (buffer-name))
3340 (rename-buffer new-name t))))
3341 (setq buffer-backed-up nil)
f36012a6
RS
3342 (or along-with-file
3343 (clear-visited-file-modtime))
8ccdc29e 3344 ;; Abbreviate the file names of the buffer.
4826e97f 3345 (if truename
8ccdc29e
RS
3346 (progn
3347 (setq buffer-file-truename (abbreviate-file-name truename))
3348 (if find-file-visit-truename
b1f1ceb8 3349 (setq buffer-file-name truename))))
a522e5bf
RS
3350 (setq buffer-file-number
3351 (if filename
2a47b4f5 3352 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 3353 nil)))
0370fe77 3354 ;; write-file-functions is normally used for things like ftp-find-file
b4da00e9
RM
3355 ;; that visit things that are not local files as if they were files.
3356 ;; Changing to visit an ordinary local file instead should flush the hook.
0370fe77 3357 (kill-local-variable 'write-file-functions)
c9dca4e0 3358 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
3359 (kill-local-variable 'revert-buffer-function)
3360 (kill-local-variable 'backup-inhibited)
ee81c959
RS
3361 ;; If buffer was read-only because of version control,
3362 ;; that reason is gone now, so make it writable.
3363 (if vc-mode
3364 (setq buffer-read-only nil))
3365 (kill-local-variable 'vc-mode)
b4da00e9
RM
3366 ;; Turn off backup files for certain file names.
3367 ;; Since this is a permanent local, the major mode won't eliminate it.
4d49551a 3368 (and buffer-file-name
b98a8e06 3369 backup-enable-predicate
4d49551a 3370 (not (funcall backup-enable-predicate buffer-file-name))
b4da00e9
RM
3371 (progn
3372 (make-local-variable 'backup-inhibited)
3373 (setq backup-inhibited t)))
c77a81cf
RS
3374 (let ((oauto buffer-auto-save-file-name))
3375 ;; If auto-save was not already on, turn it on if appropriate.
3376 (if (not buffer-auto-save-file-name)
3377 (and buffer-file-name auto-save-default
3378 (auto-save-mode t))
3379 ;; If auto save is on, start using a new name.
3380 ;; We deliberately don't rename or delete the old auto save
3381 ;; for the old visited file name. This is because perhaps
3382 ;; the user wants to save the new state and then compare with the
3383 ;; previous state from the auto save file.
3384 (setq buffer-auto-save-file-name
3385 (make-auto-save-file-name)))
3386 ;; Rename the old auto save file if any.
3387 (and oauto buffer-auto-save-file-name
e6f0e76c 3388 (file-exists-p oauto)
c77a81cf 3389 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
3390 (and buffer-file-name
3391 (not along-with-file)
9de9b6a2
RS
3392 (set-buffer-modified-p t))
3393 ;; Update the major mode, if the file name determines it.
3394 (condition-case nil
3395 ;; Don't change the mode if it is special.
3396 (or (not change-major-mode-with-file-name)
3397 (get major-mode 'mode-class)
3398 ;; Don't change the mode if the local variable list specifies it.
3399 (hack-local-variables t)
3400 (set-auto-mode t))
3401 (error nil)))
b4da00e9 3402
912192d1 3403(defun write-file (filename &optional confirm)
b4da00e9 3404 "Write current buffer into file FILENAME.
7f99999a 3405This makes the buffer visit that file, and marks it as not modified.
7458cc35 3406
7f99999a
KH
3407If you specify just a directory name as FILENAME, that means to use
3408the default file name but in that directory. You can also yank
074eb6ac 3409the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
7f99999a
KH
3410
3411If the buffer is not already visiting a file, the default file name
3412for the output file is the buffer name.
3413
3414If optional second arg CONFIRM is non-nil, this function
3415asks for confirmation before overwriting an existing file.
912192d1 3416Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
3417;; (interactive "FWrite file: ")
3418 (interactive
3419 (list (if buffer-file-name
3420 (read-file-name "Write file: "
f3684505 3421 nil nil nil nil)
7f99999a
KH
3422 (read-file-name "Write file: " default-directory
3423 (expand-file-name
3424 (file-name-nondirectory (buffer-name))
3425 default-directory)
3426 nil nil))
912192d1 3427 (not current-prefix-arg)))
b4da00e9 3428 (or (null filename) (string-equal filename "")
41f48cb1
RS
3429 (progn
3430 ;; If arg is just a directory,
7f99999a
KH
3431 ;; use the default file name, but in that directory.
3432 (if (file-directory-p filename)
41f48cb1 3433 (setq filename (concat (file-name-as-directory filename)
7f99999a
KH
3434 (file-name-nondirectory
3435 (or buffer-file-name (buffer-name))))))
c2fb8488
RS
3436 (and confirm
3437 (file-exists-p filename)
3438 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3439 (error "Canceled")))
5f65549e 3440 (set-visited-file-name filename (not confirm))))
b4da00e9 3441 (set-buffer-modified-p t)
6492b55d
KH
3442 ;; Make buffer writable if file is writable.
3443 (and buffer-file-name
3444 (file-writable-p buffer-file-name)
3445 (setq buffer-read-only nil))
8e5c7b90
SM
3446 (save-buffer)
3447 ;; It's likely that the VC status at the new location is different from
3448 ;; the one at the old location.
3449 (vc-find-file-hook))
b4da00e9
RM
3450\f
3451(defun backup-buffer ()
3452 "Make a backup of the disk file visited by the current buffer, if appropriate.
3453This is normally done before saving the buffer the first time.
27ab6944
KH
3454
3455A backup may be done by renaming or by copying; see documentation of
3456variable `make-backup-files'. If it's done by renaming, then the file is
f3f9e207
RS
3457no longer accessible under its old name.
3458
3459The value is non-nil after a backup was made by renaming.
3460It has the form (MODES . BACKUPNAME).
3461MODES is the result of `file-modes' on the original
3462file; this means that the caller, after saving the buffer, should change
3463the modes of the new file to agree with the old modes.
3464BACKUPNAME is the backup file name, which is the old file renamed."
b4da00e9
RM
3465 (if (and make-backup-files (not backup-inhibited)
3466 (not buffer-backed-up)
3467 (file-exists-p buffer-file-name)
3468 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3469 '(?- ?l)))
3470 (let ((real-file-name buffer-file-name)
3471 backup-info backupname targets setmodes)
3472 ;; If specified name is a symbolic link, chase it to the target.
3473 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 3474 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
3475 (setq backup-info (find-backup-file-name real-file-name)
3476 backupname (car backup-info)
3477 targets (cdr backup-info))
5c6d31a4
SM
3478 ;; (if (file-directory-p buffer-file-name)
3479 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
3480 (if backup-info
3481 (condition-case ()
3482 (let ((delete-old-versions
3483 ;; If have old versions to maybe delete,
3484 ;; ask the user to confirm now, before doing anything.
3485 ;; But don't actually delete til later.
3486 (and targets
3487 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3488 (or delete-old-versions
3489 (y-or-n-p (format "Delete excess backup versions of %s? "
446c63b0
RS
3490 real-file-name)))))
3491 (modes (file-modes buffer-file-name)))
eb650569
RS
3492 ;; Actually write the back up file.
3493 (condition-case ()
3494 (if (or file-precious-flag
ffc0e1ca 3495 ; (file-symlink-p buffer-file-name)
eb650569 3496 backup-by-copying
446c63b0 3497 ;; Don't rename a suid or sgid file.
7da6bf00 3498 (and modes (< 0 (logand modes #o6000)))
79d2d279 3499 (not (file-writable-p (file-name-directory real-file-name)))
eb650569
RS
3500 (and backup-by-copying-when-linked
3501 (> (file-nlinks real-file-name) 1))
ffc0e1ca
AS
3502 (and (or backup-by-copying-when-mismatch
3503 (integerp backup-by-copying-when-privileged-mismatch))
eb650569 3504 (let ((attr (file-attributes real-file-name)))
ffc0e1ca
AS
3505 (and (or backup-by-copying-when-mismatch
3506 (and (integerp (nth 2 attr))
3507 (integerp backup-by-copying-when-privileged-mismatch)
3508 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3509 (or (nth 9 attr)
3510 (not (file-ownership-preserved-p real-file-name)))))))
446c63b0 3511 (backup-buffer-copy real-file-name backupname modes)
eb650569
RS
3512 ;; rename-file should delete old backup.
3513 (rename-file real-file-name backupname t)
446c63b0 3514 (setq setmodes (cons modes backupname)))
eb650569
RS
3515 (file-error
3516 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
3517 (setq backupname (expand-file-name
3518 (convert-standard-filename
3519 "~/%backup%~")))
3520 (message "Cannot write backup file; backing up in %s"
6ba7756e 3521 backupname)
eb650569 3522 (sleep-for 1)
446c63b0 3523 (backup-buffer-copy real-file-name backupname modes)))
eb650569
RS
3524 (setq buffer-backed-up t)
3525 ;; Now delete the old versions, if desired.
3526 (if delete-old-versions
3527 (while targets
3528 (condition-case ()
3529 (delete-file (car targets))
3530 (file-error nil))
3531 (setq targets (cdr targets))))
3532 setmodes)
3533 (file-error nil))))))
b4da00e9 3534
446c63b0 3535(defun backup-buffer-copy (from-name to-name modes)
44dce0fb
RS
3536 (let ((umask (default-file-modes)))
3537 (unwind-protect
3538 (progn
3539 ;; Create temp files with strict access rights. It's easy to
3540 ;; loosen them later, whereas it's impossible to close the
3541 ;; time-window of loose permissions otherwise.
3542 (set-default-file-modes ?\700)
0f39d2c9
MR
3543 (when (condition-case nil
3544 ;; Try to overwrite old backup first.
5b2e628f 3545 (copy-file from-name to-name t t t)
0f39d2c9
MR
3546 (error t))
3547 (while (condition-case nil
3548 (progn
3549 (when (file-exists-p to-name)
3550 (delete-file to-name))
5b2e628f 3551 (copy-file from-name to-name nil t t)
0f39d2c9
MR
3552 nil)
3553 (file-already-exists t))
3554 ;; The file was somehow created by someone else between
3555 ;; `delete-file' and `copy-file', so let's try again.
3556 ;; rms says "I think there is also a possible race
3557 ;; condition for making backup files" (emacs-devel 20070821).
3558 nil)))
44dce0fb
RS
3559 ;; Reset the umask.
3560 (set-default-file-modes umask)))
147fbf70
RS
3561 (and modes
3562 (set-file-modes to-name (logand modes #o1777))))
446c63b0 3563
c3554e95 3564(defun file-name-sans-versions (name &optional keep-backup-version)
ffc0e1ca 3565 "Return file NAME sans backup versions or strings.
b4da00e9 3566This is a separate procedure so your site-init or startup file can
c3554e95
RS
3567redefine it.
3568If the optional argument KEEP-BACKUP-VERSION is non-nil,
3569we do not remove backup version numbers, only true file version numbers."
6eaebaa2 3570 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
3571 (if handler
3572 (funcall handler 'file-name-sans-versions name keep-backup-version)
3573 (substring name 0
7c2fb837
DN
3574 (if keep-backup-version
3575 (length name)
3576 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3577 (string-match "~\\'" name)
3578 (length name)))))))
b4da00e9 3579
cb0cd911 3580(defun file-ownership-preserved-p (file)
ffc0e1ca 3581 "Return t if deleting FILE and rewriting it would preserve the owner."
cb0cd911
RS
3582 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3583 (if handler
3584 (funcall handler 'file-ownership-preserved-p file)
ec5533be 3585 (let ((attributes (file-attributes file)))
306faa42
RS
3586 ;; Return t if the file doesn't exist, since it's true that no
3587 ;; information would be lost by an (attempted) delete and create.
3588 (or (null attributes)
3589 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 3590
20b5d24c
RS
3591(defun file-name-sans-extension (filename)
3592 "Return FILENAME sans final \"extension\".
2531b0c3
EZ
3593The extension, in a file name, is the part that follows the last `.',
3594except that a leading `.', if any, doesn't count."
20b5d24c
RS
3595 (save-match-data
3596 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3597 directory)
2531b0c3
EZ
3598 (if (and (string-match "\\.[^.]*\\'" file)
3599 (not (eq 0 (match-beginning 0))))
20b5d24c 3600 (if (setq directory (file-name-directory filename))
6ee24f1e
RS
3601 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3602 ;; we don't want to expand it.
3603 (concat directory (substring file 0 (match-beginning 0)))
20b5d24c
RS
3604 (substring file 0 (match-beginning 0)))
3605 filename))))
3606
93a2702d
RS
3607(defun file-name-extension (filename &optional period)
3608 "Return FILENAME's final \"extension\".
2531b0c3 3609The extension, in a file name, is the part that follows the last `.',
32483280 3610excluding version numbers and backup suffixes,
2531b0c3 3611except that a leading `.', if any, doesn't count.
93a2702d
RS
3612Return nil for extensionless file names such as `foo'.
3613Return the empty string for file names such as `foo.'.
3614
3615If PERIOD is non-nil, then the returned value includes the period
3616that delimits the extension, and if FILENAME has no extension,
3617the value is \"\"."
3618 (save-match-data
3619 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2531b0c3
EZ
3620 (if (and (string-match "\\.[^.]*\\'" file)
3621 (not (eq 0 (match-beginning 0))))
93a2702d
RS
3622 (substring file (+ (match-beginning 0) (if period 0 1)))
3623 (if period
3624 "")))))
3625
ffc0e1ca
AS
3626(defcustom make-backup-file-name-function nil
3627 "A function to use instead of the default `make-backup-file-name'.
643c985d 3628A value of nil gives the default `make-backup-file-name' behavior.
ffc0e1ca 3629
d5798fa7 3630This could be buffer-local to do something special for specific
ffc0e1ca
AS
3631files. If you define it, you may need to change `backup-file-name-p'
3632and `file-name-sans-versions' too.
3633
3634See also `backup-directory-alist'."
3635 :group 'backup
3636 :type '(choice (const :tag "Default" nil)
3637 (function :tag "Your function")))
3638
3639(defcustom backup-directory-alist nil
3640 "Alist of filename patterns and backup directory names.
3641Each element looks like (REGEXP . DIRECTORY). Backups of files with
3642names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3643relative or absolute. If it is absolute, so that all matching files
3644are backed up into the same directory, the file names in this
3645directory will be the full name of the file backed up with all
3646directory separators changed to `!' to prevent clashes. This will not
3647work correctly if your filesystem truncates the resulting name.
3648
3649For the common case of all backups going into one directory, the alist
3650should contain a single element pairing \".\" with the appropriate
3651directory name.
3652
3653If this variable is nil, or it fails to match a filename, the backup
3654is made in the original file's directory.
3655
3656On MS-DOS filesystems without long names this variable is always
3657ignored."
3658 :group 'backup
dca5e71d 3659 :type '(repeat (cons (regexp :tag "Regexp matching filename")
ffc0e1ca
AS
3660 (directory :tag "Backup directory name"))))
3661
388d6ab5
RS
3662(defun normal-backup-enable-predicate (name)
3663 "Default `backup-enable-predicate' function.
0c2f6dda
RS
3664Checks for files in `temporary-file-directory',
3665`small-temporary-file-directory', and /tmp."
388d6ab5
RS
3666 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3667 name 0 nil)))
3668 ;; Directory is under temporary-file-directory.
3669 (and (not (eq comp t))
3670 (< comp (- (length temporary-file-directory)))))
0c2f6dda
RS
3671 (let ((comp (compare-strings "/tmp" 0 nil
3672 name 0 nil)))
3673 ;; Directory is under /tmp.
3674 (and (not (eq comp t))
3675 (< comp (- (length "/tmp")))))
388d6ab5
RS
3676 (if small-temporary-file-directory
3677 (let ((comp (compare-strings small-temporary-file-directory
3678 0 nil
3679 name 0 nil)))
3680 ;; Directory is under small-temporary-file-directory.
3681 (and (not (eq comp t))
3682 (< comp (- (length small-temporary-file-directory)))))))))
3683
b4da00e9
RM
3684(defun make-backup-file-name (file)
3685 "Create the non-numeric backup file name for FILE.
ffc0e1ca
AS
3686Normally this will just be the file's name with `~' appended.
3687Customization hooks are provided as follows.
3688
3689If the variable `make-backup-file-name-function' is non-nil, its value
3690should be a function which will be called with FILE as its argument;
3691the resulting name is used.
3692
3693Otherwise a match for FILE is sought in `backup-directory-alist'; see
3694the documentation of that variable. If the directory for the backup
3695doesn't exist, it is created."
3696 (if make-backup-file-name-function
3697 (funcall make-backup-file-name-function file)
3698 (if (and (eq system-type 'ms-dos)
3699 (not (msdos-long-file-names)))
3700 (let ((fn (file-name-nondirectory file)))
3701 (concat (file-name-directory file)
3702 (or (and (string-match "\\`[^.]+\\'" fn)
3703 (concat (match-string 0 fn) ".~"))
3704 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3705 (concat (match-string 0 fn) "~")))))
3706 (concat (make-backup-file-name-1 file) "~"))))
3707
3708(defun make-backup-file-name-1 (file)
3709 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3710 (let ((alist backup-directory-alist)
6ba7756e 3711 elt backup-directory abs-backup-directory)
ffc0e1ca
AS
3712 (while alist
3713 (setq elt (pop alist))
3714 (if (string-match (car elt) file)
3715 (setq backup-directory (cdr elt)
3716 alist nil)))
eb0455ab
RS
3717 ;; If backup-directory is relative, it should be relative to the
3718 ;; file's directory. By expanding explicitly here, we avoid
3719 ;; depending on default-directory.
3720 (if backup-directory
6ba7756e
RS
3721 (setq abs-backup-directory
3722 (expand-file-name backup-directory
3723 (file-name-directory file))))
3724 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
ffc0e1ca 3725 (condition-case nil
6ba7756e
RS
3726 (make-directory abs-backup-directory 'parents)
3727 (file-error (setq backup-directory nil
3728 abs-backup-directory nil))))
ee291b46
RS
3729 (if (null backup-directory)
3730 file
ffc0e1ca
AS
3731 (if (file-name-absolute-p backup-directory)
3732 (progn
c60ee5e7 3733 (when (memq system-type '(windows-nt ms-dos cygwin))
d7b6ca4a
RS
3734 ;; Normalize DOSish file names: downcase the drive
3735 ;; letter, if any, and replace the leading "x:" with
3736 ;; "/drive_x".
ffc0e1ca
AS
3737 (or (file-name-absolute-p file)
3738 (setq file (expand-file-name file))) ; make defaults explicit
3739 ;; Replace any invalid file-name characters (for the
3740 ;; case of backing up remote files).
446c097e 3741 (setq file (expand-file-name (convert-standard-filename file)))
ffc0e1ca 3742 (if (eq (aref file 1) ?:)
d7b6ca4a 3743 (setq file (concat "/"
ffc0e1ca
AS
3744 "drive_"
3745 (char-to-string (downcase (aref file 0)))
d7b6ca4a 3746 (if (eq (aref file 2) ?/)
ffc0e1ca 3747 ""
d7b6ca4a 3748 "/")
ffc0e1ca
AS
3749 (substring file 2)))))
3750 ;; Make the name unique by substituting directory
3751 ;; separators. It may not really be worth bothering about
3752 ;; doubling `!'s in the original name...
3753 (expand-file-name
3754 (subst-char-in-string
d7b6ca4a 3755 ?/ ?!
ffc0e1ca
AS
3756 (replace-regexp-in-string "!" "!!" file))
3757 backup-directory))
3758 (expand-file-name (file-name-nondirectory file)
6ba7756e 3759 (file-name-as-directory abs-backup-directory))))))
b4da00e9
RM
3760
3761(defun backup-file-name-p (file)
3762 "Return non-nil if FILE is a backup file name (numeric or not).
3763This is a separate function so you can redefine it for customization.
3764You may need to redefine `file-name-sans-versions' as well."
066327ae 3765 (string-match "~\\'" file))
b4da00e9 3766
e2b30772
RS
3767(defvar backup-extract-version-start)
3768
2d051399 3769;; This is used in various files.
a7aa942a
KH
3770;; The usage of backup-extract-version-start is not very clean,
3771;; but I can't see a good alternative, so as of now I am leaving it alone.
2d051399 3772(defun backup-extract-version (fn)
ffc0e1ca 3773 "Given the name of a numeric backup file, FN, return the backup number.
e2b30772 3774Uses the free variable `backup-extract-version-start', whose value should be
2d051399 3775the index in the name where the version number begins."
6cf29fe8 3776 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
e2b30772 3777 (= (match-beginning 0) backup-extract-version-start))
027a4b6b 3778 (string-to-number (substring fn backup-extract-version-start -1))
2d051399
RS
3779 0))
3780
b4da00e9 3781(defun find-backup-file-name (fn)
ffc0e1ca 3782 "Find a file name for a backup file FN, and suggestions for deletions.
b4da00e9 3783Value is a list whose car is the name for the backup file
ffc0e1ca
AS
3784and whose cdr is a list of old versions to consider deleting now.
3785If the value is nil, don't make a backup.
3786Uses `backup-directory-alist' in the same way as does
3787`make-backup-file-name'."
eb650569
RS
3788 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3789 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3790 (if handler
3791 (funcall handler 'find-backup-file-name fn)
f26d858e
EZ
3792 (if (or (eq version-control 'never)
3793 ;; We don't support numbered backups on plain MS-DOS
3794 ;; when long file names are unavailable.
3795 (and (eq system-type 'ms-dos)
3796 (not (msdos-long-file-names))))
b4da00e9 3797 (list (make-backup-file-name fn))
ffc0e1ca
AS
3798 (let* ((basic-name (make-backup-file-name-1 fn))
3799 (base-versions (concat (file-name-nondirectory basic-name)
3800 ".~"))
e2b30772 3801 (backup-extract-version-start (length base-versions))
eb650569 3802 (high-water-mark 0)
ffc0e1ca
AS
3803 (number-to-delete 0)
3804 possibilities deserve-versions-p versions)
eb650569
RS
3805 (condition-case ()
3806 (setq possibilities (file-name-all-completions
3807 base-versions
ffc0e1ca
AS
3808 (file-name-directory basic-name))
3809 versions (sort (mapcar #'backup-extract-version
3810 possibilities)
3811 #'<)
eb650569
RS
3812 high-water-mark (apply 'max 0 versions)
3813 deserve-versions-p (or version-control
3814 (> high-water-mark 0))
3815 number-to-delete (- (length versions)
ffc0e1ca
AS
3816 kept-old-versions
3817 kept-new-versions
3818 -1))
3819 (file-error (setq possibilities nil)))
eb650569 3820 (if (not deserve-versions-p)
8767d866 3821 (list (make-backup-file-name fn))
ffc0e1ca 3822 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
eb650569
RS
3823 (if (and (> number-to-delete 0)
3824 ;; Delete nothing if there is overflow
3825 ;; in the number of versions to keep.
3826 (>= (+ kept-new-versions kept-old-versions -1) 0))
ffc0e1ca
AS
3827 (mapcar (lambda (n)
3828 (format "%s.~%d~" basic-name n))
eb650569
RS
3829 (let ((v (nthcdr kept-old-versions versions)))
3830 (rplacd (nthcdr (1- number-to-delete) v) ())
3831 v))))))))))
b4da00e9 3832
b4da00e9
RM
3833(defun file-nlinks (filename)
3834 "Return number of names file FILENAME has."
3835 (car (cdr (file-attributes filename))))
6c636af9 3836
753ad988
KG
3837;; (defun file-relative-name (filename &optional directory)
3838;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3839;; This function returns a relative file name which is equivalent to FILENAME
3840;; when used with that default directory as the default.
3841;; If this is impossible (which can happen on MSDOS and Windows
3842;; when the file name and directory use different drive names)
3843;; then it returns FILENAME."
3844;; (save-match-data
3845;; (let ((fname (expand-file-name filename)))
3846;; (setq directory (file-name-as-directory
3847;; (expand-file-name (or directory default-directory))))
3848;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3849;; ;; drive names, they can't be relative, so return the absolute name.
3850;; (if (and (or (eq system-type 'ms-dos)
3851;; (eq system-type 'cygwin)
3852;; (eq system-type 'windows-nt))
3853;; (not (string-equal (substring fname 0 2)
3854;; (substring directory 0 2))))
3855;; filename
3856;; (let ((ancestor ".")
3857;; (fname-dir (file-name-as-directory fname)))
3858;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3859;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3860;; (setq directory (file-name-directory (substring directory 0 -1))
3861;; ancestor (if (equal ancestor ".")
3862;; ".."
3863;; (concat "../" ancestor))))
3864;; ;; Now ancestor is empty, or .., or ../.., etc.
3865;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3866;; ;; We matched within FNAME's directory part.
3867;; ;; Add the rest of FNAME onto ANCESTOR.
3868;; (let ((rest (substring fname (match-end 0))))
3869;; (if (and (equal ancestor ".")
3870;; (not (equal rest "")))
3871;; ;; But don't bother with ANCESTOR if it would give us `./'.
3872;; rest
3873;; (concat (file-name-as-directory ancestor) rest)))
3874;; ;; We matched FNAME's directory equivalent.
3875;; ancestor))))))
3876
6c636af9 3877(defun file-relative-name (filename &optional directory)
ffc0e1ca 3878 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2d6562a5
RS
3879This function returns a relative file name which is equivalent to FILENAME
3880when used with that default directory as the default.
753ad988 3881If FILENAME and DIRECTORY lie on different machines or on different drives
1be0210d 3882on a DOS/Windows machine, it returns FILENAME in expanded form."
96c188b0 3883 (save-match-data
753ad988
KG
3884 (setq directory
3885 (file-name-as-directory (expand-file-name (or directory
3886 default-directory))))
3887 (setq filename (expand-file-name filename))
3f788773
KG
3888 (let ((fremote (file-remote-p filename))
3889 (dremote (file-remote-p directory)))
493c98af
KG
3890 (if ;; Conditions for separate trees
3891 (or
3892 ;; Test for different drives on DOS/Windows
3893 (and
7c64272b 3894 ;; Should `cygwin' really be included here? --stef
493c98af 3895 (memq system-type '(ms-dos cygwin windows-nt))
7c64272b 3896 (not (eq t (compare-strings filename 0 2 directory 0 2))))
493c98af 3897 ;; Test for different remote file system identification
3f788773 3898 (not (equal fremote dremote)))
e2b30772 3899 filename
753ad988
KG
3900 (let ((ancestor ".")
3901 (filename-dir (file-name-as-directory filename)))
7c64272b
SM
3902 (while (not
3903 (or
3904 (eq t (compare-strings filename-dir nil (length directory)
3905 directory nil nil case-fold-search))
3906 (eq t (compare-strings filename nil (length directory)
3907 directory nil nil case-fold-search))))
753ad988 3908 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
3909 ancestor (if (equal ancestor ".")
3910 ".."
3911 (concat "../" ancestor))))
753ad988 3912 ;; Now ancestor is empty, or .., or ../.., etc.
7c64272b
SM
3913 (if (eq t (compare-strings filename nil (length directory)
3914 directory nil nil case-fold-search))
753ad988
KG
3915 ;; We matched within FILENAME's directory part.
3916 ;; Add the rest of FILENAME onto ANCESTOR.
3f7d6528 3917 (let ((rest (substring filename (length directory))))
753ad988 3918 (if (and (equal ancestor ".") (not (equal rest "")))
9695aac6
RS
3919 ;; But don't bother with ANCESTOR if it would give us `./'.
3920 rest
3921 (concat (file-name-as-directory ancestor) rest)))
753ad988
KG
3922 ;; We matched FILENAME's directory equivalent.
3923 ancestor))))))
b4da00e9
RM
3924\f
3925(defun save-buffer (&optional args)
e8f4db18
RS
3926 "Save current buffer in visited file if modified.
3927Variations are described below.
3928
b4da00e9
RM
3929By default, makes the previous version into a backup file
3930 if previously requested or if this is the first save.
dc2ab26e 3931Prefixed with one \\[universal-argument], marks this version
b4da00e9 3932 to become a backup when the next save is done.
dc2ab26e 3933Prefixed with two \\[universal-argument]'s,
b4da00e9 3934 unconditionally makes the previous version into a backup file.
dc2ab26e 3935Prefixed with three \\[universal-argument]'s, marks this version
ac9650be
RS
3936 to become a backup when the next save is done,
3937 and unconditionally makes the previous version into a backup file.
3938
dc2ab26e
EZ
3939With a numeric argument of 0, never make the previous version
3940into a backup file.
b4da00e9
RM
3941
3942If a file's name is FOO, the names of its numbered backup versions are
3943 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3944Numeric backups (rather than FOO~) will be made if value of
3945 `version-control' is not the atom `never' and either there are already
3946 numeric versions of the file being backed up, or `version-control' is
3947 non-nil.
3948We don't want excessive versions piling up, so there are variables
3949 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3950 and `kept-new-versions', which tells how many newest versions to keep.
3951 Defaults are 2 old versions and 2 new.
3952`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 3953If `delete-old-versions' is nil, system will query user
e73ec04b
RS
3954 before trimming versions. Otherwise it does it silently.
3955
749d2ee6
RS
3956If `vc-make-backup-files' is nil, which is the default,
3957 no backup files are made for files managed by version control.
3958 (This is because the version control system itself records previous versions.)
3959
e73ec04b 3960See the subroutine `basic-save-buffer' for more information."
b4da00e9
RM
3961 (interactive "p")
3962 (let ((modp (buffer-modified-p))
3963 (large (> (buffer-size) 50000))
b5a8e0fc
RS
3964 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3965 (memq args '(16 64)))))
b4da00e9 3966 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
b4990dde
GM
3967 (if (and modp large (buffer-file-name))
3968 (message "Saving file %s..." (buffer-file-name)))
b4da00e9
RM
3969 (basic-save-buffer)
3970 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3971
3972(defun delete-auto-save-file-if-necessary (&optional force)
3973 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3974Normally delete only if the file was written by this Emacs since
3975the last real save, but optional arg FORCE non-nil means delete anyway."
3976 (and buffer-auto-save-file-name delete-auto-save-files
3977 (not (string= buffer-file-name buffer-auto-save-file-name))
3978 (or force (recent-auto-save-p))
3979 (progn
3980 (condition-case ()
3981 (delete-file buffer-auto-save-file-name)
3982 (file-error nil))
3983 (set-buffer-auto-saved))))
3984
481f215b
KH
3985(defvar auto-save-hook nil
3986 "Normal hook run just before auto-saving.")
3987
3c3b81d1
SJ
3988(defcustom before-save-hook nil
3989 "Normal hook that is run before a buffer is saved to its file."
25f6295e 3990 :options '(copyright-update time-stamp)
3c3b81d1
SJ
3991 :type 'hook
3992 :group 'files)
3993
ffc0e1ca
AS
3994(defcustom after-save-hook nil
3995 "Normal hook that is run after a buffer is saved to its file."
3996 :options '(executable-make-buffer-file-executable-if-script-p)
3997 :type 'hook
3998 :group 'files)
1cc852cc 3999
0516edee
RS
4000(defvar save-buffer-coding-system nil
4001 "If non-nil, use this coding system for saving the buffer.
4002More precisely, use this coding system in place of the
4003value of `buffer-file-coding-system', when saving the buffer.
4004Calling `write-region' for any purpose other than saving the buffer
4005will still use `buffer-file-coding-system'; this variable has no effect
4006in such cases.")
4007
d5fe94cc
RS
4008(make-variable-buffer-local 'save-buffer-coding-system)
4009(put 'save-buffer-coding-system 'permanent-local t)
4010
b4da00e9 4011(defun basic-save-buffer ()
1cc852cc 4012 "Save the current buffer in its visited file, if it has been modified.
0370fe77
SM
4013The hooks `write-contents-functions' and `write-file-functions' get a chance
4014to do the job of saving; if they do not, then the buffer is saved in
222cf381 4015the visited file in the usual way.
3c3b81d1
SJ
4016Before and after saving the buffer, this function runs
4017`before-save-hook' and `after-save-hook', respectively."
b4da00e9 4018 (interactive)
19618231 4019 (save-current-buffer
c11a94fe
RS
4020 ;; In an indirect buffer, save its base buffer instead.
4021 (if (buffer-base-buffer)
4022 (set-buffer (buffer-base-buffer)))
4023 (if (buffer-modified-p)
4024 (let ((recent-save (recent-auto-save-p))
818286f4 4025 setmodes)
c11a94fe
RS
4026 ;; If buffer has no file name, ask user for one.
4027 (or buffer-file-name
182891ef
RS
4028 (let ((filename
4029 (expand-file-name
4030 (read-file-name "File to save in: ") nil)))
8400146f
MR
4031 (if (file-exists-p filename)
4032 (if (file-directory-p filename)
4033 ;; Signal an error if the user specified the name of an
4034 ;; existing directory.
4035 (error "%s is a directory" filename)
4036 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4037 filename))
4038 (error "Canceled")))
4039 ;; Signal an error if the specified name refers to a
4040 ;; non-existing directory.
4041 (let ((dir (file-name-directory filename)))
4042 (unless (file-directory-p dir)
4043 (if (file-exists-p dir)
4044 (error "%s is not a directory" dir)
4045 (error "%s: no such directory" dir)))))
182891ef 4046 (set-visited-file-name filename)))
c11a94fe
RS
4047 (or (verify-visited-file-modtime (current-buffer))
4048 (not (file-exists-p buffer-file-name))
4049 (yes-or-no-p
4050 (format "%s has changed since visited or saved. Save anyway? "
4051 (file-name-nondirectory buffer-file-name)))
4052 (error "Save not confirmed"))
4053 (save-restriction
4054 (widen)
19618231 4055 (save-excursion
0370fe77 4056 (and (> (point-max) (point-min))
407b4328 4057 (not find-file-literally)
19618231
RS
4058 (/= (char-after (1- (point-max))) ?\n)
4059 (not (and (eq selective-display t)
4060 (= (char-after (1- (point-max))) ?\r)))
4061 (or (eq require-final-newline t)
f4206092 4062 (eq require-final-newline 'visit-save)
19618231
RS
4063 (and require-final-newline
4064 (y-or-n-p
4065 (format "Buffer %s does not end in newline. Add one? "
4066 (buffer-name)))))
4067 (save-excursion
4068 (goto-char (point-max))
4069 (insert ?\n))))
fa5867f6
AS
4070 ;; Support VC version backups.
4071 (vc-before-save)
3c3b81d1 4072 (run-hooks 'before-save-hook)
0370fe77 4073 (or (run-hook-with-args-until-success 'write-contents-functions)
c11a94fe 4074 (run-hook-with-args-until-success 'local-write-file-hooks)
0370fe77 4075 (run-hook-with-args-until-success 'write-file-functions)
0ba5894b
RS
4076 ;; If a hook returned t, file is already "written".
4077 ;; Otherwise, write it the usual way now.
4078 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
4079 ;; Now we have saved the current buffer. Let's make sure
4080 ;; that buffer-file-coding-system is fixed to what
4081 ;; actually used for saving by binding it locally.
0516edee
RS
4082 (if save-buffer-coding-system
4083 (setq save-buffer-coding-system last-coding-system-used)
4084 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
4085 (setq buffer-file-number
4086 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
4087 (if setmodes
4088 (condition-case ()
f3f9e207 4089 (set-file-modes buffer-file-name (car setmodes))
c11a94fe
RS
4090 (error nil))))
4091 ;; If the auto-save file was recent before this command,
4092 ;; delete it now.
4093 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
4094 ;; Support VC `implicit' locking.
4095 (vc-after-save)
c11a94fe
RS
4096 (run-hooks 'after-save-hook))
4097 (message "(No changes need to be saved)"))))
b4da00e9 4098
87d26afc
RS
4099;; This does the "real job" of writing a buffer into its visited file
4100;; and making a backup file. This is what is normally done
0370fe77 4101;; but inhibited if one of write-file-functions returns non-nil.
f3f9e207 4102;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
87d26afc 4103(defun basic-save-buffer-1 ()
969be033
RS
4104 (prog1
4105 (if save-buffer-coding-system
4106 (let ((coding-system-for-write save-buffer-coding-system))
4107 (basic-save-buffer-2))
d5fe94cc 4108 (basic-save-buffer-2))
969be033 4109 (setq buffer-file-coding-system-explicit last-coding-system-used)))
d5fe94cc 4110
f3f9e207 4111;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
d5fe94cc
RS
4112(defun basic-save-buffer-2 ()
4113 (let (tempsetmodes setmodes)
87d26afc
RS
4114 (if (not (file-writable-p buffer-file-name))
4115 (let ((dir (file-name-directory buffer-file-name)))
4116 (if (not (file-directory-p dir))
83c6f446
RS
4117 (if (file-exists-p dir)
4118 (error "%s is not a directory" dir)
87c60260 4119 (error "%s: no such directory" dir))
87d26afc
RS
4120 (if (not (file-exists-p buffer-file-name))
4121 (error "Directory %s write-protected" dir)
4122 (if (yes-or-no-p
4123 (format "File %s is write-protected; try to save anyway? "
4124 (file-name-nondirectory
4125 buffer-file-name)))
4126 (setq tempsetmodes t)
4127 (error "Attempt to save to a file which you aren't allowed to write"))))))
4128 (or buffer-backed-up
4129 (setq setmodes (backup-buffer)))
76d5492b 4130 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
4131 (if (and file-precious-flag
4132 (file-writable-p dir))
4133 ;; If file is precious, write temp name, then rename it.
4134 ;; This requires write access to the containing dir,
4135 ;; which is why we don't try it if we don't have that access.
4136 (let ((realname buffer-file-name)
44dce0fb
RS
4137 tempname succeed
4138 (umask (default-file-modes))
6782610c 4139 (old-modtime (visited-file-modtime)))
44dce0fb
RS
4140 ;; Create temp files with strict access rights. It's easy to
4141 ;; loosen them later, whereas it's impossible to close the
4142 ;; time-window of loose permissions otherwise.
f4a0f59b 4143 (unwind-protect
44dce0fb
RS
4144 (progn
4145 (clear-visited-file-modtime)
4146 (set-default-file-modes ?\700)
4147 ;; Try various temporary names.
4148 ;; This code follows the example of make-temp-file,
4149 ;; but it calls write-region in the appropriate way
4150 ;; for saving the buffer.
4151 (while (condition-case ()
4152 (progn
4153 (setq tempname
4154 (make-temp-name
4155 (expand-file-name "tmp" dir)))
6b3d752c
SM
4156 ;; Pass in nil&nil rather than point-min&max
4157 ;; cause we're saving the whole buffer.
4158 ;; write-region-annotate-functions may use it.
4159 (write-region nil nil
44dce0fb
RS
4160 tempname nil realname
4161 buffer-file-truename 'excl)
4162 nil)
4163 (file-already-exists t))
4164 ;; The file was somehow created by someone else between
4165 ;; `make-temp-name' and `write-region', let's try again.
4166 nil)
4167 (setq succeed t))
4168 ;; Reset the umask.
4169 (set-default-file-modes umask)
4170 ;; If we failed, restore the buffer's modtime.
4171 (unless succeed
4172 (set-visited-file-modtime old-modtime)))
4173 ;; Since we have created an entirely new file,
4174 ;; make sure it gets the right permission bits set.
730df8db 4175 (setq setmodes (or setmodes
562ca538
RS
4176 (cons (or (file-modes buffer-file-name)
4177 (logand ?\666 umask))
730df8db 4178 buffer-file-name)))
f4a0f59b
RS
4179 ;; We succeeded in writing the temp file,
4180 ;; so rename it.
4181 (rename-file tempname buffer-file-name t))
4182 ;; If file not writable, see if we can make it writable
4183 ;; temporarily while we write it.
4184 ;; But no need to do so if we have just backed it up
4185 ;; (setmodes is set) because that says we're superseding.
4186 (cond ((and tempsetmodes (not setmodes))
4187 ;; Change the mode back, after writing.
f3f9e207
RS
4188 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
4189 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
4190 (let (success)
4191 (unwind-protect
4192 (progn
6b3d752c
SM
4193 ;; Pass in nil&nil rather than point-min&max to indicate
4194 ;; we're saving the buffer rather than just a region.
4195 ;; write-region-annotate-functions may make us of it.
4196 (write-region nil nil
f3f9e207
RS
4197 buffer-file-name nil t buffer-file-truename)
4198 (setq success t))
4199 ;; If we get an error writing the new file, and we made
4200 ;; the backup by renaming, undo the backing-up.
4201 (and setmodes (not success)
0133dab9
EZ
4202 (progn
4203 (rename-file (cdr setmodes) buffer-file-name t)
4204 (setq buffer-backed-up nil)))))))
87d26afc
RS
4205 setmodes))
4206
1eeae2a1
RS
4207(defun diff-buffer-with-file (&optional buffer)
4208 "View the differences between BUFFER and its associated file.
0b9e4749 4209This requires the external program `diff' to be in your `exec-path'."
1eeae2a1 4210 (interactive "bBuffer: ")
0b9e4749 4211 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4e4e9519
MR
4212 (if (and buffer-file-name
4213 (file-exists-p buffer-file-name))
4214 (let ((tempfile (make-temp-file "buffer-content-")))
4215 (unwind-protect
ab1d3835
SM
4216 (progn
4217 (write-region nil nil tempfile nil 'nomessage)
4e4e9519
MR
4218 (diff buffer-file-name tempfile nil t)
4219 (sit-for 0))
4220 (when (file-exists-p tempfile)
4221 (delete-file tempfile))))
4222 (message "Buffer %s has no associated file on disc" (buffer-name))
4223 ;; Display that message for 1 second so that user can read it
4224 ;; in the minibuffer.
4225 (sit-for 1)))
4226 ;; return always nil, so that save-buffers-kill-emacs will not move
4227 ;; over to the next unsaved buffer when calling `d'.
4228 nil)
1eeae2a1
RS
4229
4230(defvar save-some-buffers-action-alist
9b106871
SM
4231 `((?\C-r
4232 ,(lambda (buf)
4233 (if (not enable-recursive-minibuffers)
4234 (progn (display-buffer buf)
4235 (setq other-window-scroll-buffer buf))
4236 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4237 (recursive-edit))
4238 ;; Return nil to ask about BUF again.
4239 nil)
5c471b12 4240 "view this buffer")
9b106871
SM
4241 (?d ,(lambda (buf)
4242 (if (null buffer-file-name)
4243 (message "Not applicable: no file")
4244 (save-window-excursion (diff-buffer-with-file buf))
4245 (if (not enable-recursive-minibuffers)
4246 (progn (display-buffer (get-buffer-create "*Diff*"))
4247 (setq other-window-scroll-buffer "*Diff*"))
4248 (view-buffer (get-buffer-create "*Diff*")
4249 (lambda (_) (exit-recursive-edit)))
4250 (recursive-edit)))
4251 ;; Return nil to ask about BUF again.
4252 nil)
5c471b12 4253 "view changes in this buffer"))
1eeae2a1 4254 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
1eeae2a1 4255
a1b0c2a7
RS
4256(defvar buffer-save-without-query nil
4257 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4258(make-variable-buffer-local 'buffer-save-without-query)
4259
ffc0e1ca 4260(defun save-some-buffers (&optional arg pred)
b4da00e9 4261 "Save some modified file-visiting buffers. Asks user about each one.
1eeae2a1
RS
4262You can answer `y' to save, `n' not to save, `C-r' to look at the
4263buffer in question with `view-buffer' before deciding or `d' to
126c9dda 4264view the differences using `diff-buffer-with-file'.
8fd9c174 4265
5bbbceb1 4266Optional argument (the prefix) non-nil means save all with no questions.
ffc0e1ca
AS
4267Optional second argument PRED determines which buffers are considered:
4268If PRED is nil, all the file-visiting buffers are considered.
4269If PRED is t, then certain non-file buffers will also be considered.
4270If PRED is a zero-argument function, it indicates for each buffer whether
1eeae2a1
RS
4271to consider it or not when called with that buffer current.
4272
4273See `save-some-buffers-action-alist' if you want to
4274change the additional actions you can take on files."
b4da00e9 4275 (interactive "P")
907482b9 4276 (save-window-excursion
a1b0c2a7
RS
4277 (let* (queried some-automatic
4278 files-done abbrevs-done)
4279 (dolist (buffer (buffer-list))
4280 ;; First save any buffers that we're supposed to save unconditionally.
4281 ;; That way the following code won't ask about them.
4282 (with-current-buffer buffer
4283 (when (and buffer-save-without-query (buffer-modified-p))
4284 (setq some-automatic t)
4285 (save-buffer))))
4286 ;; Ask about those buffers that merit it,
4287 ;; and record the number thus saved.
4288 (setq files-done
76d5492b 4289 (map-y-or-n-p
9b106871
SM
4290 (lambda (buffer)
4291 (and (buffer-modified-p buffer)
4292 (not (buffer-base-buffer buffer))
4293 (or
4294 (buffer-file-name buffer)
4295 (and pred
4296 (progn
4297 (set-buffer buffer)
4298 (and buffer-offer-save (> (buffer-size) 0)))))
4299 (or (not (functionp pred))
4300 (with-current-buffer buffer (funcall pred)))
4301 (if arg
4302 t
4303 (setq queried t)
4304 (if (buffer-file-name buffer)
4305 (format "Save file %s? "
4306 (buffer-file-name buffer))
4307 (format "Save buffer %s? "
4308 (buffer-name buffer))))))
4309 (lambda (buffer)
4310 (with-current-buffer buffer
4311 (save-buffer)))
4312 (buffer-list)
76d5492b 4313 '("buffer" "buffers" "save")
1eeae2a1 4314 save-some-buffers-action-alist))
bf247b6e 4315 ;; Maybe to save abbrevs, and record whether
a1b0c2a7
RS
4316 ;; we either saved them or asked to.
4317 (and save-abbrevs abbrevs-changed
4318 (progn
4319 (if (or arg
4320 (eq save-abbrevs 'silently)
4321 (y-or-n-p (format "Save abbrevs in %s? "
4322 abbrev-file-name)))
4323 (write-abbrev-file nil))
4324 ;; Don't keep bothering user if he says no.
4325 (setq abbrevs-changed nil)
4326 (setq abbrevs-done t)))
76d5492b 4327 (or queried (> files-done 0) abbrevs-done
a1b0c2a7
RS
4328 (message (if some-automatic
4329 "(Some special files were saved without asking)"
4330 "(No files need saving)"))))))
b4da00e9
RM
4331\f
4332(defun not-modified (&optional arg)
4333 "Mark current buffer as unmodified, not needing to be saved.
8fc29035 4334With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
a641f9a1
RM
4335
4336It is not a good idea to use this function in Lisp programs, because it
4337prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
4338 (interactive "P")
4339 (message (if arg "Modification-flag set"
4340 "Modification-flag cleared"))
4341 (set-buffer-modified-p arg))
4342
4343(defun toggle-read-only (&optional arg)
4344 "Change whether this buffer is visiting its file read-only.
4837b516
GM
4345With prefix argument ARG, make the buffer read-only if ARG is
4346positive, otherwise make it writable. If visiting file read-only
4347and `view-read-only' is non-nil, enter view mode."
b4da00e9 4348 (interactive "P")
c60ee5e7 4349 (if (and arg
d758359d
AS
4350 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4351 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4352 nil ; do nothing.
4353 ;; Toggle.
4354 (cond
4355 ((and buffer-read-only view-mode)
4356 (View-exit-and-edit)
4357 (make-local-variable 'view-read-only)
4358 (setq view-read-only t)) ; Must leave view mode.
4359 ((and (not buffer-read-only) view-read-only
818286f4
SM
4360 ;; If view-mode is already active, `view-mode-enter' is a nop.
4361 (not view-mode)
d758359d
AS
4362 (not (eq (get major-mode 'mode-class) 'special)))
4363 (view-mode-enter))
4364 (t (setq buffer-read-only (not buffer-read-only))
4365 (force-mode-line-update)))
4366 (if (vc-backend buffer-file-name)
8a26c165 4367 (message "%s" (substitute-command-keys
a5dd5f60
RS
4368 (concat "File is under version-control; "
4369 "use \\[vc-next-action] to check in/out"))))))
b4da00e9 4370
912192d1 4371(defun insert-file (filename)
b4da00e9
RM
4372 "Insert contents of file FILENAME into buffer after point.
4373Set mark after the inserted text.
4374
4375This function is meant for the user to run interactively.
4376Don't call it from programs! Use `insert-file-contents' instead.
4377\(Its calling sequence is different; see its documentation)."
912192d1 4378 (interactive "*fInsert file: ")
3a64a3cf 4379 (insert-file-1 filename #'insert-file-contents))
b4da00e9 4380
912192d1 4381(defun append-to-file (start end filename)
b4da00e9
RM
4382 "Append the contents of the region to the end of file FILENAME.
4383When called from a function, expects three arguments,
4384START, END and FILENAME. START and END are buffer positions
da30bf98 4385saying what text to write."
912192d1
KH
4386 (interactive "r\nFAppend to file: ")
4387 (write-region start end filename t))
b4da00e9
RM
4388
4389(defun file-newest-backup (filename)
4390 "Return most recent backup file for FILENAME or nil if no backups exist."
ffc0e1ca
AS
4391 ;; `make-backup-file-name' will get us the right directory for
4392 ;; ordinary or numeric backups. It might create a directory for
4393 ;; backups as a side-effect, according to `backup-directory-alist'.
e31cfca5 4394 (let* ((filename (file-name-sans-versions
783bf210 4395 (make-backup-file-name (expand-file-name filename))))
b4da00e9
RM
4396 (file (file-name-nondirectory filename))
4397 (dir (file-name-directory filename))
4398 (comp (file-name-all-completions file dir))
cf7e94a0
RS
4399 (newest nil)
4400 tem)
b4da00e9 4401 (while comp
ffc0e1ca 4402 (setq tem (pop comp))
cf7e94a0
RS
4403 (cond ((and (backup-file-name-p tem)
4404 (string= (file-name-sans-versions tem) file))
4405 (setq tem (concat dir tem))
4406 (if (or (null newest)
4407 (file-newer-than-file-p tem newest))
4408 (setq newest tem)))))
b4da00e9
RM
4409 newest))
4410
4411(defun rename-uniquely ()
4412 "Rename current buffer to a similar name not already taken.
4413This function is useful for creating multiple shell process buffers
4414or multiple mail buffers, etc."
4415 (interactive)
40eb8038 4416 (save-match-data
e0df3aef
KH
4417 (let ((base-name (buffer-name)))
4418 (and (string-match "<[0-9]+>\\'" base-name)
4419 (not (and buffer-file-name
4420 (string= base-name
4421 (file-name-nondirectory buffer-file-name))))
4422 ;; If the existing buffer name has a <NNN>,
4423 ;; which isn't part of the file name (if any),
4424 ;; then get rid of that.
4425 (setq base-name (substring base-name 0 (match-beginning 0))))
4426 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 4427 (force-mode-line-update))))
5bbbceb1 4428
4e43240a 4429(defun make-directory (dir &optional parents)
5ce8bb89 4430 "Create the directory DIR and any nonexistent parent dirs.
ae0ece90 4431If DIR already exists as a directory, signal an error, unless PARENTS is set.
789cb0f9 4432
5ce8bb89
RS
4433Interactively, the default choice of directory to create
4434is the current default directory for file names.
0225ae5e 4435That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
4436
4437Noninteractively, the second (optional) argument PARENTS says whether
07703430
RS
4438to create parent directories if they don't exist. Interactively,
4439this happens by default."
5ce8bb89
RS
4440 (interactive
4441 (list (read-file-name "Make directory: " default-directory default-directory
4442 nil nil)
4443 t))
ee291b46
RS
4444 ;; If default-directory is a remote directory,
4445 ;; make sure we find its make-directory handler.
4446 (setq dir (expand-file-name dir))
6eaebaa2 4447 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
4448 (if handler
4449 (funcall handler 'make-directory dir parents)
4450 (if (not parents)
4451 (make-directory-internal dir)
4452 (let ((dir (directory-file-name (expand-file-name dir)))
4453 create-list)
4454 (while (not (file-exists-p dir))
76d5492b 4455 (setq create-list (cons dir create-list)
4e43240a
RS
4456 dir (directory-file-name (file-name-directory dir))))
4457 (while create-list
4458 (make-directory-internal (car create-list))
4459 (setq create-list (cdr create-list))))))))
b4da00e9
RM
4460\f
4461(put 'revert-buffer-function 'permanent-local t)
4462(defvar revert-buffer-function nil
0973d78b
RS
4463 "Function to use to revert this buffer, or nil to do the default.
4464The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4465which are the arguments that `revert-buffer' received.")
b4da00e9
RM
4466
4467(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4468(defvar revert-buffer-insert-file-contents-function nil
4469 "Function to use to insert contents when reverting this buffer.
4470Gets two args, first the nominal file name to use,
2df32500
RS
4471and second, t if reading the auto-save file.
4472
4473The function you specify is responsible for updating (or preserving) point.")
b4da00e9 4474
b0dc9757
LT
4475(defvar buffer-stale-function nil
4476 "Function to check whether a non-file buffer needs reverting.
4477This should be a function with one optional argument NOCONFIRM.
44dce0fb 4478Auto Revert Mode passes t for NOCONFIRM. The function should return
8b0b6932
LT
4479non-nil if the buffer should be reverted. A return value of
4480`fast' means that the need for reverting was not checked, but
4481that reverting the buffer is fast. The buffer is current when
4482this function is called.
b0dc9757 4483
4f8453ae
LT
4484The idea behind the NOCONFIRM argument is that it should be
4485non-nil if the buffer is going to be reverted without asking the
4486user. In such situations, one has to be careful with potentially
c90dcdd5
LT
4487time consuming operations.
4488
4489For more information on how this variable is used by Auto Revert mode,
b3a59350 4490see Info node `(emacs)Supporting additional buffers'.")
b0dc9757 4491
5f76e7d4
KH
4492(defvar before-revert-hook nil
4493 "Normal hook for `revert-buffer' to run before reverting.
4494If `revert-buffer-function' is used to override the normal revert
4495mechanism, this hook is not used.")
4496
4497(defvar after-revert-hook nil
4498 "Normal hook for `revert-buffer' to run after reverting.
4499Note that the hook value that it runs is the value that was in effect
4500before reverting; that makes a difference if you have buffer-local
4501hook functions.
4502
4503If `revert-buffer-function' is used to override the normal revert
4504mechanism, this hook is not used.")
4505
1554c03b
RS
4506(defvar revert-buffer-internal-hook)
4507
9a30563f 4508(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 4509 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 4510This undoes all changes since the file was visited or saved.
8c0e7b73
JB
4511With a prefix argument, offer to revert from latest auto-save file, if
4512that is more recent than the visited file.
1ab31687 4513
0dff8975
VJL
4514This command also implements an interface for special buffers
4515that contain text which doesn't come from a file, but reflects
4516some other data instead (e.g. Dired buffers, `buffer-list'
8fc29035
JB
4517buffers). This is done via the variable `revert-buffer-function'.
4518In these cases, it should reconstruct the buffer contents from the
4519appropriate data.
7e7c9c4e 4520
65ee6096 4521When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
4522to revert from the auto-save file when this is nil. Note that the
4523sense of this argument is the reverse of the prefix argument, for the
4524sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4525to nil.
4526
8fc29035
JB
4527Optional second argument NOCONFIRM means don't ask for confirmation
4528at all. \(The variable `revert-without-query' offers another way to
518dc5be 4529revert buffers without querying for confirmation.)
b4da00e9 4530
5b2b26d5
RS
4531Optional third argument PRESERVE-MODES non-nil means don't alter
4532the files modes. Normally we reinitialize them using `normal-mode'.
4533
8c0e7b73 4534If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
4535do all the work for this command. Otherwise, the hooks
4536`before-revert-hook' and `after-revert-hook' are run at the beginning
4537and the end, and if `revert-buffer-insert-file-contents-function' is
4538non-nil, it is called instead of rereading visited file contents."
fb6208a6 4539
1ab31687
JB
4540 ;; I admit it's odd to reverse the sense of the prefix argument, but
4541 ;; there is a lot of code out there which assumes that the first
4542 ;; argument should be t to avoid consulting the auto-save file, and
4543 ;; there's no straightforward way to encourage authors to notice a
4544 ;; reversal of the argument sense. So I'm just changing the user
4545 ;; interface, but leaving the programmatic interface the same.
e0867e99 4546 (interactive (list (not current-prefix-arg)))
b4da00e9 4547 (if revert-buffer-function
1ab31687 4548 (funcall revert-buffer-function ignore-auto noconfirm)
44dce0fb
RS
4549 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4550 (current-buffer))
4551 (let* ((auto-save-p (and (not ignore-auto)
4552 (recent-auto-save-p)
4553 buffer-auto-save-file-name
4554 (file-readable-p buffer-auto-save-file-name)
4555 (y-or-n-p
4556 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4557 (file-name (if auto-save-p
4558 buffer-auto-save-file-name
4559 buffer-file-name)))
4560 (cond ((null file-name)
4561 (error "Buffer does not seem to be associated with any file"))
4562 ((or noconfirm
4563 (and (not (buffer-modified-p))
518dc5be
EZ
4564 (catch 'found
4565 (dolist (regexp revert-without-query)
4566 (when (string-match regexp file-name)
4567 (throw 'found t)))))
44dce0fb
RS
4568 (yes-or-no-p (format "Revert buffer from file %s? "
4569 file-name)))
4570 (run-hooks 'before-revert-hook)
4571 ;; If file was backed up but has changed since,
4572 ;; we shd make another backup.
4573 (and (not auto-save-p)
4574 (not (verify-visited-file-modtime (current-buffer)))
4575 (setq buffer-backed-up nil))
44dce0fb
RS
4576 ;; Effectively copy the after-revert-hook status,
4577 ;; since after-find-file will clobber it.
4578 (let ((global-hook (default-value 'after-revert-hook))
518dc5be
EZ
4579 (local-hook (when (local-variable-p 'after-revert-hook)
4580 after-revert-hook))
4581 (inhibit-read-only t))
4582 (cond
4583 (revert-buffer-insert-file-contents-function
4584 (unless (eq buffer-undo-list t)
4585 ;; Get rid of all undo records for this buffer.
4586 (setq buffer-undo-list nil))
4587 ;; Don't make undo records for the reversion.
4588 (let ((buffer-undo-list t))
4589 (funcall revert-buffer-insert-file-contents-function
4590 file-name auto-save-p)))
4591 ((not (file-exists-p file-name))
4592 (error (if buffer-file-number
4593 "File %s no longer exists!"
4594 "Cannot revert nonexistent file %s")
4595 file-name))
b2d239c1
RS
4596 ((not (file-readable-p file-name))
4597 (error (if buffer-file-number
4598 "File %s no longer readable!"
4599 "Cannot revert unreadable file %s")
4600 file-name))
518dc5be
EZ
4601 (t
4602 ;; Bind buffer-file-name to nil
4603 ;; so that we don't try to lock the file.
4604 (let ((buffer-file-name nil))
4605 (or auto-save-p
4606 (unlock-buffer)))
4607 (widen)
4608 (let ((coding-system-for-read
4609 ;; Auto-saved file should be read by Emacs'
4610 ;; internal coding.
4611 (if auto-save-p 'auto-save-coding
4612 (or coding-system-for-read
4613 buffer-file-coding-system-explicit))))
e1ee3b54 4614 (if (and (not enable-multibyte-characters)
52f9b751 4615 coding-system-for-read
e1ee3b54
KH
4616 (not (memq (coding-system-base
4617 coding-system-for-read)
4618 '(no-conversion raw-text))))
4619 ;; As a coding system suitable for multibyte
4620 ;; buffer is specified, make the current
4621 ;; buffer multibyte.
4622 (set-buffer-multibyte t))
4623
518dc5be
EZ
4624 ;; This force after-insert-file-set-coding
4625 ;; (called from insert-file-contents) to set
4626 ;; buffer-file-coding-system to a proper value.
4627 (kill-local-variable 'buffer-file-coding-system)
4628
4629 ;; Note that this preserves point in an intelligent way.
4630 (if preserve-modes
4631 (let ((buffer-file-format buffer-file-format))
4632 (insert-file-contents file-name (not auto-save-p)
4633 nil nil t))
4634 (insert-file-contents file-name (not auto-save-p)
2a29c409 4635 nil nil t)))))
44dce0fb
RS
4636 ;; Recompute the truename in case changes in symlinks
4637 ;; have changed the truename.
4638 (setq buffer-file-truename
4639 (abbreviate-file-name (file-truename buffer-file-name)))
4640 (after-find-file nil nil t t preserve-modes)
4641 ;; Run after-revert-hook as it was before we reverted.
4642 (setq-default revert-buffer-internal-hook global-hook)
518dc5be 4643 (if local-hook
44dce0fb
RS
4644 (set (make-local-variable 'revert-buffer-internal-hook)
4645 local-hook)
4646 (kill-local-variable 'revert-buffer-internal-hook))
4647 (run-hooks 'revert-buffer-internal-hook))
4648 t))))))
b4da00e9 4649
64d18e8f
RS
4650(defun recover-this-file ()
4651 "Recover the visited file--get contents from its last auto-save file."
4652 (interactive)
4653 (recover-file buffer-file-name))
4654
b4da00e9
RM
4655(defun recover-file (file)
4656 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
4657 ;; Actually putting the file name in the minibuffer should be used
4658 ;; only rarely.
4659 ;; Not just because users often use the default.
e1dadc17 4660 (interactive "FRecover file: ")
b4da00e9 4661 (setq file (expand-file-name file))
f7da6740 4662 (if (auto-save-file-name-p (file-name-nondirectory file))
4e163715 4663 (error "%s is an auto-save file" (abbreviate-file-name file)))
b4da00e9
RM
4664 (let ((file-name (let ((buffer-file-name file))
4665 (make-auto-save-file-name))))
945e1965
RS
4666 (cond ((if (file-exists-p file)
4667 (not (file-newer-than-file-p file-name file))
4668 (not (file-exists-p file-name)))
4e163715
SM
4669 (error "Auto-save file %s not current"
4670 (abbreviate-file-name file-name)))
b4da00e9 4671 ((save-window-excursion
ffc0e1ca
AS
4672 (with-output-to-temp-buffer "*Directory*"
4673 (buffer-disable-undo standard-output)
4674 (save-excursion
4675 (let ((switches dired-listing-switches))
4676 (if (file-symlink-p file)
4677 (setq switches (concat switches "L")))
4678 (set-buffer standard-output)
bc22fd18
EZ
4679 ;; Use insert-directory-safely, not insert-directory,
4680 ;; because these files might not exist. In particular,
4681 ;; FILE might not exist if the auto-save file was for
4682 ;; a buffer that didn't visit a file, such as "*mail*".
4683 ;; The code in v20.x called `ls' directly, so we need
4684 ;; to emulate what `ls' did in that case.
4685 (insert-directory-safely file switches)
4686 (insert-directory-safely file-name switches))))
b4da00e9
RM
4687 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4688 (switch-to-buffer (find-file-noselect file t))
518dc5be 4689 (let ((inhibit-read-only t)
1e87edf5
KH
4690 ;; Keep the current buffer-file-coding-system.
4691 (coding-system buffer-file-coding-system)
1d0ec0d1 4692 ;; Auto-saved file should be read with special coding.
77619f8e 4693 (coding-system-for-read 'auto-save-coding))
b4da00e9 4694 (erase-buffer)
1e87edf5
KH
4695 (insert-file-contents file-name nil)
4696 (set-buffer-file-coding-system coding-system))
8cfb9d46 4697 (after-find-file nil nil t))
ffa7ab70 4698 (t (error "Recover-file cancelled")))))
b4da00e9 4699
6598027d 4700(defun recover-session ()
9aee5392
RS
4701 "Recover auto save files from a previous Emacs session.
4702This command first displays a Dired buffer showing you the
4703previous sessions that you could recover from.
4704To choose one, move point to the proper line and then type C-c C-c.
4705Then you'll be asked about a number of files to recover."
4706 (interactive)
363a5030
RS
4707 (if (null auto-save-list-file-prefix)
4708 (error "You set `auto-save-list-file-prefix' to disable making session files"))
ffc0e1ca
AS
4709 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4710 (unless (file-directory-p dir)
194600a8
JPW
4711 (make-directory dir t))
4712 (unless (directory-files dir nil
4713 (concat "\\`" (regexp-quote
4714 (file-name-nondirectory
4715 auto-save-list-file-prefix)))
4716 t)
4717 (error "No previous sessions to recover")))
6f4983e6 4718 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
4719 (dired (concat auto-save-list-file-prefix "*")
4720 (concat dired-listing-switches "t")))
05e076c7
AS
4721 (save-excursion
4722 (goto-char (point-min))
4723 (or (looking-at " Move to the session you want to recover,")
4724 (let ((inhibit-read-only t))
4725 ;; Each line starts with a space
4726 ;; so that Font Lock mode won't highlight the first character.
4727 (insert " Move to the session you want to recover,\n"
4728 " then type C-c C-c to select it.\n\n"
4729 " You can also delete some of these files;\n"
4730 " type d on a line to mark that file for deletion.\n\n"))))
9aee5392 4731 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 4732 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 4733
80280bb7 4734(defun recover-session-finish ()
9aee5392
RS
4735 "Choose one saved session to recover auto-save files from.
4736This command is used in the special Dired buffer created by
80280bb7 4737\\[recover-session]."
9aee5392
RS
4738 (interactive)
4739 ;; Get the name of the session file to recover from.
4740 (let ((file (dired-get-filename))
953a03b2 4741 files
9aee5392 4742 (buffer (get-buffer-create " *recover*")))
c11032b9 4743 (dired-unmark 1)
033ef863 4744 (dired-do-flagged-delete t)
9aee5392
RS
4745 (unwind-protect
4746 (save-excursion
4747 ;; Read in the auto-save-list file.
4748 (set-buffer buffer)
4749 (erase-buffer)
4750 (insert-file-contents file)
953a03b2
RS
4751 ;; Loop thru the text of that file
4752 ;; and get out the names of the files to recover.
4753 (while (not (eobp))
4754 (let (thisfile autofile)
4755 (if (eolp)
4756 ;; This is a pair of lines for a non-file-visiting buffer.
4757 ;; Get the auto-save file name and manufacture
4758 ;; a "visited file name" from that.
4759 (progn
4760 (forward-line 1)
259be4e6
JB
4761 ;; If there is no auto-save file name, the
4762 ;; auto-save-list file is probably corrupted.
4763 (unless (eolp)
4764 (setq autofile
4765 (buffer-substring-no-properties
4766 (point)
e442c62b 4767 (line-end-position)))
259be4e6
JB
4768 (setq thisfile
4769 (expand-file-name
4770 (substring
4771 (file-name-nondirectory autofile)
4772 1 -1)
4773 (file-name-directory autofile))))
953a03b2
RS
4774 (forward-line 1))
4775 ;; This pair of lines is a file-visiting
4776 ;; buffer. Use the visited file name.
4777 (progn
4778 (setq thisfile
4779 (buffer-substring-no-properties
4780 (point) (progn (end-of-line) (point))))
4781 (forward-line 1)
4782 (setq autofile
4783 (buffer-substring-no-properties
4784 (point) (progn (end-of-line) (point))))
4785 (forward-line 1)))
4786 ;; Ignore a file if its auto-save file does not exist now.
259be4e6 4787 (if (and autofile (file-exists-p autofile))
953a03b2
RS
4788 (setq files (cons thisfile files)))))
4789 (setq files (nreverse files))
945e1965
RS
4790 ;; The file contains a pair of line for each auto-saved buffer.
4791 ;; The first line of the pair contains the visited file name
4792 ;; or is empty if the buffer was not visiting a file.
4793 ;; The second line is the auto-save file name.
953a03b2
RS
4794 (if files
4795 (map-y-or-n-p "Recover %s? "
4796 (lambda (file)
4797 (condition-case nil
4798 (save-excursion (recover-file file))
76d5492b 4799 (error
953a03b2
RS
4800 "Failed to recover `%s'" file)))
4801 files
4802 '("file" "files" "recover"))
4803 (message "No files can be recovered from this session now")))
9aee5392
RS
4804 (kill-buffer buffer))))
4805
a151f82c 4806(defun kill-buffer-ask (buffer)
8fc29035 4807 "Kill BUFFER if confirmed."
a151f82c
SS
4808 (when (yes-or-no-p
4809 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4810 (if (buffer-modified-p buffer)
4811 "HAS BEEN EDITED" "is unmodified")))
4812 (kill-buffer buffer)))
4813
73ba610a 4814(defun kill-some-buffers (&optional list)
243a3ae0 4815 "Kill some buffers. Asks the user whether to kill each one of them.
bb8eaf67 4816Non-interactively, if optional argument LIST is non-nil, it
243a3ae0 4817specifies the list of buffers to kill, asking for approval for each one."
b4da00e9 4818 (interactive)
73ba610a
RS
4819 (if (null list)
4820 (setq list (buffer-list)))
4821 (while list
4822 (let* ((buffer (car list))
4823 (name (buffer-name buffer)))
cbca0a4b
RS
4824 (and name ; Can be nil for an indirect buffer
4825 ; if we killed the base buffer.
4826 (not (string-equal name ""))
26b9ecbc 4827 (/= (aref name 0) ?\s)
a151f82c 4828 (kill-buffer-ask buffer)))
73ba610a 4829 (setq list (cdr list))))
a151f82c
SS
4830
4831(defun kill-matching-buffers (regexp &optional internal-too)
8fc29035 4832 "Kill buffers whose name matches the specified REGEXP.
a151f82c
SS
4833The optional second argument indicates whether to kill internal buffers too."
4834 (interactive "sKill buffers matching this regular expression: \nP")
4835 (dolist (buffer (buffer-list))
4836 (let ((name (buffer-name buffer)))
4837 (when (and name (not (string-equal name ""))
4838 (or internal-too (/= (aref name 0) ?\s))
4839 (string-match regexp name))
4840 (kill-buffer-ask buffer)))))
4841
b4da00e9
RM
4842\f
4843(defun auto-save-mode (arg)
4844 "Toggle auto-saving of contents of current buffer.
f3e23606 4845With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
4846 (interactive "P")
4847 (setq buffer-auto-save-file-name
4848 (and (if (null arg)
74b9c2af 4849 (or (not buffer-auto-save-file-name)
4e0c8650 4850 ;; If auto-save is off because buffer has shrunk,
74b9c2af
RS
4851 ;; then toggling should turn it on.
4852 (< buffer-saved-size 0))
b4da00e9
RM
4853 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4854 (if (and buffer-file-name auto-save-visited-file-name
4855 (not buffer-read-only))
4856 buffer-file-name
4857 (make-auto-save-file-name))))
0b7f1ef2
RS
4858 ;; If -1 was stored here, to temporarily turn off saving,
4859 ;; turn it back on.
4860 (and (< buffer-saved-size 0)
4861 (setq buffer-saved-size 0))
b4da00e9
RM
4862 (if (interactive-p)
4863 (message "Auto-save %s (in this buffer)"
4864 (if buffer-auto-save-file-name "on" "off")))
4865 buffer-auto-save-file-name)
4866
4867(defun rename-auto-save-file ()
4868 "Adjust current buffer's auto save file name for current conditions.
4869Also rename any existing auto save file, if it was made in this session."
4870 (let ((osave buffer-auto-save-file-name))
4871 (setq buffer-auto-save-file-name
4872 (make-auto-save-file-name))
4873 (if (and osave buffer-auto-save-file-name
4874 (not (string= buffer-auto-save-file-name buffer-file-name))
4875 (not (string= buffer-auto-save-file-name osave))
4876 (file-exists-p osave)
4877 (recent-auto-save-p))
4878 (rename-file osave buffer-auto-save-file-name t))))
4879
4880(defun make-auto-save-file-name ()
4881 "Return file name to use for auto-saves of current buffer.
4882Does not consider `auto-save-visited-file-name' as that variable is checked
4883before calling this function. You can redefine this for customization.
4884See also `auto-save-file-name-p'."
4885 (if buffer-file-name
c1105d05
MA
4886 (let ((handler (find-file-name-handler buffer-file-name
4887 'make-auto-save-file-name)))
4888 (if handler
4889 (funcall handler 'make-auto-save-file-name)
4890 (let ((list auto-save-file-name-transforms)
4891 (filename buffer-file-name)
4892 result uniq)
4893 ;; Apply user-specified translations
4894 ;; to the file name.
4895 (while (and list (not result))
4896 (if (string-match (car (car list)) filename)
4897 (setq result (replace-match (cadr (car list)) t nil
4898 filename)
4899 uniq (car (cddr (car list)))))
4900 (setq list (cdr list)))
4901 (if result
4902 (if uniq
4903 (setq filename (concat
4904 (file-name-directory result)
4905 (subst-char-in-string
4906 ?/ ?!
4907 (replace-regexp-in-string "!" "!!"
4908 filename))))
4909 (setq filename result)))
4910 (setq result
4911 (if (and (eq system-type 'ms-dos)
4912 (not (msdos-long-file-names)))
4913 ;; We truncate the file name to DOS 8+3 limits
4914 ;; before doing anything else, because the regexp
4915 ;; passed to string-match below cannot handle
4916 ;; extensions longer than 3 characters, multiple
4917 ;; dots, and other atrocities.
4918 (let ((fn (dos-8+3-filename
4919 (file-name-nondirectory buffer-file-name))))
4920 (string-match
4921 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4922 fn)
4923 (concat (file-name-directory buffer-file-name)
4924 "#" (match-string 1 fn)
4925 "." (match-string 3 fn) "#"))
4926 (concat (file-name-directory filename)
4927 "#"
4928 (file-name-nondirectory filename)
4929 "#")))
4930 ;; Make sure auto-save file names don't contain characters
4931 ;; invalid for the underlying filesystem.
18b28ef1 4932 (if (and (memq system-type '(ms-dos windows-nt cygwin))
c1105d05
MA
4933 ;; Don't modify remote (ange-ftp) filenames
4934 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4935 (convert-standard-filename result)
4936 result))))
0a1763b4
RS
4937
4938 ;; Deal with buffers that don't have any associated files. (Mail
4939 ;; mode tends to create a good number of these.)
4940
7d483e8c 4941 (let ((buffer-name (buffer-name))
ff5c7181 4942 (limit 0)
77d18896 4943 file-name)
ad80c679
JR
4944 ;; Restrict the characters used in the file name to those which
4945 ;; are known to be safe on all filesystems, url-encoding the
4946 ;; rest.
4947 ;; We do this on all platforms, because even if we are not
4948 ;; running on DOS/Windows, the current directory may be on a
4949 ;; mounted VFAT filesystem, such as a USB memory stick.
4950 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
c3348e10
RS
4951 (let* ((character (aref buffer-name (match-beginning 0)))
4952 (replacement
ad80c679
JR
4953 ;; For multibyte characters, this will produce more than
4954 ;; 2 hex digits, so is not true URL encoding.
4955 (format "%%%02X" character)))
c3348e10
RS
4956 (setq buffer-name (replace-match replacement t t buffer-name))
4957 (setq limit (1+ (match-end 0)))))
a8abaf83 4958 ;; Generate the file name.
ff5c7181
RS
4959 (setq file-name
4960 (make-temp-file
4961 (let ((fname
4962 (expand-file-name
4963 (format "#%s#" buffer-name)
4964 ;; Try a few alternative directories, to get one we can
4965 ;; write it.
4966 (cond
4967 ((file-writable-p default-directory) default-directory)
4968 ((file-writable-p "/var/tmp/") "/var/tmp/")
4969 ("~/")))))
18b28ef1 4970 (if (and (memq system-type '(ms-dos windows-nt cygwin))
ff5c7181
RS
4971 ;; Don't modify remote (ange-ftp) filenames
4972 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4973 ;; The call to convert-standard-filename is in case
4974 ;; buffer-name includes characters not allowed by the
4975 ;; DOS/Windows filesystems. make-temp-file writes to the
4976 ;; file it creates, so we must fix the file name _before_
4977 ;; make-temp-file is called.
4978 (convert-standard-filename fname)
4979 fname))
4980 nil "#"))
4981 ;; make-temp-file creates the file,
4982 ;; but we don't want it to exist until we do an auto-save.
4983 (condition-case ()
4984 (delete-file file-name)
4985 (file-error nil))
4986 file-name)))
b4da00e9
RM
4987
4988(defun auto-save-file-name-p (filename)
4989 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4990FILENAME should lack slashes. You can redefine this for customization."
4991 (string-match "^#.*#$" filename))
4992\f
6f4983e6
RS
4993(defun wildcard-to-regexp (wildcard)
4994 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4837b516 4995The generated regexp will match a filename only if the filename
6f4983e6
RS
4996matches that wildcard according to shell rules. Only wildcards known
4997by `sh' are supported."
4998 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4999 ;; Copy the initial run of non-special characters.
5000 (result (substring wildcard 0 i))
5001 (len (length wildcard)))
5002 ;; If no special characters, we're almost done.
5003 (if i
5004 (while (< i len)
5005 (let ((ch (aref wildcard i))
5006 j)
5007 (setq
5008 result
5009 (concat result
5010 (cond
7e7c9c4e
RS
5011 ((and (eq ch ?\[)
5012 (< (1+ i) len)
5013 (eq (aref wildcard (1+ i)) ?\]))
5014 "\\[")
6f4983e6
RS
5015 ((eq ch ?\[) ; [...] maps to regexp char class
5016 (progn
5017 (setq i (1+ i))
5018 (concat
5019 (cond
5020 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5021 (progn
5022 (setq i (1+ i))
5023 (if (eq (aref wildcard i) ?\])
5024 (progn
5025 (setq i (1+ i))
5026 "[^]")
5027 "[^")))
5028 ((eq (aref wildcard i) ?^)
5029 ;; Found "[^". Insert a `\0' character
5030 ;; (which cannot happen in a filename)
5031 ;; into the character class, so that `^'
5032 ;; is not the first character after `[',
5033 ;; and thus non-special in a regexp.
5034 (progn
5035 (setq i (1+ i))
5036 "[\000^"))
5037 ((eq (aref wildcard i) ?\])
5038 ;; I don't think `]' can appear in a
5039 ;; character class in a wildcard, but
5040 ;; let's be general here.
5041 (progn
5042 (setq i (1+ i))
5043 "[]"))
5044 (t "["))
5045 (prog1 ; copy everything upto next `]'.
5046 (substring wildcard
5047 i
5048 (setq j (string-match
5049 "]" wildcard i)))
5050 (setq i (if j (1- j) (1- len)))))))
5051 ((eq ch ?.) "\\.")
5052 ((eq ch ?*) "[^\000]*")
5053 ((eq ch ?+) "\\+")
5054 ((eq ch ?^) "\\^")
5055 ((eq ch ?$) "\\$")
5056 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5057 ((eq ch ??) "[^\000]")
5058 (t (char-to-string ch)))))
5059 (setq i (1+ i)))))
5060 ;; Shell wildcards should match the entire filename,
5061 ;; not its part. Make the regexp say so.
5062 (concat "\\`" result "\\'")))
5063\f
21540597 5064(defcustom list-directory-brief-switches
7c2fb837 5065 "-CF"
ba83982b 5066 "Switches for `list-directory' to pass to `ls' for brief listing."
21540597
RS
5067 :type 'string
5068 :group 'dired)
b4da00e9 5069
21540597 5070(defcustom list-directory-verbose-switches
7c2fb837 5071 "-l"
ba83982b 5072 "Switches for `list-directory' to pass to `ls' for verbose listing."
21540597
RS
5073 :type 'string
5074 :group 'dired)
b4da00e9 5075
5de148a2
RS
5076(defun file-expand-wildcards (pattern &optional full)
5077 "Expand wildcard pattern PATTERN.
4db2a7de
RS
5078This returns a list of file names which match the pattern.
5079
814af837 5080If PATTERN is written as an absolute file name,
4db2a7de
RS
5081the values are absolute also.
5082
5083If PATTERN is written as a relative file name, it is interpreted
5084relative to the current default directory, `default-directory'.
5085The file names returned are normally also relative to the current
5086default directory. However, if FULL is non-nil, they are absolute."
032388f3
RS
5087 (save-match-data
5088 (let* ((nondir (file-name-nondirectory pattern))
5089 (dirpart (file-name-directory pattern))
5090 ;; A list of all dirs that DIRPART specifies.
5091 ;; This can be more than one dir
5092 ;; if DIRPART contains wildcards.
5093 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
5094 (mapcar 'file-name-as-directory
5095 (file-expand-wildcards (directory-file-name dirpart)))
5096 (list dirpart)))
5097 contents)
5098 (while dirs
5099 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5100 (file-directory-p (directory-file-name (car dirs))))
5101 (let ((this-dir-contents
5102 ;; Filter out "." and ".."
5103 (delq nil
5104 (mapcar #'(lambda (name)
5105 (unless (string-match "\\`\\.\\.?\\'"
5106 (file-name-nondirectory name))
5107 name))
5108 (directory-files (or (car dirs) ".") full
5109 (wildcard-to-regexp nondir))))))
5110 (setq contents
5111 (nconc
5112 (if (and (car dirs) (not full))
5113 (mapcar (function (lambda (name) (concat (car dirs) name)))
5114 this-dir-contents)
5115 this-dir-contents)
5116 contents))))
5117 (setq dirs (cdr dirs)))
5118 contents)))
5de148a2 5119
b4da00e9
RM
5120(defun list-directory (dirname &optional verbose)
5121 "Display a list of files in or matching DIRNAME, a la `ls'.
5122DIRNAME is globbed by the shell if necessary.
5123Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5124Actions controlled by variables `list-directory-brief-switches'
5125and `list-directory-verbose-switches'."
5126 (interactive (let ((pfx current-prefix-arg))
5127 (list (read-file-name (if pfx "List directory (verbose): "
5128 "List directory (brief): ")
5129 nil default-directory nil)
5130 pfx)))
5131 (let ((switches (if verbose list-directory-verbose-switches
84905190
RS
5132 list-directory-brief-switches))
5133 buffer)
b4da00e9
RM
5134 (or dirname (setq dirname default-directory))
5135 (setq dirname (expand-file-name dirname))
5136 (with-output-to-temp-buffer "*Directory*"
84905190 5137 (setq buffer standard-output)
b4da00e9
RM
5138 (buffer-disable-undo standard-output)
5139 (princ "Directory ")
5140 (princ dirname)
5141 (terpri)
c3554e95
RS
5142 (save-excursion
5143 (set-buffer "*Directory*")
5144 (let ((wildcard (not (file-directory-p dirname))))
84905190
RS
5145 (insert-directory dirname switches wildcard (not wildcard)))))
5146 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5147 (with-current-buffer buffer
5148 (setq default-directory
5149 (if (file-directory-p dirname)
5150 (file-name-as-directory dirname)
5151 (file-name-directory dirname))))))
c3554e95 5152
ffc0e1ca
AS
5153(defun shell-quote-wildcard-pattern (pattern)
5154 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5155
5156PATTERN is assumed to represent a file-name wildcard suitable for the
5157underlying filesystem. For Unix and GNU/Linux, the characters from the
d6d61574 5158set [ \\t\\n;<>&|()'\"#$] are quoted with a backslash; for DOS/Windows, all
ffc0e1ca
AS
5159the parts of the pattern which don't include wildcard characters are
5160quoted with double quotes.
5161Existing quote characters in PATTERN are left alone, so you can pass
5162PATTERN that already quotes some of the special characters."
5163 (save-match-data
5164 (cond
c60ee5e7 5165 ((memq system-type '(ms-dos windows-nt cygwin))
ffc0e1ca
AS
5166 ;; DOS/Windows don't allow `"' in file names. So if the
5167 ;; argument has quotes, we can safely assume it is already
5168 ;; quoted by the caller.
5169 (if (or (string-match "[\"]" pattern)
5170 ;; We quote [&()#$'] in case their shell is a port of a
5171 ;; Unixy shell. We quote [,=+] because stock DOS and
5172 ;; Windows shells require that in some cases, such as
5173 ;; passing arguments to batch files that use positional
5174 ;; arguments like %1.
5175 (not (string-match "[ \t;&()#$',=+]" pattern)))
5176 pattern
5177 (let ((result "\"")
5178 (beg 0)
5179 end)
5180 (while (string-match "[*?]+" pattern beg)
5181 (setq end (match-beginning 0)
5182 result (concat result (substring pattern beg end)
5183 "\""
5184 (substring pattern end (match-end 0))
5185 "\"")
5186 beg (match-end 0)))
5187 (concat result (substring pattern beg) "\""))))
5188 (t
5189 (let ((beg 0))
d6d61574 5190 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
ffc0e1ca
AS
5191 (setq pattern
5192 (concat (substring pattern 0 (match-beginning 0))
5193 "\\"
5194 (substring pattern (match-beginning 0)))
5195 beg (1+ (match-end 0)))))
5196 pattern))))
5197
5198
c3554e95
RS
5199(defvar insert-directory-program "ls"
5200 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5201
f4d04672 5202(defcustom directory-free-space-program "df"
ba83982b 5203 "Program to get the amount of free space on a file system.
f4d04672
RS
5204We assume the output has the format of `df'.
5205The value of this variable must be just a command name or file name;
5206if you want to specify options, use `directory-free-space-args'.
5207
01b26b90
EZ
5208A value of nil disables this feature.
5209
5210If the function `file-system-info' is defined, it is always used in
5211preference to the program given by this variable."
f4d04672
RS
5212 :type '(choice (string :tag "Program") (const :tag "None" nil))
5213 :group 'dired)
5214
525fdbc9
AS
5215(defcustom directory-free-space-args
5216 (if (eq system-type 'darwin) "-k" "-Pk")
ba83982b 5217 "Options to use when running `directory-free-space-program'."
f4d04672
RS
5218 :type 'string
5219 :group 'dired)
5220
01b26b90 5221(defun get-free-disk-space (dir)
26b9ecbc 5222 "Return the amount of free space on directory DIR's file system.
01b26b90 5223The result is a string that gives the number of free 1KB blocks,
26b9ecbc 5224or nil if the system call or the program which retrieve the information
06531fc3 5225fail. It returns also nil when DIR is a remote directory.
01b26b90
EZ
5226
5227This function calls `file-system-info' if it is available, or invokes the
5228program specified by `directory-free-space-program' if that is non-nil."
06531fc3
MA
5229 (when (not (file-remote-p dir))
5230 ;; Try to find the number of free blocks. Non-Posix systems don't
5231 ;; always have df, but might have an equivalent system call.
5232 (if (fboundp 'file-system-info)
5233 (let ((fsinfo (file-system-info dir)))
5234 (if fsinfo
5235 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5236 (save-match-data
5237 (with-temp-buffer
5238 (when (and directory-free-space-program
5239 (eq 0 (call-process directory-free-space-program
5240 nil t nil
5241 directory-free-space-args
5242 dir)))
5243 ;; Usual format is a header line followed by a line of
5244 ;; numbers.
5245 (goto-char (point-min))
5246 (forward-line 1)
5247 (if (not (eobp))
5248 (progn
5249 ;; Move to the end of the "available blocks" number.
5250 (skip-chars-forward "^ \t")
5251 (forward-word 3)
5252 ;; Copy it into AVAILABLE.
5253 (let ((end (point)))
5254 (forward-word -1)
5255 (buffer-substring (point) end))))))))))
01b26b90 5256
9bc260cf
MA
5257;; The following expression replaces `dired-move-to-filename-regexp'.
5258(defvar directory-listing-before-filename-regexp
5259 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5260 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5261 ;; In some locales, month abbreviations are as short as 2 letters,
5262 ;; and they can be followed by ".".
5263 ;; In Breton, a month name can include a quote character.
5264 (month (concat l-or-quote l-or-quote "+\\.?"))
5265 (s " ")
5266 (yyyy "[0-9][0-9][0-9][0-9]")
5267 (dd "[ 0-3][0-9]")
5268 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5269 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5270 (zone "[-+][0-2][0-9][0-5][0-9]")
5271 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5272 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5273 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5274 "\\|" yyyy "-" iso-mm-dd "\\)"))
5275 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5276 s "+"
5277 "\\(" HH:MM "\\|" yyyy "\\)"))
5278 (western-comma (concat month s "+" dd "," s "+" yyyy))
5279 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5280 ;; omits the Kanji characters after month and day-of-month.
5281 ;; On Mac OS X 10.3, the date format in East Asian locales is
5282 ;; day-of-month digits followed by month digits.
5283 (mm "[ 0-1]?[0-9]")
5284 (east-asian
5285 (concat "\\(" mm l "?" s dd l "?" s "+"
5286 "\\|" dd s mm s "+" "\\)"
5287 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5288 ;; The "[0-9]" below requires the previous column to end in a digit.
5289 ;; This avoids recognizing `1 may 1997' as a date in the line:
5290 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5291
5292 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5293 ;; The ".*" below finds the last match if there are multiple matches.
5294 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5295 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5296
5297 ;; vc dired listings provide the state or blanks between file
5298 ;; permissions and date. The state is always surrounded by
5299 ;; parantheses:
5300 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5301 ;; This is not supported yet.
5302 (concat ".*[0-9][BkKMGTPEZY]?" s
5303 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
5304 s "+"))
5305 "Regular expression to match up to the file name in a directory listing.
5306The default value is designed to recognize dates and times
5307regardless of the language.")
01b26b90 5308
a1b0c2a7
RS
5309(defvar insert-directory-ls-version 'unknown)
5310
c3554e95
RS
5311;; insert-directory
5312;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5313;; FULL-DIRECTORY-P is nil.
5314;; The single line of output must display FILE's name as it was
5315;; given, namely, an absolute path name.
5316;; - must insert exactly one line for each file if WILDCARD or
5317;; FULL-DIRECTORY-P is t, plus one optional "total" line
5318;; before the file lines, plus optional text after the file lines.
5319;; Lines are delimited by "\n", so filenames containing "\n" are not
5320;; allowed.
5321;; File lines should display the basename.
5322;; - must be consistent with
5323;; - functions dired-move-to-filename, (these two define what a file line is)
5324;; dired-move-to-end-of-filename,
5325;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5326;; dired-insert-headerline
5327;; dired-after-subdir-garbage (defines what a "total" line is)
5328;; - variable dired-subdir-regexp
1fc85dae
KG
5329;; - may be passed "--dired" as the first argument in SWITCHES.
5330;; Filename handlers might have to remove this switch if their
5331;; "ls" command does not support it.
c3554e95 5332(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 5333 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 5334Leaves point after the inserted text.
8f8607be
LT
5335SWITCHES may be a string of options, or a list of strings
5336representing individual options.
c3554e95
RS
5337Optional third arg WILDCARD means treat FILE as shell wildcard.
5338Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5339switches do not contain `d', so that a full listing is expected.
5340
5341This works by running a directory listing program
406e12d9 5342whose name is in the variable `insert-directory-program'.
8f8607be
LT
5343If WILDCARD, it also runs the shell specified by `shell-file-name'.
5344
60ce7e3e 5345When SWITCHES contains the long `--dired' option, this function
8f8607be
LT
5346treats it specially, for the sake of dired. However, the
5347normally equivalent short `-D' option is just passed on to
5348`insert-directory-program', as any other option."
c870ab8e 5349 ;; We need the directory in order to find the right handler.
d2473540
AS
5350 (let ((handler (find-file-name-handler (expand-file-name file)
5351 'insert-directory)))
ebad92dc 5352 (if handler
c3554e95
RS
5353 (funcall handler 'insert-directory file switches
5354 wildcard full-directory-p)
818286f4 5355 (let (result (beg (point)))
ebad92dc
RS
5356
5357 ;; Read the actual directory using `insert-directory-program'.
5358 ;; RESULT gets the status code.
99f01c91
KH
5359 (let* (;; We at first read by no-conversion, then after
5360 ;; putting text property `dired-filename, decode one
5361 ;; bunch by one to preserve that property.
5362 (coding-system-for-read 'no-conversion)
5363 ;; This is to control encoding the arguments in call-process.
c60ee5e7 5364 (coding-system-for-write
82e22b57
KH
5365 (and enable-multibyte-characters
5366 (or file-name-coding-system
99f01c91 5367 default-file-name-coding-system))))
ebad92dc
RS
5368 (setq result
5369 (if wildcard
5370 ;; Run ls in the directory part of the file pattern
5371 ;; using the last component as argument.
5372 (let ((default-directory
5373 (if (file-name-absolute-p file)
5374 (file-name-directory file)
5375 (file-name-directory (expand-file-name file))))
5376 (pattern (file-name-nondirectory file)))
5377 (call-process
5378 shell-file-name nil t nil
5379 "-c"
5380 (concat (if (memq system-type '(ms-dos windows-nt))
5381 ""
5382 "\\") ; Disregard Unix shell aliases!
5383 insert-directory-program
5384 " -d "
5385 (if (stringp switches)
5386 switches
5387 (mapconcat 'identity switches " "))
5388 " -- "
5389 ;; Quote some characters that have
5390 ;; special meanings in shells; but
5391 ;; don't quote the wildcards--we want
5392 ;; them to be special. We also
5393 ;; currently don't quote the quoting
5394 ;; characters in case people want to
5395 ;; use them explicitly to quote
5396 ;; wildcard characters.
5397 (shell-quote-wildcard-pattern pattern))))
5398 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5399 ;; directory if FILE is a symbolic link.
5400 (apply 'call-process
5401 insert-directory-program nil t nil
5402 (append
5403 (if (listp switches) switches
5404 (unless (equal switches "")
5405 ;; Split the switches at any spaces so we can
5406 ;; pass separate options as separate args.
5407 (split-string switches)))
5408 ;; Avoid lossage if FILE starts with `-'.
5409 '("--")
5410 (progn
5411 (if (string-match "\\`~" file)
5412 (setq file (expand-file-name file)))
5413 (list
5414 (if full-directory-p
5415 (concat (file-name-as-directory file) ".")
5416 file))))))))
5417
a1b0c2a7
RS
5418 ;; If we got "//DIRED//" in the output, it means we got a real
5419 ;; directory listing, even if `ls' returned nonzero.
5420 ;; So ignore any errors.
5421 (when (if (stringp switches)
5422 (string-match "--dired\\>" switches)
5423 (member "--dired" switches))
5424 (save-excursion
5425 (forward-line -2)
5426 (when (looking-at "//SUBDIRED//")
5427 (forward-line -1))
5428 (if (looking-at "//DIRED//")
5429 (setq result 0))))
5430
5431 (when (and (not (eq 0 result))
5432 (eq insert-directory-ls-version 'unknown))
5433 ;; The first time ls returns an error,
5434 ;; find the version numbers of ls,
5435 ;; and set insert-directory-ls-version
5436 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5437 ;; is equal or if the info cannot be obtained.
5438 ;; (That can mean it isn't GNU ls.)
5439 (let ((version-out
5440 (with-temp-buffer
5441 (call-process "ls" nil t nil "--version")
5442 (buffer-string))))
5443 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5444 (let* ((version (match-string 1 version-out))
5445 (split (split-string version "[.]"))
027a4b6b 5446 (numbers (mapcar 'string-to-number split))
a1b0c2a7
RS
5447 (min '(5 2 1))
5448 comparison)
5449 (while (and (not comparison) (or numbers min))
5450 (cond ((null min)
5451 (setq comparison '>))
5452 ((null numbers)
5453 (setq comparison '<))
5454 ((> (car numbers) (car min))
5455 (setq comparison '>))
5456 ((< (car numbers) (car min))
5457 (setq comparison '<))
5458 (t
5459 (setq numbers (cdr numbers)
5460 min (cdr min)))))
5461 (setq insert-directory-ls-version (or comparison '=)))
5462 (setq insert-directory-ls-version nil))))
5463
5464 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5465 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5466 (setq result 0))
5467
ebad92dc 5468 ;; If `insert-directory-program' failed, signal an error.
15502042 5469 (unless (eq 0 result)
f2440e42
RS
5470 ;; Delete the error message it may have output.
5471 (delete-region beg (point))
15502042
EZ
5472 ;; On non-Posix systems, we cannot open a directory, so
5473 ;; don't even try, because that will always result in
5474 ;; the ubiquitous "Access denied". Instead, show the
5475 ;; command line so the user can try to guess what went wrong.
5476 (if (and (file-directory-p file)
5477 (memq system-type '(ms-dos windows-nt)))
5478 (error
5479 "Reading directory: \"%s %s -- %s\" exited with status %s"
5480 insert-directory-program
5481 (if (listp switches) (concat switches) switches)
5482 file result)
5483 ;; Unix. Access the file to get a suitable error.
5484 (access-file file "Reading directory")
5485 (error "Listing directory failed but `access-file' worked")))
ebad92dc 5486
8f8607be
LT
5487 (when (if (stringp switches)
5488 (string-match "--dired\\>" switches)
5489 (member "--dired" switches))
9bb99df6
LT
5490 ;; The following overshoots by one line for an empty
5491 ;; directory listed with "--dired", but without "-a"
5492 ;; switch, where the ls output contains a
5493 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5494 ;; We take care of that case later.
ff7affeb 5495 (forward-line -2)
9423860f
AS
5496 (when (looking-at "//SUBDIRED//")
5497 (delete-region (point) (progn (forward-line 1) (point)))
5498 (forward-line -1))
9bb99df6
LT
5499 (if (looking-at "//DIRED//")
5500 (let ((end (line-end-position))
5501 (linebeg (point))
5502 error-lines)
5503 ;; Find all the lines that are error messages,
5504 ;; and record the bounds of each one.
5505 (goto-char beg)
5506 (while (< (point) linebeg)
5507 (or (eql (following-char) ?\s)
5508 (push (list (point) (line-end-position)) error-lines))
5509 (forward-line 1))
5510 (setq error-lines (nreverse error-lines))
5511 ;; Now read the numeric positions of file names.
5512 (goto-char linebeg)
5513 (forward-word 1)
5514 (forward-char 3)
5515 (while (< (point) end)
5516 (let ((start (insert-directory-adj-pos
5517 (+ beg (read (current-buffer)))
5518 error-lines))
5519 (end (insert-directory-adj-pos
a1b0c2a7 5520 (+ beg (read (current-buffer)))
9bb99df6 5521 error-lines)))
26b9ecbc 5522 (if (memq (char-after end) '(?\n ?\s))
9bb99df6
LT
5523 ;; End is followed by \n or by " -> ".
5524 (put-text-property start end 'dired-filename t)
5525 ;; It seems that we can't trust ls's output as to
5526 ;; byte positions of filenames.
5527 (put-text-property beg (point) 'dired-filename nil)
5528 (end-of-line))))
5529 (goto-char end)
5530 (beginning-of-line)
5531 (delete-region (point) (progn (forward-line 1) (point))))
5532 ;; Take care of the case where the ls output contains a
5533 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5534 ;; and we went one line too far back (see above).
5535 (forward-line 1))
5536 (if (looking-at "//DIRED-OPTIONS//")
5537 (delete-region (point) (progn (forward-line 1) (point)))))
ff7affeb 5538
99f01c91 5539 ;; Now decode what read if necessary.
b6647390
KH
5540 (let ((coding (or coding-system-for-read
5541 file-name-coding-system
5542 default-file-name-coding-system
5543 'undecided))
0bded065 5544 coding-no-eol
99f01c91 5545 val pos)
b6647390
KH
5546 (when (and enable-multibyte-characters
5547 (not (memq (coding-system-base coding)
5548 '(raw-text no-conversion))))
5549 ;; If no coding system is specified or detection is
5550 ;; requested, detect the coding.
5551 (if (eq (coding-system-base coding) 'undecided)
5552 (setq coding (detect-coding-region beg (point) t)))
5553 (if (not (eq (coding-system-base coding) 'undecided))
5554 (save-restriction
0bded065
AS
5555 (setq coding-no-eol
5556 (coding-system-change-eol-conversion coding 'unix))
b6647390
KH
5557 (narrow-to-region beg (point))
5558 (goto-char (point-min))
5559 (while (not (eobp))
5560 (setq pos (point)
5561 val (get-text-property (point) 'dired-filename))
5562 (goto-char (next-single-property-change
5563 (point) 'dired-filename nil (point-max)))
0bded065
AS
5564 ;; Force no eol conversion on a file name, so
5565 ;; that CR is preserved.
5566 (decode-coding-region pos (point)
5567 (if val coding-no-eol coding))
b6647390
KH
5568 (if val
5569 (put-text-property pos (point)
5570 'dired-filename t)))))))
99f01c91 5571
75bb5ca4
AS
5572 (if full-directory-p
5573 ;; Try to insert the amount of free space.
5574 (save-excursion
5575 (goto-char beg)
5576 ;; First find the line to put it on.
5577 (when (re-search-forward "^ *\\(total\\)" nil t)
5578 (let ((available (get-free-disk-space ".")))
5579 (when available
5580 ;; Replace "total" with "used", to avoid confusion.
5581 (replace-match "total used in directory" nil nil nil 1)
5582 (end-of-line)
7c2fb837 5583 (insert " available " available))))))))))
34342a07 5584
a1b0c2a7 5585(defun insert-directory-adj-pos (pos error-lines)
fead94d6 5586 "Convert `ls --dired' file name position value POS to a buffer position.
a1b0c2a7
RS
5587File name position values returned in ls --dired output
5588count only stdout; they don't count the error messages sent to stderr.
5589So this function converts to them to real buffer positions.
5590ERROR-LINES is a list of buffer positions of error message lines,
5591of the form (START END)."
5592 (while (and error-lines (< (caar error-lines) pos))
5593 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5594 (pop error-lines))
5595 pos)
5596
bc22fd18
EZ
5597(defun insert-directory-safely (file switches
5598 &optional wildcard full-directory-p)
5599 "Insert directory listing for FILE, formatted according to SWITCHES.
5600
5601Like `insert-directory', but if FILE does not exist, it inserts a
5602message to that effect instead of signaling an error."
5603 (if (file-exists-p file)
5604 (insert-directory file switches wildcard full-directory-p)
5605 ;; Simulate the message printed by `ls'.
5606 (insert (format "%s: No such file or directory\n" file))))
5607
88902b35 5608(defvar kill-emacs-query-functions nil
65d5c6de 5609 "Functions to call with no arguments to query about killing Emacs.
78c793d1 5610If any of these functions returns nil, killing Emacs is cancelled.
6daab4ed
JB
5611`save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5612the low level primitive, does not. See also `kill-emacs-hook'.")
88902b35 5613
11f15305 5614(defcustom confirm-kill-emacs nil
9c2ba08f
EZ
5615 "How to ask for confirmation when leaving Emacs.
5616If nil, the default, don't ask at all. If the value is non-nil, it should
5617be a predicate function such as `yes-or-no-p'."
11f15305
GM
5618 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5619 (const :tag "Ask with y-or-n-p" y-or-n-p)
5620 (const :tag "Don't confirm" nil))
bdd9ab6e 5621 :group 'convenience
11f15305
GM
5622 :version "21.1")
5623
b4da00e9
RM
5624(defun save-buffers-kill-emacs (&optional arg)
5625 "Offer to save each buffer, then kill this Emacs process.
8fc29035 5626With prefix ARG, silently save all file-visiting buffers, then kill."
b4da00e9
RM
5627 (interactive "P")
5628 (save-some-buffers arg t)
5629 (and (or (not (memq t (mapcar (function
5630 (lambda (buf) (and (buffer-file-name buf)
5631 (buffer-modified-p buf))))
5632 (buffer-list))))
5633 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5634 (or (not (fboundp 'process-list))
7c2fb837 5635 ;; process-list is not defined on MSDOS.
b4da00e9
RM
5636 (let ((processes (process-list))
5637 active)
5638 (while processes
48a4a1fb
KS
5639 (and (memq (process-status (car processes)) '(run stop open listen))
5640 (process-query-on-exit-flag (car processes))
b4da00e9
RM
5641 (setq active t))
5642 (setq processes (cdr processes)))
5643 (or (not active)
48a4a1fb 5644 (list-processes t)
b4da00e9 5645 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 5646 ;; Query the user for other things, perhaps.
fb15c113 5647 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
11f15305
GM
5648 (or (null confirm-kill-emacs)
5649 (funcall confirm-kill-emacs "Really exit Emacs? "))
b4da00e9 5650 (kill-emacs)))
59e085e0 5651
6ed8eeff 5652(defun save-buffers-kill-terminal (&optional arg)
59e085e0
KL
5653 "Offer to save each buffer, then kill the current connection.
5654If the current frame has no client, kill Emacs itself.
5655
8fc29035 5656With prefix ARG, silently save all file-visiting buffers, then kill.
59e085e0
KL
5657
5658If emacsclient was started with a list of filenames to edit, then
5659only these files will be asked to be saved."
5660 (interactive "P")
5661 (let ((proc (frame-parameter (selected-frame) 'client))
5662 (frame (selected-frame)))
5663 (if (null proc)
5664 (save-buffers-kill-emacs)
6ed8eeff 5665 (server-save-buffers-kill-terminal proc arg))))
59e085e0 5666
b4da00e9 5667\f
ffc0e1ca 5668;; We use /: as a prefix to "quote" a file name
47afc068
RS
5669;; so that magic file name handlers will not apply to it.
5670
5671(setq file-name-handler-alist
5672 (cons '("\\`/:" . file-name-non-special)
5673 file-name-handler-alist))
5674
5675;; We depend on being the last handler on the list,
5676;; so that anything else which does need handling
5677;; has been handled already.
5678;; So it is safe for us to inhibit *all* magic file name handlers.
5679
5680(defun file-name-non-special (operation &rest arguments)
5681 (let ((file-name-handler-alist nil)
5cb1f728
KH
5682 (default-directory
5683 (if (eq operation 'insert-directory)
5684 (directory-file-name
ffc0e1ca 5685 (expand-file-name
5cb1f728
KH
5686 (unhandled-file-name-directory default-directory)))
5687 default-directory))
47afc068
RS
5688 ;; Get a list of the indices of the args which are file names.
5689 (file-arg-indices
5690 (cdr (or (assq operation
ae3b2983 5691 ;; The first six are special because they
47afc068
RS
5692 ;; return a file name. We want to include the /:
5693 ;; in the return value.
5694 ;; So just avoid stripping it in the first place.
5695 '((expand-file-name . nil)
5696 (file-name-directory . nil)
5697 (file-name-as-directory . nil)
5698 (directory-file-name . nil)
c736f678 5699 (file-name-sans-versions . nil)
ae3b2983 5700 (find-backup-file-name . nil)
c736f678 5701 ;; `identity' means just return the first arg
6750c852
RS
5702 ;; not stripped of its quoting.
5703 (substitute-in-file-name identity)
ae3b2983
MA
5704 ;; `add' means add "/:" to the result.
5705 (file-truename add 0)
5706 ;; `quote' means add "/:" to buffer-file-name.
5707 (insert-file-contents quote 0)
5708 ;; `unquote-then-quote' means set buffer-file-name
5709 ;; temporarily to unquoted filename.
5710 (verify-visited-file-modtime unquote-then-quote)
5711 ;; List the arguments which are filenames.
c37adaa5
SM
5712 (file-name-completion 1)
5713 (file-name-all-completions 1)
ae3b2983 5714 (write-region 2 5)
47afc068
RS
5715 (rename-file 0 1)
5716 (copy-file 0 1)
5717 (make-symbolic-link 0 1)
5718 (add-name-to-file 0 1)))
5719 ;; For all other operations, treat the first argument only
5720 ;; as the file name.
5721 '(nil 0))))
6750c852 5722 method
47afc068
RS
5723 ;; Copy ARGUMENTS so we can replace elements in it.
5724 (arguments (copy-sequence arguments)))
6750c852
RS
5725 (if (symbolp (car file-arg-indices))
5726 (setq method (pop file-arg-indices)))
5727 ;; Strip off the /: from the file names that have it.
47afc068 5728 (save-match-data
18b9dced 5729 (while (consp file-arg-indices)
fe4d9852
KH
5730 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5731 (and (car pair)
5732 (string-match "\\`/:" (car pair))
5733 (setcar pair
5734 (if (= (length (car pair)) 2)
5735 "/"
5736 (substring (car pair) 2)))))
47afc068 5737 (setq file-arg-indices (cdr file-arg-indices))))
6750c852
RS
5738 (cond ((eq method 'identity)
5739 (car arguments))
ae3b2983 5740 ((eq method 'add)
6750c852 5741 (concat "/:" (apply operation arguments)))
ae3b2983 5742 ((eq method 'quote)
e8f30180
RS
5743 (unwind-protect
5744 (apply operation arguments)
ae3b2983
MA
5745 (setq buffer-file-name (concat "/:" buffer-file-name))))
5746 ((eq method 'unquote-then-quote)
5747 (let (res)
5748 (setq buffer-file-name (substring buffer-file-name 2))
5749 (setq res (apply operation arguments))
5750 (setq buffer-file-name (concat "/:" buffer-file-name))
5751 res))
6750c852
RS
5752 (t
5753 (apply operation arguments)))))
47afc068 5754\f
90d10f16
MC
5755;; Symbolic modes and read-file-modes.
5756
5757(defun file-modes-char-to-who (char)
e240aaa9
EZ
5758 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5759CHAR is in [ugoa] and represents the category of users (Owner, Group,
5760Others, or All) for whom to produce the mask.
5761The bit-mask that is returned extracts from mode bits the access rights
5762for the specified category of users."
90d10f16
MC
5763 (cond ((= char ?u) #o4700)
5764 ((= char ?g) #o2070)
5765 ((= char ?o) #o1007)
5766 ((= char ?a) #o7777)
5767 (t (error "%c: bad `who' character" char))))
5768
5769(defun file-modes-char-to-right (char &optional from)
e240aaa9
EZ
5770 "Convert CHAR to a numeric value of mode bits.
5771CHAR is in [rwxXstugo] and represents symbolic access permissions.
5772If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
90d10f16
MC
5773 (or from (setq from 0))
5774 (cond ((= char ?r) #o0444)
5775 ((= char ?w) #o0222)
5776 ((= char ?x) #o0111)
5777 ((= char ?s) #o1000)
5778 ((= char ?t) #o6000)
5779 ;; Rights relative to the previous file modes.
5780 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5781 ((= char ?u) (let ((uright (logand #o4700 from)))
5782 (+ uright (/ uright #o10) (/ uright #o100))))
5783 ((= char ?g) (let ((gright (logand #o2070 from)))
5784 (+ gright (/ gright #o10) (* gright #o10))))
5785 ((= char ?o) (let ((oright (logand #o1007 from)))
5786 (+ oright (* oright #o10) (* oright #o100))))
5787 (t (error "%c: bad right character" char))))
5788
5789(defun file-modes-rights-to-number (rights who-mask &optional from)
e240aaa9
EZ
5790 "Convert a symbolic mode string specification to an equivalent number.
5791RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]+)+\".
5792WHO-MASK is the bit-mask specifying the category of users to which to
5793apply the access permissions. See `file-modes-char-to-who'.
5794FROM (or 0 if nil) gives the mode bits on which to base permissions if
5795RIGHTS request to add, remove, or set permissions based on existing ones,
5796as in \"og+rX-w\"."
90d10f16
MC
5797 (let* ((num-rights (or from 0))
5798 (list-rights (string-to-list rights))
5799 (op (pop list-rights)))
5800 (while (memq op '(?+ ?- ?=))
5801 (let ((num-right 0)
5802 char-right)
5803 (while (memq (setq char-right (pop list-rights))
5804 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5805 (setq num-right
5806 (logior num-right
5807 (file-modes-char-to-right char-right num-rights))))
5808 (setq num-right (logand who-mask num-right)
5809 num-rights
5810 (cond ((= op ?+) (logior num-rights num-right))
5811 ((= op ?-) (logand num-rights (lognot num-right)))
5812 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5813 op char-right)))
5814 num-rights))
5815
5816(defun file-modes-symbolic-to-number (modes &optional from)
5817 "Convert symbolic file modes to numeric file modes.
5818MODES is the string to convert, it should match
5819\"[ugoa]*([+-=][rwxXstugo]+)+,...\".
5820See (info \"(coreutils)File permissions\") for more information on this
5821notation.
e240aaa9
EZ
5822FROM (or 0 if nil) gives the mode bits on which to base permissions if
5823MODES request to add, remove, or set permissions based on existing ones,
5824as in \"og+rX-w\"."
90d10f16
MC
5825 (save-match-data
5826 (let ((case-fold-search nil)
5827 (num-modes (or from 0)))
5828 (while (/= (string-to-char modes) 0)
5829 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes)
5830 (let ((num-who (apply 'logior 0
5831 (mapcar 'file-modes-char-to-who
5832 (match-string 1 modes)))))
5833 (when (= num-who 0)
5834 (setq num-who (default-file-modes)))
5835 (setq num-modes
5836 (file-modes-rights-to-number (substring modes (match-end 1))
5837 num-who num-modes)
5838 modes (substring modes (match-end 3))))
5839 (error "Parse error in modes near `%s'" (substring modes 0))))
5840 num-modes)))
5841
5842(defun read-file-modes (&optional prompt orig-file)
e240aaa9 5843 "Read file modes in octal or symbolic notation and return its numeric value.
90d10f16 5844PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
e240aaa9
EZ
5845ORIG-FILE is the name of a file on whose mode bits to base returned
5846permissions if what user types requests to add, remove, or set permissions
5847based on existing mode bits, as in \"og+rX-w\"."
90d10f16
MC
5848 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
5849 (error "File not found")))
7cb41b32
JL
5850 (modestr (and (stringp orig-file)
5851 (nth 8 (file-attributes orig-file))))
5852 (default
5853 (and (stringp modestr)
5854 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
5855 (replace-regexp-in-string
5856 "-" ""
5857 (format "u=%s,g=%s,o=%s"
5858 (match-string 1 modestr)
5859 (match-string 2 modestr)
5860 (match-string 3 modestr)))))
5861 (value (read-string (or prompt "File modes (octal or symbolic): ")
5862 nil nil default)))
90d10f16
MC
5863 (save-match-data
5864 (if (string-match "^[0-7]+" value)
5865 (string-to-number value 8)
5866 (file-modes-symbolic-to-number value modes)))))
5867
5868\f
e240aaa9
EZ
5869;; Trashcan handling.
5870(defcustom trash-directory (convert-standard-filename "~/.Trash")
6cf29fe8
JR
5871 "Directory for `move-file-to-trash' to move files and directories to.
5872This directory is only used when the function `system-move-file-to-trash' is
5873not defined. Relative paths are interpreted relative to `default-directory'.
5874See also `delete-by-moving-to-trash'."
5875 :type 'directory
5876 :group 'auto-save
5877 :version "23.1")
5878
5879(declare-function system-move-file-to-trash "w32fns.c" (filename))
5880
5881(defun move-file-to-trash (filename)
5882 "Move file (or directory) name FILENAME to the trash.
5883This function is called by `delete-file' and `delete-directory' when
5884`delete-by-moving-to-trash' is non-nil. On platforms that define
5885`system-move-file-to-trash', that function is used to move FILENAME to the
5886system trash, otherwise FILENAME is moved to `trash-directory'.
5887Returns nil on success."
5888 (interactive "fMove file to trash: ")
5889 (cond
5890 ((fboundp 'system-move-file-to-trash)
5891 (system-move-file-to-trash filename))
5892 (t
5893 (let* ((trash-dir (expand-file-name trash-directory))
5894 (fn (directory-file-name (expand-file-name filename)))
5895 (fn-nondir (file-name-nondirectory fn))
5896 (new-fn (expand-file-name fn-nondir trash-dir)))
5897 (or (file-directory-p trash-dir)
5898 (make-directory trash-dir t))
5899 (and (file-exists-p new-fn)
5900 ;; make new-fn unique.
5901 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5902 (let ((version-control t))
5903 (setq new-fn (car (find-backup-file-name new-fn)))))
5904 ;; stop processing if fn is same or parent directory of trash-dir.
5905 (and (string-match fn trash-dir)
5906 (error "Filename `%s' is same or parent directory of trash-directory"
5907 filename))
3102b342
GM
5908 (let ((delete-by-moving-to-trash nil))
5909 (rename-file fn new-fn))))))
6cf29fe8
JR
5910
5911\f
b4da00e9 5912(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
5913(define-key ctl-x-map "\C-r" 'find-file-read-only)
5914(define-key ctl-x-map "\C-v" 'find-alternate-file)
5915(define-key ctl-x-map "\C-s" 'save-buffer)
5916(define-key ctl-x-map "s" 'save-some-buffers)
5917(define-key ctl-x-map "\C-w" 'write-file)
5918(define-key ctl-x-map "i" 'insert-file)
5919(define-key esc-map "~" 'not-modified)
5920(define-key ctl-x-map "\C-d" 'list-directory)
6ed8eeff 5921(define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
d758359d 5922(define-key ctl-x-map "\C-q" 'toggle-read-only)
b4da00e9
RM
5923
5924(define-key ctl-x-4-map "f" 'find-file-other-window)
5925(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5926(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5927(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 5928(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 5929
f98955ea
JB
5930(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5931(define-key ctl-x-5-map "f" 'find-file-other-frame)
5932(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5933(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
3095ccf5 5934(define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
c0274f38 5935
c3f6aa20 5936;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
c0274f38 5937;;; files.el ends here