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