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