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