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