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