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