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