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