]> code.delx.au - gnu-emacs/blob - lisp/files.el
(x-create-frame-with-faces): Handle reverseVideo resource.
[gnu-emacs] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc.
4
5 ;; Maintainer: FSF
6
7 ;; This file is part of GNU Emacs.
8
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
22
23 ;;; Commentary:
24
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
28
29 ;;; Code:
30
31 (defconst delete-auto-save-files t
32 "*Non-nil means delete a buffer's auto-save file when the buffer is saved.")
33
34 (defconst directory-abbrev-alist
35 nil
36 "*Alist of abbreviations for file directories.
37 A list of elements of the form (FROM . TO), each meaning to replace
38 FROM with TO when it appears in a directory name. This replacement is
39 done when setting up the default directory of a newly visited file.
40 *Every* FROM string should start with `^'.
41
42 Use this feature when you have directories which you normally refer to
43 via absolute symbolic links. Make TO the name of the link, and FROM
44 the name it is linked to.")
45
46 ;;; Turn off backup files on VMS since it has version numbers.
47 (defconst make-backup-files (not (eq system-type 'vax-vms))
48 "*Create a backup of each file when it is saved for the first time.
49 This can be done by renaming the file or by copying.
50
51 Renaming means that Emacs renames the existing file so that it is a
52 backup file, then writes the buffer into a new file. Any other names
53 that the old file had will now refer to the backup file. The new file
54 is owned by you and its group is defaulted.
55
56 Copying means that Emacs copies the existing file into the backup
57 file, then writes the buffer on top of the existing file. Any other
58 names that the old file had will now refer to the new (edited) file.
59 The file's owner and group are unchanged.
60
61 The choice of renaming or copying is controlled by the variables
62 `backup-by-copying', `backup-by-copying-when-linked' and
63 `backup-by-copying-when-mismatch'.")
64
65 ;; Do this so that local variables based on the file name
66 ;; are not overridden by the major mode.
67 (defvar backup-inhibited nil
68 "Non-nil means don't make a backup file for this buffer.")
69 (put 'backup-inhibited 'permanent-local t)
70
71 (defconst backup-by-copying nil
72 "*Non-nil means always use copying to create backup files.
73 See documentation of variable `make-backup-files'.")
74
75 (defconst backup-by-copying-when-linked nil
76 "*Non-nil means use copying to create backups for files with multiple names.
77 This causes the alternate names to refer to the latest version as edited.
78 This variable is relevant only if `backup-by-copying' is nil.")
79
80 (defconst backup-by-copying-when-mismatch nil
81 "*Non-nil means create backups by copying if this preserves owner or group.
82 Renaming may still be used (subject to control of other variables)
83 when it would not result in changing the owner or group of the file;
84 that is, for files which are owned by you and whose group matches
85 the default for a new file created there by you.
86 This variable is relevant only if `backup-by-copying' is nil.")
87
88 (defvar backup-enable-predicate
89 '(lambda (name)
90 (or (< (length name) 5)
91 (not (string-equal "/tmp/" (substring name 0 5)))))
92 "Predicate that looks at a file name and decides whether to make backups.
93 Called with an absolute file name as argument, it returns t to enable backup.")
94
95 (defconst buffer-offer-save nil
96 "*Non-nil in a buffer means offer to save the buffer on exit
97 even if the buffer is not visiting a file.
98 Automatically local in all buffers.")
99 (make-variable-buffer-local 'buffer-offer-save)
100
101 (defconst find-file-existing-other-name nil
102 "*Non-nil means find a file under alternative names, in existing buffers.
103 This means if any existing buffer is visiting the file you want
104 under another name, you get the existing buffer instead of a new buffer.")
105
106 (defconst find-file-visit-truename nil
107 "*Non-nil means visit a file under its truename.
108 The truename of a file is found by chasing all links
109 both at the file level and at the levels of the containing directories.")
110
111 (defvar buffer-file-truename nil
112 "The truename of the file visited in the current buffer.
113 This variable is automatically local in all buffers, when non-nil.")
114 (make-variable-buffer-local 'buffer-file-truename)
115 (put 'buffer-file-truename 'permanent-local t)
116
117 (defvar buffer-file-number nil
118 "The device number and file number of the file visited in the current buffer.
119 The value is a list of the form (FILENUM DEVNUM).
120 This pair of numbers uniquely identifies the file.
121 If the buffer is visiting a new file, the value is nil.")
122 (make-variable-buffer-local 'buffer-file-number)
123 (put 'buffer-file-number 'permanent-local t)
124
125 (defconst file-precious-flag nil
126 "*Non-nil means protect against I/O errors while saving files.
127 Some modes set this non-nil in particular buffers.")
128
129 (defvar version-control nil
130 "*Control use of version numbers for backup files.
131 t means make numeric backup versions unconditionally.
132 nil means make them for files that have some already.
133 never means do not make them.")
134
135 (defvar dired-kept-versions 2
136 "*When cleaning directory, number of versions to keep.")
137
138 (defvar trim-versions-without-asking nil
139 "*If t, deletes excess backup versions silently.
140 If nil, asks confirmation. Any other value prevents any trimming.")
141
142 (defvar kept-old-versions 2
143 "*Number of oldest versions to keep when a new numbered backup is made.")
144
145 (defvar kept-new-versions 2
146 "*Number of newest versions to keep when a new numbered backup is made.
147 Includes the new backup. Must be > 0")
148
149 (defconst require-final-newline nil
150 "*Value of t says silently ensure a file ends in a newline when it is saved.
151 Non-nil but not t says ask user whether to add a newline when there isn't one.
152 nil means don't add newlines.")
153
154 (defconst auto-save-default t
155 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
156
157 (defconst auto-save-visited-file-name nil
158 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
159 Normally auto-save files are written under other names.")
160
161 (defconst save-abbrevs nil
162 "*Non-nil means save word abbrevs too when files are saved.
163 Loading an abbrev file sets this to t.")
164
165 (defconst find-file-run-dired t
166 "*Non-nil says run dired if find-file is given the name of a directory.")
167
168 ;;;It is not useful to make this a local variable.
169 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
170 (defvar find-file-not-found-hooks nil
171 "List of functions to be called for `find-file' on nonexistent file.
172 These functions are called as soon as the error is detected.
173 `buffer-file-name' is already set up.
174 The functions are called in the order given until one of them returns non-nil.")
175
176 ;;;It is not useful to make this a local variable.
177 ;;;(put 'find-file-hooks 'permanent-local t)
178 (defvar find-file-hooks nil
179 "List of functions to be called after a buffer is loaded from a file.
180 The buffer's local variables (if any) will have been processed before the
181 functions are called.")
182
183 ;;; In case someone does make it local.
184 (put 'write-file-hooks 'permanent-local t)
185 (defvar write-file-hooks nil
186 "List of functions to be called before writing out a buffer to a file.
187 If one of them returns non-nil, the file is considered already written
188 and the rest are not called.
189 These hooks are considered to pertain to the visited file.
190 So this list is cleared if you change the visited file name.
191 See also `write-contents-hooks'.
192 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.")
193
194 (put 'local-write-file-hooks 'permanent-local t)
195 (defvar local-write-file-hooks nil
196 "Just like `write-file-hooks', except intended for per-buffer use.
197 The functions in this list are called before the ones in
198 `write-file-hooks'.")
199
200 (defvar write-contents-hooks nil
201 "List of functions to be called before writing out a buffer to a file.
202 If one of them returns non-nil, the file is considered already written
203 and the rest are not called.
204 These hooks are considered to pertain to the buffer's contents,
205 not to the particular visited file; thus, `set-visited-file-name' does
206 not clear this variable, but changing the major mode does clear it.
207 See also `write-file-hooks'.")
208
209 (defconst enable-local-variables t
210 "*Control use of local-variables lists in files you visit.
211 The value can be t, nil or something else.
212 A value of t means local-variables lists are obeyed;
213 nil means they are ignored; anything else means query.
214
215 The command \\[normal-mode] always obeys local-variables lists
216 and ignores this variable.")
217
218 (defconst enable-local-eval 'maybe
219 "*Control processing of the \"variable\" `eval' in a file's local variables.
220 The value can be t, nil or something else.
221 A value of t means obey `eval' variables;
222 nil means ignore them; anything else means query.
223
224 The command \\[normal-mode] always obeys local-variables lists
225 and ignores this variable.")
226
227 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
228 (or (fboundp 'lock-buffer)
229 (defalias 'lock-buffer 'ignore))
230 (or (fboundp 'unlock-buffer)
231 (defalias 'unlock-buffer 'ignore))
232 \f
233 (defun pwd ()
234 "Show the current default directory."
235 (interactive nil)
236 (message "Directory %s" default-directory))
237
238 (defvar cd-path nil
239 "Value of the CDPATH environment variable, as a list.
240 Not actually set up until the first time you you use it.")
241
242 (defun parse-colon-path (cd-path)
243 "Explode a colon-separated list of paths into a string list."
244 (and cd-path
245 (let (cd-prefix cd-list (cd-start 0) cd-colon)
246 (setq cd-path (concat cd-path ":"))
247 (while (setq cd-colon (string-match ":" cd-path cd-start))
248 (setq cd-list
249 (nconc cd-list
250 (list (substitute-in-file-name
251 (file-name-as-directory
252 (substring cd-path cd-start cd-colon))))))
253 (setq cd-start (+ cd-colon 1)))
254 cd-list)))
255
256 (defun cd-absolute (dir)
257 "Change current directory to given absolute path DIR."
258 (interactive "DChange default directory: ")
259 (setq dir (expand-file-name dir))
260 (if (not (eq system-type 'vax-vms))
261 (setq dir (file-name-as-directory dir)))
262 (if (not (file-directory-p dir))
263 (error "%s is not a directory" dir)
264 (if (file-executable-p dir)
265 (setq default-directory dir)
266 (error "Cannot cd to %s: Permission denied" dir))))
267
268 (defun cd (dir)
269 "Make DIR become the current buffer's default directory.
270 If your environment imcludes a $CDPATH variable, cd tries each one of that
271 colon-separated list of directories when resolving a relative cd."
272 (interactive "FChange default directory: ")
273 (let ((first (aref dir 0)))
274 (if (or (= first ?/) (= first ?~))
275 (cd-absolute (expand-file-name dir))
276 (if (null cd-path)
277 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
278 (setq cd-path (or trypath (list "./")))))
279 (if (not (catch 'found
280 (mapcar
281 (function (lambda (x)
282 (let ((f (expand-file-name (concat x dir))))
283 (if (file-directory-p f)
284 (progn
285 (cd-absolute f)
286 (throw 'found t))))))
287 cd-path)
288 nil))
289 (error "No such directory on your cd path.")))
290 ))
291
292 (defun load-file (file)
293 "Load the Lisp file named FILE."
294 (interactive "fLoad file: ")
295 (load (expand-file-name file) nil nil t))
296
297 (defun load-library (library)
298 "Load the library named LIBRARY.
299 This is an interface to the function `load'."
300 (interactive "sLoad library: ")
301 (load library))
302
303 ;; OTHER is the other file to be compared.
304 (defun file-local-copy (file)
305 "Copy the file FILE into a temporary file on this machine.
306 Returns the name of the local copy, or nil, if FILE is directly
307 accessible."
308 (let ((handler (find-file-name-handler file)))
309 (if handler
310 (funcall handler 'file-local-copy file)
311 nil)))
312
313 (defun file-truename (filename)
314 "Return the truename of FILENAME, which should be absolute.
315 The truename of a file name is found by chasing symbolic links
316 both at the level of the file and at the level of the directories
317 containing it, until no links are left at any level."
318 (if (string= filename "~")
319 (progn
320 (setq filename (expand-file-name filename))
321 (if (string= filename "")
322 (setq filename "/"))))
323 (let ((handler (find-file-name-handler filename)))
324 ;; For file name that has a special handler, call handler.
325 ;; This is so that ange-ftp can save time by doing a no-op.
326 (if handler
327 (funcall handler 'file-truename filename)
328 (let ((dir (file-name-directory filename))
329 target dirfile)
330 ;; Get the truename of the directory.
331 (setq dirfile (directory-file-name dir))
332 ;; If these are equal, we have the (or a) root directory.
333 (or (string= dir dirfile)
334 (setq dir (file-name-as-directory (file-truename dirfile))))
335 ;; Put it back on the file name.
336 (setq filename (concat dir (file-name-nondirectory filename)))
337 ;; Is the file name the name of a link?
338 (setq target (file-symlink-p filename))
339 (if target
340 ;; Yes => chase that link, then start all over
341 ;; since the link may point to a directory name that uses links.
342 (file-truename (expand-file-name target dir))
343 ;; No, we are done!
344 filename)))))
345
346 \f
347 (defun switch-to-buffer-other-window (buffer)
348 "Select buffer BUFFER in another window."
349 (interactive "BSwitch to buffer in other window: ")
350 (let ((pop-up-windows t))
351 (pop-to-buffer buffer t)))
352
353 (defun switch-to-buffer-other-frame (buffer)
354 "Switch to buffer BUFFER in another frame."
355 (interactive "BSwitch to buffer in other frame: ")
356 (let ((pop-up-frames t))
357 (pop-to-buffer buffer t)))
358
359 (defun find-file (filename)
360 "Edit file FILENAME.
361 Switch to a buffer visiting file FILENAME,
362 creating one if none already exists."
363 (interactive "FFind file: ")
364 (switch-to-buffer (find-file-noselect filename)))
365
366 (defun find-file-other-window (filename)
367 "Edit file FILENAME, in another window.
368 May create a new window, or reuse an existing one.
369 See the function `display-buffer'."
370 (interactive "FFind file in other window: ")
371 (switch-to-buffer-other-window (find-file-noselect filename)))
372
373 (defun find-file-other-frame (filename)
374 "Edit file FILENAME, in another frame.
375 May create a new frame, or reuse an existing one.
376 See the function `display-buffer'."
377 (interactive "FFind file in other frame: ")
378 (switch-to-buffer-other-frame (find-file-noselect filename)))
379
380 (defun find-file-read-only (filename)
381 "Edit file FILENAME but don't allow changes.
382 Like \\[find-file] but marks buffer as read-only.
383 Use \\[toggle-read-only] to permit editing."
384 (interactive "fFind file read-only: ")
385 (find-file filename)
386 (setq buffer-read-only t))
387
388 (defun find-file-read-only-other-window (filename)
389 "Edit file FILENAME in another window but don't allow changes.
390 Like \\[find-file-other-window] but marks buffer as read-only.
391 Use \\[toggle-read-only] to permit editing."
392 (interactive "fFind file read-only other window: ")
393 (find-file-other-window filename)
394 (setq buffer-read-only t))
395
396 (defun find-file-read-only-other-frame (filename)
397 "Edit file FILENAME in another frame but don't allow changes.
398 Like \\[find-file-other-frame] but marks buffer as read-only.
399 Use \\[toggle-read-only] to permit editing."
400 (interactive "fFind file read-only other frame: ")
401 (find-file-other-frame filename)
402 (setq buffer-read-only t))
403
404 (defun find-alternate-file (filename)
405 "Find file FILENAME, select its buffer, kill previous buffer.
406 If the current buffer now contains an empty file that you just visited
407 \(presumably by mistake), use this command to visit the file you really want."
408 (interactive
409 (let ((file buffer-file-name)
410 (file-name nil)
411 (file-dir nil))
412 (and file
413 (setq file-name (file-name-nondirectory file)
414 file-dir (file-name-directory file)))
415 (list (read-file-name
416 "Find alternate file: " file-dir nil nil file-name))))
417 (and (buffer-modified-p)
418 ;; (not buffer-read-only)
419 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
420 (buffer-name))))
421 (error "Aborted"))
422 (let ((obuf (current-buffer))
423 (ofile buffer-file-name)
424 (oname (buffer-name)))
425 (rename-buffer " **lose**")
426 (setq buffer-file-name nil)
427 (unwind-protect
428 (progn
429 (unlock-buffer)
430 (find-file filename))
431 (cond ((eq obuf (current-buffer))
432 (setq buffer-file-name ofile)
433 (lock-buffer)
434 (rename-buffer oname))))
435 (or (eq (current-buffer) obuf)
436 (kill-buffer obuf))))
437
438 (defun create-file-buffer (filename)
439 "Create a suitably named buffer for visiting FILENAME, and return it.
440 FILENAME (sans directory) is used unchanged if that name is free;
441 otherwise a string <2> or <3> or ... is appended to get an unused name."
442 (let ((lastname (file-name-nondirectory filename)))
443 (if (string= lastname "")
444 (setq lastname filename))
445 (generate-new-buffer lastname)))
446
447 (defun generate-new-buffer (name)
448 "Create and return a buffer with a name based on NAME.
449 Choose the buffer's name using `generate-new-buffer-name'."
450 (get-buffer-create (generate-new-buffer-name name)))
451
452 (defconst automount-dir-prefix "^/tmp_mnt/"
453 "Regexp to match the automounter prefix in a directory name.")
454
455 (defvar abbreviated-home-dir nil
456 "The the user's homedir abbreviated according to `directory-abbrev-list'.")
457
458 (defun abbreviate-file-name (filename)
459 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
460 This also substitutes \"~\" for the user's home directory.
461 Type \\[describe-variable] directory-abbrev-alist RET for more information."
462 ;; Get rid of the prefixes added by the automounter.
463 (if (and (string-match automount-dir-prefix filename)
464 (file-exists-p (file-name-directory
465 (substring filename (1- (match-end 0))))))
466 (setq filename (substring filename (1- (match-end 0)))))
467 (let ((tail directory-abbrev-alist))
468 ;; If any elt of directory-abbrev-alist matches this name,
469 ;; abbreviate accordingly.
470 (while tail
471 (if (string-match (car (car tail)) filename)
472 (setq filename
473 (concat (cdr (car tail)) (substring filename (match-end 0)))))
474 (setq tail (cdr tail)))
475 ;; Compute and save the abbreviated homedir name.
476 ;; We defer computing this until the first time it's needed, to
477 ;; give time for directory-abbrev-alist to be set properly.
478 (or abbreviated-home-dir
479 (setq abbreviated-home-dir
480 (let ((abbreviated-home-dir "$foo"))
481 (concat "^" (abbreviate-file-name (expand-file-name "~"))))))
482 ;; If FILENAME starts with the abbreviated homedir,
483 ;; make it start with `~' instead.
484 (if (string-match abbreviated-home-dir filename)
485 (setq filename
486 (concat "~"
487 ;; If abbreviated-home-dir ends with a slash,
488 ;; don't remove the corresponding slash from
489 ;; filename. On MS-DOS and OS/2, you can have
490 ;; home directories like "g:/", in which it is
491 ;; important not to remove the slash. And what
492 ;; about poor root on Unix systems?
493 (if (eq ?/ (aref abbreviated-home-dir
494 (1- (length abbreviated-home-dir))))
495 "/"
496 "")
497 (substring filename (match-end 0)))))
498 filename))
499
500 (defvar find-file-not-true-dirname-list nil
501 "*List of logical names for which visiting shouldn't save the true dirname.
502 On VMS, when you visit a file using a logical name that searches a path,
503 you may or may not want the visited file name to record the specific
504 directory where the file was found. If you *do not* want that, add the logical
505 name to this list as a string.")
506
507 (defun find-file-noselect (filename &optional nowarn)
508 "Read file FILENAME into a buffer and return the buffer.
509 If a buffer exists visiting FILENAME, return that one, but
510 verify that the file has not changed since visited or saved.
511 The buffer is not selected, just returned to the caller."
512 (setq filename
513 (abbreviate-file-name
514 (expand-file-name filename)))
515 (if (file-directory-p filename)
516 (if find-file-run-dired
517 (dired-noselect filename)
518 (error "%s is a directory." filename))
519 (let* ((buf (get-file-buffer filename))
520 (truename (abbreviate-file-name (file-truename filename)))
521 (number (nthcdr 10 (file-attributes truename)))
522 ;; Find any buffer for a file which has same truename.
523 (same-truename
524 (or buf ; Shortcut
525 (let (found
526 (list (buffer-list)))
527 (while (and (not found) list)
528 (save-excursion
529 (set-buffer (car list))
530 (if (and buffer-file-name
531 (string= buffer-file-truename truename))
532 (setq found (car list))))
533 (setq list (cdr list)))
534 found)))
535 (same-number
536 (or buf ; Shortcut
537 (and number
538 (let (found
539 (list (buffer-list)))
540 (while (and (not found) list)
541 (save-excursion
542 (set-buffer (car list))
543 (if (and (equal buffer-file-number number)
544 ;; Verify this buffer's file number
545 ;; still belongs to its file.
546 (file-exists-p buffer-file-name)
547 (equal (nthcdr 10 (file-attributes buffer-file-name)) number))
548 (setq found (car list))))
549 (setq list (cdr list)))
550 found))))
551 error)
552 ;; Let user know if there is a buffer with the same truename.
553 (if (and (not buf) same-truename (not nowarn))
554 (message "%s and %s are the same file (%s)"
555 filename (buffer-file-name same-truename)
556 truename)
557 (if (and (not buf) same-number (not nowarn))
558 (message "%s and %s are the same file"
559 filename (buffer-file-name same-number))))
560
561 ;; Optionally also find that buffer.
562 (if (or find-file-existing-other-name find-file-visit-truename)
563 (setq buf (or same-truename same-number)))
564 (if buf
565 (or nowarn
566 (verify-visited-file-modtime buf)
567 (cond ((not (file-exists-p filename))
568 (error "File %s no longer exists!" filename))
569 ((yes-or-no-p
570 (format
571 (if (buffer-modified-p buf)
572 "File %s changed on disk. Discard your edits? "
573 "File %s changed on disk. Read the new version? ")
574 (file-name-nondirectory filename)))
575 (save-excursion
576 (set-buffer buf)
577 (revert-buffer t t)))))
578 (save-excursion
579 ;;; The truename stuff makes this obsolete.
580 ;;; (let* ((link-name (car (file-attributes filename)))
581 ;;; (linked-buf (and (stringp link-name)
582 ;;; (get-file-buffer link-name))))
583 ;;; (if (bufferp linked-buf)
584 ;;; (message "Symbolic link to file in buffer %s"
585 ;;; (buffer-name linked-buf))))
586 (setq buf (create-file-buffer filename))
587 (set-buffer buf)
588 (erase-buffer)
589 (condition-case ()
590 (insert-file-contents filename t)
591 (file-error
592 (setq error t)
593 ;; Run find-file-not-found-hooks until one returns non-nil.
594 (let ((hooks find-file-not-found-hooks))
595 (while (and hooks
596 (not (funcall (car hooks))))
597 (setq hooks (cdr hooks))))))
598 ;; Find the file's truename, and maybe use that as visited name.
599 (setq buffer-file-truename (abbreviate-file-name truename))
600 (setq buffer-file-number number)
601 ;; On VMS, we may want to remember which directory in a search list
602 ;; the file was found in.
603 (and (eq system-type 'vax-vms)
604 (let (logical)
605 (if (string-match ":" (file-name-directory filename))
606 (setq logical (substring (file-name-directory filename)
607 0 (match-beginning 0))))
608 (not (member logical find-file-not-true-dirname-list)))
609 (setq buffer-file-name buffer-file-truename))
610 (if find-file-visit-truename
611 (setq buffer-file-name
612 (setq filename
613 (expand-file-name buffer-file-truename))))
614 ;; Set buffer's default directory to that of the file.
615 (setq default-directory (file-name-directory filename))
616 ;; Turn off backup files for certain file names. Since
617 ;; this is a permanent local, the major mode won't eliminate it.
618 (and (not (funcall backup-enable-predicate buffer-file-name))
619 (progn
620 (make-local-variable 'backup-inhibited)
621 (setq backup-inhibited t)))
622 (after-find-file error (not nowarn))))
623 buf)))
624 \f
625 (defun after-find-file (&optional error warn noauto)
626 "Called after finding a file and by the default revert function.
627 Sets buffer mode, parses local variables.
628 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
629 error in reading the file. WARN non-nil means warn if there
630 exists an auto-save file more recent than the visited file.
631 NOAUTO means don't mess with auto-save mode.
632 Finishes by calling the functions in `find-file-hooks'."
633 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
634 (if noninteractive
635 nil
636 (let* (not-serious
637 (msg
638 (cond ((and error (file-attributes buffer-file-name))
639 (setq buffer-read-only t)
640 "File exists, but is read-protected.")
641 ((not buffer-read-only)
642 (if (and warn
643 (file-newer-than-file-p (make-auto-save-file-name)
644 buffer-file-name))
645 "Auto save file is newer; consider M-x recover-file"
646 (setq not-serious t)
647 (if error "(New file)" nil)))
648 ((not error)
649 (setq not-serious t)
650 "Note: file is write protected")
651 ((file-attributes (directory-file-name default-directory))
652 "File not found and directory write-protected")
653 ((file-exists-p (file-name-directory buffer-file-name))
654 (setq buffer-read-only nil))
655 (t
656 (setq buffer-read-only nil)
657 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
658 "Use M-x make-dir RET RET to create the directory"
659 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
660 (if msg
661 (progn
662 (message msg)
663 (or not-serious (sit-for 1 nil t)))))
664 (if (and auto-save-default (not noauto))
665 (auto-save-mode t)))
666 (normal-mode t)
667 (mapcar 'funcall find-file-hooks))
668
669 (defun normal-mode (&optional find-file)
670 "Choose the major mode for this buffer automatically.
671 Also sets up any specified local variables of the file.
672 Uses the visited file name, the -*- line, and the local variables spec.
673
674 This function is called automatically from `find-file'. In that case,
675 we may set up specified local variables depending on the value of
676 `enable-local-variables': if it is t, we do; if it is nil, we don't;
677 otherwise, we query. `enable-local-variables' is ignored if you
678 run `normal-mode' explicitly."
679 (interactive)
680 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
681 (condition-case err
682 (set-auto-mode)
683 (error (message "File mode specification error: %s"
684 (prin1-to-string err))))
685 (condition-case err
686 (let ((enable-local-variables (or (not find-file)
687 enable-local-variables)))
688 (hack-local-variables))
689 (error (message "File local-variables error: %s"
690 (prin1-to-string err)))))
691
692 (defvar auto-mode-alist (mapcar 'purecopy
693 '(("\\.text\\'" . text-mode)
694 ("\\.c\\'" . c-mode)
695 ("\\.h\\'" . c-mode)
696 ("\\.tex\\'" . TeX-mode)
697 ("\\.ltx\\'" . LaTeX-mode)
698 ("\\.el\\'" . emacs-lisp-mode)
699 ("\\.mm\\'" . nroff-mode)
700 ("\\.me\\'" . nroff-mode)
701 ("\\.ms\\'" . nroff-mode)
702 ("\\.man\\'" . nroff-mode)
703 ("\\.scm\\'" . scheme-mode)
704 ("\\.l\\'" . lisp-mode)
705 ("\\.lisp\\'" . lisp-mode)
706 ("\\.f\\'" . fortran-mode)
707 ("\\.for\\'" . fortran-mode)
708 ("\\.mss\\'" . scribe-mode)
709 ("\\.pl\\'" . prolog-mode)
710 ("\\.cc\\'" . c++-mode)
711 ("\\.hh\\'" . c++-mode)
712 ("\\.C\\'" . c++-mode)
713 ("\\.H\\'" . c++-mode)
714 ;;; ("\\.mk\\'" . makefile-mode)
715 ;;; ("[Mm]akefile" . makefile-mode)
716 ;;; Less common extensions come here
717 ;;; so more common ones above are found faster.
718 ("\\.s\\'" . asm-mode)
719 ("ChangeLog\\'" . change-log-mode)
720 ("ChangeLog.[0-9]+\\'" . change-log-mode)
721 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
722 ;; The following should come after the ChangeLog pattern
723 ;; for the sake of ChangeLog.1, etc.
724 ("\\.[12345678]\\'" . nroff-mode)
725 ("\\.TeX\\'" . TeX-mode)
726 ("\\.sty\\'" . LaTeX-mode)
727 ("\\.bbl\\'" . LaTeX-mode)
728 ("\\.bib\\'" . bibtex-mode)
729 ("\\.article\\'" . text-mode)
730 ("\\.letter\\'" . text-mode)
731 ("\\.texinfo\\'" . texinfo-mode)
732 ("\\.texi\\'" . texinfo-mode)
733 ("\\.lsp\\'" . lisp-mode)
734 ("\\.awk\\'" . awk-mode)
735 ("\\.prolog\\'" . prolog-mode)
736 ("\\.tar\\'" . tar-mode)
737 ;; Mailer puts message to be edited in
738 ;; /tmp/Re.... or Message
739 ("^/tmp/Re" . text-mode)
740 ("/Message[0-9]*\\'" . text-mode)
741 ;; some news reader is reported to use this
742 ("^/tmp/fol/" . text-mode)
743 ("\\.y\\'" . c-mode)
744 ("\\.lex\\'" . c-mode)
745 ("\\.oak\\'" . scheme-mode)
746 ("\\.scm.[0-9]*\\'" . scheme-mode)
747 ("\\.sgm\\'" sgml-mode)
748 ("\\.sgml\\'" sgml-mode)
749 ("\\.dtd\\'" sgml-mode)
750 ;; .emacs following a directory delimiter
751 ;; in either Unix or VMS syntax.
752 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
753 ("\\.ml\\'" . lisp-mode)))
754 "\
755 Alist of filename patterns vs corresponding major mode functions.
756 Each element looks like (REGEXP . FUNCTION).
757 Visiting a file whose name matches REGEXP causes FUNCTION to be called.")
758
759 (defun set-auto-mode ()
760 "Select major mode appropriate for current buffer.
761 This checks for a -*- mode tag in the buffer's text, or
762 compares the filename against the entries in auto-mode-alist. It does
763 not check for the \"mode:\" local variable in the Local Variables
764 section of the file; for that, use `hack-local-variables'.
765
766 If `enable-local-variables' is nil, this function does not check for a
767 -*- mode tag."
768 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
769 (let (beg end mode)
770 (save-excursion
771 (goto-char (point-min))
772 (skip-chars-forward " \t\n")
773 (if (and enable-local-variables
774 (search-forward "-*-" (save-excursion
775 ;; If the file begins with "#!"
776 ;; (exec interpreter magic), look
777 ;; for mode frobs in the first two
778 ;; lines. You cannot necessarily
779 ;; put them in the first line of
780 ;; such a file without screwing up
781 ;; the interpreter invocation.
782 (end-of-line (and (looking-at "^#!") 2))
783 (point)) t)
784 (progn
785 (skip-chars-forward " \t")
786 (setq beg (point))
787 (search-forward "-*-"
788 (save-excursion (end-of-line) (point))
789 t))
790 (progn
791 (forward-char -3)
792 (skip-chars-backward " \t")
793 (setq end (point))
794 (goto-char beg)
795 (if (search-forward ":" end t)
796 (progn
797 (goto-char beg)
798 (if (let ((case-fold-search t))
799 (search-forward "mode:" end t))
800 (progn
801 (skip-chars-forward " \t")
802 (setq beg (point))
803 (if (search-forward ";" end t)
804 (forward-char -1)
805 (goto-char end))
806 (skip-chars-backward " \t")
807 (setq mode (buffer-substring beg (point))))))
808 (setq mode (buffer-substring beg end)))))
809 (setq mode (intern (concat (downcase mode) "-mode")))
810 (if buffer-file-name
811 (let ((alist auto-mode-alist)
812 (name buffer-file-name))
813 (let ((case-fold-search (eq system-type 'vax-vms)))
814 ;; Remove backup-suffixes from file name.
815 (setq name (file-name-sans-versions name))
816 ;; Find first matching alist entry.
817 (while (and (not mode) alist)
818 (if (string-match (car (car alist)) name)
819 (setq mode (cdr (car alist))))
820 (setq alist (cdr alist))))))))
821 (if mode (funcall mode))))
822
823 (defun hack-local-variables-prop-line ()
824 ;; Set local variables specified in the -*- line.
825 ;; Returns t if mode was set.
826 (save-excursion
827 (goto-char (point-min))
828 (skip-chars-forward " \t\n\r")
829 (let ((result '())
830 (end (save-excursion (end-of-line) (point)))
831 mode-p)
832 ;; Parse the -*- line into the `result' alist.
833 (cond ((not (search-forward "-*-" end t))
834 ;; doesn't have one.
835 nil)
836 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
837 ;; Simple form: "-*- MODENAME -*-".
838 (setq result
839 (list (cons 'mode
840 (intern (buffer-substring
841 (match-beginning 1)
842 (match-end 1)))))))
843 (t
844 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
845 ;; (last ";" is optional).
846 (save-excursion
847 (if (search-forward "-*-" end t)
848 (setq end (- (point) 3))
849 (error "-*- not terminated before end of line")))
850 (while (< (point) end)
851 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
852 (error "malformed -*- line"))
853 (goto-char (match-end 0))
854 (let ((key (intern (downcase (buffer-substring
855 (match-beginning 1)
856 (match-end 1)))))
857 (val (save-restriction
858 (narrow-to-region (point) end)
859 (read (current-buffer)))))
860 (setq result (cons (cons key val) result))
861 (skip-chars-forward " \t;")))
862 (setq result (nreverse result))))
863
864 ;; Mode is magic.
865 (let (mode)
866 (while (setq mode (assq 'mode result))
867 (setq mode-p t result (delq mode result))
868 (funcall (intern (concat (downcase (symbol-name (cdr mode)))
869 "-mode")))))
870
871 (if (and result
872 (or (eq enable-local-variables t)
873 (and enable-local-variables
874 (save-window-excursion
875 (switch-to-buffer (current-buffer))
876 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
877 (file-name-nondirectory buffer-file-name)))))))
878 (while result
879 (let ((key (car (car result)))
880 (val (cdr (car result))))
881 ;; 'mode has already been removed from this list.
882 (hack-one-local-variable key val))
883 (setq result (cdr result))))
884 mode-p)))
885
886 (defun hack-local-variables ()
887 "Parse and put into effect this buffer's local variables spec."
888 (hack-local-variables-prop-line)
889 ;; Look for "Local variables:" line in last page.
890 (save-excursion
891 (goto-char (point-max))
892 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
893 (if (let ((case-fold-search t))
894 (and (search-forward "Local Variables:" nil t)
895 (or (eq enable-local-variables t)
896 (and enable-local-variables
897 (save-window-excursion
898 (switch-to-buffer (current-buffer))
899 (save-excursion
900 (beginning-of-line)
901 (set-window-start (selected-window) (point)))
902 (y-or-n-p (format "Set local variables as specified at end of %s? "
903 (file-name-nondirectory buffer-file-name))))))))
904 (let ((continue t)
905 prefix prefixlen suffix beg
906 (enable-local-eval enable-local-eval))
907 ;; The prefix is what comes before "local variables:" in its line.
908 ;; The suffix is what comes after "local variables:" in its line.
909 (skip-chars-forward " \t")
910 (or (eolp)
911 (setq suffix (buffer-substring (point)
912 (progn (end-of-line) (point)))))
913 (goto-char (match-beginning 0))
914 (or (bolp)
915 (setq prefix
916 (buffer-substring (point)
917 (progn (beginning-of-line) (point)))))
918
919 (if prefix (setq prefixlen (length prefix)
920 prefix (regexp-quote prefix)))
921 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
922 (while continue
923 ;; Look at next local variable spec.
924 (if selective-display (re-search-forward "[\n\C-m]")
925 (forward-line 1))
926 ;; Skip the prefix, if any.
927 (if prefix
928 (if (looking-at prefix)
929 (forward-char prefixlen)
930 (error "Local variables entry is missing the prefix")))
931 ;; Find the variable name; strip whitespace.
932 (skip-chars-forward " \t")
933 (setq beg (point))
934 (skip-chars-forward "^:\n")
935 (if (eolp) (error "Missing colon in local variables entry"))
936 (skip-chars-backward " \t")
937 (let* ((str (buffer-substring beg (point)))
938 (var (read str))
939 val)
940 ;; Setting variable named "end" means end of list.
941 (if (string-equal (downcase str) "end")
942 (setq continue nil)
943 ;; Otherwise read the variable value.
944 (skip-chars-forward "^:")
945 (forward-char 1)
946 (setq val (read (current-buffer)))
947 (skip-chars-backward "\n")
948 (skip-chars-forward " \t")
949 (or (if suffix (looking-at suffix) (eolp))
950 (error "Local variables entry is terminated incorrectly"))
951 ;; Set the variable. "Variables" mode and eval are funny.
952 (hack-one-local-variable var val))))))))
953
954 (defconst ignored-local-variables
955 '(enable-local-eval)
956 "Variables to be ignored in a file's local variable spec.")
957
958 ;; "Set" one variable in a local variables spec.
959 ;; A few variable names are treated specially.
960 (defun hack-one-local-variable (var val)
961 (cond ((eq var 'mode)
962 (funcall (intern (concat (downcase (symbol-name val))
963 "-mode"))))
964 ((memq var ignored-local-variables)
965 nil)
966 ;; "Setting" eval means either eval it or do nothing.
967 ((eq var 'eval)
968 (if (and (not (string= (user-login-name) "root"))
969 (or (eq enable-local-eval t)
970 (and enable-local-eval
971 (save-window-excursion
972 (switch-to-buffer (current-buffer))
973 (save-excursion
974 (beginning-of-line)
975 (set-window-start (selected-window) (point)))
976 (setq enable-local-eval
977 (y-or-n-p (format "Process `eval' local variable in file %s? "
978 (file-name-nondirectory buffer-file-name))))))))
979 (save-excursion (eval val))
980 (message "Ignoring `eval:' in file's local variables")))
981 ;; Ordinary variable, really set it.
982 (t (make-local-variable var)
983 (set var val))))
984
985 \f
986 (defun set-visited-file-name (filename)
987 "Change name of file visited in current buffer to FILENAME.
988 The next time the buffer is saved it will go in the newly specified file.
989 nil or empty string as argument means make buffer not be visiting any file.
990 Remember to delete the initial contents of the minibuffer
991 if you wish to pass an empty string as the argument."
992 (interactive "FSet visited file name: ")
993 (if filename
994 (setq filename
995 (if (string-equal filename "")
996 nil
997 (expand-file-name filename))))
998 (or (equal filename buffer-file-name)
999 (null filename)
1000 (progn
1001 (lock-buffer filename)
1002 (unlock-buffer)))
1003 (setq buffer-file-name filename)
1004 (if filename ; make buffer name reflect filename.
1005 (let ((new-name (file-name-nondirectory buffer-file-name)))
1006 (if (string= new-name "")
1007 (error "Empty file name"))
1008 (if (eq system-type 'vax-vms)
1009 (setq new-name (downcase new-name)))
1010 (setq default-directory (file-name-directory buffer-file-name))
1011 (rename-buffer new-name t)))
1012 (setq buffer-backed-up nil)
1013 (clear-visited-file-modtime)
1014 (if filename
1015 (progn
1016 (setq buffer-file-truename
1017 (abbreviate-file-name (file-truename buffer-file-name)))
1018 (if find-file-visit-truename
1019 (setq buffer-file-name buffer-file-truename))
1020 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name))))
1021 (setq buffer-file-truename nil buffer-file-number nil))
1022 ;; write-file-hooks is normally used for things like ftp-find-file
1023 ;; that visit things that are not local files as if they were files.
1024 ;; Changing to visit an ordinary local file instead should flush the hook.
1025 (kill-local-variable 'write-file-hooks)
1026 (kill-local-variable 'local-write-file-hooks)
1027 (kill-local-variable 'revert-buffer-function)
1028 (kill-local-variable 'backup-inhibited)
1029 ;; Turn off backup files for certain file names.
1030 ;; Since this is a permanent local, the major mode won't eliminate it.
1031 (and (not (funcall backup-enable-predicate buffer-file-name))
1032 (progn
1033 (make-local-variable 'backup-inhibited)
1034 (setq backup-inhibited t)))
1035 ;; If auto-save was not already on, turn it on if appropriate.
1036 (if (not buffer-auto-save-file-name)
1037 (auto-save-mode (and buffer-file-name auto-save-default))
1038 ;; If auto save is on, start using a new name.
1039 ;; We deliberately don't rename or delete the old auto save
1040 ;; for the old visited file name. This is because perhaps
1041 ;; the user wants to save the new state and then compare with the
1042 ;; previous state from the auto save file.
1043 (setq buffer-auto-save-file-name
1044 (make-auto-save-file-name)))
1045 (if buffer-file-name
1046 (set-buffer-modified-p t)))
1047
1048 (defun write-file (filename)
1049 "Write current buffer into file FILENAME.
1050 Makes buffer visit that file, and marks it not modified.
1051 If the buffer is already visiting a file, you can specify
1052 a directory name as FILENAME, to write a file of the same
1053 old name in that directory."
1054 ;; (interactive "FWrite file: ")
1055 (interactive
1056 (list (if buffer-file-name
1057 (read-file-name "Write file: "
1058 nil nil nil nil)
1059 (read-file-name "Write file: "
1060 (cdr (assq 'default-directory
1061 (buffer-local-variables)))
1062 nil nil (buffer-name)))))
1063 (or (null filename) (string-equal filename "")
1064 (progn
1065 ;; If arg is just a directory,
1066 ;; use same file name, but in that directory.
1067 (if (and (file-directory-p filename) buffer-file-name)
1068 (setq filename (concat (file-name-as-directory filename)
1069 (file-name-nondirectory buffer-file-name))))
1070 (set-visited-file-name filename)))
1071 (set-buffer-modified-p t)
1072 (save-buffer))
1073 \f
1074 (defun backup-buffer ()
1075 "Make a backup of the disk file visited by the current buffer, if appropriate.
1076 This is normally done before saving the buffer the first time.
1077 If the value is non-nil, it is the result of `file-modes' on the original
1078 file; this means that the caller, after saving the buffer, should change
1079 the modes of the new file to agree with the old modes."
1080 (if (and make-backup-files (not backup-inhibited)
1081 (not buffer-backed-up)
1082 (file-exists-p buffer-file-name)
1083 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1084 '(?- ?l)))
1085 (let ((real-file-name buffer-file-name)
1086 backup-info backupname targets setmodes)
1087 ;; If specified name is a symbolic link, chase it to the target.
1088 ;; Thus we make the backups in the directory where the real file is.
1089 (while (let ((tem (file-symlink-p real-file-name)))
1090 (if tem
1091 (setq real-file-name
1092 (expand-file-name tem
1093 (file-name-directory real-file-name))))
1094 tem))
1095 (setq backup-info (find-backup-file-name real-file-name)
1096 backupname (car backup-info)
1097 targets (cdr backup-info))
1098 ;;; (if (file-directory-p buffer-file-name)
1099 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1100 (condition-case ()
1101 (let ((delete-old-versions
1102 ;; If have old versions to maybe delete,
1103 ;; ask the user to confirm now, before doing anything.
1104 ;; But don't actually delete til later.
1105 (and targets
1106 (or (eq trim-versions-without-asking t) (eq trim-versions-without-asking nil))
1107 (or trim-versions-without-asking
1108 (y-or-n-p (format "Delete excess backup versions of %s? "
1109 real-file-name))))))
1110 ;; Actually write the back up file.
1111 (condition-case ()
1112 (if (or file-precious-flag
1113 ; (file-symlink-p buffer-file-name)
1114 backup-by-copying
1115 (and backup-by-copying-when-linked
1116 (> (file-nlinks real-file-name) 1))
1117 (and backup-by-copying-when-mismatch
1118 (let ((attr (file-attributes real-file-name)))
1119 (or (nth 9 attr)
1120 (/= (nth 2 attr) (user-uid))))))
1121 (condition-case ()
1122 (copy-file real-file-name backupname t t)
1123 (file-error
1124 ;; If copying fails because file BACKUPNAME
1125 ;; is not writable, delete that file and try again.
1126 (if (and (file-exists-p backupname)
1127 (not (file-writable-p backupname)))
1128 (delete-file backupname))
1129 (copy-file real-file-name backupname t t)))
1130 ;; rename-file should delete old backup.
1131 (rename-file real-file-name backupname t)
1132 (setq setmodes (file-modes backupname)))
1133 (file-error
1134 ;; If trouble writing the backup, write it in ~.
1135 (setq backupname (expand-file-name "~/%backup%~"))
1136 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1137 (sleep-for 1)
1138 (condition-case ()
1139 (copy-file real-file-name backupname t t)
1140 (file-error
1141 ;; If copying fails because file BACKUPNAME
1142 ;; is not writable, delete that file and try again.
1143 (if (and (file-exists-p backupname)
1144 (not (file-writable-p backupname)))
1145 (delete-file backupname))
1146 (copy-file real-file-name backupname t t)))))
1147 (setq buffer-backed-up t)
1148 ;; Now delete the old versions, if desired.
1149 (if delete-old-versions
1150 (while targets
1151 (condition-case ()
1152 (delete-file (car targets))
1153 (file-error nil))
1154 (setq targets (cdr targets))))
1155 setmodes)
1156 (file-error nil)))))
1157
1158 (defun file-name-sans-versions (name &optional keep-backup-version)
1159 "Return FILENAME sans backup versions or strings.
1160 This is a separate procedure so your site-init or startup file can
1161 redefine it.
1162 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1163 we do not remove backup version numbers, only true file version numbers."
1164 (let ((handler (find-file-name-handler name)))
1165 (if handler
1166 (funcall handler 'file-name-sans-versions name keep-backup-version)
1167 (substring name 0
1168 (if (eq system-type 'vax-vms)
1169 ;; VMS version number is (a) semicolon, optional
1170 ;; sign, zero or more digits or (b) period, option
1171 ;; sign, zero or more digits, provided this is the
1172 ;; second period encountered outside of the
1173 ;; device/directory part of the file name.
1174 (or (string-match ";[---+]?[0-9]*\\'" name)
1175 (if (string-match "\\.[^]>:]*\\(\\.[---+]?[0-9]*\\)\\'"
1176 name)
1177 (match-beginning 1))
1178 (length name))
1179 (if keep-backup-version
1180 (length name)
1181 (or (string-match "\\.~[0-9]+~\\'" name)
1182 (string-match "~\\'" name)
1183 (length name))))))))
1184
1185 (defun make-backup-file-name (file)
1186 "Create the non-numeric backup file name for FILE.
1187 This is a separate function so you can redefine it for customization."
1188 (concat file "~"))
1189
1190 (defun backup-file-name-p (file)
1191 "Return non-nil if FILE is a backup file name (numeric or not).
1192 This is a separate function so you can redefine it for customization.
1193 You may need to redefine `file-name-sans-versions' as well."
1194 (string-match "~$" file))
1195
1196 ;; This is used in various files.
1197 ;; The usage of bv-length is not very clean,
1198 ;; but I can't see a good alternative,
1199 ;; so as of now I am leaving it alone.
1200 (defun backup-extract-version (fn)
1201 "Given the name of a numeric backup file, return the backup number.
1202 Uses the free variable `bv-length', whose value should be
1203 the index in the name where the version number begins."
1204 (if (and (string-match "[0-9]+~$" fn bv-length)
1205 (= (match-beginning 0) bv-length))
1206 (string-to-int (substring fn bv-length -1))
1207 0))
1208
1209 ;; I believe there is no need to alter this behavior for VMS;
1210 ;; since backup files are not made on VMS, it should not get called.
1211 (defun find-backup-file-name (fn)
1212 "Find a file name for a backup file, and suggestions for deletions.
1213 Value is a list whose car is the name for the backup file
1214 and whose cdr is a list of old versions to consider deleting now."
1215 (if (eq version-control 'never)
1216 (list (make-backup-file-name fn))
1217 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1218 (bv-length (length base-versions))
1219 (possibilities (file-name-all-completions
1220 base-versions
1221 (file-name-directory fn)))
1222 (versions (sort (mapcar
1223 (function backup-extract-version)
1224 possibilities)
1225 '<))
1226 (high-water-mark (apply 'max 0 versions))
1227 (deserve-versions-p
1228 (or version-control
1229 (> high-water-mark 0)))
1230 (number-to-delete (- (length versions)
1231 kept-old-versions kept-new-versions -1)))
1232 (if (not deserve-versions-p)
1233 (list (make-backup-file-name fn))
1234 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
1235 (if (and (> number-to-delete 0)
1236 ;; Delete nothing if there is overflow
1237 ;; in the number of versions to keep.
1238 (>= (+ kept-new-versions kept-old-versions -1) 0))
1239 (mapcar (function (lambda (n)
1240 (concat fn ".~" (int-to-string n) "~")))
1241 (let ((v (nthcdr kept-old-versions versions)))
1242 (rplacd (nthcdr (1- number-to-delete) v) ())
1243 v))))))))
1244
1245 (defun file-nlinks (filename)
1246 "Return number of names file FILENAME has."
1247 (car (cdr (file-attributes filename))))
1248
1249 (defun file-relative-name-1 (directory)
1250 (cond ((string= directory "/")
1251 filename)
1252 ((string-match (concat "^" (regexp-quote directory))
1253 filename)
1254 (substring filename (match-end 0)))
1255 (t
1256 (file-relative-name-1
1257 (file-name-directory (substring directory 0 -1))))))
1258
1259 (defun file-relative-name (filename &optional directory)
1260 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1261 (setq filename (expand-file-name filename)
1262 directory (file-name-as-directory (if directory
1263 (expand-file-name directory)
1264 default-directory)))
1265 (file-relative-name-1 directory))
1266 \f
1267 (defun save-buffer (&optional args)
1268 "Save current buffer in visited file if modified. Versions described below.
1269 By default, makes the previous version into a backup file
1270 if previously requested or if this is the first save.
1271 With 1 or 3 \\[universal-argument]'s, marks this version
1272 to become a backup when the next save is done.
1273 With 2 or 3 \\[universal-argument]'s,
1274 unconditionally makes the previous version into a backup file.
1275 With argument of 0, never makes the previous version into a backup file.
1276
1277 If a file's name is FOO, the names of its numbered backup versions are
1278 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1279 Numeric backups (rather than FOO~) will be made if value of
1280 `version-control' is not the atom `never' and either there are already
1281 numeric versions of the file being backed up, or `version-control' is
1282 non-nil.
1283 We don't want excessive versions piling up, so there are variables
1284 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1285 and `kept-new-versions', which tells how many newest versions to keep.
1286 Defaults are 2 old versions and 2 new.
1287 `dired-kept-versions' controls dired's clean-directory (.) command.
1288 If `trim-versions-without-asking' is nil, system will query user
1289 before trimming versions. Otherwise it does it silently."
1290 (interactive "p")
1291 (let ((modp (buffer-modified-p))
1292 (large (> (buffer-size) 50000))
1293 (make-backup-files (and make-backup-files (not (eq args 0)))))
1294 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
1295 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
1296 (basic-save-buffer)
1297 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
1298
1299 (defun delete-auto-save-file-if-necessary (&optional force)
1300 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1301 Normally delete only if the file was written by this Emacs since
1302 the last real save, but optional arg FORCE non-nil means delete anyway."
1303 (and buffer-auto-save-file-name delete-auto-save-files
1304 (not (string= buffer-file-name buffer-auto-save-file-name))
1305 (or force (recent-auto-save-p))
1306 (progn
1307 (condition-case ()
1308 (delete-file buffer-auto-save-file-name)
1309 (file-error nil))
1310 (set-buffer-auto-saved))))
1311
1312 (defun basic-save-buffer ()
1313 "Save the current buffer in its visited file, if it has been modified."
1314 (interactive)
1315 (if (buffer-modified-p)
1316 (let ((recent-save (recent-auto-save-p))
1317 setmodes tempsetmodes)
1318 ;; On VMS, rename file and buffer to get rid of version number.
1319 (if (and (eq system-type 'vax-vms)
1320 (not (string= buffer-file-name
1321 (file-name-sans-versions buffer-file-name))))
1322 (let (buffer-new-name)
1323 ;; Strip VMS version number before save.
1324 (setq buffer-file-name
1325 (file-name-sans-versions buffer-file-name))
1326 ;; Construct a (unique) buffer name to correspond.
1327 (let ((buf (create-file-buffer (downcase buffer-file-name))))
1328 (setq buffer-new-name (buffer-name buf))
1329 (kill-buffer buf))
1330 (rename-buffer buffer-new-name)))
1331 ;; If buffer has no file name, ask user for one.
1332 (or buffer-file-name
1333 (progn
1334 (setq buffer-file-name
1335 (expand-file-name (read-file-name "File to save in: ") nil)
1336 default-directory (file-name-directory buffer-file-name))
1337 (auto-save-mode auto-save-default)))
1338 (or (verify-visited-file-modtime (current-buffer))
1339 (not (file-exists-p buffer-file-name))
1340 (yes-or-no-p
1341 (format "%s has changed since visited or saved. Save anyway? "
1342 (file-name-nondirectory buffer-file-name)))
1343 (error "Save not confirmed"))
1344 (save-restriction
1345 (widen)
1346 (and (> (point-max) 1)
1347 (/= (char-after (1- (point-max))) ?\n)
1348 (or (eq require-final-newline t)
1349 (and require-final-newline
1350 (y-or-n-p
1351 (format "Buffer %s does not end in newline. Add one? "
1352 (buffer-name)))))
1353 (save-excursion
1354 (goto-char (point-max))
1355 (insert ?\n)))
1356 (let ((hooks (append write-contents-hooks local-write-file-hooks
1357 write-file-hooks))
1358 (done nil))
1359 (while (and hooks
1360 (not (setq done (funcall (car hooks)))))
1361 (setq hooks (cdr hooks)))
1362 ;; If a hook returned t, file is already "written".
1363 (cond ((not done)
1364 (if (not (file-writable-p buffer-file-name))
1365 (let ((dir (file-name-directory buffer-file-name)))
1366 (if (not (file-directory-p dir))
1367 (error "%s is not a directory" dir)
1368 (if (not (file-exists-p buffer-file-name))
1369 (error "Directory %s write-protected" dir)
1370 (if (yes-or-no-p
1371 (format "File %s is write-protected; try to save anyway? "
1372 (file-name-nondirectory
1373 buffer-file-name)))
1374 (setq tempsetmodes t)
1375 (error "Attempt to save to a file which you aren't allowed to write"))))))
1376 (or buffer-backed-up
1377 (setq setmodes (backup-buffer)))
1378 (if file-precious-flag
1379 ;; If file is precious, write temp name, then rename it.
1380 (let ((dir (file-name-directory buffer-file-name))
1381 (realname buffer-file-name)
1382 tempname temp nogood i succeed)
1383 (setq i 0)
1384 (setq nogood t)
1385 ;; Find the temporary name to write under.
1386 (while nogood
1387 (setq tempname (format "%s#tmp#%d" dir i))
1388 (setq nogood (file-exists-p tempname))
1389 (setq i (1+ i)))
1390 (unwind-protect
1391 (progn (clear-visited-file-modtime)
1392 (write-region (point-min) (point-max)
1393 tempname nil realname)
1394 (setq succeed t))
1395 ;; If writing the temp file fails,
1396 ;; delete the temp file.
1397 (or succeed (delete-file tempname)))
1398 ;; Since we have created an entirely new file
1399 ;; and renamed it, make sure it gets the
1400 ;; right permission bits set.
1401 (setq setmodes (file-modes buffer-file-name))
1402 ;; We succeeded in writing the temp file,
1403 ;; so rename it.
1404 (rename-file tempname buffer-file-name t))
1405 ;; If file not writable, see if we can make it writable
1406 ;; temporarily while we write it.
1407 ;; But no need to do so if we have just backed it up
1408 ;; (setmodes is set) because that says we're superseding.
1409 (cond ((and tempsetmodes (not setmodes))
1410 ;; Change the mode back, after writing.
1411 (setq setmodes (file-modes buffer-file-name))
1412 (set-file-modes buffer-file-name 511)))
1413 (write-region (point-min) (point-max)
1414 buffer-file-name nil t)))))
1415 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name)))
1416 (if setmodes
1417 (condition-case ()
1418 (set-file-modes buffer-file-name setmodes)
1419 (error nil))))
1420 ;; If the auto-save file was recent before this command,
1421 ;; delete it now.
1422 (delete-auto-save-file-if-necessary recent-save)
1423 (run-hooks 'after-save-hooks))
1424 (message "(No changes need to be saved)")))
1425
1426 (defun save-some-buffers (&optional arg exiting)
1427 "Save some modified file-visiting buffers. Asks user about each one.
1428 Optional argument (the prefix) non-nil means save all with no questions.
1429 Optional second argument EXITING means ask about certain non-file buffers
1430 as well as about file buffers."
1431 (interactive "P")
1432 (save-window-excursion
1433 (if (zerop (map-y-or-n-p
1434 (function
1435 (lambda (buffer)
1436 (and (buffer-modified-p buffer)
1437 (or
1438 (buffer-file-name buffer)
1439 (and exiting
1440 (progn
1441 (set-buffer buffer)
1442 (and buffer-offer-save (> (buffer-size) 0)))))
1443 (if arg
1444 t
1445 (if (buffer-file-name buffer)
1446 (format "Save file %s? "
1447 (buffer-file-name buffer))
1448 (format "Save buffer %s? "
1449 (buffer-name buffer)))))))
1450 (function
1451 (lambda (buffer)
1452 (set-buffer buffer)
1453 (save-buffer)))
1454 (buffer-list)
1455 '("buffer" "buffers" "save")
1456 (list (list ?\C-r (lambda (buf)
1457 (view-buffer buf)
1458 (setq view-exit-action
1459 '(lambda (ignore)
1460 (exit-recursive-edit)))
1461 (recursive-edit)
1462 ;; Return nil to ask about BUF again.
1463 nil)
1464 "display the current buffer"))
1465 ))
1466 (message "(No files need saving)"))))
1467 \f
1468 (defun not-modified (&optional arg)
1469 "Mark current buffer as unmodified, not needing to be saved.
1470 With prefix arg, mark buffer as modified, so \\[save-buffer] will save."
1471 (interactive "P")
1472 (message (if arg "Modification-flag set"
1473 "Modification-flag cleared"))
1474 (set-buffer-modified-p arg))
1475
1476 (defun toggle-read-only (&optional arg)
1477 "Change whether this buffer is visiting its file read-only.
1478 With arg, set read-only iff arg is positive."
1479 (interactive "P")
1480 (setq buffer-read-only
1481 (if (null arg)
1482 (not buffer-read-only)
1483 (> (prefix-numeric-value arg) 0)))
1484 ;; Force mode-line redisplay
1485 (set-buffer-modified-p (buffer-modified-p)))
1486
1487 (defun insert-file (filename)
1488 "Insert contents of file FILENAME into buffer after point.
1489 Set mark after the inserted text.
1490
1491 This function is meant for the user to run interactively.
1492 Don't call it from programs! Use `insert-file-contents' instead.
1493 \(Its calling sequence is different; see its documentation)."
1494 (interactive "fInsert file: ")
1495 (let ((tem (insert-file-contents filename)))
1496 (push-mark (+ (point) (car (cdr tem))))))
1497
1498 (defun append-to-file (start end filename)
1499 "Append the contents of the region to the end of file FILENAME.
1500 When called from a function, expects three arguments,
1501 START, END and FILENAME. START and END are buffer positions
1502 saying what text to write."
1503 (interactive "r\nFAppend to file: ")
1504 (write-region start end filename t))
1505
1506 (defun file-newest-backup (filename)
1507 "Return most recent backup file for FILENAME or nil if no backups exist."
1508 (let* ((filename (expand-file-name filename))
1509 (file (file-name-nondirectory filename))
1510 (dir (file-name-directory filename))
1511 (comp (file-name-all-completions file dir))
1512 newest)
1513 (while comp
1514 (setq file (concat dir (car comp))
1515 comp (cdr comp))
1516 (if (and (backup-file-name-p file)
1517 (or (null newest) (file-newer-than-file-p file newest)))
1518 (setq newest file)))
1519 newest))
1520
1521 (defun rename-uniquely ()
1522 "Rename current buffer to a similar name not already taken.
1523 This function is useful for creating multiple shell process buffers
1524 or multiple mail buffers, etc."
1525 (interactive)
1526 (let* ((new-buf (generate-new-buffer (buffer-name)))
1527 (name (buffer-name new-buf)))
1528 (kill-buffer new-buf)
1529 (rename-buffer name)
1530 (set-buffer-modified-p (buffer-modified-p)))) ; force mode line update
1531
1532 (defun make-directory (dir &optional parents)
1533 "Create the directory DIR and any nonexistent parent dirs."
1534 (interactive "FMake directory: \nP")
1535 (let ((handler (find-file-name-handler dir)))
1536 (if handler
1537 (funcall handler 'make-directory dir parents)
1538 (if (not parents)
1539 (make-directory-internal dir)
1540 (let ((dir (directory-file-name (expand-file-name dir)))
1541 create-list)
1542 (while (not (file-exists-p dir))
1543 (setq create-list (cons dir create-list)
1544 dir (directory-file-name (file-name-directory dir))))
1545 (while create-list
1546 (make-directory-internal (car create-list))
1547 (setq create-list (cdr create-list))))))))
1548 \f
1549 (put 'revert-buffer-function 'permanent-local t)
1550 (defvar revert-buffer-function nil
1551 "Function to use to revert this buffer, or nil to do the default.")
1552
1553 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
1554 (defvar revert-buffer-insert-file-contents-function nil
1555 "Function to use to insert contents when reverting this buffer.
1556 Gets two args, first the nominal file name to use,
1557 and second, t if reading the auto-save file.")
1558
1559 (defun revert-buffer (&optional ignore-auto noconfirm)
1560 "Replace the buffer text with the text of the visited file on disk.
1561 This undoes all changes since the file was visited or saved.
1562 With a prefix argument, offer to revert from latest auto-save file, if
1563 that is more recent than the visited file.
1564
1565 When called from lisp, the first argument is IGNORE-AUTO; only offer
1566 to revert from the auto-save file when this is nil. Note that the
1567 sense of this argument is the reverse of the prefix argument, for the
1568 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
1569 to nil.
1570
1571 Optional second argument NOCONFIRM means don't ask for confirmation at
1572 all.
1573
1574 If the value of `revert-buffer-function' is non-nil, it is called to
1575 do the work."
1576 ;; I admit it's odd to reverse the sense of the prefix argument, but
1577 ;; there is a lot of code out there which assumes that the first
1578 ;; argument should be t to avoid consulting the auto-save file, and
1579 ;; there's no straightforward way to encourage authors to notice a
1580 ;; reversal of the argument sense. So I'm just changing the user
1581 ;; interface, but leaving the programmatic interface the same.
1582 (interactive (list (not prefix-arg)))
1583 (if revert-buffer-function
1584 (funcall revert-buffer-function ignore-auto noconfirm)
1585 (let* ((opoint (point))
1586 (auto-save-p (and (not ignore-auto)
1587 (recent-auto-save-p)
1588 buffer-auto-save-file-name
1589 (file-readable-p buffer-auto-save-file-name)
1590 (y-or-n-p
1591 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
1592 (file-name (if auto-save-p
1593 buffer-auto-save-file-name
1594 buffer-file-name)))
1595 (cond ((null file-name)
1596 (error "Buffer does not seem to be associated with any file"))
1597 ((or noconfirm
1598 (yes-or-no-p (format "Revert buffer from file %s? "
1599 file-name)))
1600 ;; If file was backed up but has changed since,
1601 ;; we shd make another backup.
1602 (and (not auto-save-p)
1603 (not (verify-visited-file-modtime (current-buffer)))
1604 (setq buffer-backed-up nil))
1605 ;; Get rid of all undo records for this buffer.
1606 (or (eq buffer-undo-list t)
1607 (setq buffer-undo-list nil))
1608 (let ((buffer-read-only nil)
1609 ;; Don't make undo records for the reversion.
1610 (buffer-undo-list t))
1611 (if revert-buffer-insert-file-contents-function
1612 (funcall revert-buffer-insert-file-contents-function
1613 file-name auto-save-p)
1614 (if (not (file-exists-p file-name))
1615 (error "File %s no longer exists!" file-name))
1616 ;; Bind buffer-file-name to nil
1617 ;; so that we don't try to lock the file.
1618 (let ((buffer-file-name nil))
1619 (or auto-save-p
1620 (unlock-buffer))
1621 (erase-buffer))
1622 (insert-file-contents file-name (not auto-save-p))))
1623 (goto-char (min opoint (point-max)))
1624 (after-find-file nil nil t)
1625 t)))))
1626
1627 (defun recover-file (file)
1628 "Visit file FILE, but get contents from its last auto-save file."
1629 (interactive
1630 (let ((prompt-file buffer-file-name)
1631 (file-name nil)
1632 (file-dir nil))
1633 (and prompt-file
1634 (setq file-name (file-name-nondirectory prompt-file)
1635 file-dir (file-name-directory prompt-file)))
1636 (list (read-file-name "Recover file: "
1637 file-dir nil nil file-name))))
1638 (setq file (expand-file-name file))
1639 (if (auto-save-file-name-p file) (error "%s is an auto-save file" file))
1640 (let ((file-name (let ((buffer-file-name file))
1641 (make-auto-save-file-name))))
1642 (cond ((not (file-newer-than-file-p file-name file))
1643 (error "Auto-save file %s not current" file-name))
1644 ((save-window-excursion
1645 (if (not (eq system-type 'vax-vms))
1646 (with-output-to-temp-buffer "*Directory*"
1647 (buffer-disable-undo standard-output)
1648 (call-process "ls" nil standard-output nil
1649 (if (file-symlink-p file) "-lL" "-l")
1650 file file-name)))
1651 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
1652 (switch-to-buffer (find-file-noselect file t))
1653 (let ((buffer-read-only nil))
1654 (erase-buffer)
1655 (insert-file-contents file-name nil))
1656 (after-find-file nil nil t))
1657 (t (error "Recover-file cancelled.")))))
1658
1659 (defun kill-some-buffers ()
1660 "For each buffer, ask whether to kill it."
1661 (interactive)
1662 (let ((list (buffer-list)))
1663 (while list
1664 (let* ((buffer (car list))
1665 (name (buffer-name buffer)))
1666 (and (not (string-equal name ""))
1667 (/= (aref name 0) ? )
1668 (yes-or-no-p
1669 (format "Buffer %s %s. Kill? "
1670 name
1671 (if (buffer-modified-p buffer)
1672 "HAS BEEN EDITED" "is unmodified")))
1673 (kill-buffer buffer)))
1674 (setq list (cdr list)))))
1675 \f
1676 (defun auto-save-mode (arg)
1677 "Toggle auto-saving of contents of current buffer.
1678 With prefix argument ARG, turn auto-saving on if positive, else off."
1679 (interactive "P")
1680 (setq buffer-auto-save-file-name
1681 (and (if (null arg)
1682 (not buffer-auto-save-file-name)
1683 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
1684 (if (and buffer-file-name auto-save-visited-file-name
1685 (not buffer-read-only))
1686 buffer-file-name
1687 (make-auto-save-file-name))))
1688 (if (interactive-p)
1689 (message "Auto-save %s (in this buffer)"
1690 (if buffer-auto-save-file-name "on" "off")))
1691 buffer-auto-save-file-name)
1692
1693 (defun rename-auto-save-file ()
1694 "Adjust current buffer's auto save file name for current conditions.
1695 Also rename any existing auto save file, if it was made in this session."
1696 (let ((osave buffer-auto-save-file-name))
1697 (setq buffer-auto-save-file-name
1698 (make-auto-save-file-name))
1699 (if (and osave buffer-auto-save-file-name
1700 (not (string= buffer-auto-save-file-name buffer-file-name))
1701 (not (string= buffer-auto-save-file-name osave))
1702 (file-exists-p osave)
1703 (recent-auto-save-p))
1704 (rename-file osave buffer-auto-save-file-name t))))
1705
1706 (defun make-auto-save-file-name ()
1707 "Return file name to use for auto-saves of current buffer.
1708 Does not consider `auto-save-visited-file-name' as that variable is checked
1709 before calling this function. You can redefine this for customization.
1710 See also `auto-save-file-name-p'."
1711 (if buffer-file-name
1712 (concat (file-name-directory buffer-file-name)
1713 "#"
1714 (file-name-nondirectory buffer-file-name)
1715 "#")
1716 ;; For non-file bfr, use bfr name and Emacs pid.
1717 (expand-file-name (format "#%s#%s#" (buffer-name) (make-temp-name "")))))
1718
1719 (defun auto-save-file-name-p (filename)
1720 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
1721 FILENAME should lack slashes. You can redefine this for customization."
1722 (string-match "^#.*#$" filename))
1723 \f
1724 (defconst list-directory-brief-switches
1725 (if (eq system-type 'vax-vms) "" "-CF")
1726 "*Switches for list-directory to pass to `ls' for brief listing,")
1727
1728 (defconst list-directory-verbose-switches
1729 (if (eq system-type 'vax-vms)
1730 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
1731 "-l")
1732 "*Switches for list-directory to pass to `ls' for verbose listing,")
1733
1734 (defun list-directory (dirname &optional verbose)
1735 "Display a list of files in or matching DIRNAME, a la `ls'.
1736 DIRNAME is globbed by the shell if necessary.
1737 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
1738 Actions controlled by variables `list-directory-brief-switches'
1739 and `list-directory-verbose-switches'."
1740 (interactive (let ((pfx current-prefix-arg))
1741 (list (read-file-name (if pfx "List directory (verbose): "
1742 "List directory (brief): ")
1743 nil default-directory nil)
1744 pfx)))
1745 (let ((switches (if verbose list-directory-verbose-switches
1746 list-directory-brief-switches)))
1747 (or dirname (setq dirname default-directory))
1748 (setq dirname (expand-file-name dirname))
1749 (with-output-to-temp-buffer "*Directory*"
1750 (buffer-disable-undo standard-output)
1751 (princ "Directory ")
1752 (princ dirname)
1753 (terpri)
1754 (save-excursion
1755 (set-buffer "*Directory*")
1756 (let ((wildcard (not (file-directory-p dirname))))
1757 (insert-directory dirname switches wildcard (not wildcard)))))))
1758
1759 (defvar insert-directory-program "ls"
1760 "Absolute or relative name of the `ls' program used by `insert-directory'.")
1761
1762 ;; insert-directory
1763 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
1764 ;; FULL-DIRECTORY-P is nil.
1765 ;; The single line of output must display FILE's name as it was
1766 ;; given, namely, an absolute path name.
1767 ;; - must insert exactly one line for each file if WILDCARD or
1768 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
1769 ;; before the file lines, plus optional text after the file lines.
1770 ;; Lines are delimited by "\n", so filenames containing "\n" are not
1771 ;; allowed.
1772 ;; File lines should display the basename.
1773 ;; - must be consistent with
1774 ;; - functions dired-move-to-filename, (these two define what a file line is)
1775 ;; dired-move-to-end-of-filename,
1776 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
1777 ;; dired-insert-headerline
1778 ;; dired-after-subdir-garbage (defines what a "total" line is)
1779 ;; - variable dired-subdir-regexp
1780 (defun insert-directory (file switches &optional wildcard full-directory-p)
1781 "Insert directory listing for of FILE, formatted according to SWITCHES.
1782 Leaves point after the inserted text.
1783 Optional third arg WILDCARD means treat FILE as shell wildcard.
1784 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
1785 switches do not contain `d', so that a full listing is expected.
1786
1787 This works by running a directory listing program
1788 whose name is in the variable `insert-directory-program'.
1789 If WILDCARD, it also runs the shell specified by `shell-file-name'."
1790 (let ((handler (find-file-name-handler file)))
1791 (if handler
1792 (funcall handler 'insert-directory file switches
1793 wildcard full-directory-p)
1794 (if (eq system-type 'vax-vms)
1795 (vms-read-directory file switches (current-buffer))
1796 (if wildcard
1797 (let ((default-directory (file-name-directory file)))
1798 (call-process shell-file-name nil t nil
1799 "-c" (concat insert-directory-program
1800 " -d " switches " "
1801 (file-name-nondirectory file))))
1802 ;; Barry Margolin says: "SunOS 4.1.3 (and SV and POSIX?)
1803 ;; lists the link if we give a link to a directory - yuck!"
1804 ;; That's why we used to chase symlinks. But we don't want
1805 ;; to chase links before passing the filename to ls; that
1806 ;; would mean that our line of output would not display
1807 ;; FILE's name as given. To really address the problem that
1808 ;; SunOS 4.1.3 has, we need to find the right switch to get
1809 ;; a descripton of the link itself.
1810 ;; (let (symlink)
1811 ;; (while (setq symlink (file-symlink-p file))
1812 ;; (setq file symlink)))
1813 (call-process insert-directory-program nil t nil switches file))))))
1814
1815 (defun save-buffers-kill-emacs (&optional arg)
1816 "Offer to save each buffer, then kill this Emacs process.
1817 With prefix arg, silently save all file-visiting buffers, then kill."
1818 (interactive "P")
1819 (save-some-buffers arg t)
1820 (and (or (not (memq t (mapcar (function
1821 (lambda (buf) (and (buffer-file-name buf)
1822 (buffer-modified-p buf))))
1823 (buffer-list))))
1824 (yes-or-no-p "Modified buffers exist; exit anyway? "))
1825 (or (not (fboundp 'process-list))
1826 ;; process-list is not defined on VMS.
1827 (let ((processes (process-list))
1828 active)
1829 (while processes
1830 (and (memq (process-status (car processes)) '(run stop open))
1831 (let ((val (process-kill-without-query (car processes))))
1832 (process-kill-without-query (car processes) val)
1833 val)
1834 (setq active t))
1835 (setq processes (cdr processes)))
1836 (or (not active)
1837 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
1838 (kill-emacs)))
1839 \f
1840 (define-key ctl-x-map "\C-f" 'find-file)
1841 (define-key ctl-x-map "\C-q" 'toggle-read-only)
1842 (define-key ctl-x-map "\C-r" 'find-file-read-only)
1843 (define-key ctl-x-map "\C-v" 'find-alternate-file)
1844 (define-key ctl-x-map "\C-s" 'save-buffer)
1845 (define-key ctl-x-map "s" 'save-some-buffers)
1846 (define-key ctl-x-map "\C-w" 'write-file)
1847 (define-key ctl-x-map "i" 'insert-file)
1848 (define-key esc-map "~" 'not-modified)
1849 (define-key ctl-x-map "\C-d" 'list-directory)
1850 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
1851
1852 (define-key ctl-x-4-map "f" 'find-file-other-window)
1853 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
1854 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
1855 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
1856 (define-key ctl-x-4-map "\C-o" 'display-buffer)
1857
1858 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
1859 (define-key ctl-x-5-map "f" 'find-file-other-frame)
1860 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
1861 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
1862
1863 ;;; files.el ends here