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