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