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