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