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