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