* files.el (project-settings-file): New variable.
[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
f3e23606
RS
157 "*Non-nil means visit a file under its truename.
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
RS
489The value can be t, nil or something else.
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.
760Stop at the first parent directory containing a file NAME return the directory.
761Return nil if not found."
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.
765 ;;
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'.
467ff692 1119Optional second arg NORECORD non-nil means
4c6a4739 1120do not put this buffer 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
3170(defun define-project-bindings (class list)
3171 "Map the project type CLASS to a list of variable settings.
3172CLASS is the project class, a symbol.
3173LIST is a list that declares variable settings for the class.
3174An element in LIST is either of the form:
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
3202 (setcdr elt list)
3203 (push (cons class list) project-class-alist))))
3204
ffe89e76
CY
3205(defcustom project-settings-file ".dir-settings.el"
3206 "Settings file for per-project settings. Set this to nil if you dont want to load project-specific settings."
3207 :type '(choice
3208 (const :tag "Ignore" nil)
3209 (file :tag "File"))
3210:group 'files)
3211
1b21ee06
MO
3212(defun project-find-settings-file (file)
3213 "Find the settings file for FILE.
3214This searches upward in the directory tree.
3215If a settings file is found, the file name is returned.
3216If the file is in a registered project, a cons from
3217`project-directory-alist' is returned.
3218Otherwise this returns nil."
ffe89e76
CY
3219 (when project-settings-file
3220 (setq file (expand-file-name file))
3221 (let* ((settings (locate-dominating-file file project-settings-file))
3222 (pda nil))
3223 ;; `locate-dominating-file' may have abbreviated the name.
3224 (if settings (setq settings (expand-file-name ".dir-settings.el" settings)))
3225 (dolist (x project-directory-alist)
3226 (when (and (eq t (compare-strings file nil (length (car x))
3227 (car x) nil nil))
3228 (> (length (car x)) (length (car pda))))
3229 (setq pda x)))
3230 (if (and settings pda)
3231 (if (> (length (file-name-directory settings))
3232 (length (car pda)))
3233 settings pda)
3234 (or settings pda)))))
1b21ee06
MO
3235
3236(defun project-define-from-project-file (settings-file)
3237 "Load a settings file and register a new project class and instance.
3238SETTINGS-FILE is the name of the file holding the settings to apply.
3239The new class name is the same as the directory in which SETTINGS-FILE
3240is found. Returns the new class name."
3241 (with-temp-buffer
3242 ;; We should probably store the modtime of SETTINGS-FILE and then
3243 ;; reload it whenever it changes.
3244 (insert-file-contents settings-file)
3245 (let* ((dir-name (file-name-directory settings-file))
3246 (class-name (intern dir-name))
3247 (list (read (current-buffer))))
3248 (define-project-bindings class-name list)
3249 (set-directory-project dir-name class-name)
3250 class-name)))
3251
361edc85
GM
3252(declare-function c-postprocess-file-styles "cc-mode" ())
3253
1b21ee06 3254(defun hack-project-variables ()
2b8ac025
CY
3255 "Read local variables for the current buffer based on project settings.
3256Store the project variables in `file-local-variables-alist',
3257without applying them."
3258 (when (and enable-local-variables
3259 (buffer-file-name)
3260 (not (file-remote-p (buffer-file-name))))
1b21ee06
MO
3261 ;; Find the settings file.
3262 (let ((settings (project-find-settings-file (buffer-file-name)))
3263 (class nil)
3264 (root-dir nil))
3265 (cond
3266 ((stringp settings)
3267 (setq root-dir (file-name-directory (buffer-file-name)))
3268 (setq class (project-define-from-project-file settings)))
3269 ((consp settings)
3270 (setq root-dir (car settings))
3271 (setq class (cdr settings))))
3272 (when class
3273 (let ((bindings
3274 (project-collect-binding-list (project-get-alist class)
3275 root-dir nil)))
3276 (when bindings
2b8ac025 3277 (hack-local-variables-filter bindings root-dir)))))))
f3e23606 3278
b4da00e9 3279\f
21540597 3280(defcustom change-major-mode-with-file-name t
ba83982b 3281 "Non-nil means \\[write-file] should set the major mode from the file name.
9de9b6a2
RS
3282However, the mode will not be changed if
3283\(1) a local variables list or the `-*-' line specifies a major mode, or
3284\(2) the current major mode is a \"special\" mode,
96e777e1 3285\ not suitable for ordinary files, or
21540597
RS
3286\(3) the new file name does not particularly specify any mode."
3287 :type 'boolean
3288 :group 'editing-basics)
9de9b6a2 3289
f36012a6 3290(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9 3291 "Change name of file visited in current buffer to FILENAME.
1af57101 3292This also renames the buffer to correspond to the new file.
b4da00e9 3293The next time the buffer is saved it will go in the newly specified file.
1af57101 3294FILENAME nil or an empty string means mark buffer as not visiting any file.
b4da00e9 3295Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
3296if you wish to pass an empty string as the argument.
3297
3298The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
3299confirmation in the case where another buffer is already visiting FILENAME.
3300
3301The optional third argument ALONG-WITH-FILE, if non-nil, means that
3302the old visited file has been renamed to the new name FILENAME."
b4da00e9 3303 (interactive "FSet visited file name: ")
c11a94fe
RS
3304 (if (buffer-base-buffer)
3305 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
3306 (let (truename)
3307 (if filename
3308 (setq filename
3309 (if (string-equal filename "")
3310 nil
3311 (expand-file-name filename))))
3312 (if filename
3313 (progn
3314 (setq truename (file-truename filename))
3315 (if find-file-visit-truename
a522e5bf 3316 (setq filename truename))))
cbca0a4b 3317 (if filename
e6d0b67a 3318 (let ((new-name (file-name-nondirectory filename)))
cbca0a4b
RS
3319 (if (string= new-name "")
3320 (error "Empty file name"))))
11e314fa 3321 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 3322 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 3323 (not no-query)
674b7bae
JB
3324 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3325 filename)))
7b89d38e 3326 (error "Aborted")))
a522e5bf
RS
3327 (or (equal filename buffer-file-name)
3328 (progn
3329 (and filename (lock-buffer filename))
3330 (unlock-buffer)))
3331 (setq buffer-file-name filename)
3332 (if filename ; make buffer name reflect filename.
3333 (let ((new-name (file-name-nondirectory buffer-file-name)))
a522e5bf 3334 (setq default-directory (file-name-directory buffer-file-name))
67b6fd1c
SM
3335 ;; If new-name == old-name, renaming would add a spurious <2>
3336 ;; and it's considered as a feature in rename-buffer.
a522e5bf
RS
3337 (or (string= new-name (buffer-name))
3338 (rename-buffer new-name t))))
3339 (setq buffer-backed-up nil)
f36012a6
RS
3340 (or along-with-file
3341 (clear-visited-file-modtime))
8ccdc29e 3342 ;; Abbreviate the file names of the buffer.
4826e97f 3343 (if truename
8ccdc29e
RS
3344 (progn
3345 (setq buffer-file-truename (abbreviate-file-name truename))
3346 (if find-file-visit-truename
b1f1ceb8 3347 (setq buffer-file-name truename))))
a522e5bf
RS
3348 (setq buffer-file-number
3349 (if filename
2a47b4f5 3350 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 3351 nil)))
0370fe77 3352 ;; write-file-functions is normally used for things like ftp-find-file
b4da00e9
RM
3353 ;; that visit things that are not local files as if they were files.
3354 ;; Changing to visit an ordinary local file instead should flush the hook.
0370fe77 3355 (kill-local-variable 'write-file-functions)
c9dca4e0 3356 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
3357 (kill-local-variable 'revert-buffer-function)
3358 (kill-local-variable 'backup-inhibited)
ee81c959
RS
3359 ;; If buffer was read-only because of version control,
3360 ;; that reason is gone now, so make it writable.
3361 (if vc-mode
3362 (setq buffer-read-only nil))
3363 (kill-local-variable 'vc-mode)
b4da00e9
RM
3364 ;; Turn off backup files for certain file names.
3365 ;; Since this is a permanent local, the major mode won't eliminate it.
4d49551a 3366 (and buffer-file-name
b98a8e06 3367 backup-enable-predicate
4d49551a 3368 (not (funcall backup-enable-predicate buffer-file-name))
b4da00e9
RM
3369 (progn
3370 (make-local-variable 'backup-inhibited)
3371 (setq backup-inhibited t)))
c77a81cf
RS
3372 (let ((oauto buffer-auto-save-file-name))
3373 ;; If auto-save was not already on, turn it on if appropriate.
3374 (if (not buffer-auto-save-file-name)
3375 (and buffer-file-name auto-save-default
3376 (auto-save-mode t))
3377 ;; If auto save is on, start using a new name.
3378 ;; We deliberately don't rename or delete the old auto save
3379 ;; for the old visited file name. This is because perhaps
3380 ;; the user wants to save the new state and then compare with the
3381 ;; previous state from the auto save file.
3382 (setq buffer-auto-save-file-name
3383 (make-auto-save-file-name)))
3384 ;; Rename the old auto save file if any.
3385 (and oauto buffer-auto-save-file-name
e6f0e76c 3386 (file-exists-p oauto)
c77a81cf 3387 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
3388 (and buffer-file-name
3389 (not along-with-file)
9de9b6a2
RS
3390 (set-buffer-modified-p t))
3391 ;; Update the major mode, if the file name determines it.
3392 (condition-case nil
3393 ;; Don't change the mode if it is special.
3394 (or (not change-major-mode-with-file-name)
3395 (get major-mode 'mode-class)
3396 ;; Don't change the mode if the local variable list specifies it.
3397 (hack-local-variables t)
3398 (set-auto-mode t))
3399 (error nil)))
b4da00e9 3400
912192d1 3401(defun write-file (filename &optional confirm)
b4da00e9 3402 "Write current buffer into file FILENAME.
7f99999a 3403This makes the buffer visit that file, and marks it as not modified.
7458cc35 3404
7f99999a
KH
3405If you specify just a directory name as FILENAME, that means to use
3406the default file name but in that directory. You can also yank
074eb6ac 3407the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
7f99999a
KH
3408
3409If the buffer is not already visiting a file, the default file name
3410for the output file is the buffer name.
3411
3412If optional second arg CONFIRM is non-nil, this function
3413asks for confirmation before overwriting an existing file.
912192d1 3414Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
3415;; (interactive "FWrite file: ")
3416 (interactive
3417 (list (if buffer-file-name
3418 (read-file-name "Write file: "
f3684505 3419 nil nil nil nil)
7f99999a
KH
3420 (read-file-name "Write file: " default-directory
3421 (expand-file-name
3422 (file-name-nondirectory (buffer-name))
3423 default-directory)
3424 nil nil))
912192d1 3425 (not current-prefix-arg)))
b4da00e9 3426 (or (null filename) (string-equal filename "")
41f48cb1
RS
3427 (progn
3428 ;; If arg is just a directory,
7f99999a
KH
3429 ;; use the default file name, but in that directory.
3430 (if (file-directory-p filename)
41f48cb1 3431 (setq filename (concat (file-name-as-directory filename)
7f99999a
KH
3432 (file-name-nondirectory
3433 (or buffer-file-name (buffer-name))))))
c2fb8488
RS
3434 (and confirm
3435 (file-exists-p filename)
3436 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3437 (error "Canceled")))
5f65549e 3438 (set-visited-file-name filename (not confirm))))
b4da00e9 3439 (set-buffer-modified-p t)
6492b55d
KH
3440 ;; Make buffer writable if file is writable.
3441 (and buffer-file-name
3442 (file-writable-p buffer-file-name)
3443 (setq buffer-read-only nil))
8e5c7b90
SM
3444 (save-buffer)
3445 ;; It's likely that the VC status at the new location is different from
3446 ;; the one at the old location.
3447 (vc-find-file-hook))
b4da00e9
RM
3448\f
3449(defun backup-buffer ()
3450 "Make a backup of the disk file visited by the current buffer, if appropriate.
3451This is normally done before saving the buffer the first time.
27ab6944
KH
3452
3453A backup may be done by renaming or by copying; see documentation of
3454variable `make-backup-files'. If it's done by renaming, then the file is
f3f9e207
RS
3455no longer accessible under its old name.
3456
3457The value is non-nil after a backup was made by renaming.
3458It has the form (MODES . BACKUPNAME).
3459MODES is the result of `file-modes' on the original
3460file; this means that the caller, after saving the buffer, should change
3461the modes of the new file to agree with the old modes.
3462BACKUPNAME is the backup file name, which is the old file renamed."
b4da00e9
RM
3463 (if (and make-backup-files (not backup-inhibited)
3464 (not buffer-backed-up)
3465 (file-exists-p buffer-file-name)
3466 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3467 '(?- ?l)))
3468 (let ((real-file-name buffer-file-name)
3469 backup-info backupname targets setmodes)
3470 ;; If specified name is a symbolic link, chase it to the target.
3471 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 3472 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
3473 (setq backup-info (find-backup-file-name real-file-name)
3474 backupname (car backup-info)
3475 targets (cdr backup-info))
5c6d31a4
SM
3476 ;; (if (file-directory-p buffer-file-name)
3477 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
3478 (if backup-info
3479 (condition-case ()
3480 (let ((delete-old-versions
3481 ;; If have old versions to maybe delete,
3482 ;; ask the user to confirm now, before doing anything.
3483 ;; But don't actually delete til later.
3484 (and targets
3485 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3486 (or delete-old-versions
3487 (y-or-n-p (format "Delete excess backup versions of %s? "
446c63b0
RS
3488 real-file-name)))))
3489 (modes (file-modes buffer-file-name)))
eb650569
RS
3490 ;; Actually write the back up file.
3491 (condition-case ()
3492 (if (or file-precious-flag
ffc0e1ca 3493 ; (file-symlink-p buffer-file-name)
eb650569 3494 backup-by-copying
446c63b0 3495 ;; Don't rename a suid or sgid file.
7da6bf00 3496 (and modes (< 0 (logand modes #o6000)))
79d2d279 3497 (not (file-writable-p (file-name-directory real-file-name)))
eb650569
RS
3498 (and backup-by-copying-when-linked
3499 (> (file-nlinks real-file-name) 1))
ffc0e1ca
AS
3500 (and (or backup-by-copying-when-mismatch
3501 (integerp backup-by-copying-when-privileged-mismatch))
eb650569 3502 (let ((attr (file-attributes real-file-name)))
ffc0e1ca
AS
3503 (and (or backup-by-copying-when-mismatch
3504 (and (integerp (nth 2 attr))
3505 (integerp backup-by-copying-when-privileged-mismatch)
3506 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3507 (or (nth 9 attr)
3508 (not (file-ownership-preserved-p real-file-name)))))))
446c63b0 3509 (backup-buffer-copy real-file-name backupname modes)
eb650569
RS
3510 ;; rename-file should delete old backup.
3511 (rename-file real-file-name backupname t)
446c63b0 3512 (setq setmodes (cons modes backupname)))
eb650569
RS
3513 (file-error
3514 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
3515 (setq backupname (expand-file-name
3516 (convert-standard-filename
3517 "~/%backup%~")))
3518 (message "Cannot write backup file; backing up in %s"
6ba7756e 3519 backupname)
eb650569 3520 (sleep-for 1)
446c63b0 3521 (backup-buffer-copy real-file-name backupname modes)))
eb650569
RS
3522 (setq buffer-backed-up t)
3523 ;; Now delete the old versions, if desired.
3524 (if delete-old-versions
3525 (while targets
3526 (condition-case ()
3527 (delete-file (car targets))
3528 (file-error nil))
3529 (setq targets (cdr targets))))
3530 setmodes)
3531 (file-error nil))))))
b4da00e9 3532
446c63b0 3533(defun backup-buffer-copy (from-name to-name modes)
44dce0fb
RS
3534 (let ((umask (default-file-modes)))
3535 (unwind-protect
3536 (progn
3537 ;; Create temp files with strict access rights. It's easy to
3538 ;; loosen them later, whereas it's impossible to close the
3539 ;; time-window of loose permissions otherwise.
3540 (set-default-file-modes ?\700)
0f39d2c9
MR
3541 (when (condition-case nil
3542 ;; Try to overwrite old backup first.
5b2e628f 3543 (copy-file from-name to-name t t t)
0f39d2c9
MR
3544 (error t))
3545 (while (condition-case nil
3546 (progn
3547 (when (file-exists-p to-name)
3548 (delete-file to-name))
5b2e628f 3549 (copy-file from-name to-name nil t t)
0f39d2c9
MR
3550 nil)
3551 (file-already-exists t))
3552 ;; The file was somehow created by someone else between
3553 ;; `delete-file' and `copy-file', so let's try again.
3554 ;; rms says "I think there is also a possible race
3555 ;; condition for making backup files" (emacs-devel 20070821).
3556 nil)))
44dce0fb
RS
3557 ;; Reset the umask.
3558 (set-default-file-modes umask)))
147fbf70
RS
3559 (and modes
3560 (set-file-modes to-name (logand modes #o1777))))
446c63b0 3561
c3554e95 3562(defun file-name-sans-versions (name &optional keep-backup-version)
ffc0e1ca 3563 "Return file NAME sans backup versions or strings.
b4da00e9 3564This is a separate procedure so your site-init or startup file can
c3554e95
RS
3565redefine it.
3566If the optional argument KEEP-BACKUP-VERSION is non-nil,
3567we do not remove backup version numbers, only true file version numbers."
6eaebaa2 3568 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
3569 (if handler
3570 (funcall handler 'file-name-sans-versions name keep-backup-version)
3571 (substring name 0
7c2fb837
DN
3572 (if keep-backup-version
3573 (length name)
3574 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3575 (string-match "~\\'" name)
3576 (length name)))))))
b4da00e9 3577
cb0cd911 3578(defun file-ownership-preserved-p (file)
ffc0e1ca 3579 "Return t if deleting FILE and rewriting it would preserve the owner."
cb0cd911
RS
3580 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3581 (if handler
3582 (funcall handler 'file-ownership-preserved-p file)
ec5533be 3583 (let ((attributes (file-attributes file)))
306faa42
RS
3584 ;; Return t if the file doesn't exist, since it's true that no
3585 ;; information would be lost by an (attempted) delete and create.
3586 (or (null attributes)
3587 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 3588
20b5d24c
RS
3589(defun file-name-sans-extension (filename)
3590 "Return FILENAME sans final \"extension\".
2531b0c3
EZ
3591The extension, in a file name, is the part that follows the last `.',
3592except that a leading `.', if any, doesn't count."
20b5d24c
RS
3593 (save-match-data
3594 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3595 directory)
2531b0c3
EZ
3596 (if (and (string-match "\\.[^.]*\\'" file)
3597 (not (eq 0 (match-beginning 0))))
20b5d24c 3598 (if (setq directory (file-name-directory filename))
6ee24f1e
RS
3599 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3600 ;; we don't want to expand it.
3601 (concat directory (substring file 0 (match-beginning 0)))
20b5d24c
RS
3602 (substring file 0 (match-beginning 0)))
3603 filename))))
3604
93a2702d
RS
3605(defun file-name-extension (filename &optional period)
3606 "Return FILENAME's final \"extension\".
2531b0c3 3607The extension, in a file name, is the part that follows the last `.',
32483280 3608excluding version numbers and backup suffixes,
2531b0c3 3609except that a leading `.', if any, doesn't count.
93a2702d
RS
3610Return nil for extensionless file names such as `foo'.
3611Return the empty string for file names such as `foo.'.
3612
3613If PERIOD is non-nil, then the returned value includes the period
3614that delimits the extension, and if FILENAME has no extension,
3615the value is \"\"."
3616 (save-match-data
3617 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2531b0c3
EZ
3618 (if (and (string-match "\\.[^.]*\\'" file)
3619 (not (eq 0 (match-beginning 0))))
93a2702d
RS
3620 (substring file (+ (match-beginning 0) (if period 0 1)))
3621 (if period
3622 "")))))
3623
ffc0e1ca
AS
3624(defcustom make-backup-file-name-function nil
3625 "A function to use instead of the default `make-backup-file-name'.
643c985d 3626A value of nil gives the default `make-backup-file-name' behavior.
ffc0e1ca 3627
d5798fa7 3628This could be buffer-local to do something special for specific
ffc0e1ca
AS
3629files. If you define it, you may need to change `backup-file-name-p'
3630and `file-name-sans-versions' too.
3631
3632See also `backup-directory-alist'."
3633 :group 'backup
3634 :type '(choice (const :tag "Default" nil)
3635 (function :tag "Your function")))
3636
3637(defcustom backup-directory-alist nil
3638 "Alist of filename patterns and backup directory names.
3639Each element looks like (REGEXP . DIRECTORY). Backups of files with
3640names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3641relative or absolute. If it is absolute, so that all matching files
3642are backed up into the same directory, the file names in this
3643directory will be the full name of the file backed up with all
3644directory separators changed to `!' to prevent clashes. This will not
3645work correctly if your filesystem truncates the resulting name.
3646
3647For the common case of all backups going into one directory, the alist
3648should contain a single element pairing \".\" with the appropriate
3649directory name.
3650
3651If this variable is nil, or it fails to match a filename, the backup
3652is made in the original file's directory.
3653
3654On MS-DOS filesystems without long names this variable is always
3655ignored."
3656 :group 'backup
dca5e71d 3657 :type '(repeat (cons (regexp :tag "Regexp matching filename")
ffc0e1ca
AS
3658 (directory :tag "Backup directory name"))))
3659
388d6ab5
RS
3660(defun normal-backup-enable-predicate (name)
3661 "Default `backup-enable-predicate' function.
0c2f6dda
RS
3662Checks for files in `temporary-file-directory',
3663`small-temporary-file-directory', and /tmp."
388d6ab5
RS
3664 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3665 name 0 nil)))
3666 ;; Directory is under temporary-file-directory.
3667 (and (not (eq comp t))
3668 (< comp (- (length temporary-file-directory)))))
0c2f6dda
RS
3669 (let ((comp (compare-strings "/tmp" 0 nil
3670 name 0 nil)))
3671 ;; Directory is under /tmp.
3672 (and (not (eq comp t))
3673 (< comp (- (length "/tmp")))))
388d6ab5
RS
3674 (if small-temporary-file-directory
3675 (let ((comp (compare-strings small-temporary-file-directory
3676 0 nil
3677 name 0 nil)))
3678 ;; Directory is under small-temporary-file-directory.
3679 (and (not (eq comp t))
3680 (< comp (- (length small-temporary-file-directory)))))))))
3681
b4da00e9
RM
3682(defun make-backup-file-name (file)
3683 "Create the non-numeric backup file name for FILE.
ffc0e1ca
AS
3684Normally this will just be the file's name with `~' appended.
3685Customization hooks are provided as follows.
3686
3687If the variable `make-backup-file-name-function' is non-nil, its value
3688should be a function which will be called with FILE as its argument;
3689the resulting name is used.
3690
3691Otherwise a match for FILE is sought in `backup-directory-alist'; see
3692the documentation of that variable. If the directory for the backup
3693doesn't exist, it is created."
3694 (if make-backup-file-name-function
3695 (funcall make-backup-file-name-function file)
3696 (if (and (eq system-type 'ms-dos)
3697 (not (msdos-long-file-names)))
3698 (let ((fn (file-name-nondirectory file)))
3699 (concat (file-name-directory file)
3700 (or (and (string-match "\\`[^.]+\\'" fn)
3701 (concat (match-string 0 fn) ".~"))
3702 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3703 (concat (match-string 0 fn) "~")))))
3704 (concat (make-backup-file-name-1 file) "~"))))
3705
3706(defun make-backup-file-name-1 (file)
3707 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3708 (let ((alist backup-directory-alist)
6ba7756e 3709 elt backup-directory abs-backup-directory)
ffc0e1ca
AS
3710 (while alist
3711 (setq elt (pop alist))
3712 (if (string-match (car elt) file)
3713 (setq backup-directory (cdr elt)
3714 alist nil)))
eb0455ab
RS
3715 ;; If backup-directory is relative, it should be relative to the
3716 ;; file's directory. By expanding explicitly here, we avoid
3717 ;; depending on default-directory.
3718 (if backup-directory
6ba7756e
RS
3719 (setq abs-backup-directory
3720 (expand-file-name backup-directory
3721 (file-name-directory file))))
3722 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
ffc0e1ca 3723 (condition-case nil
6ba7756e
RS
3724 (make-directory abs-backup-directory 'parents)
3725 (file-error (setq backup-directory nil
3726 abs-backup-directory nil))))
ee291b46
RS
3727 (if (null backup-directory)
3728 file
ffc0e1ca
AS
3729 (if (file-name-absolute-p backup-directory)
3730 (progn
c60ee5e7 3731 (when (memq system-type '(windows-nt ms-dos cygwin))
d7b6ca4a
RS
3732 ;; Normalize DOSish file names: downcase the drive
3733 ;; letter, if any, and replace the leading "x:" with
3734 ;; "/drive_x".
ffc0e1ca
AS
3735 (or (file-name-absolute-p file)
3736 (setq file (expand-file-name file))) ; make defaults explicit
3737 ;; Replace any invalid file-name characters (for the
3738 ;; case of backing up remote files).
446c097e 3739 (setq file (expand-file-name (convert-standard-filename file)))
ffc0e1ca 3740 (if (eq (aref file 1) ?:)
d7b6ca4a 3741 (setq file (concat "/"
ffc0e1ca
AS
3742 "drive_"
3743 (char-to-string (downcase (aref file 0)))
d7b6ca4a 3744 (if (eq (aref file 2) ?/)
ffc0e1ca 3745 ""
d7b6ca4a 3746 "/")
ffc0e1ca
AS
3747 (substring file 2)))))
3748 ;; Make the name unique by substituting directory
3749 ;; separators. It may not really be worth bothering about
3750 ;; doubling `!'s in the original name...
3751 (expand-file-name
3752 (subst-char-in-string
d7b6ca4a 3753 ?/ ?!
ffc0e1ca
AS
3754 (replace-regexp-in-string "!" "!!" file))
3755 backup-directory))
3756 (expand-file-name (file-name-nondirectory file)
6ba7756e 3757 (file-name-as-directory abs-backup-directory))))))
b4da00e9
RM
3758
3759(defun backup-file-name-p (file)
3760 "Return non-nil if FILE is a backup file name (numeric or not).
3761This is a separate function so you can redefine it for customization.
3762You may need to redefine `file-name-sans-versions' as well."
066327ae 3763 (string-match "~\\'" file))
b4da00e9 3764
e2b30772
RS
3765(defvar backup-extract-version-start)
3766
2d051399 3767;; This is used in various files.
a7aa942a
KH
3768;; The usage of backup-extract-version-start is not very clean,
3769;; but I can't see a good alternative, so as of now I am leaving it alone.
2d051399 3770(defun backup-extract-version (fn)
ffc0e1ca 3771 "Given the name of a numeric backup file, FN, return the backup number.
e2b30772 3772Uses the free variable `backup-extract-version-start', whose value should be
2d051399 3773the index in the name where the version number begins."
6cf29fe8 3774 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
e2b30772 3775 (= (match-beginning 0) backup-extract-version-start))
027a4b6b 3776 (string-to-number (substring fn backup-extract-version-start -1))
2d051399
RS
3777 0))
3778
b4da00e9 3779(defun find-backup-file-name (fn)
ffc0e1ca 3780 "Find a file name for a backup file FN, and suggestions for deletions.
b4da00e9 3781Value is a list whose car is the name for the backup file
ffc0e1ca
AS
3782and whose cdr is a list of old versions to consider deleting now.
3783If the value is nil, don't make a backup.
3784Uses `backup-directory-alist' in the same way as does
3785`make-backup-file-name'."
eb650569
RS
3786 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3787 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3788 (if handler
3789 (funcall handler 'find-backup-file-name fn)
f26d858e
EZ
3790 (if (or (eq version-control 'never)
3791 ;; We don't support numbered backups on plain MS-DOS
3792 ;; when long file names are unavailable.
3793 (and (eq system-type 'ms-dos)
3794 (not (msdos-long-file-names))))
b4da00e9 3795 (list (make-backup-file-name fn))
ffc0e1ca
AS
3796 (let* ((basic-name (make-backup-file-name-1 fn))
3797 (base-versions (concat (file-name-nondirectory basic-name)
3798 ".~"))
e2b30772 3799 (backup-extract-version-start (length base-versions))
eb650569 3800 (high-water-mark 0)
ffc0e1ca
AS
3801 (number-to-delete 0)
3802 possibilities deserve-versions-p versions)
eb650569
RS
3803 (condition-case ()
3804 (setq possibilities (file-name-all-completions
3805 base-versions
ffc0e1ca
AS
3806 (file-name-directory basic-name))
3807 versions (sort (mapcar #'backup-extract-version
3808 possibilities)
3809 #'<)
eb650569
RS
3810 high-water-mark (apply 'max 0 versions)
3811 deserve-versions-p (or version-control
3812 (> high-water-mark 0))
3813 number-to-delete (- (length versions)
ffc0e1ca
AS
3814 kept-old-versions
3815 kept-new-versions
3816 -1))
3817 (file-error (setq possibilities nil)))
eb650569 3818 (if (not deserve-versions-p)
8767d866 3819 (list (make-backup-file-name fn))
ffc0e1ca 3820 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
eb650569
RS
3821 (if (and (> number-to-delete 0)
3822 ;; Delete nothing if there is overflow
3823 ;; in the number of versions to keep.
3824 (>= (+ kept-new-versions kept-old-versions -1) 0))
ffc0e1ca
AS
3825 (mapcar (lambda (n)
3826 (format "%s.~%d~" basic-name n))
eb650569
RS
3827 (let ((v (nthcdr kept-old-versions versions)))
3828 (rplacd (nthcdr (1- number-to-delete) v) ())
3829 v))))))))))
b4da00e9 3830
b4da00e9
RM
3831(defun file-nlinks (filename)
3832 "Return number of names file FILENAME has."
3833 (car (cdr (file-attributes filename))))
6c636af9 3834
753ad988
KG
3835;; (defun file-relative-name (filename &optional directory)
3836;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3837;; This function returns a relative file name which is equivalent to FILENAME
3838;; when used with that default directory as the default.
3839;; If this is impossible (which can happen on MSDOS and Windows
3840;; when the file name and directory use different drive names)
3841;; then it returns FILENAME."
3842;; (save-match-data
3843;; (let ((fname (expand-file-name filename)))
3844;; (setq directory (file-name-as-directory
3845;; (expand-file-name (or directory default-directory))))
3846;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3847;; ;; drive names, they can't be relative, so return the absolute name.
3848;; (if (and (or (eq system-type 'ms-dos)
3849;; (eq system-type 'cygwin)
3850;; (eq system-type 'windows-nt))
3851;; (not (string-equal (substring fname 0 2)
3852;; (substring directory 0 2))))
3853;; filename
3854;; (let ((ancestor ".")
3855;; (fname-dir (file-name-as-directory fname)))
3856;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3857;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3858;; (setq directory (file-name-directory (substring directory 0 -1))
3859;; ancestor (if (equal ancestor ".")
3860;; ".."
3861;; (concat "../" ancestor))))
3862;; ;; Now ancestor is empty, or .., or ../.., etc.
3863;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3864;; ;; We matched within FNAME's directory part.
3865;; ;; Add the rest of FNAME onto ANCESTOR.
3866;; (let ((rest (substring fname (match-end 0))))
3867;; (if (and (equal ancestor ".")
3868;; (not (equal rest "")))
3869;; ;; But don't bother with ANCESTOR if it would give us `./'.
3870;; rest
3871;; (concat (file-name-as-directory ancestor) rest)))
3872;; ;; We matched FNAME's directory equivalent.
3873;; ancestor))))))
3874
6c636af9 3875(defun file-relative-name (filename &optional directory)
ffc0e1ca 3876 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2d6562a5
RS
3877This function returns a relative file name which is equivalent to FILENAME
3878when used with that default directory as the default.
753ad988 3879If FILENAME and DIRECTORY lie on different machines or on different drives
1be0210d 3880on a DOS/Windows machine, it returns FILENAME in expanded form."
96c188b0 3881 (save-match-data
753ad988
KG
3882 (setq directory
3883 (file-name-as-directory (expand-file-name (or directory
3884 default-directory))))
3885 (setq filename (expand-file-name filename))
3f788773
KG
3886 (let ((fremote (file-remote-p filename))
3887 (dremote (file-remote-p directory)))
493c98af
KG
3888 (if ;; Conditions for separate trees
3889 (or
3890 ;; Test for different drives on DOS/Windows
3891 (and
7c64272b 3892 ;; Should `cygwin' really be included here? --stef
493c98af 3893 (memq system-type '(ms-dos cygwin windows-nt))
7c64272b 3894 (not (eq t (compare-strings filename 0 2 directory 0 2))))
493c98af 3895 ;; Test for different remote file system identification
3f788773 3896 (not (equal fremote dremote)))
e2b30772 3897 filename
753ad988
KG
3898 (let ((ancestor ".")
3899 (filename-dir (file-name-as-directory filename)))
7c64272b
SM
3900 (while (not
3901 (or
3902 (eq t (compare-strings filename-dir nil (length directory)
3903 directory nil nil case-fold-search))
3904 (eq t (compare-strings filename nil (length directory)
3905 directory nil nil case-fold-search))))
753ad988 3906 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
3907 ancestor (if (equal ancestor ".")
3908 ".."
3909 (concat "../" ancestor))))
753ad988 3910 ;; Now ancestor is empty, or .., or ../.., etc.
7c64272b
SM
3911 (if (eq t (compare-strings filename nil (length directory)
3912 directory nil nil case-fold-search))
753ad988
KG
3913 ;; We matched within FILENAME's directory part.
3914 ;; Add the rest of FILENAME onto ANCESTOR.
3f7d6528 3915 (let ((rest (substring filename (length directory))))
753ad988 3916 (if (and (equal ancestor ".") (not (equal rest "")))
9695aac6
RS
3917 ;; But don't bother with ANCESTOR if it would give us `./'.
3918 rest
3919 (concat (file-name-as-directory ancestor) rest)))
753ad988
KG
3920 ;; We matched FILENAME's directory equivalent.
3921 ancestor))))))
b4da00e9
RM
3922\f
3923(defun save-buffer (&optional args)
e8f4db18
RS
3924 "Save current buffer in visited file if modified.
3925Variations are described below.
3926
b4da00e9
RM
3927By default, makes the previous version into a backup file
3928 if previously requested or if this is the first save.
dc2ab26e 3929Prefixed with one \\[universal-argument], marks this version
b4da00e9 3930 to become a backup when the next save is done.
dc2ab26e 3931Prefixed with two \\[universal-argument]'s,
b4da00e9 3932 unconditionally makes the previous version into a backup file.
dc2ab26e 3933Prefixed with three \\[universal-argument]'s, marks this version
ac9650be
RS
3934 to become a backup when the next save is done,
3935 and unconditionally makes the previous version into a backup file.
3936
dc2ab26e
EZ
3937With a numeric argument of 0, never make the previous version
3938into a backup file.
b4da00e9
RM
3939
3940If a file's name is FOO, the names of its numbered backup versions are
3941 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3942Numeric backups (rather than FOO~) will be made if value of
3943 `version-control' is not the atom `never' and either there are already
3944 numeric versions of the file being backed up, or `version-control' is
3945 non-nil.
3946We don't want excessive versions piling up, so there are variables
3947 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3948 and `kept-new-versions', which tells how many newest versions to keep.
3949 Defaults are 2 old versions and 2 new.
3950`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 3951If `delete-old-versions' is nil, system will query user
e73ec04b
RS
3952 before trimming versions. Otherwise it does it silently.
3953
749d2ee6
RS
3954If `vc-make-backup-files' is nil, which is the default,
3955 no backup files are made for files managed by version control.
3956 (This is because the version control system itself records previous versions.)
3957
e73ec04b 3958See the subroutine `basic-save-buffer' for more information."
b4da00e9
RM
3959 (interactive "p")
3960 (let ((modp (buffer-modified-p))
3961 (large (> (buffer-size) 50000))
b5a8e0fc
RS
3962 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3963 (memq args '(16 64)))))
b4da00e9 3964 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
b4990dde
GM
3965 (if (and modp large (buffer-file-name))
3966 (message "Saving file %s..." (buffer-file-name)))
b4da00e9
RM
3967 (basic-save-buffer)
3968 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3969
3970(defun delete-auto-save-file-if-necessary (&optional force)
3971 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3972Normally delete only if the file was written by this Emacs since
3973the last real save, but optional arg FORCE non-nil means delete anyway."
3974 (and buffer-auto-save-file-name delete-auto-save-files
3975 (not (string= buffer-file-name buffer-auto-save-file-name))
3976 (or force (recent-auto-save-p))
3977 (progn
3978 (condition-case ()
3979 (delete-file buffer-auto-save-file-name)
3980 (file-error nil))
3981 (set-buffer-auto-saved))))
3982
481f215b
KH
3983(defvar auto-save-hook nil
3984 "Normal hook run just before auto-saving.")
3985
3c3b81d1
SJ
3986(defcustom before-save-hook nil
3987 "Normal hook that is run before a buffer is saved to its file."
25f6295e 3988 :options '(copyright-update time-stamp)
3c3b81d1
SJ
3989 :type 'hook
3990 :group 'files)
3991
ffc0e1ca
AS
3992(defcustom after-save-hook nil
3993 "Normal hook that is run after a buffer is saved to its file."
3994 :options '(executable-make-buffer-file-executable-if-script-p)
3995 :type 'hook
3996 :group 'files)
1cc852cc 3997
0516edee
RS
3998(defvar save-buffer-coding-system nil
3999 "If non-nil, use this coding system for saving the buffer.
4000More precisely, use this coding system in place of the
4001value of `buffer-file-coding-system', when saving the buffer.
4002Calling `write-region' for any purpose other than saving the buffer
4003will still use `buffer-file-coding-system'; this variable has no effect
4004in such cases.")
4005
d5fe94cc
RS
4006(make-variable-buffer-local 'save-buffer-coding-system)
4007(put 'save-buffer-coding-system 'permanent-local t)
4008
b4da00e9 4009(defun basic-save-buffer ()
1cc852cc 4010 "Save the current buffer in its visited file, if it has been modified.
0370fe77
SM
4011The hooks `write-contents-functions' and `write-file-functions' get a chance
4012to do the job of saving; if they do not, then the buffer is saved in
222cf381 4013the visited file in the usual way.
3c3b81d1
SJ
4014Before and after saving the buffer, this function runs
4015`before-save-hook' and `after-save-hook', respectively."
b4da00e9 4016 (interactive)
19618231 4017 (save-current-buffer
c11a94fe
RS
4018 ;; In an indirect buffer, save its base buffer instead.
4019 (if (buffer-base-buffer)
4020 (set-buffer (buffer-base-buffer)))
4021 (if (buffer-modified-p)
4022 (let ((recent-save (recent-auto-save-p))
818286f4 4023 setmodes)
c11a94fe
RS
4024 ;; If buffer has no file name, ask user for one.
4025 (or buffer-file-name
182891ef
RS
4026 (let ((filename
4027 (expand-file-name
4028 (read-file-name "File to save in: ") nil)))
8400146f
MR
4029 (if (file-exists-p filename)
4030 (if (file-directory-p filename)
4031 ;; Signal an error if the user specified the name of an
4032 ;; existing directory.
4033 (error "%s is a directory" filename)
4034 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4035 filename))
4036 (error "Canceled")))
4037 ;; Signal an error if the specified name refers to a
4038 ;; non-existing directory.
4039 (let ((dir (file-name-directory filename)))
4040 (unless (file-directory-p dir)
4041 (if (file-exists-p dir)
4042 (error "%s is not a directory" dir)
4043 (error "%s: no such directory" dir)))))
182891ef 4044 (set-visited-file-name filename)))
c11a94fe
RS
4045 (or (verify-visited-file-modtime (current-buffer))
4046 (not (file-exists-p buffer-file-name))
4047 (yes-or-no-p
4048 (format "%s has changed since visited or saved. Save anyway? "
4049 (file-name-nondirectory buffer-file-name)))
4050 (error "Save not confirmed"))
4051 (save-restriction
4052 (widen)
19618231 4053 (save-excursion
0370fe77 4054 (and (> (point-max) (point-min))
407b4328 4055 (not find-file-literally)
19618231
RS
4056 (/= (char-after (1- (point-max))) ?\n)
4057 (not (and (eq selective-display t)
4058 (= (char-after (1- (point-max))) ?\r)))
4059 (or (eq require-final-newline t)
f4206092 4060 (eq require-final-newline 'visit-save)
19618231
RS
4061 (and require-final-newline
4062 (y-or-n-p
4063 (format "Buffer %s does not end in newline. Add one? "
4064 (buffer-name)))))
4065 (save-excursion
4066 (goto-char (point-max))
4067 (insert ?\n))))
fa5867f6
AS
4068 ;; Support VC version backups.
4069 (vc-before-save)
3c3b81d1 4070 (run-hooks 'before-save-hook)
0370fe77 4071 (or (run-hook-with-args-until-success 'write-contents-functions)
c11a94fe 4072 (run-hook-with-args-until-success 'local-write-file-hooks)
0370fe77 4073 (run-hook-with-args-until-success 'write-file-functions)
0ba5894b
RS
4074 ;; If a hook returned t, file is already "written".
4075 ;; Otherwise, write it the usual way now.
4076 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
4077 ;; Now we have saved the current buffer. Let's make sure
4078 ;; that buffer-file-coding-system is fixed to what
4079 ;; actually used for saving by binding it locally.
0516edee
RS
4080 (if save-buffer-coding-system
4081 (setq save-buffer-coding-system last-coding-system-used)
4082 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
4083 (setq buffer-file-number
4084 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
4085 (if setmodes
4086 (condition-case ()
f3f9e207 4087 (set-file-modes buffer-file-name (car setmodes))
c11a94fe
RS
4088 (error nil))))
4089 ;; If the auto-save file was recent before this command,
4090 ;; delete it now.
4091 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
4092 ;; Support VC `implicit' locking.
4093 (vc-after-save)
c11a94fe
RS
4094 (run-hooks 'after-save-hook))
4095 (message "(No changes need to be saved)"))))
b4da00e9 4096
87d26afc
RS
4097;; This does the "real job" of writing a buffer into its visited file
4098;; and making a backup file. This is what is normally done
0370fe77 4099;; but inhibited if one of write-file-functions returns non-nil.
f3f9e207 4100;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
87d26afc 4101(defun basic-save-buffer-1 ()
969be033
RS
4102 (prog1
4103 (if save-buffer-coding-system
4104 (let ((coding-system-for-write save-buffer-coding-system))
4105 (basic-save-buffer-2))
d5fe94cc 4106 (basic-save-buffer-2))
969be033 4107 (setq buffer-file-coding-system-explicit last-coding-system-used)))
d5fe94cc 4108
f3f9e207 4109;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
d5fe94cc
RS
4110(defun basic-save-buffer-2 ()
4111 (let (tempsetmodes setmodes)
87d26afc
RS
4112 (if (not (file-writable-p buffer-file-name))
4113 (let ((dir (file-name-directory buffer-file-name)))
4114 (if (not (file-directory-p dir))
83c6f446
RS
4115 (if (file-exists-p dir)
4116 (error "%s is not a directory" dir)
87c60260 4117 (error "%s: no such directory" dir))
87d26afc
RS
4118 (if (not (file-exists-p buffer-file-name))
4119 (error "Directory %s write-protected" dir)
4120 (if (yes-or-no-p
4121 (format "File %s is write-protected; try to save anyway? "
4122 (file-name-nondirectory
4123 buffer-file-name)))
4124 (setq tempsetmodes t)
4125 (error "Attempt to save to a file which you aren't allowed to write"))))))
4126 (or buffer-backed-up
4127 (setq setmodes (backup-buffer)))
76d5492b 4128 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
4129 (if (and file-precious-flag
4130 (file-writable-p dir))
4131 ;; If file is precious, write temp name, then rename it.
4132 ;; This requires write access to the containing dir,
4133 ;; which is why we don't try it if we don't have that access.
4134 (let ((realname buffer-file-name)
44dce0fb
RS
4135 tempname succeed
4136 (umask (default-file-modes))
6782610c 4137 (old-modtime (visited-file-modtime)))
44dce0fb
RS
4138 ;; Create temp files with strict access rights. It's easy to
4139 ;; loosen them later, whereas it's impossible to close the
4140 ;; time-window of loose permissions otherwise.
f4a0f59b 4141 (unwind-protect
44dce0fb
RS
4142 (progn
4143 (clear-visited-file-modtime)
4144 (set-default-file-modes ?\700)
4145 ;; Try various temporary names.
4146 ;; This code follows the example of make-temp-file,
4147 ;; but it calls write-region in the appropriate way
4148 ;; for saving the buffer.
4149 (while (condition-case ()
4150 (progn
4151 (setq tempname
4152 (make-temp-name
4153 (expand-file-name "tmp" dir)))
6b3d752c
SM
4154 ;; Pass in nil&nil rather than point-min&max
4155 ;; cause we're saving the whole buffer.
4156 ;; write-region-annotate-functions may use it.
4157 (write-region nil nil
44dce0fb
RS
4158 tempname nil realname
4159 buffer-file-truename 'excl)
4160 nil)
4161 (file-already-exists t))
4162 ;; The file was somehow created by someone else between
4163 ;; `make-temp-name' and `write-region', let's try again.
4164 nil)
4165 (setq succeed t))
4166 ;; Reset the umask.
4167 (set-default-file-modes umask)
4168 ;; If we failed, restore the buffer's modtime.
4169 (unless succeed
4170 (set-visited-file-modtime old-modtime)))
4171 ;; Since we have created an entirely new file,
4172 ;; make sure it gets the right permission bits set.
730df8db 4173 (setq setmodes (or setmodes
562ca538
RS
4174 (cons (or (file-modes buffer-file-name)
4175 (logand ?\666 umask))
730df8db 4176 buffer-file-name)))
f4a0f59b
RS
4177 ;; We succeeded in writing the temp file,
4178 ;; so rename it.
4179 (rename-file tempname buffer-file-name t))
4180 ;; If file not writable, see if we can make it writable
4181 ;; temporarily while we write it.
4182 ;; But no need to do so if we have just backed it up
4183 ;; (setmodes is set) because that says we're superseding.
4184 (cond ((and tempsetmodes (not setmodes))
4185 ;; Change the mode back, after writing.
f3f9e207
RS
4186 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
4187 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
4188 (let (success)
4189 (unwind-protect
4190 (progn
6b3d752c
SM
4191 ;; Pass in nil&nil rather than point-min&max to indicate
4192 ;; we're saving the buffer rather than just a region.
4193 ;; write-region-annotate-functions may make us of it.
4194 (write-region nil nil
f3f9e207
RS
4195 buffer-file-name nil t buffer-file-truename)
4196 (setq success t))
4197 ;; If we get an error writing the new file, and we made
4198 ;; the backup by renaming, undo the backing-up.
4199 (and setmodes (not success)
0133dab9
EZ
4200 (progn
4201 (rename-file (cdr setmodes) buffer-file-name t)
4202 (setq buffer-backed-up nil)))))))
87d26afc
RS
4203 setmodes))
4204
1eeae2a1
RS
4205(defun diff-buffer-with-file (&optional buffer)
4206 "View the differences between BUFFER and its associated file.
0b9e4749 4207This requires the external program `diff' to be in your `exec-path'."
1eeae2a1 4208 (interactive "bBuffer: ")
0b9e4749 4209 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4e4e9519
MR
4210 (if (and buffer-file-name
4211 (file-exists-p buffer-file-name))
4212 (let ((tempfile (make-temp-file "buffer-content-")))
4213 (unwind-protect
ab1d3835
SM
4214 (progn
4215 (write-region nil nil tempfile nil 'nomessage)
4e4e9519
MR
4216 (diff buffer-file-name tempfile nil t)
4217 (sit-for 0))
4218 (when (file-exists-p tempfile)
4219 (delete-file tempfile))))
4220 (message "Buffer %s has no associated file on disc" (buffer-name))
4221 ;; Display that message for 1 second so that user can read it
4222 ;; in the minibuffer.
4223 (sit-for 1)))
4224 ;; return always nil, so that save-buffers-kill-emacs will not move
4225 ;; over to the next unsaved buffer when calling `d'.
4226 nil)
1eeae2a1
RS
4227
4228(defvar save-some-buffers-action-alist
9b106871
SM
4229 `((?\C-r
4230 ,(lambda (buf)
4231 (if (not enable-recursive-minibuffers)
4232 (progn (display-buffer buf)
4233 (setq other-window-scroll-buffer buf))
4234 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4235 (recursive-edit))
4236 ;; Return nil to ask about BUF again.
4237 nil)
5c471b12 4238 "view this buffer")
9b106871
SM
4239 (?d ,(lambda (buf)
4240 (if (null buffer-file-name)
4241 (message "Not applicable: no file")
4242 (save-window-excursion (diff-buffer-with-file buf))
4243 (if (not enable-recursive-minibuffers)
4244 (progn (display-buffer (get-buffer-create "*Diff*"))
4245 (setq other-window-scroll-buffer "*Diff*"))
4246 (view-buffer (get-buffer-create "*Diff*")
4247 (lambda (_) (exit-recursive-edit)))
4248 (recursive-edit)))
4249 ;; Return nil to ask about BUF again.
4250 nil)
5c471b12 4251 "view changes in this buffer"))
1eeae2a1 4252 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
1eeae2a1 4253
a1b0c2a7
RS
4254(defvar buffer-save-without-query nil
4255 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4256(make-variable-buffer-local 'buffer-save-without-query)
4257
ffc0e1ca 4258(defun save-some-buffers (&optional arg pred)
b4da00e9 4259 "Save some modified file-visiting buffers. Asks user about each one.
1eeae2a1
RS
4260You can answer `y' to save, `n' not to save, `C-r' to look at the
4261buffer in question with `view-buffer' before deciding or `d' to
126c9dda 4262view the differences using `diff-buffer-with-file'.
8fd9c174 4263
5bbbceb1 4264Optional argument (the prefix) non-nil means save all with no questions.
ffc0e1ca
AS
4265Optional second argument PRED determines which buffers are considered:
4266If PRED is nil, all the file-visiting buffers are considered.
4267If PRED is t, then certain non-file buffers will also be considered.
4268If PRED is a zero-argument function, it indicates for each buffer whether
1eeae2a1
RS
4269to consider it or not when called with that buffer current.
4270
4271See `save-some-buffers-action-alist' if you want to
4272change the additional actions you can take on files."
b4da00e9 4273 (interactive "P")
907482b9 4274 (save-window-excursion
a1b0c2a7
RS
4275 (let* (queried some-automatic
4276 files-done abbrevs-done)
4277 (dolist (buffer (buffer-list))
4278 ;; First save any buffers that we're supposed to save unconditionally.
4279 ;; That way the following code won't ask about them.
4280 (with-current-buffer buffer
4281 (when (and buffer-save-without-query (buffer-modified-p))
4282 (setq some-automatic t)
4283 (save-buffer))))
4284 ;; Ask about those buffers that merit it,
4285 ;; and record the number thus saved.
4286 (setq files-done
76d5492b 4287 (map-y-or-n-p
9b106871
SM
4288 (lambda (buffer)
4289 (and (buffer-modified-p buffer)
4290 (not (buffer-base-buffer buffer))
4291 (or
4292 (buffer-file-name buffer)
4293 (and pred
4294 (progn
4295 (set-buffer buffer)
4296 (and buffer-offer-save (> (buffer-size) 0)))))
4297 (or (not (functionp pred))
4298 (with-current-buffer buffer (funcall pred)))
4299 (if arg
4300 t
4301 (setq queried t)
4302 (if (buffer-file-name buffer)
4303 (format "Save file %s? "
4304 (buffer-file-name buffer))
4305 (format "Save buffer %s? "
4306 (buffer-name buffer))))))
4307 (lambda (buffer)
4308 (with-current-buffer buffer
4309 (save-buffer)))
4310 (buffer-list)
76d5492b 4311 '("buffer" "buffers" "save")
1eeae2a1 4312 save-some-buffers-action-alist))
bf247b6e 4313 ;; Maybe to save abbrevs, and record whether
a1b0c2a7
RS
4314 ;; we either saved them or asked to.
4315 (and save-abbrevs abbrevs-changed
4316 (progn
4317 (if (or arg
4318 (eq save-abbrevs 'silently)
4319 (y-or-n-p (format "Save abbrevs in %s? "
4320 abbrev-file-name)))
4321 (write-abbrev-file nil))
4322 ;; Don't keep bothering user if he says no.
4323 (setq abbrevs-changed nil)
4324 (setq abbrevs-done t)))
76d5492b 4325 (or queried (> files-done 0) abbrevs-done
a1b0c2a7
RS
4326 (message (if some-automatic
4327 "(Some special files were saved without asking)"
4328 "(No files need saving)"))))))
b4da00e9
RM
4329\f
4330(defun not-modified (&optional arg)
4331 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
4332With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
4333
4334It is not a good idea to use this function in Lisp programs, because it
4335prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
4336 (interactive "P")
4337 (message (if arg "Modification-flag set"
4338 "Modification-flag cleared"))
4339 (set-buffer-modified-p arg))
4340
4341(defun toggle-read-only (&optional arg)
4342 "Change whether this buffer is visiting its file read-only.
4837b516
GM
4343With prefix argument ARG, make the buffer read-only if ARG is
4344positive, otherwise make it writable. If visiting file read-only
4345and `view-read-only' is non-nil, enter view mode."
b4da00e9 4346 (interactive "P")
c60ee5e7 4347 (if (and arg
d758359d
AS
4348 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4349 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4350 nil ; do nothing.
4351 ;; Toggle.
4352 (cond
4353 ((and buffer-read-only view-mode)
4354 (View-exit-and-edit)
4355 (make-local-variable 'view-read-only)
4356 (setq view-read-only t)) ; Must leave view mode.
4357 ((and (not buffer-read-only) view-read-only
818286f4
SM
4358 ;; If view-mode is already active, `view-mode-enter' is a nop.
4359 (not view-mode)
d758359d
AS
4360 (not (eq (get major-mode 'mode-class) 'special)))
4361 (view-mode-enter))
4362 (t (setq buffer-read-only (not buffer-read-only))
4363 (force-mode-line-update)))
4364 (if (vc-backend buffer-file-name)
8a26c165 4365 (message "%s" (substitute-command-keys
a5dd5f60
RS
4366 (concat "File is under version-control; "
4367 "use \\[vc-next-action] to check in/out"))))))
b4da00e9 4368
912192d1 4369(defun insert-file (filename)
b4da00e9
RM
4370 "Insert contents of file FILENAME into buffer after point.
4371Set mark after the inserted text.
4372
4373This function is meant for the user to run interactively.
4374Don't call it from programs! Use `insert-file-contents' instead.
4375\(Its calling sequence is different; see its documentation)."
912192d1 4376 (interactive "*fInsert file: ")
3a64a3cf 4377 (insert-file-1 filename #'insert-file-contents))
b4da00e9 4378
912192d1 4379(defun append-to-file (start end filename)
b4da00e9
RM
4380 "Append the contents of the region to the end of file FILENAME.
4381When called from a function, expects three arguments,
4382START, END and FILENAME. START and END are buffer positions
da30bf98 4383saying what text to write."
912192d1
KH
4384 (interactive "r\nFAppend to file: ")
4385 (write-region start end filename t))
b4da00e9
RM
4386
4387(defun file-newest-backup (filename)
4388 "Return most recent backup file for FILENAME or nil if no backups exist."
ffc0e1ca
AS
4389 ;; `make-backup-file-name' will get us the right directory for
4390 ;; ordinary or numeric backups. It might create a directory for
4391 ;; backups as a side-effect, according to `backup-directory-alist'.
e31cfca5 4392 (let* ((filename (file-name-sans-versions
783bf210 4393 (make-backup-file-name (expand-file-name filename))))
b4da00e9
RM
4394 (file (file-name-nondirectory filename))
4395 (dir (file-name-directory filename))
4396 (comp (file-name-all-completions file dir))
cf7e94a0
RS
4397 (newest nil)
4398 tem)
b4da00e9 4399 (while comp
ffc0e1ca 4400 (setq tem (pop comp))
cf7e94a0
RS
4401 (cond ((and (backup-file-name-p tem)
4402 (string= (file-name-sans-versions tem) file))
4403 (setq tem (concat dir tem))
4404 (if (or (null newest)
4405 (file-newer-than-file-p tem newest))
4406 (setq newest tem)))))
b4da00e9
RM
4407 newest))
4408
4409(defun rename-uniquely ()
4410 "Rename current buffer to a similar name not already taken.
4411This function is useful for creating multiple shell process buffers
4412or multiple mail buffers, etc."
4413 (interactive)
40eb8038 4414 (save-match-data
e0df3aef
KH
4415 (let ((base-name (buffer-name)))
4416 (and (string-match "<[0-9]+>\\'" base-name)
4417 (not (and buffer-file-name
4418 (string= base-name
4419 (file-name-nondirectory buffer-file-name))))
4420 ;; If the existing buffer name has a <NNN>,
4421 ;; which isn't part of the file name (if any),
4422 ;; then get rid of that.
4423 (setq base-name (substring base-name 0 (match-beginning 0))))
4424 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 4425 (force-mode-line-update))))
5bbbceb1 4426
4e43240a 4427(defun make-directory (dir &optional parents)
5ce8bb89 4428 "Create the directory DIR and any nonexistent parent dirs.
ae0ece90 4429If DIR already exists as a directory, signal an error, unless PARENTS is set.
789cb0f9 4430
5ce8bb89
RS
4431Interactively, the default choice of directory to create
4432is the current default directory for file names.
0225ae5e 4433That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
4434
4435Noninteractively, the second (optional) argument PARENTS says whether
07703430
RS
4436to create parent directories if they don't exist. Interactively,
4437this happens by default."
5ce8bb89
RS
4438 (interactive
4439 (list (read-file-name "Make directory: " default-directory default-directory
4440 nil nil)
4441 t))
ee291b46
RS
4442 ;; If default-directory is a remote directory,
4443 ;; make sure we find its make-directory handler.
4444 (setq dir (expand-file-name dir))
6eaebaa2 4445 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
4446 (if handler
4447 (funcall handler 'make-directory dir parents)
4448 (if (not parents)
4449 (make-directory-internal dir)
4450 (let ((dir (directory-file-name (expand-file-name dir)))
4451 create-list)
4452 (while (not (file-exists-p dir))
76d5492b 4453 (setq create-list (cons dir create-list)
4e43240a
RS
4454 dir (directory-file-name (file-name-directory dir))))
4455 (while create-list
4456 (make-directory-internal (car create-list))
4457 (setq create-list (cdr create-list))))))))
b4da00e9
RM
4458\f
4459(put 'revert-buffer-function 'permanent-local t)
4460(defvar revert-buffer-function nil
0973d78b
RS
4461 "Function to use to revert this buffer, or nil to do the default.
4462The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4463which are the arguments that `revert-buffer' received.")
b4da00e9
RM
4464
4465(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4466(defvar revert-buffer-insert-file-contents-function nil
4467 "Function to use to insert contents when reverting this buffer.
4468Gets two args, first the nominal file name to use,
2df32500
RS
4469and second, t if reading the auto-save file.
4470
4471The function you specify is responsible for updating (or preserving) point.")
b4da00e9 4472
b0dc9757
LT
4473(defvar buffer-stale-function nil
4474 "Function to check whether a non-file buffer needs reverting.
4475This should be a function with one optional argument NOCONFIRM.
44dce0fb 4476Auto Revert Mode passes t for NOCONFIRM. The function should return
8b0b6932
LT
4477non-nil if the buffer should be reverted. A return value of
4478`fast' means that the need for reverting was not checked, but
4479that reverting the buffer is fast. The buffer is current when
4480this function is called.
b0dc9757 4481
4f8453ae
LT
4482The idea behind the NOCONFIRM argument is that it should be
4483non-nil if the buffer is going to be reverted without asking the
4484user. In such situations, one has to be careful with potentially
c90dcdd5
LT
4485time consuming operations.
4486
4487For more information on how this variable is used by Auto Revert mode,
b3a59350 4488see Info node `(emacs)Supporting additional buffers'.")
b0dc9757 4489
5f76e7d4
KH
4490(defvar before-revert-hook nil
4491 "Normal hook for `revert-buffer' to run before reverting.
4492If `revert-buffer-function' is used to override the normal revert
4493mechanism, this hook is not used.")
4494
4495(defvar after-revert-hook nil
4496 "Normal hook for `revert-buffer' to run after reverting.
4497Note that the hook value that it runs is the value that was in effect
4498before reverting; that makes a difference if you have buffer-local
4499hook functions.
4500
4501If `revert-buffer-function' is used to override the normal revert
4502mechanism, this hook is not used.")
4503
1554c03b
RS
4504(defvar revert-buffer-internal-hook)
4505
9a30563f 4506(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 4507 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 4508This undoes all changes since the file was visited or saved.
8c0e7b73
JB
4509With a prefix argument, offer to revert from latest auto-save file, if
4510that is more recent than the visited file.
1ab31687 4511
0dff8975
VJL
4512This command also implements an interface for special buffers
4513that contain text which doesn't come from a file, but reflects
4514some other data instead (e.g. Dired buffers, `buffer-list'
c84b3004
VJL
4515buffers). This is done via the variable
4516`revert-buffer-function'. In these cases, it should reconstruct
0dff8975 4517the buffer contents from the appropriate data.
7e7c9c4e 4518
65ee6096 4519When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
4520to revert from the auto-save file when this is nil. Note that the
4521sense of this argument is the reverse of the prefix argument, for the
4522sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4523to nil.
4524
4525Optional second argument NOCONFIRM means don't ask for confirmation at
518dc5be
EZ
4526all. \(The variable `revert-without-query' offers another way to
4527revert buffers without querying for confirmation.)
b4da00e9 4528
5b2b26d5
RS
4529Optional third argument PRESERVE-MODES non-nil means don't alter
4530the files modes. Normally we reinitialize them using `normal-mode'.
4531
8c0e7b73 4532If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
4533do all the work for this command. Otherwise, the hooks
4534`before-revert-hook' and `after-revert-hook' are run at the beginning
4535and the end, and if `revert-buffer-insert-file-contents-function' is
4536non-nil, it is called instead of rereading visited file contents."
fb6208a6 4537
1ab31687
JB
4538 ;; I admit it's odd to reverse the sense of the prefix argument, but
4539 ;; there is a lot of code out there which assumes that the first
4540 ;; argument should be t to avoid consulting the auto-save file, and
4541 ;; there's no straightforward way to encourage authors to notice a
4542 ;; reversal of the argument sense. So I'm just changing the user
4543 ;; interface, but leaving the programmatic interface the same.
e0867e99 4544 (interactive (list (not current-prefix-arg)))
b4da00e9 4545 (if revert-buffer-function
1ab31687 4546 (funcall revert-buffer-function ignore-auto noconfirm)
44dce0fb
RS
4547 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4548 (current-buffer))
4549 (let* ((auto-save-p (and (not ignore-auto)
4550 (recent-auto-save-p)
4551 buffer-auto-save-file-name
4552 (file-readable-p buffer-auto-save-file-name)
4553 (y-or-n-p
4554 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4555 (file-name (if auto-save-p
4556 buffer-auto-save-file-name
4557 buffer-file-name)))
4558 (cond ((null file-name)
4559 (error "Buffer does not seem to be associated with any file"))
4560 ((or noconfirm
4561 (and (not (buffer-modified-p))
518dc5be
EZ
4562 (catch 'found
4563 (dolist (regexp revert-without-query)
4564 (when (string-match regexp file-name)
4565 (throw 'found t)))))
44dce0fb
RS
4566 (yes-or-no-p (format "Revert buffer from file %s? "
4567 file-name)))
4568 (run-hooks 'before-revert-hook)
4569 ;; If file was backed up but has changed since,
4570 ;; we shd make another backup.
4571 (and (not auto-save-p)
4572 (not (verify-visited-file-modtime (current-buffer)))
4573 (setq buffer-backed-up nil))
44dce0fb
RS
4574 ;; Effectively copy the after-revert-hook status,
4575 ;; since after-find-file will clobber it.
4576 (let ((global-hook (default-value 'after-revert-hook))
518dc5be
EZ
4577 (local-hook (when (local-variable-p 'after-revert-hook)
4578 after-revert-hook))
4579 (inhibit-read-only t))
4580 (cond
4581 (revert-buffer-insert-file-contents-function
4582 (unless (eq buffer-undo-list t)
4583 ;; Get rid of all undo records for this buffer.
4584 (setq buffer-undo-list nil))
4585 ;; Don't make undo records for the reversion.
4586 (let ((buffer-undo-list t))
4587 (funcall revert-buffer-insert-file-contents-function
4588 file-name auto-save-p)))
4589 ((not (file-exists-p file-name))
4590 (error (if buffer-file-number
4591 "File %s no longer exists!"
4592 "Cannot revert nonexistent file %s")
4593 file-name))
b2d239c1
RS
4594 ((not (file-readable-p file-name))
4595 (error (if buffer-file-number
4596 "File %s no longer readable!"
4597 "Cannot revert unreadable file %s")
4598 file-name))
518dc5be
EZ
4599 (t
4600 ;; Bind buffer-file-name to nil
4601 ;; so that we don't try to lock the file.
4602 (let ((buffer-file-name nil))
4603 (or auto-save-p
4604 (unlock-buffer)))
4605 (widen)
4606 (let ((coding-system-for-read
4607 ;; Auto-saved file should be read by Emacs'
4608 ;; internal coding.
4609 (if auto-save-p 'auto-save-coding
4610 (or coding-system-for-read
4611 buffer-file-coding-system-explicit))))
e1ee3b54 4612 (if (and (not enable-multibyte-characters)
52f9b751 4613 coding-system-for-read
e1ee3b54
KH
4614 (not (memq (coding-system-base
4615 coding-system-for-read)
4616 '(no-conversion raw-text))))
4617 ;; As a coding system suitable for multibyte
4618 ;; buffer is specified, make the current
4619 ;; buffer multibyte.
4620 (set-buffer-multibyte t))
4621
518dc5be
EZ
4622 ;; This force after-insert-file-set-coding
4623 ;; (called from insert-file-contents) to set
4624 ;; buffer-file-coding-system to a proper value.
4625 (kill-local-variable 'buffer-file-coding-system)
4626
4627 ;; Note that this preserves point in an intelligent way.
4628 (if preserve-modes
4629 (let ((buffer-file-format buffer-file-format))
4630 (insert-file-contents file-name (not auto-save-p)
4631 nil nil t))
4632 (insert-file-contents file-name (not auto-save-p)
2a29c409 4633 nil nil t)))))
44dce0fb
RS
4634 ;; Recompute the truename in case changes in symlinks
4635 ;; have changed the truename.
4636 (setq buffer-file-truename
4637 (abbreviate-file-name (file-truename buffer-file-name)))
4638 (after-find-file nil nil t t preserve-modes)
4639 ;; Run after-revert-hook as it was before we reverted.
4640 (setq-default revert-buffer-internal-hook global-hook)
518dc5be 4641 (if local-hook
44dce0fb
RS
4642 (set (make-local-variable 'revert-buffer-internal-hook)
4643 local-hook)
4644 (kill-local-variable 'revert-buffer-internal-hook))
4645 (run-hooks 'revert-buffer-internal-hook))
4646 t))))))
b4da00e9 4647
64d18e8f
RS
4648(defun recover-this-file ()
4649 "Recover the visited file--get contents from its last auto-save file."
4650 (interactive)
4651 (recover-file buffer-file-name))
4652
b4da00e9
RM
4653(defun recover-file (file)
4654 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
4655 ;; Actually putting the file name in the minibuffer should be used
4656 ;; only rarely.
4657 ;; Not just because users often use the default.
e1dadc17 4658 (interactive "FRecover file: ")
b4da00e9 4659 (setq file (expand-file-name file))
f7da6740 4660 (if (auto-save-file-name-p (file-name-nondirectory file))
4e163715 4661 (error "%s is an auto-save file" (abbreviate-file-name file)))
b4da00e9
RM
4662 (let ((file-name (let ((buffer-file-name file))
4663 (make-auto-save-file-name))))
945e1965
RS
4664 (cond ((if (file-exists-p file)
4665 (not (file-newer-than-file-p file-name file))
4666 (not (file-exists-p file-name)))
4e163715
SM
4667 (error "Auto-save file %s not current"
4668 (abbreviate-file-name file-name)))
b4da00e9 4669 ((save-window-excursion
ffc0e1ca
AS
4670 (with-output-to-temp-buffer "*Directory*"
4671 (buffer-disable-undo standard-output)
4672 (save-excursion
4673 (let ((switches dired-listing-switches))
4674 (if (file-symlink-p file)
4675 (setq switches (concat switches "L")))
4676 (set-buffer standard-output)
bc22fd18
EZ
4677 ;; Use insert-directory-safely, not insert-directory,
4678 ;; because these files might not exist. In particular,
4679 ;; FILE might not exist if the auto-save file was for
4680 ;; a buffer that didn't visit a file, such as "*mail*".
4681 ;; The code in v20.x called `ls' directly, so we need
4682 ;; to emulate what `ls' did in that case.
4683 (insert-directory-safely file switches)
4684 (insert-directory-safely file-name switches))))
b4da00e9
RM
4685 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4686 (switch-to-buffer (find-file-noselect file t))
518dc5be 4687 (let ((inhibit-read-only t)
1e87edf5
KH
4688 ;; Keep the current buffer-file-coding-system.
4689 (coding-system buffer-file-coding-system)
1d0ec0d1 4690 ;; Auto-saved file should be read with special coding.
77619f8e 4691 (coding-system-for-read 'auto-save-coding))
b4da00e9 4692 (erase-buffer)
1e87edf5
KH
4693 (insert-file-contents file-name nil)
4694 (set-buffer-file-coding-system coding-system))
8cfb9d46 4695 (after-find-file nil nil t))
ffa7ab70 4696 (t (error "Recover-file cancelled")))))
b4da00e9 4697
6598027d 4698(defun recover-session ()
9aee5392
RS
4699 "Recover auto save files from a previous Emacs session.
4700This command first displays a Dired buffer showing you the
4701previous sessions that you could recover from.
4702To choose one, move point to the proper line and then type C-c C-c.
4703Then you'll be asked about a number of files to recover."
4704 (interactive)
363a5030
RS
4705 (if (null auto-save-list-file-prefix)
4706 (error "You set `auto-save-list-file-prefix' to disable making session files"))
ffc0e1ca
AS
4707 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4708 (unless (file-directory-p dir)
194600a8
JPW
4709 (make-directory dir t))
4710 (unless (directory-files dir nil
4711 (concat "\\`" (regexp-quote
4712 (file-name-nondirectory
4713 auto-save-list-file-prefix)))
4714 t)
4715 (error "No previous sessions to recover")))
6f4983e6 4716 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
4717 (dired (concat auto-save-list-file-prefix "*")
4718 (concat dired-listing-switches "t")))
05e076c7
AS
4719 (save-excursion
4720 (goto-char (point-min))
4721 (or (looking-at " Move to the session you want to recover,")
4722 (let ((inhibit-read-only t))
4723 ;; Each line starts with a space
4724 ;; so that Font Lock mode won't highlight the first character.
4725 (insert " Move to the session you want to recover,\n"
4726 " then type C-c C-c to select it.\n\n"
4727 " You can also delete some of these files;\n"
4728 " type d on a line to mark that file for deletion.\n\n"))))
9aee5392 4729 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 4730 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 4731
80280bb7 4732(defun recover-session-finish ()
9aee5392
RS
4733 "Choose one saved session to recover auto-save files from.
4734This command is used in the special Dired buffer created by
80280bb7 4735\\[recover-session]."
9aee5392
RS
4736 (interactive)
4737 ;; Get the name of the session file to recover from.
4738 (let ((file (dired-get-filename))
953a03b2 4739 files
9aee5392 4740 (buffer (get-buffer-create " *recover*")))
c11032b9 4741 (dired-unmark 1)
033ef863 4742 (dired-do-flagged-delete t)
9aee5392
RS
4743 (unwind-protect
4744 (save-excursion
4745 ;; Read in the auto-save-list file.
4746 (set-buffer buffer)
4747 (erase-buffer)
4748 (insert-file-contents file)
953a03b2
RS
4749 ;; Loop thru the text of that file
4750 ;; and get out the names of the files to recover.
4751 (while (not (eobp))
4752 (let (thisfile autofile)
4753 (if (eolp)
4754 ;; This is a pair of lines for a non-file-visiting buffer.
4755 ;; Get the auto-save file name and manufacture
4756 ;; a "visited file name" from that.
4757 (progn
4758 (forward-line 1)
259be4e6
JB
4759 ;; If there is no auto-save file name, the
4760 ;; auto-save-list file is probably corrupted.
4761 (unless (eolp)
4762 (setq autofile
4763 (buffer-substring-no-properties
4764 (point)
e442c62b 4765 (line-end-position)))
259be4e6
JB
4766 (setq thisfile
4767 (expand-file-name
4768 (substring
4769 (file-name-nondirectory autofile)
4770 1 -1)
4771 (file-name-directory autofile))))
953a03b2
RS
4772 (forward-line 1))
4773 ;; This pair of lines is a file-visiting
4774 ;; buffer. Use the visited file name.
4775 (progn
4776 (setq thisfile
4777 (buffer-substring-no-properties
4778 (point) (progn (end-of-line) (point))))
4779 (forward-line 1)
4780 (setq autofile
4781 (buffer-substring-no-properties
4782 (point) (progn (end-of-line) (point))))
4783 (forward-line 1)))
4784 ;; Ignore a file if its auto-save file does not exist now.
259be4e6 4785 (if (and autofile (file-exists-p autofile))
953a03b2
RS
4786 (setq files (cons thisfile files)))))
4787 (setq files (nreverse files))
945e1965
RS
4788 ;; The file contains a pair of line for each auto-saved buffer.
4789 ;; The first line of the pair contains the visited file name
4790 ;; or is empty if the buffer was not visiting a file.
4791 ;; The second line is the auto-save file name.
953a03b2
RS
4792 (if files
4793 (map-y-or-n-p "Recover %s? "
4794 (lambda (file)
4795 (condition-case nil
4796 (save-excursion (recover-file file))
76d5492b 4797 (error
953a03b2
RS
4798 "Failed to recover `%s'" file)))
4799 files
4800 '("file" "files" "recover"))
4801 (message "No files can be recovered from this session now")))
9aee5392
RS
4802 (kill-buffer buffer))))
4803
a151f82c
SS
4804(defun kill-buffer-ask (buffer)
4805 "Kill buffer if confirmed."
4806 (when (yes-or-no-p
4807 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4808 (if (buffer-modified-p buffer)
4809 "HAS BEEN EDITED" "is unmodified")))
4810 (kill-buffer buffer)))
4811
73ba610a 4812(defun kill-some-buffers (&optional list)
243a3ae0 4813 "Kill some buffers. Asks the user whether to kill each one of them.
bb8eaf67 4814Non-interactively, if optional argument LIST is non-nil, it
243a3ae0 4815specifies the list of buffers to kill, asking for approval for each one."
b4da00e9 4816 (interactive)
73ba610a
RS
4817 (if (null list)
4818 (setq list (buffer-list)))
4819 (while list
4820 (let* ((buffer (car list))
4821 (name (buffer-name buffer)))
cbca0a4b
RS
4822 (and name ; Can be nil for an indirect buffer
4823 ; if we killed the base buffer.
4824 (not (string-equal name ""))
26b9ecbc 4825 (/= (aref name 0) ?\s)
a151f82c 4826 (kill-buffer-ask buffer)))
73ba610a 4827 (setq list (cdr list))))
a151f82c
SS
4828
4829(defun kill-matching-buffers (regexp &optional internal-too)
4830 "Kill buffers whose name matches the specified regexp.
4831The optional second argument indicates whether to kill internal buffers too."
4832 (interactive "sKill buffers matching this regular expression: \nP")
4833 (dolist (buffer (buffer-list))
4834 (let ((name (buffer-name buffer)))
4835 (when (and name (not (string-equal name ""))
4836 (or internal-too (/= (aref name 0) ?\s))
4837 (string-match regexp name))
4838 (kill-buffer-ask buffer)))))
4839
b4da00e9
RM
4840\f
4841(defun auto-save-mode (arg)
4842 "Toggle auto-saving of contents of current buffer.
f3e23606 4843With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
4844 (interactive "P")
4845 (setq buffer-auto-save-file-name
4846 (and (if (null arg)
74b9c2af 4847 (or (not buffer-auto-save-file-name)
4e0c8650 4848 ;; If auto-save is off because buffer has shrunk,
74b9c2af
RS
4849 ;; then toggling should turn it on.
4850 (< buffer-saved-size 0))
b4da00e9
RM
4851 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4852 (if (and buffer-file-name auto-save-visited-file-name
4853 (not buffer-read-only))
4854 buffer-file-name
4855 (make-auto-save-file-name))))
0b7f1ef2
RS
4856 ;; If -1 was stored here, to temporarily turn off saving,
4857 ;; turn it back on.
4858 (and (< buffer-saved-size 0)
4859 (setq buffer-saved-size 0))
b4da00e9
RM
4860 (if (interactive-p)
4861 (message "Auto-save %s (in this buffer)"
4862 (if buffer-auto-save-file-name "on" "off")))
4863 buffer-auto-save-file-name)
4864
4865(defun rename-auto-save-file ()
4866 "Adjust current buffer's auto save file name for current conditions.
4867Also rename any existing auto save file, if it was made in this session."
4868 (let ((osave buffer-auto-save-file-name))
4869 (setq buffer-auto-save-file-name
4870 (make-auto-save-file-name))
4871 (if (and osave buffer-auto-save-file-name
4872 (not (string= buffer-auto-save-file-name buffer-file-name))
4873 (not (string= buffer-auto-save-file-name osave))
4874 (file-exists-p osave)
4875 (recent-auto-save-p))
4876 (rename-file osave buffer-auto-save-file-name t))))
4877
4878(defun make-auto-save-file-name ()
4879 "Return file name to use for auto-saves of current buffer.
4880Does not consider `auto-save-visited-file-name' as that variable is checked
4881before calling this function. You can redefine this for customization.
4882See also `auto-save-file-name-p'."
4883 (if buffer-file-name
c1105d05
MA
4884 (let ((handler (find-file-name-handler buffer-file-name
4885 'make-auto-save-file-name)))
4886 (if handler
4887 (funcall handler 'make-auto-save-file-name)
4888 (let ((list auto-save-file-name-transforms)
4889 (filename buffer-file-name)
4890 result uniq)
4891 ;; Apply user-specified translations
4892 ;; to the file name.
4893 (while (and list (not result))
4894 (if (string-match (car (car list)) filename)
4895 (setq result (replace-match (cadr (car list)) t nil
4896 filename)
4897 uniq (car (cddr (car list)))))
4898 (setq list (cdr list)))
4899 (if result
4900 (if uniq
4901 (setq filename (concat
4902 (file-name-directory result)
4903 (subst-char-in-string
4904 ?/ ?!
4905 (replace-regexp-in-string "!" "!!"
4906 filename))))
4907 (setq filename result)))
4908 (setq result
4909 (if (and (eq system-type 'ms-dos)
4910 (not (msdos-long-file-names)))
4911 ;; We truncate the file name to DOS 8+3 limits
4912 ;; before doing anything else, because the regexp
4913 ;; passed to string-match below cannot handle
4914 ;; extensions longer than 3 characters, multiple
4915 ;; dots, and other atrocities.
4916 (let ((fn (dos-8+3-filename
4917 (file-name-nondirectory buffer-file-name))))
4918 (string-match
4919 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4920 fn)
4921 (concat (file-name-directory buffer-file-name)
4922 "#" (match-string 1 fn)
4923 "." (match-string 3 fn) "#"))
4924 (concat (file-name-directory filename)
4925 "#"
4926 (file-name-nondirectory filename)
4927 "#")))
4928 ;; Make sure auto-save file names don't contain characters
4929 ;; invalid for the underlying filesystem.
18b28ef1 4930 (if (and (memq system-type '(ms-dos windows-nt cygwin))
c1105d05
MA
4931 ;; Don't modify remote (ange-ftp) filenames
4932 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4933 (convert-standard-filename result)
4934 result))))
0a1763b4
RS
4935
4936 ;; Deal with buffers that don't have any associated files. (Mail
4937 ;; mode tends to create a good number of these.)
4938
7d483e8c 4939 (let ((buffer-name (buffer-name))
ff5c7181 4940 (limit 0)
77d18896 4941 file-name)
ad80c679
JR
4942 ;; Restrict the characters used in the file name to those which
4943 ;; are known to be safe on all filesystems, url-encoding the
4944 ;; rest.
4945 ;; We do this on all platforms, because even if we are not
4946 ;; running on DOS/Windows, the current directory may be on a
4947 ;; mounted VFAT filesystem, such as a USB memory stick.
4948 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
c3348e10
RS
4949 (let* ((character (aref buffer-name (match-beginning 0)))
4950 (replacement
ad80c679
JR
4951 ;; For multibyte characters, this will produce more than
4952 ;; 2 hex digits, so is not true URL encoding.
4953 (format "%%%02X" character)))
c3348e10
RS
4954 (setq buffer-name (replace-match replacement t t buffer-name))
4955 (setq limit (1+ (match-end 0)))))
a8abaf83 4956 ;; Generate the file name.
ff5c7181
RS
4957 (setq file-name
4958 (make-temp-file
4959 (let ((fname
4960 (expand-file-name
4961 (format "#%s#" buffer-name)
4962 ;; Try a few alternative directories, to get one we can
4963 ;; write it.
4964 (cond
4965 ((file-writable-p default-directory) default-directory)
4966 ((file-writable-p "/var/tmp/") "/var/tmp/")
4967 ("~/")))))
18b28ef1 4968 (if (and (memq system-type '(ms-dos windows-nt cygwin))
ff5c7181
RS
4969 ;; Don't modify remote (ange-ftp) filenames
4970 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4971 ;; The call to convert-standard-filename is in case
4972 ;; buffer-name includes characters not allowed by the
4973 ;; DOS/Windows filesystems. make-temp-file writes to the
4974 ;; file it creates, so we must fix the file name _before_
4975 ;; make-temp-file is called.
4976 (convert-standard-filename fname)
4977 fname))
4978 nil "#"))
4979 ;; make-temp-file creates the file,
4980 ;; but we don't want it to exist until we do an auto-save.
4981 (condition-case ()
4982 (delete-file file-name)
4983 (file-error nil))
4984 file-name)))
b4da00e9
RM
4985
4986(defun auto-save-file-name-p (filename)
4987 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4988FILENAME should lack slashes. You can redefine this for customization."
4989 (string-match "^#.*#$" filename))
4990\f
6f4983e6
RS
4991(defun wildcard-to-regexp (wildcard)
4992 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4837b516 4993The generated regexp will match a filename only if the filename
6f4983e6
RS
4994matches that wildcard according to shell rules. Only wildcards known
4995by `sh' are supported."
4996 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4997 ;; Copy the initial run of non-special characters.
4998 (result (substring wildcard 0 i))
4999 (len (length wildcard)))
5000 ;; If no special characters, we're almost done.
5001 (if i
5002 (while (< i len)
5003 (let ((ch (aref wildcard i))
5004 j)
5005 (setq
5006 result
5007 (concat result
5008 (cond
7e7c9c4e
RS
5009 ((and (eq ch ?\[)
5010 (< (1+ i) len)
5011 (eq (aref wildcard (1+ i)) ?\]))
5012 "\\[")
6f4983e6
RS
5013 ((eq ch ?\[) ; [...] maps to regexp char class
5014 (progn
5015 (setq i (1+ i))
5016 (concat
5017 (cond
5018 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5019 (progn
5020 (setq i (1+ i))
5021 (if (eq (aref wildcard i) ?\])
5022 (progn
5023 (setq i (1+ i))
5024 "[^]")
5025 "[^")))
5026 ((eq (aref wildcard i) ?^)
5027 ;; Found "[^". Insert a `\0' character
5028 ;; (which cannot happen in a filename)
5029 ;; into the character class, so that `^'
5030 ;; is not the first character after `[',
5031 ;; and thus non-special in a regexp.
5032 (progn
5033 (setq i (1+ i))
5034 "[\000^"))
5035 ((eq (aref wildcard i) ?\])
5036 ;; I don't think `]' can appear in a
5037 ;; character class in a wildcard, but
5038 ;; let's be general here.
5039 (progn
5040 (setq i (1+ i))
5041 "[]"))
5042 (t "["))
5043 (prog1 ; copy everything upto next `]'.
5044 (substring wildcard
5045 i
5046 (setq j (string-match
5047 "]" wildcard i)))
5048 (setq i (if j (1- j) (1- len)))))))
5049 ((eq ch ?.) "\\.")
5050 ((eq ch ?*) "[^\000]*")
5051 ((eq ch ?+) "\\+")
5052 ((eq ch ?^) "\\^")
5053 ((eq ch ?$) "\\$")
5054 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5055 ((eq ch ??) "[^\000]")
5056 (t (char-to-string ch)))))
5057 (setq i (1+ i)))))
5058 ;; Shell wildcards should match the entire filename,
5059 ;; not its part. Make the regexp say so.
5060 (concat "\\`" result "\\'")))
5061\f
21540597 5062(defcustom list-directory-brief-switches
7c2fb837 5063 "-CF"
ba83982b 5064 "Switches for `list-directory' to pass to `ls' for brief listing."
21540597
RS
5065 :type 'string
5066 :group 'dired)
b4da00e9 5067
21540597 5068(defcustom list-directory-verbose-switches
7c2fb837 5069 "-l"
ba83982b 5070 "Switches for `list-directory' to pass to `ls' for verbose listing."
21540597
RS
5071 :type 'string
5072 :group 'dired)
b4da00e9 5073
5de148a2
RS
5074(defun file-expand-wildcards (pattern &optional full)
5075 "Expand wildcard pattern PATTERN.
4db2a7de
RS
5076This returns a list of file names which match the pattern.
5077
814af837 5078If PATTERN is written as an absolute file name,
4db2a7de
RS
5079the values are absolute also.
5080
5081If PATTERN is written as a relative file name, it is interpreted
5082relative to the current default directory, `default-directory'.
5083The file names returned are normally also relative to the current
5084default directory. However, if FULL is non-nil, they are absolute."
032388f3
RS
5085 (save-match-data
5086 (let* ((nondir (file-name-nondirectory pattern))
5087 (dirpart (file-name-directory pattern))
5088 ;; A list of all dirs that DIRPART specifies.
5089 ;; This can be more than one dir
5090 ;; if DIRPART contains wildcards.
5091 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
5092 (mapcar 'file-name-as-directory
5093 (file-expand-wildcards (directory-file-name dirpart)))
5094 (list dirpart)))
5095 contents)
5096 (while dirs
5097 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5098 (file-directory-p (directory-file-name (car dirs))))
5099 (let ((this-dir-contents
5100 ;; Filter out "." and ".."
5101 (delq nil
5102 (mapcar #'(lambda (name)
5103 (unless (string-match "\\`\\.\\.?\\'"
5104 (file-name-nondirectory name))
5105 name))
5106 (directory-files (or (car dirs) ".") full
5107 (wildcard-to-regexp nondir))))))
5108 (setq contents
5109 (nconc
5110 (if (and (car dirs) (not full))
5111 (mapcar (function (lambda (name) (concat (car dirs) name)))
5112 this-dir-contents)
5113 this-dir-contents)
5114 contents))))
5115 (setq dirs (cdr dirs)))
5116 contents)))
5de148a2 5117
b4da00e9
RM
5118(defun list-directory (dirname &optional verbose)
5119 "Display a list of files in or matching DIRNAME, a la `ls'.
5120DIRNAME is globbed by the shell if necessary.
5121Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5122Actions controlled by variables `list-directory-brief-switches'
5123and `list-directory-verbose-switches'."
5124 (interactive (let ((pfx current-prefix-arg))
5125 (list (read-file-name (if pfx "List directory (verbose): "
5126 "List directory (brief): ")
5127 nil default-directory nil)
5128 pfx)))
5129 (let ((switches (if verbose list-directory-verbose-switches
84905190
RS
5130 list-directory-brief-switches))
5131 buffer)
b4da00e9
RM
5132 (or dirname (setq dirname default-directory))
5133 (setq dirname (expand-file-name dirname))
5134 (with-output-to-temp-buffer "*Directory*"
84905190 5135 (setq buffer standard-output)
b4da00e9
RM
5136 (buffer-disable-undo standard-output)
5137 (princ "Directory ")
5138 (princ dirname)
5139 (terpri)
c3554e95
RS
5140 (save-excursion
5141 (set-buffer "*Directory*")
5142 (let ((wildcard (not (file-directory-p dirname))))
84905190
RS
5143 (insert-directory dirname switches wildcard (not wildcard)))))
5144 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5145 (with-current-buffer buffer
5146 (setq default-directory
5147 (if (file-directory-p dirname)
5148 (file-name-as-directory dirname)
5149 (file-name-directory dirname))))))
c3554e95 5150
ffc0e1ca
AS
5151(defun shell-quote-wildcard-pattern (pattern)
5152 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5153
5154PATTERN is assumed to represent a file-name wildcard suitable for the
5155underlying filesystem. For Unix and GNU/Linux, the characters from the
d6d61574 5156set [ \\t\\n;<>&|()'\"#$] are quoted with a backslash; for DOS/Windows, all
ffc0e1ca
AS
5157the parts of the pattern which don't include wildcard characters are
5158quoted with double quotes.
5159Existing quote characters in PATTERN are left alone, so you can pass
5160PATTERN that already quotes some of the special characters."
5161 (save-match-data
5162 (cond
c60ee5e7 5163 ((memq system-type '(ms-dos windows-nt cygwin))
ffc0e1ca
AS
5164 ;; DOS/Windows don't allow `"' in file names. So if the
5165 ;; argument has quotes, we can safely assume it is already
5166 ;; quoted by the caller.
5167 (if (or (string-match "[\"]" pattern)
5168 ;; We quote [&()#$'] in case their shell is a port of a
5169 ;; Unixy shell. We quote [,=+] because stock DOS and
5170 ;; Windows shells require that in some cases, such as
5171 ;; passing arguments to batch files that use positional
5172 ;; arguments like %1.
5173 (not (string-match "[ \t;&()#$',=+]" pattern)))
5174 pattern
5175 (let ((result "\"")
5176 (beg 0)
5177 end)
5178 (while (string-match "[*?]+" pattern beg)
5179 (setq end (match-beginning 0)
5180 result (concat result (substring pattern beg end)
5181 "\""
5182 (substring pattern end (match-end 0))
5183 "\"")
5184 beg (match-end 0)))
5185 (concat result (substring pattern beg) "\""))))
5186 (t
5187 (let ((beg 0))
d6d61574 5188 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
ffc0e1ca
AS
5189 (setq pattern
5190 (concat (substring pattern 0 (match-beginning 0))
5191 "\\"
5192 (substring pattern (match-beginning 0)))
5193 beg (1+ (match-end 0)))))
5194 pattern))))
5195
5196
c3554e95
RS
5197(defvar insert-directory-program "ls"
5198 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5199
f4d04672 5200(defcustom directory-free-space-program "df"
ba83982b 5201 "Program to get the amount of free space on a file system.
f4d04672
RS
5202We assume the output has the format of `df'.
5203The value of this variable must be just a command name or file name;
5204if you want to specify options, use `directory-free-space-args'.
5205
01b26b90
EZ
5206A value of nil disables this feature.
5207
5208If the function `file-system-info' is defined, it is always used in
5209preference to the program given by this variable."
f4d04672
RS
5210 :type '(choice (string :tag "Program") (const :tag "None" nil))
5211 :group 'dired)
5212
525fdbc9
AS
5213(defcustom directory-free-space-args
5214 (if (eq system-type 'darwin) "-k" "-Pk")
ba83982b 5215 "Options to use when running `directory-free-space-program'."
f4d04672
RS
5216 :type 'string
5217 :group 'dired)
5218
01b26b90 5219(defun get-free-disk-space (dir)
26b9ecbc 5220 "Return the amount of free space on directory DIR's file system.
01b26b90 5221The result is a string that gives the number of free 1KB blocks,
26b9ecbc 5222or nil if the system call or the program which retrieve the information
06531fc3 5223fail. It returns also nil when DIR is a remote directory.
01b26b90
EZ
5224
5225This function calls `file-system-info' if it is available, or invokes the
5226program specified by `directory-free-space-program' if that is non-nil."
06531fc3
MA
5227 (when (not (file-remote-p dir))
5228 ;; Try to find the number of free blocks. Non-Posix systems don't
5229 ;; always have df, but might have an equivalent system call.
5230 (if (fboundp 'file-system-info)
5231 (let ((fsinfo (file-system-info dir)))
5232 (if fsinfo
5233 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5234 (save-match-data
5235 (with-temp-buffer
5236 (when (and directory-free-space-program
5237 (eq 0 (call-process directory-free-space-program
5238 nil t nil
5239 directory-free-space-args
5240 dir)))
5241 ;; Usual format is a header line followed by a line of
5242 ;; numbers.
5243 (goto-char (point-min))
5244 (forward-line 1)
5245 (if (not (eobp))
5246 (progn
5247 ;; Move to the end of the "available blocks" number.
5248 (skip-chars-forward "^ \t")
5249 (forward-word 3)
5250 ;; Copy it into AVAILABLE.
5251 (let ((end (point)))
5252 (forward-word -1)
5253 (buffer-substring (point) end))))))))))
01b26b90 5254
9bc260cf
MA
5255;; The following expression replaces `dired-move-to-filename-regexp'.
5256(defvar directory-listing-before-filename-regexp
5257 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5258 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5259 ;; In some locales, month abbreviations are as short as 2 letters,
5260 ;; and they can be followed by ".".
5261 ;; In Breton, a month name can include a quote character.
5262 (month (concat l-or-quote l-or-quote "+\\.?"))
5263 (s " ")
5264 (yyyy "[0-9][0-9][0-9][0-9]")
5265 (dd "[ 0-3][0-9]")
5266 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5267 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5268 (zone "[-+][0-2][0-9][0-5][0-9]")
5269 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5270 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5271 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5272 "\\|" yyyy "-" iso-mm-dd "\\)"))
5273 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5274 s "+"
5275 "\\(" HH:MM "\\|" yyyy "\\)"))
5276 (western-comma (concat month s "+" dd "," s "+" yyyy))
5277 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5278 ;; omits the Kanji characters after month and day-of-month.
5279 ;; On Mac OS X 10.3, the date format in East Asian locales is
5280 ;; day-of-month digits followed by month digits.
5281 (mm "[ 0-1]?[0-9]")
5282 (east-asian
5283 (concat "\\(" mm l "?" s dd l "?" s "+"
5284 "\\|" dd s mm s "+" "\\)"
5285 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5286 ;; The "[0-9]" below requires the previous column to end in a digit.
5287 ;; This avoids recognizing `1 may 1997' as a date in the line:
5288 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5289
5290 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5291 ;; The ".*" below finds the last match if there are multiple matches.
5292 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5293 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5294
5295 ;; vc dired listings provide the state or blanks between file
5296 ;; permissions and date. The state is always surrounded by
5297 ;; parantheses:
5298 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5299 ;; This is not supported yet.
5300 (concat ".*[0-9][BkKMGTPEZY]?" s
5301 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
5302 s "+"))
5303 "Regular expression to match up to the file name in a directory listing.
5304The default value is designed to recognize dates and times
5305regardless of the language.")
01b26b90 5306
a1b0c2a7
RS
5307(defvar insert-directory-ls-version 'unknown)
5308
c3554e95
RS
5309;; insert-directory
5310;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5311;; FULL-DIRECTORY-P is nil.
5312;; The single line of output must display FILE's name as it was
5313;; given, namely, an absolute path name.
5314;; - must insert exactly one line for each file if WILDCARD or
5315;; FULL-DIRECTORY-P is t, plus one optional "total" line
5316;; before the file lines, plus optional text after the file lines.
5317;; Lines are delimited by "\n", so filenames containing "\n" are not
5318;; allowed.
5319;; File lines should display the basename.
5320;; - must be consistent with
5321;; - functions dired-move-to-filename, (these two define what a file line is)
5322;; dired-move-to-end-of-filename,
5323;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5324;; dired-insert-headerline
5325;; dired-after-subdir-garbage (defines what a "total" line is)
5326;; - variable dired-subdir-regexp
1fc85dae
KG
5327;; - may be passed "--dired" as the first argument in SWITCHES.
5328;; Filename handlers might have to remove this switch if their
5329;; "ls" command does not support it.
c3554e95 5330(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 5331 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 5332Leaves point after the inserted text.
8f8607be
LT
5333SWITCHES may be a string of options, or a list of strings
5334representing individual options.
c3554e95
RS
5335Optional third arg WILDCARD means treat FILE as shell wildcard.
5336Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5337switches do not contain `d', so that a full listing is expected.
5338
5339This works by running a directory listing program
406e12d9 5340whose name is in the variable `insert-directory-program'.
8f8607be
LT
5341If WILDCARD, it also runs the shell specified by `shell-file-name'.
5342
60ce7e3e 5343When SWITCHES contains the long `--dired' option, this function
8f8607be
LT
5344treats it specially, for the sake of dired. However, the
5345normally equivalent short `-D' option is just passed on to
5346`insert-directory-program', as any other option."
c870ab8e 5347 ;; We need the directory in order to find the right handler.
d2473540
AS
5348 (let ((handler (find-file-name-handler (expand-file-name file)
5349 'insert-directory)))
ebad92dc 5350 (if handler
c3554e95
RS
5351 (funcall handler 'insert-directory file switches
5352 wildcard full-directory-p)
818286f4 5353 (let (result (beg (point)))
ebad92dc
RS
5354
5355 ;; Read the actual directory using `insert-directory-program'.
5356 ;; RESULT gets the status code.
99f01c91
KH
5357 (let* (;; We at first read by no-conversion, then after
5358 ;; putting text property `dired-filename, decode one
5359 ;; bunch by one to preserve that property.
5360 (coding-system-for-read 'no-conversion)
5361 ;; This is to control encoding the arguments in call-process.
c60ee5e7 5362 (coding-system-for-write
82e22b57
KH
5363 (and enable-multibyte-characters
5364 (or file-name-coding-system
99f01c91 5365 default-file-name-coding-system))))
ebad92dc
RS
5366 (setq result
5367 (if wildcard
5368 ;; Run ls in the directory part of the file pattern
5369 ;; using the last component as argument.
5370 (let ((default-directory
5371 (if (file-name-absolute-p file)
5372 (file-name-directory file)
5373 (file-name-directory (expand-file-name file))))
5374 (pattern (file-name-nondirectory file)))
5375 (call-process
5376 shell-file-name nil t nil
5377 "-c"
5378 (concat (if (memq system-type '(ms-dos windows-nt))
5379 ""
5380 "\\") ; Disregard Unix shell aliases!
5381 insert-directory-program
5382 " -d "
5383 (if (stringp switches)
5384 switches
5385 (mapconcat 'identity switches " "))
5386 " -- "
5387 ;; Quote some characters that have
5388 ;; special meanings in shells; but
5389 ;; don't quote the wildcards--we want
5390 ;; them to be special. We also
5391 ;; currently don't quote the quoting
5392 ;; characters in case people want to
5393 ;; use them explicitly to quote
5394 ;; wildcard characters.
5395 (shell-quote-wildcard-pattern pattern))))
5396 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5397 ;; directory if FILE is a symbolic link.
5398 (apply 'call-process
5399 insert-directory-program nil t nil
5400 (append
5401 (if (listp switches) switches
5402 (unless (equal switches "")
5403 ;; Split the switches at any spaces so we can
5404 ;; pass separate options as separate args.
5405 (split-string switches)))
5406 ;; Avoid lossage if FILE starts with `-'.
5407 '("--")
5408 (progn
5409 (if (string-match "\\`~" file)
5410 (setq file (expand-file-name file)))
5411 (list
5412 (if full-directory-p
5413 (concat (file-name-as-directory file) ".")
5414 file))))))))
5415
a1b0c2a7
RS
5416 ;; If we got "//DIRED//" in the output, it means we got a real
5417 ;; directory listing, even if `ls' returned nonzero.
5418 ;; So ignore any errors.
5419 (when (if (stringp switches)
5420 (string-match "--dired\\>" switches)
5421 (member "--dired" switches))
5422 (save-excursion
5423 (forward-line -2)
5424 (when (looking-at "//SUBDIRED//")
5425 (forward-line -1))
5426 (if (looking-at "//DIRED//")
5427 (setq result 0))))
5428
5429 (when (and (not (eq 0 result))
5430 (eq insert-directory-ls-version 'unknown))
5431 ;; The first time ls returns an error,
5432 ;; find the version numbers of ls,
5433 ;; and set insert-directory-ls-version
5434 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5435 ;; is equal or if the info cannot be obtained.
5436 ;; (That can mean it isn't GNU ls.)
5437 (let ((version-out
5438 (with-temp-buffer
5439 (call-process "ls" nil t nil "--version")
5440 (buffer-string))))
5441 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5442 (let* ((version (match-string 1 version-out))
5443 (split (split-string version "[.]"))
027a4b6b 5444 (numbers (mapcar 'string-to-number split))
a1b0c2a7
RS
5445 (min '(5 2 1))
5446 comparison)
5447 (while (and (not comparison) (or numbers min))
5448 (cond ((null min)
5449 (setq comparison '>))
5450 ((null numbers)
5451 (setq comparison '<))
5452 ((> (car numbers) (car min))
5453 (setq comparison '>))
5454 ((< (car numbers) (car min))
5455 (setq comparison '<))
5456 (t
5457 (setq numbers (cdr numbers)
5458 min (cdr min)))))
5459 (setq insert-directory-ls-version (or comparison '=)))
5460 (setq insert-directory-ls-version nil))))
5461
5462 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5463 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5464 (setq result 0))
5465
ebad92dc 5466 ;; If `insert-directory-program' failed, signal an error.
15502042 5467 (unless (eq 0 result)
f2440e42
RS
5468 ;; Delete the error message it may have output.
5469 (delete-region beg (point))
15502042
EZ
5470 ;; On non-Posix systems, we cannot open a directory, so
5471 ;; don't even try, because that will always result in
5472 ;; the ubiquitous "Access denied". Instead, show the
5473 ;; command line so the user can try to guess what went wrong.
5474 (if (and (file-directory-p file)
5475 (memq system-type '(ms-dos windows-nt)))
5476 (error
5477 "Reading directory: \"%s %s -- %s\" exited with status %s"
5478 insert-directory-program
5479 (if (listp switches) (concat switches) switches)
5480 file result)
5481 ;; Unix. Access the file to get a suitable error.
5482 (access-file file "Reading directory")
5483 (error "Listing directory failed but `access-file' worked")))
ebad92dc 5484
8f8607be
LT
5485 (when (if (stringp switches)
5486 (string-match "--dired\\>" switches)
5487 (member "--dired" switches))
9bb99df6
LT
5488 ;; The following overshoots by one line for an empty
5489 ;; directory listed with "--dired", but without "-a"
5490 ;; switch, where the ls output contains a
5491 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5492 ;; We take care of that case later.
ff7affeb 5493 (forward-line -2)
9423860f
AS
5494 (when (looking-at "//SUBDIRED//")
5495 (delete-region (point) (progn (forward-line 1) (point)))
5496 (forward-line -1))
9bb99df6
LT
5497 (if (looking-at "//DIRED//")
5498 (let ((end (line-end-position))
5499 (linebeg (point))
5500 error-lines)
5501 ;; Find all the lines that are error messages,
5502 ;; and record the bounds of each one.
5503 (goto-char beg)
5504 (while (< (point) linebeg)
5505 (or (eql (following-char) ?\s)
5506 (push (list (point) (line-end-position)) error-lines))
5507 (forward-line 1))
5508 (setq error-lines (nreverse error-lines))
5509 ;; Now read the numeric positions of file names.
5510 (goto-char linebeg)
5511 (forward-word 1)
5512 (forward-char 3)
5513 (while (< (point) end)
5514 (let ((start (insert-directory-adj-pos
5515 (+ beg (read (current-buffer)))
5516 error-lines))
5517 (end (insert-directory-adj-pos
a1b0c2a7 5518 (+ beg (read (current-buffer)))
9bb99df6 5519 error-lines)))
26b9ecbc 5520 (if (memq (char-after end) '(?\n ?\s))
9bb99df6
LT
5521 ;; End is followed by \n or by " -> ".
5522 (put-text-property start end 'dired-filename t)
5523 ;; It seems that we can't trust ls's output as to
5524 ;; byte positions of filenames.
5525 (put-text-property beg (point) 'dired-filename nil)
5526 (end-of-line))))
5527 (goto-char end)
5528 (beginning-of-line)
5529 (delete-region (point) (progn (forward-line 1) (point))))
5530 ;; Take care of the case where the ls output contains a
5531 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5532 ;; and we went one line too far back (see above).
5533 (forward-line 1))
5534 (if (looking-at "//DIRED-OPTIONS//")
5535 (delete-region (point) (progn (forward-line 1) (point)))))
ff7affeb 5536
99f01c91 5537 ;; Now decode what read if necessary.
b6647390
KH
5538 (let ((coding (or coding-system-for-read
5539 file-name-coding-system
5540 default-file-name-coding-system
5541 'undecided))
0bded065 5542 coding-no-eol
99f01c91 5543 val pos)
b6647390
KH
5544 (when (and enable-multibyte-characters
5545 (not (memq (coding-system-base coding)
5546 '(raw-text no-conversion))))
5547 ;; If no coding system is specified or detection is
5548 ;; requested, detect the coding.
5549 (if (eq (coding-system-base coding) 'undecided)
5550 (setq coding (detect-coding-region beg (point) t)))
5551 (if (not (eq (coding-system-base coding) 'undecided))
5552 (save-restriction
0bded065
AS
5553 (setq coding-no-eol
5554 (coding-system-change-eol-conversion coding 'unix))
b6647390
KH
5555 (narrow-to-region beg (point))
5556 (goto-char (point-min))
5557 (while (not (eobp))
5558 (setq pos (point)
5559 val (get-text-property (point) 'dired-filename))
5560 (goto-char (next-single-property-change
5561 (point) 'dired-filename nil (point-max)))
0bded065
AS
5562 ;; Force no eol conversion on a file name, so
5563 ;; that CR is preserved.
5564 (decode-coding-region pos (point)
5565 (if val coding-no-eol coding))
b6647390
KH
5566 (if val
5567 (put-text-property pos (point)
5568 'dired-filename t)))))))
99f01c91 5569
75bb5ca4
AS
5570 (if full-directory-p
5571 ;; Try to insert the amount of free space.
5572 (save-excursion
5573 (goto-char beg)
5574 ;; First find the line to put it on.
5575 (when (re-search-forward "^ *\\(total\\)" nil t)
5576 (let ((available (get-free-disk-space ".")))
5577 (when available
5578 ;; Replace "total" with "used", to avoid confusion.
5579 (replace-match "total used in directory" nil nil nil 1)
5580 (end-of-line)
7c2fb837 5581 (insert " available " available))))))))))
34342a07 5582
a1b0c2a7 5583(defun insert-directory-adj-pos (pos error-lines)
fead94d6 5584 "Convert `ls --dired' file name position value POS to a buffer position.
a1b0c2a7
RS
5585File name position values returned in ls --dired output
5586count only stdout; they don't count the error messages sent to stderr.
5587So this function converts to them to real buffer positions.
5588ERROR-LINES is a list of buffer positions of error message lines,
5589of the form (START END)."
5590 (while (and error-lines (< (caar error-lines) pos))
5591 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5592 (pop error-lines))
5593 pos)
5594
bc22fd18
EZ
5595(defun insert-directory-safely (file switches
5596 &optional wildcard full-directory-p)
5597 "Insert directory listing for FILE, formatted according to SWITCHES.
5598
5599Like `insert-directory', but if FILE does not exist, it inserts a
5600message to that effect instead of signaling an error."
5601 (if (file-exists-p file)
5602 (insert-directory file switches wildcard full-directory-p)
5603 ;; Simulate the message printed by `ls'.
5604 (insert (format "%s: No such file or directory\n" file))))
5605
88902b35 5606(defvar kill-emacs-query-functions nil
65d5c6de 5607 "Functions to call with no arguments to query about killing Emacs.
78c793d1 5608If any of these functions returns nil, killing Emacs is cancelled.
6daab4ed
JB
5609`save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5610the low level primitive, does not. See also `kill-emacs-hook'.")
88902b35 5611
11f15305 5612(defcustom confirm-kill-emacs nil
9c2ba08f
EZ
5613 "How to ask for confirmation when leaving Emacs.
5614If nil, the default, don't ask at all. If the value is non-nil, it should
5615be a predicate function such as `yes-or-no-p'."
11f15305
GM
5616 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5617 (const :tag "Ask with y-or-n-p" y-or-n-p)
5618 (const :tag "Don't confirm" nil))
bdd9ab6e 5619 :group 'convenience
11f15305
GM
5620 :version "21.1")
5621
b4da00e9
RM
5622(defun save-buffers-kill-emacs (&optional arg)
5623 "Offer to save each buffer, then kill this Emacs process.
5624With prefix arg, silently save all file-visiting buffers, then kill."
5625 (interactive "P")
5626 (save-some-buffers arg t)
5627 (and (or (not (memq t (mapcar (function
5628 (lambda (buf) (and (buffer-file-name buf)
5629 (buffer-modified-p buf))))
5630 (buffer-list))))
5631 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5632 (or (not (fboundp 'process-list))
7c2fb837 5633 ;; process-list is not defined on MSDOS.
b4da00e9
RM
5634 (let ((processes (process-list))
5635 active)
5636 (while processes
48a4a1fb
KS
5637 (and (memq (process-status (car processes)) '(run stop open listen))
5638 (process-query-on-exit-flag (car processes))
b4da00e9
RM
5639 (setq active t))
5640 (setq processes (cdr processes)))
5641 (or (not active)
48a4a1fb 5642 (list-processes t)
b4da00e9 5643 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 5644 ;; Query the user for other things, perhaps.
fb15c113 5645 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
11f15305
GM
5646 (or (null confirm-kill-emacs)
5647 (funcall confirm-kill-emacs "Really exit Emacs? "))
b4da00e9 5648 (kill-emacs)))
59e085e0 5649
6ed8eeff 5650(defun save-buffers-kill-terminal (&optional arg)
59e085e0
KL
5651 "Offer to save each buffer, then kill the current connection.
5652If the current frame has no client, kill Emacs itself.
5653
5654With prefix arg, silently save all file-visiting buffers, then kill.
5655
5656If emacsclient was started with a list of filenames to edit, then
5657only these files will be asked to be saved."
5658 (interactive "P")
5659 (let ((proc (frame-parameter (selected-frame) 'client))
5660 (frame (selected-frame)))
5661 (if (null proc)
5662 (save-buffers-kill-emacs)
6ed8eeff 5663 (server-save-buffers-kill-terminal proc arg))))
59e085e0 5664
b4da00e9 5665\f
ffc0e1ca 5666;; We use /: as a prefix to "quote" a file name
47afc068
RS
5667;; so that magic file name handlers will not apply to it.
5668
5669(setq file-name-handler-alist
5670 (cons '("\\`/:" . file-name-non-special)
5671 file-name-handler-alist))
5672
5673;; We depend on being the last handler on the list,
5674;; so that anything else which does need handling
5675;; has been handled already.
5676;; So it is safe for us to inhibit *all* magic file name handlers.
5677
5678(defun file-name-non-special (operation &rest arguments)
5679 (let ((file-name-handler-alist nil)
5cb1f728
KH
5680 (default-directory
5681 (if (eq operation 'insert-directory)
5682 (directory-file-name
ffc0e1ca 5683 (expand-file-name
5cb1f728
KH
5684 (unhandled-file-name-directory default-directory)))
5685 default-directory))
47afc068
RS
5686 ;; Get a list of the indices of the args which are file names.
5687 (file-arg-indices
5688 (cdr (or (assq operation
ae3b2983 5689 ;; The first six are special because they
47afc068
RS
5690 ;; return a file name. We want to include the /:
5691 ;; in the return value.
5692 ;; So just avoid stripping it in the first place.
5693 '((expand-file-name . nil)
5694 (file-name-directory . nil)
5695 (file-name-as-directory . nil)
5696 (directory-file-name . nil)
c736f678 5697 (file-name-sans-versions . nil)
ae3b2983 5698 (find-backup-file-name . nil)
c736f678 5699 ;; `identity' means just return the first arg
6750c852
RS
5700 ;; not stripped of its quoting.
5701 (substitute-in-file-name identity)
ae3b2983
MA
5702 ;; `add' means add "/:" to the result.
5703 (file-truename add 0)
5704 ;; `quote' means add "/:" to buffer-file-name.
5705 (insert-file-contents quote 0)
5706 ;; `unquote-then-quote' means set buffer-file-name
5707 ;; temporarily to unquoted filename.
5708 (verify-visited-file-modtime unquote-then-quote)
5709 ;; List the arguments which are filenames.
c37adaa5
SM
5710 (file-name-completion 1)
5711 (file-name-all-completions 1)
ae3b2983 5712 (write-region 2 5)
47afc068
RS
5713 (rename-file 0 1)
5714 (copy-file 0 1)
5715 (make-symbolic-link 0 1)
5716 (add-name-to-file 0 1)))
5717 ;; For all other operations, treat the first argument only
5718 ;; as the file name.
5719 '(nil 0))))
6750c852 5720 method
47afc068
RS
5721 ;; Copy ARGUMENTS so we can replace elements in it.
5722 (arguments (copy-sequence arguments)))
6750c852
RS
5723 (if (symbolp (car file-arg-indices))
5724 (setq method (pop file-arg-indices)))
5725 ;; Strip off the /: from the file names that have it.
47afc068 5726 (save-match-data
18b9dced 5727 (while (consp file-arg-indices)
fe4d9852
KH
5728 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5729 (and (car pair)
5730 (string-match "\\`/:" (car pair))
5731 (setcar pair
5732 (if (= (length (car pair)) 2)
5733 "/"
5734 (substring (car pair) 2)))))
47afc068 5735 (setq file-arg-indices (cdr file-arg-indices))))
6750c852
RS
5736 (cond ((eq method 'identity)
5737 (car arguments))
ae3b2983 5738 ((eq method 'add)
6750c852 5739 (concat "/:" (apply operation arguments)))
ae3b2983 5740 ((eq method 'quote)
e8f30180
RS
5741 (unwind-protect
5742 (apply operation arguments)
ae3b2983
MA
5743 (setq buffer-file-name (concat "/:" buffer-file-name))))
5744 ((eq method 'unquote-then-quote)
5745 (let (res)
5746 (setq buffer-file-name (substring buffer-file-name 2))
5747 (setq res (apply operation arguments))
5748 (setq buffer-file-name (concat "/:" buffer-file-name))
5749 res))
6750c852
RS
5750 (t
5751 (apply operation arguments)))))
47afc068 5752\f
90d10f16
MC
5753;; Symbolic modes and read-file-modes.
5754
5755(defun file-modes-char-to-who (char)
e240aaa9
EZ
5756 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5757CHAR is in [ugoa] and represents the category of users (Owner, Group,
5758Others, or All) for whom to produce the mask.
5759The bit-mask that is returned extracts from mode bits the access rights
5760for the specified category of users."
90d10f16
MC
5761 (cond ((= char ?u) #o4700)
5762 ((= char ?g) #o2070)
5763 ((= char ?o) #o1007)
5764 ((= char ?a) #o7777)
5765 (t (error "%c: bad `who' character" char))))
5766
5767(defun file-modes-char-to-right (char &optional from)
e240aaa9
EZ
5768 "Convert CHAR to a numeric value of mode bits.
5769CHAR is in [rwxXstugo] and represents symbolic access permissions.
5770If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
90d10f16
MC
5771 (or from (setq from 0))
5772 (cond ((= char ?r) #o0444)
5773 ((= char ?w) #o0222)
5774 ((= char ?x) #o0111)
5775 ((= char ?s) #o1000)
5776 ((= char ?t) #o6000)
5777 ;; Rights relative to the previous file modes.
5778 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5779 ((= char ?u) (let ((uright (logand #o4700 from)))
5780 (+ uright (/ uright #o10) (/ uright #o100))))
5781 ((= char ?g) (let ((gright (logand #o2070 from)))
5782 (+ gright (/ gright #o10) (* gright #o10))))
5783 ((= char ?o) (let ((oright (logand #o1007 from)))
5784 (+ oright (* oright #o10) (* oright #o100))))
5785 (t (error "%c: bad right character" char))))
5786
5787(defun file-modes-rights-to-number (rights who-mask &optional from)
e240aaa9
EZ
5788 "Convert a symbolic mode string specification to an equivalent number.
5789RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]+)+\".
5790WHO-MASK is the bit-mask specifying the category of users to which to
5791apply the access permissions. See `file-modes-char-to-who'.
5792FROM (or 0 if nil) gives the mode bits on which to base permissions if
5793RIGHTS request to add, remove, or set permissions based on existing ones,
5794as in \"og+rX-w\"."
90d10f16
MC
5795 (let* ((num-rights (or from 0))
5796 (list-rights (string-to-list rights))
5797 (op (pop list-rights)))
5798 (while (memq op '(?+ ?- ?=))
5799 (let ((num-right 0)
5800 char-right)
5801 (while (memq (setq char-right (pop list-rights))
5802 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5803 (setq num-right
5804 (logior num-right
5805 (file-modes-char-to-right char-right num-rights))))
5806 (setq num-right (logand who-mask num-right)
5807 num-rights
5808 (cond ((= op ?+) (logior num-rights num-right))
5809 ((= op ?-) (logand num-rights (lognot num-right)))
5810 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5811 op char-right)))
5812 num-rights))
5813
5814(defun file-modes-symbolic-to-number (modes &optional from)
5815 "Convert symbolic file modes to numeric file modes.
5816MODES is the string to convert, it should match
5817\"[ugoa]*([+-=][rwxXstugo]+)+,...\".
5818See (info \"(coreutils)File permissions\") for more information on this
5819notation.
e240aaa9
EZ
5820FROM (or 0 if nil) gives the mode bits on which to base permissions if
5821MODES request to add, remove, or set permissions based on existing ones,
5822as in \"og+rX-w\"."
90d10f16
MC
5823 (save-match-data
5824 (let ((case-fold-search nil)
5825 (num-modes (or from 0)))
5826 (while (/= (string-to-char modes) 0)
5827 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes)
5828 (let ((num-who (apply 'logior 0
5829 (mapcar 'file-modes-char-to-who
5830 (match-string 1 modes)))))
5831 (when (= num-who 0)
5832 (setq num-who (default-file-modes)))
5833 (setq num-modes
5834 (file-modes-rights-to-number (substring modes (match-end 1))
5835 num-who num-modes)
5836 modes (substring modes (match-end 3))))
5837 (error "Parse error in modes near `%s'" (substring modes 0))))
5838 num-modes)))
5839
5840(defun read-file-modes (&optional prompt orig-file)
e240aaa9 5841 "Read file modes in octal or symbolic notation and return its numeric value.
90d10f16 5842PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
e240aaa9
EZ
5843ORIG-FILE is the name of a file on whose mode bits to base returned
5844permissions if what user types requests to add, remove, or set permissions
5845based on existing mode bits, as in \"og+rX-w\"."
90d10f16
MC
5846 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
5847 (error "File not found")))
7cb41b32
JL
5848 (modestr (and (stringp orig-file)
5849 (nth 8 (file-attributes orig-file))))
5850 (default
5851 (and (stringp modestr)
5852 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
5853 (replace-regexp-in-string
5854 "-" ""
5855 (format "u=%s,g=%s,o=%s"
5856 (match-string 1 modestr)
5857 (match-string 2 modestr)
5858 (match-string 3 modestr)))))
5859 (value (read-string (or prompt "File modes (octal or symbolic): ")
5860 nil nil default)))
90d10f16
MC
5861 (save-match-data
5862 (if (string-match "^[0-7]+" value)
5863 (string-to-number value 8)
5864 (file-modes-symbolic-to-number value modes)))))
5865
5866\f
e240aaa9
EZ
5867;; Trashcan handling.
5868(defcustom trash-directory (convert-standard-filename "~/.Trash")
6cf29fe8
JR
5869 "Directory for `move-file-to-trash' to move files and directories to.
5870This directory is only used when the function `system-move-file-to-trash' is
5871not defined. Relative paths are interpreted relative to `default-directory'.
5872See also `delete-by-moving-to-trash'."
5873 :type 'directory
5874 :group 'auto-save
5875 :version "23.1")
5876
5877(declare-function system-move-file-to-trash "w32fns.c" (filename))
5878
5879(defun move-file-to-trash (filename)
5880 "Move file (or directory) name FILENAME to the trash.
5881This function is called by `delete-file' and `delete-directory' when
5882`delete-by-moving-to-trash' is non-nil. On platforms that define
5883`system-move-file-to-trash', that function is used to move FILENAME to the
5884system trash, otherwise FILENAME is moved to `trash-directory'.
5885Returns nil on success."
5886 (interactive "fMove file to trash: ")
5887 (cond
5888 ((fboundp 'system-move-file-to-trash)
5889 (system-move-file-to-trash filename))
5890 (t
5891 (let* ((trash-dir (expand-file-name trash-directory))
5892 (fn (directory-file-name (expand-file-name filename)))
5893 (fn-nondir (file-name-nondirectory fn))
5894 (new-fn (expand-file-name fn-nondir trash-dir)))
5895 (or (file-directory-p trash-dir)
5896 (make-directory trash-dir t))
5897 (and (file-exists-p new-fn)
5898 ;; make new-fn unique.
5899 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5900 (let ((version-control t))
5901 (setq new-fn (car (find-backup-file-name new-fn)))))
5902 ;; stop processing if fn is same or parent directory of trash-dir.
5903 (and (string-match fn trash-dir)
5904 (error "Filename `%s' is same or parent directory of trash-directory"
5905 filename))
3102b342
GM
5906 (let ((delete-by-moving-to-trash nil))
5907 (rename-file fn new-fn))))))
6cf29fe8
JR
5908
5909\f
b4da00e9 5910(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
5911(define-key ctl-x-map "\C-r" 'find-file-read-only)
5912(define-key ctl-x-map "\C-v" 'find-alternate-file)
5913(define-key ctl-x-map "\C-s" 'save-buffer)
5914(define-key ctl-x-map "s" 'save-some-buffers)
5915(define-key ctl-x-map "\C-w" 'write-file)
5916(define-key ctl-x-map "i" 'insert-file)
5917(define-key esc-map "~" 'not-modified)
5918(define-key ctl-x-map "\C-d" 'list-directory)
6ed8eeff 5919(define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
d758359d 5920(define-key ctl-x-map "\C-q" 'toggle-read-only)
b4da00e9
RM
5921
5922(define-key ctl-x-4-map "f" 'find-file-other-window)
5923(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5924(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5925(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 5926(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 5927
f98955ea
JB
5928(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5929(define-key ctl-x-5-map "f" 'find-file-other-frame)
5930(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5931(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
3095ccf5 5932(define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
c0274f38 5933
c3f6aa20 5934;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
c0274f38 5935;;; files.el ends here