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