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