(w32_menu_show): Set widget call_data to 0 if definition is nil.
[bpt/emacs.git] / lisp / files.el
... / ...
CommitLineData
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
45Note that auto-save file will not be deleted if the buffer is killed
46when 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.
53A list of elements of the form (FROM . TO), each meaning to replace
54FROM with TO when it appears in a directory name. This replacement is
55done when setting up the default directory of a newly visited file.
56*Every* FROM string should start with `^'.
57
58Do not use `~' in the TO strings.
59They should be ordinary absolute directory names.
60
61Use this feature when you have directories which you normally refer to
62via absolute symbolic links. Make TO the name of the link, and FROM
63the 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.
74This can be done by renaming the file or by copying.
75
76Renaming means that Emacs renames the existing file so that it is a
77backup file, then writes the buffer into a new file. Any other names
78that the old file had will now refer to the backup file. The new file
79is owned by you and its group is defaulted.
80
81Copying means that Emacs copies the existing file into the backup
82file, then writes the buffer on top of the existing file. Any other
83names that the old file had will now refer to the new (edited) file.
84The file's owner and group are unchanged.
85
86The 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.
96This variable is intended for use by making it local to a buffer.
97But 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.
102See 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.
108This causes the alternate names to refer to the latest version as edited.
109This 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.
115Renaming may still be used (subject to control of other variables)
116when it would not result in changing the owner or group of the file;
117that is, for files which are owned by you and whose group matches
118the default for a new file created there by you.
119This 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.
128Called 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
132even if the buffer is not visiting a file.
133Automatically 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.
140This means if any existing buffer is visiting the file you want
141under 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.
147The truename of a file is found by chasing all links
148both 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.
155The value is a list of regular expressions.
156If the file name matches one of these regular expressions,
157then `revert-buffer' reverts the file without querying
158if 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.
164The value is a list of the form (FILENUM DEVNUM).
165This pair of numbers uniquely identifies the file.
166If 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]:\\)?/?.*:\\)\\|" ; 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]:\\)?/?.*:\\)\\|" ; 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.
188Some modes set this non-nil in particular buffers.
189
190This feature works by writing the new contents into a temporary file
191and then renaming the temporary file to replace the original.
192In this way, any I/O error in writing leaves the original untouched,
193and there is never any instant where the file is nonexistent.
194
195Note that this feature forces backups to be made by copying.
196Yet, at the same time, saving a precious file
197breaks 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.
203t means make numeric backup versions unconditionally.
204nil 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.
220If 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.
233Includes 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.
239Non-nil but not t says ask user whether to add a newline when there isn't one.
240nil 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.
253Normally 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.
259Loading 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.
272These functions are called as soon as the error is detected.
273`buffer-file-name' is already set up.
274The 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.
280The buffer's local variables (if any) will have been processed before the
281functions are called.")
282
283(defvar write-file-hooks nil
284 "List of functions to be called before writing out a buffer to a file.
285If one of them returns non-nil, the file is considered already written
286and the rest are not called.
287These hooks are considered to pertain to the visited file.
288So this list is cleared if you change the visited file name.
289
290Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
291See 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.
297The functions in this list are called before the ones in
298`write-file-hooks'.
299
300This variable is meant to be used for hooks that have to do with a
301particular visited file. Therefore, it is a permanent local, so that
302changing 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.
309If one of them returns non-nil, the file is considered already written
310and the rest are not called.
311
312This variable is meant to be used for hooks that pertain to the
313buffer's contents, not to the particular visited file; thus,
314`set-visited-file-name' does not clear this variable; but changing the
315major mode does clear it.
316
317This variable automatically becomes buffer-local whenever it is set.
318If you use `add-hook' to add elements to the list, use nil for the
319LOCAL argument.
320
321See 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.
326The value can be t, nil or something else.
327A value of t means file local variables specifications are obeyed;
328nil means they are ignored; anything else means query.
329
330The command \\[normal-mode] always obeys file local variable
331specifications 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.
339If a major mode sets this to nil, buffer-locally, then any local
340variables 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.
344The value can be t, nil or something else.
345A value of t means obey `eval' variables;
346nil means ignore them; anything else means query.
347
348The command \\[normal-mode] always obeys local-variables lists
349and 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.
395This function's standard definition is trivial; it just returns the argument.
396However, on some systems, the function is redefined
397with 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.
407Not 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.
442If your environment includes a `CDPATH' variable, try each one of that
443colon-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.
473This 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.
479Returns the name of the local copy, or nil, if FILE is directly
480accessible."
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.
488The truename of a file name is found by chasing symbolic links
489both at the level of the file and at the level of the directories
490containing it, until no links are left at any level.
491
492The arguments COUNTER and PREV-DIRS are used only in recursive calls.
493Do 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.
598Does not examine containing directories for links,
599unlike `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.
627Optional second arg NORECORD non-nil means
628do 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.
635Optional second arg NORECORD non-nil means
636do 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.
644Switch to a buffer visiting file FILENAME,
645creating 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.
651May create a new window, or reuse an existing one.
652See 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.
658May create a new frame, or reuse an existing one.
659See 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.
665Like \\[find-file] but marks buffer as read-only.
666Use \\[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.
674Like \\[find-file-other-window] but marks buffer as read-only.
675Use \\[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.
683Like \\[find-file-other-frame] but marks buffer as read-only.
684Use \\[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.
692This 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.
712If 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.
754FILENAME (sans directory) is used unchanged if that name is free;
755otherwise 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.
763Choose 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'.
774This also substitutes \"~\" for the user's home directory.
775Type \\[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.
821On VMS, when you visit a file using a logical name that searches a path,
822you may or may not want the visited file name to record the specific
823directory where the file was found. If you *do not* want that, add the logical
824name 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).
830This is like `get-file-buffer', except that it checks for any buffer
831visiting the same file, possibly under a different name.
832If 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.
865If a buffer exists visiting FILENAME, return that one, but
866verify that the file has not changed since visited or saved.
867The buffer is not selected, just returned to the caller.
868Optional first arg NOWARN non-nil means suppress any warning messages.
869Optional 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 (when (not (eq rawfile (not (null find-file-literally))))
932 (with-current-buffer buf
933 (if (buffer-modified-p)
934 (if (y-or-n-p (if rawfile
935 "Save file and revisit literally? "
936 "Save file and revisit non-literally? "))
937 (progn
938 (save-buffer)
939 (find-file-noselect-1 buf filename nowarn
940 rawfile truename number))
941 (if (y-or-n-p (if rawfile
942 "Discard your edits and revisit file literally? "
943 "Discard your edits and revisit file non-literally? "))
944 (find-file-noselect-1 buf filename nowarn
945 rawfile truename number)
946 (error (if rawfile "File already visited non-literally"
947 "File already visited literally"))))
948 (if (y-or-n-p (if rawfile
949 "Revisit file literally? "
950 "Revisit file non-literally? "))
951 (find-file-noselect-1 buf filename nowarn
952 rawfile truename number)
953 (error (if rawfile "File already visited non-literally"
954 "File already visited literally"))))))
955 ;; Return the buffer we are using.
956 buf)
957 ;; Create a new buffer.
958 (setq buf (create-file-buffer filename))
959 (set-buffer-major-mode buf)
960 ;; find-file-noselect-1 may use a different buffer.
961 (find-file-noselect-1 buf filename nowarn
962 rawfile truename number)))))
963
964(defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
965 (let ((inhibit-read-only t)
966 error)
967 (with-current-buffer buf
968 (kill-local-variable 'find-file-literally)
969 ;; Needed in case we are re-visiting the file with a different
970 ;; text representation.
971 (setq buffer-file-coding-system default-buffer-file-coding-system)
972 (erase-buffer)
973 (and (default-value 'enable-multibyte-characters)
974 (not rawfile)
975 (set-buffer-multibyte t))
976 (if rawfile
977 (condition-case ()
978 (insert-file-contents-literally filename t)
979 (file-error
980 (when (and (file-exists-p filename)
981 (not (file-readable-p filename)))
982 (kill-buffer buf)
983 (signal 'file-error (list "File is not readable"
984 filename)))
985 ;; Unconditionally set error
986 (setq error t)))
987 (condition-case ()
988 (insert-file-contents filename t)
989 (file-error
990 (when (and (file-exists-p filename)
991 (not (file-readable-p filename)))
992 (kill-buffer buf)
993 (signal 'file-error (list "File is not readable"
994 filename)))
995 ;; Run find-file-not-found-hooks until one returns non-nil.
996 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
997 ;; If they fail too, set error.
998 (setq error t)))))
999 ;; Find the file's truename, and maybe use that as visited name.
1000 (setq buffer-file-truename truename)
1001 (setq buffer-file-number number)
1002 ;; On VMS, we may want to remember which directory in a search list
1003 ;; the file was found in.
1004 (and (eq system-type 'vax-vms)
1005 (let (logical)
1006 (if (string-match ":" (file-name-directory filename))
1007 (setq logical (substring (file-name-directory filename)
1008 0 (match-beginning 0))))
1009 (not (member logical find-file-not-true-dirname-list)))
1010 (setq buffer-file-name buffer-file-truename))
1011 (if find-file-visit-truename
1012 (setq buffer-file-name
1013 (setq filename
1014 (expand-file-name buffer-file-truename))))
1015 ;; Set buffer's default directory to that of the file.
1016 (setq default-directory (file-name-directory filename))
1017 ;; Turn off backup files for certain file names. Since
1018 ;; this is a permanent local, the major mode won't eliminate it.
1019 (and (not (funcall backup-enable-predicate buffer-file-name))
1020 (progn
1021 (make-local-variable 'backup-inhibited)
1022 (setq backup-inhibited t)))
1023 (if rawfile
1024 (progn
1025 (set-buffer-multibyte nil)
1026 (setq buffer-file-coding-system 'no-conversion)
1027 (make-local-variable 'find-file-literally)
1028 (setq find-file-literally t))
1029 (after-find-file error (not nowarn)))
1030 (current-buffer))))
1031\f
1032(defun insert-file-contents-literally (filename &optional visit beg end replace)
1033 "Like `insert-file-contents', but only reads in the file literally.
1034A buffer may be modified in several ways after reading into the buffer,
1035to Emacs features such as format decoding, character code
1036conversion, find-file-hooks, automatic uncompression, etc.
1037
1038This function ensures that none of these modifications will take place."
1039 (let ((format-alist nil)
1040 (after-insert-file-functions nil)
1041 (coding-system-for-read 'no-conversion)
1042 (coding-system-for-write 'no-conversion)
1043 (jka-compr-compression-info-list nil)
1044 (find-buffer-file-type-function
1045 (if (fboundp 'find-buffer-file-type)
1046 (symbol-function 'find-buffer-file-type)
1047 nil)))
1048 (unwind-protect
1049 (progn
1050 (fset 'find-buffer-file-type (lambda (filename) t))
1051 (insert-file-contents filename visit beg end replace))
1052 (if find-buffer-file-type-function
1053 (fset 'find-buffer-file-type find-buffer-file-type-function)
1054 (fmakunbound 'find-buffer-file-type)))))
1055
1056(defun insert-file-literally (filename)
1057 "Insert contents of file FILENAME into buffer after point with no conversion.
1058
1059This function is meant for the user to run interactively.
1060Don't call it from programs! Use `insert-file-contents-literally' instead.
1061\(Its calling sequence is different; see its documentation)."
1062 (interactive "*fInsert file literally: ")
1063 (if (file-directory-p filename)
1064 (signal 'file-error (list "Opening input file" "file is a directory"
1065 filename)))
1066 (let ((tem (insert-file-contents-literally filename)))
1067 (push-mark (+ (point) (car (cdr tem))))))
1068
1069(defvar find-file-literally nil
1070 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1071This is a permanent local.")
1072(put 'find-file-literally 'permanent-local t)
1073
1074(defun find-file-literally (filename)
1075 "Visit file FILENAME with no conversion of any kind.
1076Format conversion and character code conversion are both disabled,
1077and multibyte characters are disabled in the resulting buffer.
1078The major mode used is Fundamental mode regardless of the file name,
1079and local variable specifications in the file are ignored.
1080Automatic uncompression is also disabled.
1081
1082You cannot absolutely rely on this function to result in
1083visiting the file literally. If Emacs already has a buffer
1084which is visiting the file, you get the existing buffer,
1085regardless of whether it was created literally or not.
1086
1087In a Lisp program, if you want to be sure of accessing a file's
1088contents literally, you should create a temporary buffer and then read
1089the file contents into it using `insert-file-contents-literally'."
1090 (interactive "FFind file literally: ")
1091 (switch-to-buffer (find-file-noselect filename nil t)))
1092\f
1093(defvar after-find-file-from-revert-buffer nil)
1094
1095(defun after-find-file (&optional error warn noauto
1096 after-find-file-from-revert-buffer
1097 nomodes)
1098 "Called after finding a file and by the default revert function.
1099Sets buffer mode, parses local variables.
1100Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1101error in reading the file. WARN non-nil means warn if there
1102exists an auto-save file more recent than the visited file.
1103NOAUTO means don't mess with auto-save mode.
1104Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1105 means this call was from `revert-buffer'.
1106Fifth arg NOMODES non-nil means don't alter the file's modes.
1107Finishes by calling the functions in `find-file-hooks'
1108unless NOMODES is non-nil."
1109 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1110 (if noninteractive
1111 nil
1112 (let* (not-serious
1113 (msg
1114 (cond ((and error (file-attributes buffer-file-name))
1115 (setq buffer-read-only t)
1116 "File exists, but cannot be read.")
1117 ((not buffer-read-only)
1118 (if (and warn
1119 (file-newer-than-file-p (make-auto-save-file-name)
1120 buffer-file-name))
1121 (format "%s has auto save data; consider M-x recover-file"
1122 (file-name-nondirectory buffer-file-name))
1123 (setq not-serious t)
1124 (if error "(New file)" nil)))
1125 ((not error)
1126 (setq not-serious t)
1127 "Note: file is write protected")
1128 ((file-attributes (directory-file-name default-directory))
1129 "File not found and directory write-protected")
1130 ((file-exists-p (file-name-directory buffer-file-name))
1131 (setq buffer-read-only nil))
1132 (t
1133 (setq buffer-read-only nil)
1134 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1135 "Use M-x make-dir RET RET to create the directory"
1136 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
1137 (if msg
1138 (progn
1139 (message msg)
1140 (or not-serious (sit-for 1 nil t)))))
1141 (if (and auto-save-default (not noauto))
1142 (auto-save-mode t)))
1143 (if nomodes
1144 nil
1145 (normal-mode t)
1146 (if (and buffer-read-only view-read-only
1147 (not (eq (get major-mode 'mode-class) 'special)))
1148 (view-mode-enter))
1149 (run-hooks 'find-file-hooks)))
1150
1151(defun normal-mode (&optional find-file)
1152 "Choose the major mode for this buffer automatically.
1153Also sets up any specified local variables of the file.
1154Uses the visited file name, the -*- line, and the local variables spec.
1155
1156This function is called automatically from `find-file'. In that case,
1157we may set up specified local variables depending on the value of
1158`enable-local-variables': if it is t, we do; if it is nil, we don't;
1159otherwise, we query. `enable-local-variables' is ignored if you
1160run `normal-mode' explicitly."
1161 (interactive)
1162 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1163 (condition-case err
1164 (set-auto-mode)
1165 (error (message "File mode specification error: %s"
1166 (prin1-to-string err))))
1167 (condition-case err
1168 (let ((enable-local-variables (or (not find-file)
1169 enable-local-variables)))
1170 (hack-local-variables))
1171 (error (message "File local-variables error: %s"
1172 (prin1-to-string err)))))
1173
1174(defvar auto-mode-alist
1175 '(("\\.te?xt\\'" . text-mode)
1176 ("\\.c\\'" . c-mode)
1177 ("\\.h\\'" . c-mode)
1178 ("\\.tex\\'" . tex-mode)
1179 ("\\.ltx\\'" . latex-mode)
1180 ("\\.el\\'" . emacs-lisp-mode)
1181 ("\\.mm\\'" . nroff-mode)
1182 ("\\.me\\'" . nroff-mode)
1183 ("\\.ms\\'" . nroff-mode)
1184 ("\\.man\\'" . nroff-mode)
1185 ("\\.scm\\'" . scheme-mode)
1186 ("\\.l\\'" . lisp-mode)
1187 ("\\.lisp\\'" . lisp-mode)
1188 ("\\.f\\'" . fortran-mode)
1189 ("\\.F\\'" . fortran-mode)
1190 ("\\.for\\'" . fortran-mode)
1191 ("\\.p\\'" . pascal-mode)
1192 ("\\.pas\\'" . pascal-mode)
1193 ("\\.ad[abs]\\'" . ada-mode)
1194 ("\\.\\([pP][Llm]\\|al\\)\\'" . perl-mode)
1195 ("\\.s?html?\\'" . html-mode)
1196 ("\\.cc\\'" . c++-mode)
1197 ("\\.hh\\'" . c++-mode)
1198 ("\\.hpp\\'" . c++-mode)
1199 ("\\.C\\'" . c++-mode)
1200 ("\\.H\\'" . c++-mode)
1201 ("\\.cpp\\'" . c++-mode)
1202 ("\\.cxx\\'" . c++-mode)
1203 ("\\.hxx\\'" . c++-mode)
1204 ("\\.c\\+\\+\\'" . c++-mode)
1205 ("\\.h\\+\\+\\'" . c++-mode)
1206 ("\\.m\\'" . objc-mode)
1207 ("\\.java\\'" . java-mode)
1208 ("\\.mk\\'" . makefile-mode)
1209 ("\\(M\\|m\\|GNUm\\)akefile\\(.in\\)?\\'" . makefile-mode)
1210 ("\\.am\\'" . makefile-mode) ;For Automake.
1211;;; Less common extensions come here
1212;;; so more common ones above are found faster.
1213 ("\\.texinfo\\'" . texinfo-mode)
1214 ("\\.te?xi\\'" . texinfo-mode)
1215 ("\\.s\\'" . asm-mode)
1216 ("\\.S\\'" . asm-mode)
1217 ("\\.asm\\'" . asm-mode)
1218 ("ChangeLog\\'" . change-log-mode)
1219 ("change.log\\'" . change-log-mode)
1220 ("changelo\\'" . change-log-mode)
1221 ("ChangeLog.[0-9]+\\'" . change-log-mode)
1222 ;; for MSDOS and MS-Windows (which are case-insensitive)
1223 ("changelog\\'" . change-log-mode)
1224 ("changelog.[0-9]+\\'" . change-log-mode)
1225 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1226 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1227 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1228 ("/\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1229 ("/\\.\\(bash_logout\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1230 ("/\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1231;;; The following should come after the ChangeLog pattern
1232;;; for the sake of ChangeLog.1, etc.
1233;;; and after the .scm.[0-9] pattern too.
1234 ("\\.[12345678]\\'" . nroff-mode)
1235 ("\\.TeX\\'" . tex-mode)
1236 ("\\.sty\\'" . latex-mode)
1237 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1238 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
1239 ("\\.bbl\\'" . latex-mode)
1240 ("\\.bib\\'" . bibtex-mode)
1241 ("\\.m4\\'" . m4-mode)
1242 ("\\.mc\\'" . m4-mode)
1243 ("\\.mf\\'" . metafont-mode)
1244 ("\\.mp\\'" . metapost-mode)
1245 ("\\.vhdl?\\'" . vhdl-mode)
1246 ("\\.article\\'" . text-mode)
1247 ("\\.letter\\'" . text-mode)
1248 ("\\.tcl\\'" . tcl-mode)
1249 ("\\.exp\\'" . tcl-mode)
1250 ("\\.itcl\\'" . tcl-mode)
1251 ("\\.itk\\'" . tcl-mode)
1252 ("\\.icn\\'" . icon-mode)
1253 ("\\.sim\\'" . simula-mode)
1254 ("\\.mss\\'" . scribe-mode)
1255 ("\\.f90\\'" . f90-mode)
1256 ("\\.lsp\\'" . lisp-mode)
1257 ("\\.awk\\'" . awk-mode)
1258 ("\\.prolog\\'" . prolog-mode)
1259 ("\\.tar\\'" . tar-mode)
1260 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\)\\'" . archive-mode)
1261 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\)\\'" . archive-mode)
1262 ;; Mailer puts message to be edited in
1263 ;; /tmp/Re.... or Message
1264 ("\\`/tmp/Re" . text-mode)
1265 ("/Message[0-9]*\\'" . text-mode)
1266 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1267 ("\\.zone\\'" . zone-mode)
1268 ;; some news reader is reported to use this
1269 ("\\`/tmp/fol/" . text-mode)
1270 ("\\.y\\'" . c-mode)
1271 ("\\.lex\\'" . c-mode)
1272 ("\\.oak\\'" . scheme-mode)
1273 ("\\.sgml?\\'" . sgml-mode)
1274 ("\\.xml\\'" . sgml-mode)
1275 ("\\.dtd\\'" . sgml-mode)
1276 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1277 ;; .emacs following a directory delimiter
1278 ;; in Unix, MSDOG or VMS syntax.
1279 ("[]>:/\\]\\..*emacs\\'" . emacs-lisp-mode)
1280 ;; _emacs following a directory delimiter
1281 ;; in MsDos syntax
1282 ("[:/]_emacs\\'" . emacs-lisp-mode)
1283 ("\\.ml\\'" . lisp-mode))
1284 "\
1285Alist of filename patterns vs corresponding major mode functions.
1286Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1287\(NON-NIL stands for anything that is not nil; the value does not matter.)
1288Visiting a file whose name matches REGEXP specifies FUNCTION as the
1289mode function to use. FUNCTION will be called, unless it is nil.
1290
1291If the element has the form (REGEXP FUNCTION NON-NIL), then after
1292calling FUNCTION (if it's not nil), we delete the suffix that matched
1293REGEXP and search the list again for another match.")
1294
1295
1296(defvar interpreter-mode-alist
1297 '(("perl" . perl-mode)
1298 ("perl5" . perl-mode)
1299 ("miniperl" . perl-mode)
1300 ("wish" . tcl-mode)
1301 ("wishx" . tcl-mode)
1302 ("tcl" . tcl-mode)
1303 ("tclsh" . tcl-mode)
1304 ("awk" . awk-mode)
1305 ("mawk" . awk-mode)
1306 ("nawk" . awk-mode)
1307 ("gawk" . awk-mode)
1308 ("scm" . scheme-mode)
1309 ("ash" . sh-mode)
1310 ("bash" . sh-mode)
1311 ("csh" . sh-mode)
1312 ("dtksh" . sh-mode)
1313 ("es" . sh-mode)
1314 ("itcsh" . sh-mode)
1315 ("jsh" . sh-mode)
1316 ("ksh" . sh-mode)
1317 ("oash" . sh-mode)
1318 ("pdksh" . sh-mode)
1319 ("rc" . sh-mode)
1320 ("sh" . sh-mode)
1321 ("sh5" . sh-mode)
1322 ("tcsh" . sh-mode)
1323 ("wksh" . sh-mode)
1324 ("wsh" . sh-mode)
1325 ("zsh" . sh-mode)
1326 ("tail" . text-mode)
1327 ("more" . text-mode)
1328 ("less" . text-mode)
1329 ("pg" . text-mode))
1330 "Alist mapping interpreter names to major modes.
1331This alist applies to files whose first line starts with `#!'.
1332Each element looks like (INTERPRETER . MODE).
1333The car of each element is compared with
1334the name of the interpreter specified in the first line.
1335If it matches, mode MODE is selected.")
1336
1337(defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
1338 "List of regexps; if one matches a file name, don't look for `-*-'.")
1339
1340(defvar inhibit-first-line-modes-suffixes nil
1341 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1342When checking `inhibit-first-line-modes-regexps', we first discard
1343from the end of the file name anything that matches one of these regexps.")
1344
1345(defvar user-init-file nil
1346 "File name, including directory, of user's initialization file.")
1347
1348(defun set-auto-mode (&optional just-from-file-name)
1349 "Select major mode appropriate for current buffer.
1350This checks for a -*- mode tag in the buffer's text,
1351compares the filename against the entries in `auto-mode-alist',
1352or checks the interpreter that runs this file against
1353`interpreter-mode-alist'.
1354
1355It does not check for the `mode:' local variable in the
1356Local Variables section of the file; for that, use `hack-local-variables'.
1357
1358If `enable-local-variables' is nil, this function does not check for a
1359-*- mode tag.
1360
1361If the optional argument JUST-FROM-FILE-NAME is non-nil,
1362then we do not set anything but the major mode,
1363and we don't even do that unless it would come from the file name."
1364 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1365 (let (beg end done modes)
1366 (save-excursion
1367 (goto-char (point-min))
1368 (skip-chars-forward " \t\n")
1369 (and enable-local-variables
1370 local-enable-local-variables
1371 ;; Don't look for -*- if this file name matches any
1372 ;; of the regexps in inhibit-first-line-modes-regexps.
1373 (let ((temp inhibit-first-line-modes-regexps)
1374 (name (if buffer-file-name
1375 (file-name-sans-versions buffer-file-name)
1376 (buffer-name))))
1377 (while (let ((sufs inhibit-first-line-modes-suffixes))
1378 (while (and sufs (not (string-match (car sufs) name)))
1379 (setq sufs (cdr sufs)))
1380 sufs)
1381 (setq name (substring name 0 (match-beginning 0))))
1382 (while (and temp
1383 (not (string-match (car temp) name)))
1384 (setq temp (cdr temp)))
1385 (not temp))
1386 (search-forward "-*-" (save-excursion
1387 ;; If the file begins with "#!"
1388 ;; (exec interpreter magic), look
1389 ;; for mode frobs in the first two
1390 ;; lines. You cannot necessarily
1391 ;; put them in the first line of
1392 ;; such a file without screwing up
1393 ;; the interpreter invocation.
1394 (end-of-line (and (looking-at "^#!") 2))
1395 (point)) t)
1396 (progn
1397 (skip-chars-forward " \t")
1398 (setq beg (point))
1399 (search-forward "-*-"
1400 (save-excursion (end-of-line) (point))
1401 t))
1402 (progn
1403 (forward-char -3)
1404 (skip-chars-backward " \t")
1405 (setq end (point))
1406 (goto-char beg)
1407 (if (save-excursion (search-forward ":" end t))
1408 ;; Find all specifications for the `mode:' variable
1409 ;; and execute them left to right.
1410 (while (let ((case-fold-search t))
1411 (or (and (looking-at "mode:")
1412 (goto-char (match-end 0)))
1413 (re-search-forward "[ \t;]mode:" end t)))
1414 (skip-chars-forward " \t")
1415 (setq beg (point))
1416 (if (search-forward ";" end t)
1417 (forward-char -1)
1418 (goto-char end))
1419 (skip-chars-backward " \t")
1420 (setq modes (cons (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1421 modes)))
1422 ;; Simple -*-MODE-*- case.
1423 (setq modes (cons (intern (concat (downcase (buffer-substring beg end))
1424 "-mode"))
1425 modes))))))
1426 ;; If we found modes to use, invoke them now,
1427 ;; outside the save-excursion.
1428 (when modes
1429 (unless just-from-file-name
1430 (mapcar 'funcall (nreverse modes)))
1431 (setq done t))
1432 ;; If we didn't find a mode from a -*- line, try using the file name.
1433 (if (and (not done) buffer-file-name)
1434 (let ((name buffer-file-name)
1435 (keep-going t))
1436 ;; Remove backup-suffixes from file name.
1437 (setq name (file-name-sans-versions name))
1438 (while keep-going
1439 (setq keep-going nil)
1440 (let ((alist auto-mode-alist)
1441 (mode nil))
1442 ;; Find first matching alist entry.
1443 (let ((case-fold-search
1444 (memq system-type '(vax-vms windows-nt))))
1445 (while (and (not mode) alist)
1446 (if (string-match (car (car alist)) name)
1447 (if (and (consp (cdr (car alist)))
1448 (nth 2 (car alist)))
1449 (progn
1450 (setq mode (car (cdr (car alist)))
1451 name (substring name 0 (match-beginning 0))
1452 keep-going t))
1453 (setq mode (cdr (car alist))
1454 keep-going nil)))
1455 (setq alist (cdr alist))))
1456 (if mode
1457 ;; When JUST-FROM-FILE-NAME is set,
1458 ;; we are working on behalf of set-visited-file-name.
1459 ;; In that case, if the major mode specified is the
1460 ;; same one we already have, don't actually reset it.
1461 ;; We don't want to lose minor modes such as Font Lock.
1462 (unless (and just-from-file-name (eq mode major-mode))
1463 (funcall mode))
1464 ;; If we can't deduce a mode from the file name,
1465 ;; look for an interpreter specified in the first line.
1466 ;; As a special case, allow for things like "#!/bin/env perl",
1467 ;; which finds the interpreter anywhere in $PATH.
1468 (let ((interpreter
1469 (save-excursion
1470 (goto-char (point-min))
1471 (if (looking-at "#![ \t]?\\([^ \t\n]*/bin/env[ \t]\\)?\\([^ \t\n]+\\)")
1472 (buffer-substring (match-beginning 2)
1473 (match-end 2))
1474 "")))
1475 elt)
1476 ;; Map interpreter name to a mode.
1477 (setq elt (assoc (file-name-nondirectory interpreter)
1478 interpreter-mode-alist))
1479 (unless just-from-file-name
1480 (if elt
1481 (funcall (cdr elt))))))))))))
1482
1483(defun hack-local-variables-prop-line ()
1484 ;; Set local variables specified in the -*- line.
1485 ;; Ignore any specification for `mode:' and `coding:';
1486 ;; set-auto-mode should already have handled `mode:',
1487 ;; set-auto-coding should already have handled `coding:'.
1488 (save-excursion
1489 (goto-char (point-min))
1490 (let ((result nil)
1491 (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))))
1492 ;; Parse the -*- line into the `result' alist.
1493 (cond ((not (search-forward "-*-" end t))
1494 ;; doesn't have one.
1495 nil)
1496 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1497 ;; Simple form: "-*- MODENAME -*-". Already handled.
1498 nil)
1499 (t
1500 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1501 ;; (last ";" is optional).
1502 (save-excursion
1503 (if (search-forward "-*-" end t)
1504 (setq end (- (point) 3))
1505 (error "-*- not terminated before end of line")))
1506 (while (< (point) end)
1507 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1508 (error "malformed -*- line"))
1509 (goto-char (match-end 0))
1510 ;; There used to be a downcase here,
1511 ;; but the manual didn't say so,
1512 ;; and people want to set var names that aren't all lc.
1513 (let ((key (intern (buffer-substring
1514 (match-beginning 1)
1515 (match-end 1))))
1516 (val (save-restriction
1517 (narrow-to-region (point) end)
1518 (read (current-buffer)))))
1519 ;; It is traditional to ignore
1520 ;; case when checking for `mode' in set-auto-mode,
1521 ;; so we must do that here as well.
1522 ;; That is inconsistent, but we're stuck with it.
1523 ;; The same can be said for `coding' in set-auto-coding.
1524 (or (equal (downcase (symbol-name key)) "mode")
1525 (equal (downcase (symbol-name key)) "coding")
1526 (setq result (cons (cons key val) result)))
1527 (skip-chars-forward " \t;")))
1528 (setq result (nreverse result))))
1529
1530 (if (and result
1531 (or (eq enable-local-variables t)
1532 (and enable-local-variables
1533 (save-window-excursion
1534 (condition-case nil
1535 (switch-to-buffer (current-buffer))
1536 (error
1537 ;; If we fail to switch in the selected window,
1538 ;; it is probably a minibuffer.
1539 ;; So try another window.
1540 (condition-case nil
1541 (switch-to-buffer-other-window (current-buffer))
1542 (error
1543 (switch-to-buffer-other-frame (current-buffer))))))
1544 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1545 (file-name-nondirectory buffer-file-name)))))))
1546 (let ((enable-local-eval enable-local-eval))
1547 (while result
1548 (hack-one-local-variable (car (car result)) (cdr (car result)))
1549 (setq result (cdr result))))))))
1550
1551(defvar hack-local-variables-hook nil
1552 "Normal hook run after processing a file's local variables specs.
1553Major modes can use this to examine user-specified local variables
1554in order to initialize other data structure based on them.")
1555
1556(defun hack-local-variables (&optional mode-only)
1557 "Parse and put into effect this buffer's local variables spec.
1558If MODE-ONLY is non-nil, all we do is check whether the major mode
1559is specified, returning t if it is specified."
1560 (unless mode-only
1561 (hack-local-variables-prop-line))
1562 ;; Look for "Local variables:" line in last page.
1563 (let (mode-specified)
1564 (save-excursion
1565 (goto-char (point-max))
1566 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1567 (if (let ((case-fold-search t))
1568 (and (search-forward "Local Variables:" nil t)
1569 (or (eq enable-local-variables t)
1570 mode-only
1571 (and enable-local-variables
1572 (save-window-excursion
1573 (switch-to-buffer (current-buffer))
1574 (save-excursion
1575 (beginning-of-line)
1576 (set-window-start (selected-window) (point)))
1577 (y-or-n-p (format "Set local variables as specified at end of %s? "
1578 (if buffer-file-name
1579 (file-name-nondirectory
1580 buffer-file-name)
1581 (concat "buffer "
1582 (buffer-name))))))))))
1583 (let ((continue t)
1584 prefix prefixlen suffix beg
1585 mode-specified
1586 (enable-local-eval enable-local-eval))
1587 ;; The prefix is what comes before "local variables:" in its line.
1588 ;; The suffix is what comes after "local variables:" in its line.
1589 (skip-chars-forward " \t")
1590 (or (eolp)
1591 (setq suffix (buffer-substring (point)
1592 (progn (end-of-line) (point)))))
1593 (goto-char (match-beginning 0))
1594 (or (bolp)
1595 (setq prefix
1596 (buffer-substring (point)
1597 (progn (beginning-of-line) (point)))))
1598
1599 (if prefix (setq prefixlen (length prefix)
1600 prefix (regexp-quote prefix)))
1601 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1602 (while continue
1603 ;; Look at next local variable spec.
1604 (if selective-display (re-search-forward "[\n\C-m]")
1605 (forward-line 1))
1606 ;; Skip the prefix, if any.
1607 (if prefix
1608 (if (looking-at prefix)
1609 (forward-char prefixlen)
1610 (error "Local variables entry is missing the prefix")))
1611 ;; Find the variable name; strip whitespace.
1612 (skip-chars-forward " \t")
1613 (setq beg (point))
1614 (skip-chars-forward "^:\n")
1615 (if (eolp) (error "Missing colon in local variables entry"))
1616 (skip-chars-backward " \t")
1617 (let* ((str (buffer-substring beg (point)))
1618 (var (read str))
1619 val)
1620 ;; Setting variable named "end" means end of list.
1621 (if (string-equal (downcase str) "end")
1622 (setq continue nil)
1623 ;; Otherwise read the variable value.
1624 (skip-chars-forward "^:")
1625 (forward-char 1)
1626 (setq val (read (current-buffer)))
1627 (skip-chars-backward "\n")
1628 (skip-chars-forward " \t")
1629 (or (if suffix (looking-at suffix) (eolp))
1630 (error "Local variables entry is terminated incorrectly"))
1631 (if mode-only
1632 (if (eq var 'mode)
1633 (setq mode-specified t))
1634 ;; Set the variable. "Variables" mode and eval are funny.
1635 (hack-one-local-variable var val))))))))
1636 (unless mode-only
1637 (run-hooks 'hack-local-variables-hook))
1638 mode-specified))
1639
1640(defvar ignored-local-variables
1641 '(enable-local-eval)
1642 "Variables to be ignored in a file's local variable spec.")
1643
1644;; Get confirmation before setting these variables as locals in a file.
1645(put 'debugger 'risky-local-variable t)
1646(put 'enable-local-eval 'risky-local-variable t)
1647(put 'ignored-local-variables 'risky-local-variable t)
1648(put 'eval 'risky-local-variable t)
1649(put 'file-name-handler-alist 'risky-local-variable t)
1650(put 'minor-mode-map-alist 'risky-local-variable t)
1651(put 'after-load-alist 'risky-local-variable t)
1652(put 'buffer-file-name 'risky-local-variable t)
1653(put 'buffer-auto-save-file-name 'risky-local-variable t)
1654(put 'buffer-file-truename 'risky-local-variable t)
1655(put 'exec-path 'risky-local-variable t)
1656(put 'load-path 'risky-local-variable t)
1657(put 'exec-directory 'risky-local-variable t)
1658(put 'process-environment 'risky-local-variable t)
1659(put 'dabbrev-case-fold-search 'risky-local-variable t)
1660(put 'dabbrev-case-replace 'risky-local-variable t)
1661;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1662(put 'outline-level 'risky-local-variable t)
1663(put 'rmail-output-file-alist 'risky-local-variable t)
1664
1665;; This one is safe because the user gets to check it before it is used.
1666(put 'compile-command 'safe-local-variable t)
1667
1668(defun hack-one-local-variable-quotep (exp)
1669 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1670
1671;; "Set" one variable in a local variables spec.
1672;; A few variable names are treated specially.
1673(defun hack-one-local-variable (var val)
1674 (cond ((eq var 'mode)
1675 (funcall (intern (concat (downcase (symbol-name val))
1676 "-mode"))))
1677 ((eq var 'coding)
1678 ;; We have already handled coding: tag in set-auto-coding.
1679 nil)
1680 ((memq var ignored-local-variables)
1681 nil)
1682 ;; "Setting" eval means either eval it or do nothing.
1683 ;; Likewise for setting hook variables.
1684 ((or (get var 'risky-local-variable)
1685 (and
1686 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$"
1687 (symbol-name var))
1688 (not (get var 'safe-local-variable))))
1689 ;; Permit evalling a put of a harmless property.
1690 ;; if the args do nothing tricky.
1691 (if (or (and (eq var 'eval)
1692 (consp val)
1693 (eq (car val) 'put)
1694 (hack-one-local-variable-quotep (nth 1 val))
1695 (hack-one-local-variable-quotep (nth 2 val))
1696 ;; Only allow safe values of lisp-indent-hook;
1697 ;; not functions.
1698 (or (numberp (nth 3 val))
1699 (equal (nth 3 val) ''defun))
1700 (memq (nth 1 (nth 2 val))
1701 '(lisp-indent-hook)))
1702 ;; Permit eval if not root and user says ok.
1703 (and (not (zerop (user-uid)))
1704 (or (eq enable-local-eval t)
1705 (and enable-local-eval
1706 (save-window-excursion
1707 (switch-to-buffer (current-buffer))
1708 (save-excursion
1709 (beginning-of-line)
1710 (set-window-start (selected-window) (point)))
1711 (setq enable-local-eval
1712 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1713 (file-name-nondirectory buffer-file-name)))))))))
1714 (if (eq var 'eval)
1715 (save-excursion (eval val))
1716 (make-local-variable var)
1717 (set var val))
1718 (message "Ignoring `eval:' in file's local variables")))
1719 ;; Ordinary variable, really set it.
1720 (t (make-local-variable var)
1721 (set var val))))
1722
1723\f
1724(defcustom change-major-mode-with-file-name t
1725 "*Non-nil means \\[write-file] should set the major mode from the file name.
1726However, the mode will not be changed if
1727\(1) a local variables list or the `-*-' line specifies a major mode, or
1728\(2) the current major mode is a \"special\" mode,
1729\ not suitable for ordinary files, or
1730\(3) the new file name does not particularly specify any mode."
1731 :type 'boolean
1732 :group 'editing-basics)
1733
1734(defun set-visited-file-name (filename &optional no-query along-with-file)
1735 "Change name of file visited in current buffer to FILENAME.
1736The next time the buffer is saved it will go in the newly specified file.
1737nil or empty string as argument means make buffer not be visiting any file.
1738Remember to delete the initial contents of the minibuffer
1739if you wish to pass an empty string as the argument.
1740
1741The optional second argument NO-QUERY, if non-nil, inhibits asking for
1742confirmation in the case where another buffer is already visiting FILENAME.
1743
1744The optional third argument ALONG-WITH-FILE, if non-nil, means that
1745the old visited file has been renamed to the new name FILENAME."
1746 (interactive "FSet visited file name: ")
1747 (if (buffer-base-buffer)
1748 (error "An indirect buffer cannot visit a file"))
1749 (let (truename)
1750 (if filename
1751 (setq filename
1752 (if (string-equal filename "")
1753 nil
1754 (expand-file-name filename))))
1755 (if filename
1756 (progn
1757 (setq truename (file-truename filename))
1758 (if find-file-visit-truename
1759 (setq filename truename))))
1760 (let ((buffer (and filename (find-buffer-visiting filename))))
1761 (and buffer (not (eq buffer (current-buffer)))
1762 (not no-query)
1763 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1764 filename)))
1765 (error "Aborted")))
1766 (or (equal filename buffer-file-name)
1767 (progn
1768 (and filename (lock-buffer filename))
1769 (unlock-buffer)))
1770 (setq buffer-file-name filename)
1771 (if filename ; make buffer name reflect filename.
1772 (let ((new-name (file-name-nondirectory buffer-file-name)))
1773 (if (string= new-name "")
1774 (error "Empty file name"))
1775 (if (eq system-type 'vax-vms)
1776 (setq new-name (downcase new-name)))
1777 (setq default-directory (file-name-directory buffer-file-name))
1778 (or (string= new-name (buffer-name))
1779 (rename-buffer new-name t))))
1780 (setq buffer-backed-up nil)
1781 (or along-with-file
1782 (clear-visited-file-modtime))
1783 ;; Abbreviate the file names of the buffer.
1784 (if truename
1785 (progn
1786 (setq buffer-file-truename (abbreviate-file-name truename))
1787 (if find-file-visit-truename
1788 (setq buffer-file-name buffer-file-truename))))
1789 (setq buffer-file-number
1790 (if filename
1791 (nthcdr 10 (file-attributes buffer-file-name))
1792 nil)))
1793 ;; write-file-hooks is normally used for things like ftp-find-file
1794 ;; that visit things that are not local files as if they were files.
1795 ;; Changing to visit an ordinary local file instead should flush the hook.
1796 (kill-local-variable 'write-file-hooks)
1797 (kill-local-variable 'local-write-file-hooks)
1798 (kill-local-variable 'revert-buffer-function)
1799 (kill-local-variable 'backup-inhibited)
1800 ;; If buffer was read-only because of version control,
1801 ;; that reason is gone now, so make it writable.
1802 (if vc-mode
1803 (setq buffer-read-only nil))
1804 (kill-local-variable 'vc-mode)
1805 ;; Turn off backup files for certain file names.
1806 ;; Since this is a permanent local, the major mode won't eliminate it.
1807 (and buffer-file-name
1808 (not (funcall backup-enable-predicate buffer-file-name))
1809 (progn
1810 (make-local-variable 'backup-inhibited)
1811 (setq backup-inhibited t)))
1812 (let ((oauto buffer-auto-save-file-name))
1813 ;; If auto-save was not already on, turn it on if appropriate.
1814 (if (not buffer-auto-save-file-name)
1815 (and buffer-file-name auto-save-default
1816 (auto-save-mode t))
1817 ;; If auto save is on, start using a new name.
1818 ;; We deliberately don't rename or delete the old auto save
1819 ;; for the old visited file name. This is because perhaps
1820 ;; the user wants to save the new state and then compare with the
1821 ;; previous state from the auto save file.
1822 (setq buffer-auto-save-file-name
1823 (make-auto-save-file-name)))
1824 ;; Rename the old auto save file if any.
1825 (and oauto buffer-auto-save-file-name
1826 (file-exists-p oauto)
1827 (rename-file oauto buffer-auto-save-file-name t)))
1828 (and buffer-file-name
1829 (not along-with-file)
1830 (set-buffer-modified-p t))
1831 ;; Update the major mode, if the file name determines it.
1832 (condition-case nil
1833 ;; Don't change the mode if it is special.
1834 (or (not change-major-mode-with-file-name)
1835 (get major-mode 'mode-class)
1836 ;; Don't change the mode if the local variable list specifies it.
1837 (hack-local-variables t)
1838 (set-auto-mode t))
1839 (error nil)))
1840
1841(defun write-file (filename &optional confirm)
1842 "Write current buffer into file FILENAME.
1843Makes buffer visit that file, and marks it not modified.
1844If the buffer is already visiting a file, you can specify
1845a directory name as FILENAME, to write a file of the same
1846old name in that directory.
1847
1848If optional second arg CONFIRM is non-nil,
1849ask for confirmation for overwriting an existing file.
1850Interactively, confirmation is required unless you supply a prefix argument."
1851;; (interactive "FWrite file: ")
1852 (interactive
1853 (list (if buffer-file-name
1854 (read-file-name "Write file: "
1855 nil nil nil nil)
1856 (read-file-name "Write file: "
1857 (cdr (assq 'default-directory
1858 (buffer-local-variables)))
1859 nil nil (file-name-nondirectory (buffer-name))))
1860 (not current-prefix-arg)))
1861 (or (null filename) (string-equal filename "")
1862 (progn
1863 ;; If arg is just a directory,
1864 ;; use same file name, but in that directory.
1865 (if (and (file-directory-p filename) buffer-file-name)
1866 (setq filename (concat (file-name-as-directory filename)
1867 (file-name-nondirectory buffer-file-name))))
1868 (and confirm
1869 (file-exists-p filename)
1870 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1871 (error "Canceled")))
1872 (set-visited-file-name filename (not confirm))))
1873 (set-buffer-modified-p t)
1874 ;; Make buffer writable if file is writable.
1875 (and buffer-file-name
1876 (file-writable-p buffer-file-name)
1877 (setq buffer-read-only nil))
1878 (save-buffer))
1879\f
1880(defun backup-buffer ()
1881 "Make a backup of the disk file visited by the current buffer, if appropriate.
1882This is normally done before saving the buffer the first time.
1883If the value is non-nil, it is the result of `file-modes' on the original
1884file; this means that the caller, after saving the buffer, should change
1885the modes of the new file to agree with the old modes.
1886
1887A backup may be done by renaming or by copying; see documentation of
1888variable `make-backup-files'. If it's done by renaming, then the file is
1889no longer accessible under its old name."
1890 (if (and make-backup-files (not backup-inhibited)
1891 (not buffer-backed-up)
1892 (file-exists-p buffer-file-name)
1893 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1894 '(?- ?l)))
1895 (let ((real-file-name buffer-file-name)
1896 backup-info backupname targets setmodes)
1897 ;; If specified name is a symbolic link, chase it to the target.
1898 ;; Thus we make the backups in the directory where the real file is.
1899 (setq real-file-name (file-chase-links real-file-name))
1900 (setq backup-info (find-backup-file-name real-file-name)
1901 backupname (car backup-info)
1902 targets (cdr backup-info))
1903;;; (if (file-directory-p buffer-file-name)
1904;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1905 (if backup-info
1906 (condition-case ()
1907 (let ((delete-old-versions
1908 ;; If have old versions to maybe delete,
1909 ;; ask the user to confirm now, before doing anything.
1910 ;; But don't actually delete til later.
1911 (and targets
1912 (or (eq delete-old-versions t) (eq delete-old-versions nil))
1913 (or delete-old-versions
1914 (y-or-n-p (format "Delete excess backup versions of %s? "
1915 real-file-name))))))
1916 ;; Actually write the back up file.
1917 (condition-case ()
1918 (if (or file-precious-flag
1919 ; (file-symlink-p buffer-file-name)
1920 backup-by-copying
1921 (and backup-by-copying-when-linked
1922 (> (file-nlinks real-file-name) 1))
1923 (and backup-by-copying-when-mismatch
1924 (let ((attr (file-attributes real-file-name)))
1925 (or (nth 9 attr)
1926 (not (file-ownership-preserved-p real-file-name))))))
1927 (condition-case ()
1928 (copy-file real-file-name backupname t t)
1929 (file-error
1930 ;; If copying fails because file BACKUPNAME
1931 ;; is not writable, delete that file and try again.
1932 (if (and (file-exists-p backupname)
1933 (not (file-writable-p backupname)))
1934 (delete-file backupname))
1935 (copy-file real-file-name backupname t t)))
1936 ;; rename-file should delete old backup.
1937 (rename-file real-file-name backupname t)
1938 (setq setmodes (file-modes backupname)))
1939 (file-error
1940 ;; If trouble writing the backup, write it in ~.
1941 (setq backupname (expand-file-name
1942 (convert-standard-filename
1943 "~/%backup%~")))
1944 (message "Cannot write backup file; backing up in %s"
1945 (file-name-nondirectory backupname))
1946 (sleep-for 1)
1947 (condition-case ()
1948 (copy-file real-file-name backupname t t)
1949 (file-error
1950 ;; If copying fails because file BACKUPNAME
1951 ;; is not writable, delete that file and try again.
1952 (if (and (file-exists-p backupname)
1953 (not (file-writable-p backupname)))
1954 (delete-file backupname))
1955 (copy-file real-file-name backupname t t)))))
1956 (setq buffer-backed-up t)
1957 ;; Now delete the old versions, if desired.
1958 (if delete-old-versions
1959 (while targets
1960 (condition-case ()
1961 (delete-file (car targets))
1962 (file-error nil))
1963 (setq targets (cdr targets))))
1964 setmodes)
1965 (file-error nil))))))
1966
1967(defun file-name-sans-versions (name &optional keep-backup-version)
1968 "Return FILENAME sans backup versions or strings.
1969This is a separate procedure so your site-init or startup file can
1970redefine it.
1971If the optional argument KEEP-BACKUP-VERSION is non-nil,
1972we do not remove backup version numbers, only true file version numbers."
1973 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
1974 (if handler
1975 (funcall handler 'file-name-sans-versions name keep-backup-version)
1976 (substring name 0
1977 (if (eq system-type 'vax-vms)
1978 ;; VMS version number is (a) semicolon, optional
1979 ;; sign, zero or more digits or (b) period, option
1980 ;; sign, zero or more digits, provided this is the
1981 ;; second period encountered outside of the
1982 ;; device/directory part of the file name.
1983 (or (string-match ";[-+]?[0-9]*\\'" name)
1984 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
1985 name)
1986 (match-beginning 1))
1987 (length name))
1988 (if keep-backup-version
1989 (length name)
1990 (or (string-match "\\.~[0-9.]+~\\'" name)
1991 (string-match "~\\'" name)
1992 (length name))))))))
1993
1994(defun file-ownership-preserved-p (file)
1995 "Returns t if deleting FILE and rewriting it would preserve the owner."
1996 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1997 (if handler
1998 (funcall handler 'file-ownership-preserved-p file)
1999 (let ((attributes (file-attributes file)))
2000 ;; Return t if the file doesn't exist, since it's true that no
2001 ;; information would be lost by an (attempted) delete and create.
2002 (or (null attributes)
2003 (= (nth 2 attributes) (user-uid)))))))
2004
2005(defun file-name-sans-extension (filename)
2006 "Return FILENAME sans final \"extension\".
2007The extension, in a file name, is the part that follows the last `.'."
2008 (save-match-data
2009 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2010 directory)
2011 (if (string-match "\\.[^.]*\\'" file)
2012 (if (setq directory (file-name-directory filename))
2013 (expand-file-name (substring file 0 (match-beginning 0))
2014 directory)
2015 (substring file 0 (match-beginning 0)))
2016 filename))))
2017
2018(defun file-name-extension (filename &optional period)
2019 "Return FILENAME's final \"extension\".
2020The extension, in a file name, is the part that follows the last `.'.
2021Return nil for extensionless file names such as `foo'.
2022Return the empty string for file names such as `foo.'.
2023
2024If PERIOD is non-nil, then the returned value includes the period
2025that delimits the extension, and if FILENAME has no extension,
2026the value is \"\"."
2027 (save-match-data
2028 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2029 (if (string-match "\\.[^.]*\\'" file)
2030 (substring file (+ (match-beginning 0) (if period 0 1)))
2031 (if period
2032 "")))))
2033
2034(defun make-backup-file-name (file)
2035 "Create the non-numeric backup file name for FILE.
2036This is a separate function so you can redefine it for customization."
2037 (if (and (eq system-type 'ms-dos)
2038 (not (msdos-long-file-names)))
2039 (let ((fn (file-name-nondirectory file)))
2040 (concat (file-name-directory file)
2041 (or
2042 (and (string-match "\\`[^.]+\\'" fn)
2043 (concat (match-string 0 fn) ".~"))
2044 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2045 (concat (match-string 0 fn) "~")))))
2046 (concat file "~")))
2047
2048(defun backup-file-name-p (file)
2049 "Return non-nil if FILE is a backup file name (numeric or not).
2050This is a separate function so you can redefine it for customization.
2051You may need to redefine `file-name-sans-versions' as well."
2052 (string-match "~\\'" file))
2053
2054(defvar backup-extract-version-start)
2055
2056;; This is used in various files.
2057;; The usage of bv-length is not very clean,
2058;; but I can't see a good alternative,
2059;; so as of now I am leaving it alone.
2060(defun backup-extract-version (fn)
2061 "Given the name of a numeric backup file, return the backup number.
2062Uses the free variable `backup-extract-version-start', whose value should be
2063the index in the name where the version number begins."
2064 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2065 (= (match-beginning 0) backup-extract-version-start))
2066 (string-to-int (substring fn backup-extract-version-start -1))
2067 0))
2068
2069;; I believe there is no need to alter this behavior for VMS;
2070;; since backup files are not made on VMS, it should not get called.
2071(defun find-backup-file-name (fn)
2072 "Find a file name for a backup file, and suggestions for deletions.
2073Value is a list whose car is the name for the backup file
2074 and whose cdr is a list of old versions to consider deleting now.
2075If the value is nil, don't make a backup."
2076 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2077 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2078 (if handler
2079 (funcall handler 'find-backup-file-name fn)
2080 (if (eq version-control 'never)
2081 (list (make-backup-file-name fn))
2082 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
2083 (backup-extract-version-start (length base-versions))
2084 possibilities
2085 (versions nil)
2086 (high-water-mark 0)
2087 (deserve-versions-p nil)
2088 (number-to-delete 0))
2089 (condition-case ()
2090 (setq possibilities (file-name-all-completions
2091 base-versions
2092 (file-name-directory fn))
2093 versions (sort (mapcar
2094 (function backup-extract-version)
2095 possibilities)
2096 '<)
2097 high-water-mark (apply 'max 0 versions)
2098 deserve-versions-p (or version-control
2099 (> high-water-mark 0))
2100 number-to-delete (- (length versions)
2101 kept-old-versions kept-new-versions -1))
2102 (file-error
2103 (setq possibilities nil)))
2104 (if (not deserve-versions-p)
2105 (list (make-backup-file-name fn))
2106 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
2107 (if (and (> number-to-delete 0)
2108 ;; Delete nothing if there is overflow
2109 ;; in the number of versions to keep.
2110 (>= (+ kept-new-versions kept-old-versions -1) 0))
2111 (mapcar (function (lambda (n)
2112 (concat fn ".~" (int-to-string n) "~")))
2113 (let ((v (nthcdr kept-old-versions versions)))
2114 (rplacd (nthcdr (1- number-to-delete) v) ())
2115 v))))))))))
2116
2117(defun file-nlinks (filename)
2118 "Return number of names file FILENAME has."
2119 (car (cdr (file-attributes filename))))
2120
2121(defun file-relative-name (filename &optional directory)
2122 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
2123This function returns a relative file name which is equivalent to FILENAME
2124when used with that default directory as the default.
2125If this is impossible (which can happen on MSDOS and Windows
2126when the file name and directory use different drive names)
2127then it returns FILENAME."
2128 (save-match-data
2129 (let ((fname (expand-file-name filename)))
2130 (setq directory (file-name-as-directory
2131 (expand-file-name (or directory default-directory))))
2132 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2133 ;; drive names, they can't be relative, so return the absolute name.
2134 (if (and (or (eq system-type 'ms-dos)
2135 (eq system-type 'windows-nt))
2136 (not (string-equal (substring fname 0 2)
2137 (substring directory 0 2))))
2138 filename
2139 (let ((ancestor ".")
2140 (fname-dir (file-name-as-directory fname)))
2141 (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2142 (not (string-match (concat "^" (regexp-quote directory)) fname)))
2143 (setq directory (file-name-directory (substring directory 0 -1))
2144 ancestor (if (equal ancestor ".")
2145 ".."
2146 (concat "../" ancestor))))
2147 ;; Now ancestor is empty, or .., or ../.., etc.
2148 (if (string-match (concat "^" (regexp-quote directory)) fname)
2149 ;; We matched within FNAME's directory part.
2150 ;; Add the rest of FNAME onto ANCESTOR.
2151 (let ((rest (substring fname (match-end 0))))
2152 (if (and (equal ancestor ".")
2153 (not (equal rest "")))
2154 ;; But don't bother with ANCESTOR if it would give us `./'.
2155 rest
2156 (concat (file-name-as-directory ancestor) rest)))
2157 ;; We matched FNAME's directory equivalent.
2158 ancestor))))))
2159\f
2160(defun save-buffer (&optional args)
2161 "Save current buffer in visited file if modified. Versions described below.
2162By default, makes the previous version into a backup file
2163 if previously requested or if this is the first save.
2164With 1 \\[universal-argument], marks this version
2165 to become a backup when the next save is done.
2166With 2 \\[universal-argument]'s,
2167 unconditionally makes the previous version into a backup file.
2168With 3 \\[universal-argument]'s, marks this version
2169 to become a backup when the next save is done,
2170 and unconditionally makes the previous version into a backup file.
2171
2172With argument of 0, never makes the previous version into a backup file.
2173
2174If a file's name is FOO, the names of its numbered backup versions are
2175 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2176Numeric backups (rather than FOO~) will be made if value of
2177 `version-control' is not the atom `never' and either there are already
2178 numeric versions of the file being backed up, or `version-control' is
2179 non-nil.
2180We don't want excessive versions piling up, so there are variables
2181 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2182 and `kept-new-versions', which tells how many newest versions to keep.
2183 Defaults are 2 old versions and 2 new.
2184`dired-kept-versions' controls dired's clean-directory (.) command.
2185If `delete-old-versions' is nil, system will query user
2186 before trimming versions. Otherwise it does it silently."
2187 (interactive "p")
2188 (let ((modp (buffer-modified-p))
2189 (large (> (buffer-size) 50000))
2190 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2191 (memq args '(16 64)))))
2192 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2193 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
2194 (basic-save-buffer)
2195 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2196
2197(defun delete-auto-save-file-if-necessary (&optional force)
2198 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2199Normally delete only if the file was written by this Emacs since
2200the last real save, but optional arg FORCE non-nil means delete anyway."
2201 (and buffer-auto-save-file-name delete-auto-save-files
2202 (not (string= buffer-file-name buffer-auto-save-file-name))
2203 (or force (recent-auto-save-p))
2204 (progn
2205 (condition-case ()
2206 (delete-file buffer-auto-save-file-name)
2207 (file-error nil))
2208 (set-buffer-auto-saved))))
2209
2210(defvar after-save-hook nil
2211 "Normal hook that is run after a buffer is saved to its file.")
2212
2213(defvar save-buffer-coding-system nil
2214 "If non-nil, use this coding system for saving the buffer.
2215More precisely, use this coding system in place of the
2216value of `buffer-file-coding-system', when saving the buffer.
2217Calling `write-region' for any purpose other than saving the buffer
2218will still use `buffer-file-coding-system'; this variable has no effect
2219in such cases.")
2220
2221(defun basic-save-buffer ()
2222 "Save the current buffer in its visited file, if it has been modified.
2223After saving the buffer, run `after-save-hook'."
2224 (interactive)
2225 (save-current-buffer
2226 ;; In an indirect buffer, save its base buffer instead.
2227 (if (buffer-base-buffer)
2228 (set-buffer (buffer-base-buffer)))
2229 (if (buffer-modified-p)
2230 (let ((recent-save (recent-auto-save-p))
2231 setmodes tempsetmodes)
2232 ;; On VMS, rename file and buffer to get rid of version number.
2233 (if (and (eq system-type 'vax-vms)
2234 (not (string= buffer-file-name
2235 (file-name-sans-versions buffer-file-name))))
2236 (let (buffer-new-name)
2237 ;; Strip VMS version number before save.
2238 (setq buffer-file-name
2239 (file-name-sans-versions buffer-file-name))
2240 ;; Construct a (unique) buffer name to correspond.
2241 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2242 (setq buffer-new-name (buffer-name buf))
2243 (kill-buffer buf))
2244 (rename-buffer buffer-new-name)))
2245 ;; If buffer has no file name, ask user for one.
2246 (or buffer-file-name
2247 (let ((filename
2248 (expand-file-name
2249 (read-file-name "File to save in: ") nil)))
2250 (and (file-exists-p filename)
2251 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2252 filename))
2253 (error "Canceled")))
2254 (set-visited-file-name filename)))
2255 (or (verify-visited-file-modtime (current-buffer))
2256 (not (file-exists-p buffer-file-name))
2257 (yes-or-no-p
2258 (format "%s has changed since visited or saved. Save anyway? "
2259 (file-name-nondirectory buffer-file-name)))
2260 (error "Save not confirmed"))
2261 (save-restriction
2262 (widen)
2263 (save-excursion
2264 (and (> (point-max) 1)
2265 (/= (char-after (1- (point-max))) ?\n)
2266 (not (and (eq selective-display t)
2267 (= (char-after (1- (point-max))) ?\r)))
2268 (or (eq require-final-newline t)
2269 (and require-final-newline
2270 (y-or-n-p
2271 (format "Buffer %s does not end in newline. Add one? "
2272 (buffer-name)))))
2273 (save-excursion
2274 (goto-char (point-max))
2275 (insert ?\n))))
2276 (or (run-hook-with-args-until-success 'write-contents-hooks)
2277 (run-hook-with-args-until-success 'local-write-file-hooks)
2278 (run-hook-with-args-until-success 'write-file-hooks)
2279 ;; If a hook returned t, file is already "written".
2280 ;; Otherwise, write it the usual way now.
2281 (setq setmodes (basic-save-buffer-1)))
2282 ;; Now we have saved the current buffer. Let's make sure
2283 ;; that buffer-file-coding-system is fixed to what
2284 ;; actually used for saving by binding it locally.
2285 (if save-buffer-coding-system
2286 (setq save-buffer-coding-system last-coding-system-used)
2287 (setq buffer-file-coding-system last-coding-system-used))
2288 (setq buffer-file-number
2289 (nthcdr 10 (file-attributes buffer-file-name)))
2290 (if setmodes
2291 (condition-case ()
2292 (set-file-modes buffer-file-name setmodes)
2293 (error nil))))
2294 ;; If the auto-save file was recent before this command,
2295 ;; delete it now.
2296 (delete-auto-save-file-if-necessary recent-save)
2297 ;; Support VC `implicit' locking.
2298 (vc-after-save)
2299 (run-hooks 'after-save-hook))
2300 (message "(No changes need to be saved)"))))
2301
2302;; This does the "real job" of writing a buffer into its visited file
2303;; and making a backup file. This is what is normally done
2304;; but inhibited if one of write-file-hooks returns non-nil.
2305;; It returns a value to store in setmodes.
2306(defun basic-save-buffer-1 ()
2307 (let ((buffer-file-coding-system
2308 (or save-buffer-coding-system
2309 buffer-file-coding-system))
2310 tempsetmodes setmodes)
2311 (if (not (file-writable-p buffer-file-name))
2312 (let ((dir (file-name-directory buffer-file-name)))
2313 (if (not (file-directory-p dir))
2314 (if (file-exists-p dir)
2315 (error "%s is not a directory" dir)
2316 (error "%s: no such directory" buffer-file-name))
2317 (if (not (file-exists-p buffer-file-name))
2318 (error "Directory %s write-protected" dir)
2319 (if (yes-or-no-p
2320 (format "File %s is write-protected; try to save anyway? "
2321 (file-name-nondirectory
2322 buffer-file-name)))
2323 (setq tempsetmodes t)
2324 (error "Attempt to save to a file which you aren't allowed to write"))))))
2325 (or buffer-backed-up
2326 (setq setmodes (backup-buffer)))
2327 (let ((dir (file-name-directory buffer-file-name)))
2328 (if (and file-precious-flag
2329 (file-writable-p dir))
2330 ;; If file is precious, write temp name, then rename it.
2331 ;; This requires write access to the containing dir,
2332 ;; which is why we don't try it if we don't have that access.
2333 (let ((realname buffer-file-name)
2334 tempname temp nogood i succeed
2335 (old-modtime (visited-file-modtime)))
2336 (setq i 0)
2337 (setq nogood t)
2338 ;; Find the temporary name to write under.
2339 (while nogood
2340 (setq tempname (format
2341 (if (and (eq system-type 'ms-dos)
2342 (not (msdos-long-file-names)))
2343 "%s#%d.tm#" ; MSDOS limits files to 8+3
2344 "%s#tmp#%d")
2345 dir i))
2346 (setq nogood (file-exists-p tempname))
2347 (setq i (1+ i)))
2348 (unwind-protect
2349 (progn (clear-visited-file-modtime)
2350 (write-region (point-min) (point-max)
2351 tempname nil realname
2352 buffer-file-truename)
2353 (setq succeed t))
2354 ;; If writing the temp file fails,
2355 ;; delete the temp file.
2356 (or succeed
2357 (progn
2358 (delete-file tempname)
2359 (set-visited-file-modtime old-modtime))))
2360 ;; Since we have created an entirely new file
2361 ;; and renamed it, make sure it gets the
2362 ;; right permission bits set.
2363 (setq setmodes (file-modes buffer-file-name))
2364 ;; We succeeded in writing the temp file,
2365 ;; so rename it.
2366 (rename-file tempname buffer-file-name t))
2367 ;; If file not writable, see if we can make it writable
2368 ;; temporarily while we write it.
2369 ;; But no need to do so if we have just backed it up
2370 ;; (setmodes is set) because that says we're superseding.
2371 (cond ((and tempsetmodes (not setmodes))
2372 ;; Change the mode back, after writing.
2373 (setq setmodes (file-modes buffer-file-name))
2374 (set-file-modes buffer-file-name 511)))
2375 (write-region (point-min) (point-max)
2376 buffer-file-name nil t buffer-file-truename)))
2377 setmodes))
2378
2379(defun save-some-buffers (&optional arg exiting)
2380 "Save some modified file-visiting buffers. Asks user about each one.
2381Optional argument (the prefix) non-nil means save all with no questions.
2382Optional second argument EXITING means ask about certain non-file buffers
2383 as well as about file buffers."
2384 (interactive "P")
2385 (save-window-excursion
2386 (let* ((queried nil)
2387 (files-done
2388 (map-y-or-n-p
2389 (function
2390 (lambda (buffer)
2391 (and (buffer-modified-p buffer)
2392 (not (buffer-base-buffer buffer))
2393 (or
2394 (buffer-file-name buffer)
2395 (and exiting
2396 (progn
2397 (set-buffer buffer)
2398 (and buffer-offer-save (> (buffer-size) 0)))))
2399 (if arg
2400 t
2401 (setq queried t)
2402 (if (buffer-file-name buffer)
2403 (format "Save file %s? "
2404 (buffer-file-name buffer))
2405 (format "Save buffer %s? "
2406 (buffer-name buffer)))))))
2407 (function
2408 (lambda (buffer)
2409 (set-buffer buffer)
2410 (save-buffer)))
2411 (buffer-list)
2412 '("buffer" "buffers" "save")
2413 (list (list ?\C-r (lambda (buf)
2414 (view-buffer buf
2415 (function
2416 (lambda (ignore)
2417 (exit-recursive-edit))))
2418 (recursive-edit)
2419 ;; Return nil to ask about BUF again.
2420 nil)
2421 "display the current buffer"))))
2422 (abbrevs-done
2423 (and save-abbrevs abbrevs-changed
2424 (progn
2425 (if (or arg
2426 (y-or-n-p (format "Save abbrevs in %s? "
2427 abbrev-file-name)))
2428 (write-abbrev-file nil))
2429 ;; Don't keep bothering user if he says no.
2430 (setq abbrevs-changed nil)
2431 t))))
2432 (or queried (> files-done 0) abbrevs-done
2433 (message "(No files need saving)")))))
2434\f
2435(defun not-modified (&optional arg)
2436 "Mark current buffer as unmodified, not needing to be saved.
2437With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2438
2439It is not a good idea to use this function in Lisp programs, because it
2440prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2441 (interactive "P")
2442 (message (if arg "Modification-flag set"
2443 "Modification-flag cleared"))
2444 (set-buffer-modified-p arg))
2445
2446(defun toggle-read-only (&optional arg)
2447 "Change whether this buffer is visiting its file read-only.
2448With arg, set read-only iff arg is positive.
2449If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2450 (interactive "P")
2451 (cond
2452 ((and arg (if (> (prefix-numeric-value arg) 0) buffer-read-only
2453 (not buffer-read-only))) ; If buffer-read-only is set correctly,
2454 nil) ; do nothing.
2455 ;; Toggle.
2456 ((and buffer-read-only view-mode)
2457 (View-exit-and-edit)
2458 (make-local-variable 'view-read-only)
2459 (setq view-read-only t)) ; Must leave view mode.
2460 ((and (not buffer-read-only) view-read-only
2461 (not (eq (get major-mode 'mode-class) 'special)))
2462 (view-mode-enter))
2463 (t (setq buffer-read-only (not buffer-read-only))
2464 (force-mode-line-update))))
2465
2466(defun insert-file (filename)
2467 "Insert contents of file FILENAME into buffer after point.
2468Set mark after the inserted text.
2469
2470This function is meant for the user to run interactively.
2471Don't call it from programs! Use `insert-file-contents' instead.
2472\(Its calling sequence is different; see its documentation)."
2473 (interactive "*fInsert file: ")
2474 (if (file-directory-p filename)
2475 (signal 'file-error (list "Opening input file" "file is a directory"
2476 filename)))
2477 (let ((tem (insert-file-contents filename)))
2478 (push-mark (+ (point) (car (cdr tem))))))
2479
2480(defun append-to-file (start end filename)
2481 "Append the contents of the region to the end of file FILENAME.
2482When called from a function, expects three arguments,
2483START, END and FILENAME. START and END are buffer positions
2484saying what text to write."
2485 (interactive "r\nFAppend to file: ")
2486 (write-region start end filename t))
2487
2488(defun file-newest-backup (filename)
2489 "Return most recent backup file for FILENAME or nil if no backups exist."
2490 (let* ((filename (expand-file-name filename))
2491 (file (file-name-nondirectory filename))
2492 (dir (file-name-directory filename))
2493 (comp (file-name-all-completions file dir))
2494 (newest nil)
2495 tem)
2496 (while comp
2497 (setq tem (car comp)
2498 comp (cdr comp))
2499 (cond ((and (backup-file-name-p tem)
2500 (string= (file-name-sans-versions tem) file))
2501 (setq tem (concat dir tem))
2502 (if (or (null newest)
2503 (file-newer-than-file-p tem newest))
2504 (setq newest tem)))))
2505 newest))
2506
2507(defun rename-uniquely ()
2508 "Rename current buffer to a similar name not already taken.
2509This function is useful for creating multiple shell process buffers
2510or multiple mail buffers, etc."
2511 (interactive)
2512 (save-match-data
2513 (let ((base-name (buffer-name)))
2514 (and (string-match "<[0-9]+>\\'" base-name)
2515 (not (and buffer-file-name
2516 (string= base-name
2517 (file-name-nondirectory buffer-file-name))))
2518 ;; If the existing buffer name has a <NNN>,
2519 ;; which isn't part of the file name (if any),
2520 ;; then get rid of that.
2521 (setq base-name (substring base-name 0 (match-beginning 0))))
2522 (rename-buffer (generate-new-buffer-name base-name))
2523 (force-mode-line-update))))
2524
2525(defun make-directory (dir &optional parents)
2526 "Create the directory DIR and any nonexistent parent dirs.
2527Interactively, the default choice of directory to create
2528is the current default directory for file names.
2529That is useful when you have visited a file in a nonexistent directory.
2530
2531Noninteractively, the second (optional) argument PARENTS says whether
2532to create parent directories if they don't exist."
2533 (interactive
2534 (list (read-file-name "Make directory: " default-directory default-directory
2535 nil nil)
2536 t))
2537 (let ((handler (find-file-name-handler dir 'make-directory)))
2538 (if handler
2539 (funcall handler 'make-directory dir parents)
2540 (if (not parents)
2541 (make-directory-internal dir)
2542 (let ((dir (directory-file-name (expand-file-name dir)))
2543 create-list)
2544 (while (not (file-exists-p dir))
2545 (setq create-list (cons dir create-list)
2546 dir (directory-file-name (file-name-directory dir))))
2547 (while create-list
2548 (make-directory-internal (car create-list))
2549 (setq create-list (cdr create-list))))))))
2550\f
2551(put 'revert-buffer-function 'permanent-local t)
2552(defvar revert-buffer-function nil
2553 "Function to use to revert this buffer, or nil to do the default.
2554The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2555which are the arguments that `revert-buffer' received.")
2556
2557(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2558(defvar revert-buffer-insert-file-contents-function nil
2559 "Function to use to insert contents when reverting this buffer.
2560Gets two args, first the nominal file name to use,
2561and second, t if reading the auto-save file.")
2562
2563(defvar before-revert-hook nil
2564 "Normal hook for `revert-buffer' to run before reverting.
2565If `revert-buffer-function' is used to override the normal revert
2566mechanism, this hook is not used.")
2567
2568(defvar after-revert-hook nil
2569 "Normal hook for `revert-buffer' to run after reverting.
2570Note that the hook value that it runs is the value that was in effect
2571before reverting; that makes a difference if you have buffer-local
2572hook functions.
2573
2574If `revert-buffer-function' is used to override the normal revert
2575mechanism, this hook is not used.")
2576
2577(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
2578 "Replace current buffer text with the text of the visited file on disk.
2579This undoes all changes since the file was visited or saved.
2580With a prefix argument, offer to revert from latest auto-save file, if
2581that is more recent than the visited file.
2582
2583This command also works for special buffers that contain text which
2584doesn't come from a file, but reflects some other data base instead:
2585for example, Dired buffers and buffer-list buffers. In these cases,
2586it reconstructs the buffer contents from the appropriate data base.
2587
2588When called from Lisp, the first argument is IGNORE-AUTO; only offer
2589to revert from the auto-save file when this is nil. Note that the
2590sense of this argument is the reverse of the prefix argument, for the
2591sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2592to nil.
2593
2594Optional second argument NOCONFIRM means don't ask for confirmation at
2595all.
2596
2597Optional third argument PRESERVE-MODES non-nil means don't alter
2598the files modes. Normally we reinitialize them using `normal-mode'.
2599
2600If the value of `revert-buffer-function' is non-nil, it is called to
2601do all the work for this command. Otherwise, the hooks
2602`before-revert-hook' and `after-revert-hook' are run at the beginning
2603and the end, and if `revert-buffer-insert-file-contents-function' is
2604non-nil, it is called instead of rereading visited file contents."
2605
2606 ;; I admit it's odd to reverse the sense of the prefix argument, but
2607 ;; there is a lot of code out there which assumes that the first
2608 ;; argument should be t to avoid consulting the auto-save file, and
2609 ;; there's no straightforward way to encourage authors to notice a
2610 ;; reversal of the argument sense. So I'm just changing the user
2611 ;; interface, but leaving the programmatic interface the same.
2612 (interactive (list (not current-prefix-arg)))
2613 (if revert-buffer-function
2614 (funcall revert-buffer-function ignore-auto noconfirm)
2615 (let* ((opoint (point))
2616 (auto-save-p (and (not ignore-auto)
2617 (recent-auto-save-p)
2618 buffer-auto-save-file-name
2619 (file-readable-p buffer-auto-save-file-name)
2620 (y-or-n-p
2621 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
2622 (file-name (if auto-save-p
2623 buffer-auto-save-file-name
2624 buffer-file-name)))
2625 (cond ((null file-name)
2626 (error "Buffer does not seem to be associated with any file"))
2627 ((or noconfirm
2628 (and (not (buffer-modified-p))
2629 (let ((tail revert-without-query)
2630 (found nil))
2631 (while tail
2632 (if (string-match (car tail) file-name)
2633 (setq found t))
2634 (setq tail (cdr tail)))
2635 found))
2636 (yes-or-no-p (format "Revert buffer from file %s? "
2637 file-name)))
2638 (run-hooks 'before-revert-hook)
2639 ;; If file was backed up but has changed since,
2640 ;; we shd make another backup.
2641 (and (not auto-save-p)
2642 (not (verify-visited-file-modtime (current-buffer)))
2643 (setq buffer-backed-up nil))
2644 ;; Get rid of all undo records for this buffer.
2645 (or (eq buffer-undo-list t)
2646 (setq buffer-undo-list nil))
2647 ;; Effectively copy the after-revert-hook status,
2648 ;; since after-find-file will clobber it.
2649 (let ((global-hook (default-value 'after-revert-hook))
2650 (local-hook-p (local-variable-p 'after-revert-hook))
2651 (local-hook (and (local-variable-p 'after-revert-hook)
2652 after-revert-hook)))
2653 (let (buffer-read-only
2654 ;; Don't make undo records for the reversion.
2655 (buffer-undo-list t))
2656 (if revert-buffer-insert-file-contents-function
2657 (funcall revert-buffer-insert-file-contents-function
2658 file-name auto-save-p)
2659 (if (not (file-exists-p file-name))
2660 (error "File %s no longer exists!" file-name))
2661 ;; Bind buffer-file-name to nil
2662 ;; so that we don't try to lock the file.
2663 (let ((buffer-file-name nil))
2664 (or auto-save-p
2665 (unlock-buffer)))
2666 (widen)
2667 (let ((coding-system-for-read
2668 ;; Auto-saved file shoule be read without
2669 ;; any code conversion.
2670 (if auto-save-p 'no-conversion
2671 coding-system-for-read)))
2672 (insert-file-contents file-name (not auto-save-p)
2673 nil nil t))))
2674 (goto-char (min opoint (point-max)))
2675 ;; Recompute the truename in case changes in symlinks
2676 ;; have changed the truename.
2677 (setq buffer-file-truename
2678 (abbreviate-file-name (file-truename buffer-file-name)))
2679 (after-find-file nil nil t t preserve-modes)
2680 ;; Run after-revert-hook as it was before we reverted.
2681 (setq-default revert-buffer-internal-hook global-hook)
2682 (if local-hook-p
2683 (progn
2684 (make-local-variable 'revert-buffer-internal-hook)
2685 (setq revert-buffer-internal-hook local-hook))
2686 (kill-local-variable 'revert-buffer-internal-hook))
2687 (run-hooks 'revert-buffer-internal-hook))
2688 t)))))
2689
2690(defun recover-file (file)
2691 "Visit file FILE, but get contents from its last auto-save file."
2692 ;; Actually putting the file name in the minibuffer should be used
2693 ;; only rarely.
2694 ;; Not just because users often use the default.
2695 (interactive "FRecover file: ")
2696 (setq file (expand-file-name file))
2697 (if (auto-save-file-name-p (file-name-nondirectory file))
2698 (error "%s is an auto-save file" file))
2699 (let ((file-name (let ((buffer-file-name file))
2700 (make-auto-save-file-name))))
2701 (cond ((if (file-exists-p file)
2702 (not (file-newer-than-file-p file-name file))
2703 (not (file-exists-p file-name)))
2704 (error "Auto-save file %s not current" file-name))
2705 ((save-window-excursion
2706 (if (not (memq system-type '(vax-vms windows-nt)))
2707 (with-output-to-temp-buffer "*Directory*"
2708 (buffer-disable-undo standard-output)
2709 (call-process "ls" nil standard-output nil
2710 (if (file-symlink-p file) "-lL" "-l")
2711 file file-name)))
2712 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2713 (switch-to-buffer (find-file-noselect file t))
2714 (let ((buffer-read-only nil)
2715 ;; Auto-saved file shoule be read without any code conversion.
2716 (coding-system-for-read 'no-conversion))
2717 (erase-buffer)
2718 (insert-file-contents file-name nil))
2719 (after-find-file nil nil t))
2720 (t (error "Recover-file cancelled")))))
2721
2722(defun recover-session ()
2723 "Recover auto save files from a previous Emacs session.
2724This command first displays a Dired buffer showing you the
2725previous sessions that you could recover from.
2726To choose one, move point to the proper line and then type C-c C-c.
2727Then you'll be asked about a number of files to recover."
2728 (interactive)
2729 (if (null auto-save-list-file-prefix)
2730 (error "You set `auto-save-list-file-prefix' to disable making session files"))
2731 (let ((ls-lisp-support-shell-wildcards t))
2732 (dired (concat auto-save-list-file-prefix "*")
2733 (concat dired-listing-switches "t")))
2734 (goto-char (point-min))
2735 (or (looking-at "Move to the session you want to recover,")
2736 (let ((inhibit-read-only t))
2737 (insert "Move to the session you want to recover,\n"
2738 "then type C-c C-c to select it.\n\n"
2739 "You can also delete some of these files;\n"
2740 "type d on a line to mark that file for deletion.\n\n")))
2741 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
2742 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
2743
2744(defun recover-session-finish ()
2745 "Choose one saved session to recover auto-save files from.
2746This command is used in the special Dired buffer created by
2747\\[recover-session]."
2748 (interactive)
2749 ;; Get the name of the session file to recover from.
2750 (let ((file (dired-get-filename))
2751 files
2752 (buffer (get-buffer-create " *recover*")))
2753 (dired-unmark 1)
2754 (dired-do-flagged-delete t)
2755 (unwind-protect
2756 (save-excursion
2757 ;; Read in the auto-save-list file.
2758 (set-buffer buffer)
2759 (erase-buffer)
2760 (insert-file-contents file)
2761 ;; Loop thru the text of that file
2762 ;; and get out the names of the files to recover.
2763 (while (not (eobp))
2764 (let (thisfile autofile)
2765 (if (eolp)
2766 ;; This is a pair of lines for a non-file-visiting buffer.
2767 ;; Get the auto-save file name and manufacture
2768 ;; a "visited file name" from that.
2769 (progn
2770 (forward-line 1)
2771 (setq autofile
2772 (buffer-substring-no-properties
2773 (point)
2774 (save-excursion
2775 (end-of-line)
2776 (point))))
2777 (setq thisfile
2778 (expand-file-name
2779 (substring
2780 (file-name-nondirectory autofile)
2781 1 -1)
2782 (file-name-directory autofile)))
2783 (forward-line 1))
2784 ;; This pair of lines is a file-visiting
2785 ;; buffer. Use the visited file name.
2786 (progn
2787 (setq thisfile
2788 (buffer-substring-no-properties
2789 (point) (progn (end-of-line) (point))))
2790 (forward-line 1)
2791 (setq autofile
2792 (buffer-substring-no-properties
2793 (point) (progn (end-of-line) (point))))
2794 (forward-line 1)))
2795 ;; Ignore a file if its auto-save file does not exist now.
2796 (if (file-exists-p autofile)
2797 (setq files (cons thisfile files)))))
2798 (setq files (nreverse files))
2799 ;; The file contains a pair of line for each auto-saved buffer.
2800 ;; The first line of the pair contains the visited file name
2801 ;; or is empty if the buffer was not visiting a file.
2802 ;; The second line is the auto-save file name.
2803 (if files
2804 (map-y-or-n-p "Recover %s? "
2805 (lambda (file)
2806 (condition-case nil
2807 (save-excursion (recover-file file))
2808 (error
2809 "Failed to recover `%s'" file)))
2810 files
2811 '("file" "files" "recover"))
2812 (message "No files can be recovered from this session now")))
2813 (kill-buffer buffer))))
2814
2815(defun kill-some-buffers (&optional list)
2816 "For each buffer in LIST, ask whether to kill it.
2817LIST defaults to all existing live buffers."
2818 (interactive)
2819 (if (null list)
2820 (setq list (buffer-list)))
2821 (while list
2822 (let* ((buffer (car list))
2823 (name (buffer-name buffer)))
2824 (and (not (string-equal name ""))
2825 (/= (aref name 0) ? )
2826 (yes-or-no-p
2827 (format "Buffer %s %s. Kill? "
2828 name
2829 (if (buffer-modified-p buffer)
2830 "HAS BEEN EDITED" "is unmodified")))
2831 (kill-buffer buffer)))
2832 (setq list (cdr list))))
2833\f
2834(defun auto-save-mode (arg)
2835 "Toggle auto-saving of contents of current buffer.
2836With prefix argument ARG, turn auto-saving on if positive, else off."
2837 (interactive "P")
2838 (setq buffer-auto-save-file-name
2839 (and (if (null arg)
2840 (or (not buffer-auto-save-file-name)
2841 ;; If autosave is off because buffer has shrunk,
2842 ;; then toggling should turn it on.
2843 (< buffer-saved-size 0))
2844 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2845 (if (and buffer-file-name auto-save-visited-file-name
2846 (not buffer-read-only))
2847 buffer-file-name
2848 (make-auto-save-file-name))))
2849 ;; If -1 was stored here, to temporarily turn off saving,
2850 ;; turn it back on.
2851 (and (< buffer-saved-size 0)
2852 (setq buffer-saved-size 0))
2853 (if (interactive-p)
2854 (message "Auto-save %s (in this buffer)"
2855 (if buffer-auto-save-file-name "on" "off")))
2856 buffer-auto-save-file-name)
2857
2858(defun rename-auto-save-file ()
2859 "Adjust current buffer's auto save file name for current conditions.
2860Also rename any existing auto save file, if it was made in this session."
2861 (let ((osave buffer-auto-save-file-name))
2862 (setq buffer-auto-save-file-name
2863 (make-auto-save-file-name))
2864 (if (and osave buffer-auto-save-file-name
2865 (not (string= buffer-auto-save-file-name buffer-file-name))
2866 (not (string= buffer-auto-save-file-name osave))
2867 (file-exists-p osave)
2868 (recent-auto-save-p))
2869 (rename-file osave buffer-auto-save-file-name t))))
2870
2871(defun make-auto-save-file-name ()
2872 "Return file name to use for auto-saves of current buffer.
2873Does not consider `auto-save-visited-file-name' as that variable is checked
2874before calling this function. You can redefine this for customization.
2875See also `auto-save-file-name-p'."
2876 (if buffer-file-name
2877 (if (and (eq system-type 'ms-dos)
2878 (not (msdos-long-file-names)))
2879 (let ((fn (file-name-nondirectory buffer-file-name)))
2880 (string-match "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" fn)
2881 (concat (file-name-directory buffer-file-name)
2882 "#" (match-string 1 fn)
2883 "." (match-string 3 fn) "#"))
2884 (concat (file-name-directory buffer-file-name)
2885 "#"
2886 (file-name-nondirectory buffer-file-name)
2887 "#"))
2888
2889 ;; Deal with buffers that don't have any associated files. (Mail
2890 ;; mode tends to create a good number of these.)
2891
2892 (let ((buffer-name (buffer-name))
2893 (limit 0))
2894 ;; Eliminate all slashes and backslashes by
2895 ;; replacing them with sequences that start with %.
2896 ;; Quote % also, to keep distinct names distinct.
2897 (while (string-match "[/\\%]" buffer-name limit)
2898 (let* ((character (aref buffer-name (match-beginning 0)))
2899 (replacement
2900 (cond ((eq character ?%) "%%")
2901 ((eq character ?/) "%+")
2902 ((eq character ?\\) "%-"))))
2903 (setq buffer-name (replace-match replacement t t buffer-name))
2904 (setq limit (1+ (match-end 0)))))
2905 ;; Generate the file name.
2906 (expand-file-name
2907 (format "#%s#%s#" buffer-name (make-temp-name ""))
2908 ;; Try a few alternative directories, to get one we can write it.
2909 (cond
2910 ((file-writable-p default-directory) default-directory)
2911 ((file-writable-p "/var/tmp/") "/var/tmp/")
2912 ("~/"))))))
2913
2914(defun auto-save-file-name-p (filename)
2915 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2916FILENAME should lack slashes. You can redefine this for customization."
2917 (string-match "^#.*#$" filename))
2918\f
2919(defun wildcard-to-regexp (wildcard)
2920 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2921The generated regexp will match a filename iff the filename
2922matches that wildcard according to shell rules. Only wildcards known
2923by `sh' are supported."
2924 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
2925 ;; Copy the initial run of non-special characters.
2926 (result (substring wildcard 0 i))
2927 (len (length wildcard)))
2928 ;; If no special characters, we're almost done.
2929 (if i
2930 (while (< i len)
2931 (let ((ch (aref wildcard i))
2932 j)
2933 (setq
2934 result
2935 (concat result
2936 (cond
2937 ((and (eq ch ?\[)
2938 (< (1+ i) len)
2939 (eq (aref wildcard (1+ i)) ?\]))
2940 "\\[")
2941 ((eq ch ?\[) ; [...] maps to regexp char class
2942 (progn
2943 (setq i (1+ i))
2944 (concat
2945 (cond
2946 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
2947 (progn
2948 (setq i (1+ i))
2949 (if (eq (aref wildcard i) ?\])
2950 (progn
2951 (setq i (1+ i))
2952 "[^]")
2953 "[^")))
2954 ((eq (aref wildcard i) ?^)
2955 ;; Found "[^". Insert a `\0' character
2956 ;; (which cannot happen in a filename)
2957 ;; into the character class, so that `^'
2958 ;; is not the first character after `[',
2959 ;; and thus non-special in a regexp.
2960 (progn
2961 (setq i (1+ i))
2962 "[\000^"))
2963 ((eq (aref wildcard i) ?\])
2964 ;; I don't think `]' can appear in a
2965 ;; character class in a wildcard, but
2966 ;; let's be general here.
2967 (progn
2968 (setq i (1+ i))
2969 "[]"))
2970 (t "["))
2971 (prog1 ; copy everything upto next `]'.
2972 (substring wildcard
2973 i
2974 (setq j (string-match
2975 "]" wildcard i)))
2976 (setq i (if j (1- j) (1- len)))))))
2977 ((eq ch ?.) "\\.")
2978 ((eq ch ?*) "[^\000]*")
2979 ((eq ch ?+) "\\+")
2980 ((eq ch ?^) "\\^")
2981 ((eq ch ?$) "\\$")
2982 ((eq ch ?\\) "\\\\") ; probably cannot happen...
2983 ((eq ch ??) "[^\000]")
2984 (t (char-to-string ch)))))
2985 (setq i (1+ i)))))
2986 ;; Shell wildcards should match the entire filename,
2987 ;; not its part. Make the regexp say so.
2988 (concat "\\`" result "\\'")))
2989\f
2990(defcustom list-directory-brief-switches
2991 (if (eq system-type 'vax-vms) "" "-CF")
2992 "*Switches for list-directory to pass to `ls' for brief listing,"
2993 :type 'string
2994 :group 'dired)
2995
2996(defcustom list-directory-verbose-switches
2997 (if (eq system-type 'vax-vms)
2998 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2999 "-l")
3000 "*Switches for list-directory to pass to `ls' for verbose listing,"
3001 :type 'string
3002 :group 'dired)
3003
3004(defun list-directory (dirname &optional verbose)
3005 "Display a list of files in or matching DIRNAME, a la `ls'.
3006DIRNAME is globbed by the shell if necessary.
3007Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3008Actions controlled by variables `list-directory-brief-switches'
3009and `list-directory-verbose-switches'."
3010 (interactive (let ((pfx current-prefix-arg))
3011 (list (read-file-name (if pfx "List directory (verbose): "
3012 "List directory (brief): ")
3013 nil default-directory nil)
3014 pfx)))
3015 (let ((switches (if verbose list-directory-verbose-switches
3016 list-directory-brief-switches)))
3017 (or dirname (setq dirname default-directory))
3018 (setq dirname (expand-file-name dirname))
3019 (with-output-to-temp-buffer "*Directory*"
3020 (buffer-disable-undo standard-output)
3021 (princ "Directory ")
3022 (princ dirname)
3023 (terpri)
3024 (save-excursion
3025 (set-buffer "*Directory*")
3026 (setq default-directory
3027 (if (file-directory-p dirname)
3028 (file-name-as-directory dirname)
3029 (file-name-directory dirname)))
3030 (let ((wildcard (not (file-directory-p dirname))))
3031 (insert-directory dirname switches wildcard (not wildcard)))))))
3032
3033(defvar insert-directory-program "ls"
3034 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3035
3036;; insert-directory
3037;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3038;; FULL-DIRECTORY-P is nil.
3039;; The single line of output must display FILE's name as it was
3040;; given, namely, an absolute path name.
3041;; - must insert exactly one line for each file if WILDCARD or
3042;; FULL-DIRECTORY-P is t, plus one optional "total" line
3043;; before the file lines, plus optional text after the file lines.
3044;; Lines are delimited by "\n", so filenames containing "\n" are not
3045;; allowed.
3046;; File lines should display the basename.
3047;; - must be consistent with
3048;; - functions dired-move-to-filename, (these two define what a file line is)
3049;; dired-move-to-end-of-filename,
3050;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3051;; dired-insert-headerline
3052;; dired-after-subdir-garbage (defines what a "total" line is)
3053;; - variable dired-subdir-regexp
3054(defun insert-directory (file switches &optional wildcard full-directory-p)
3055 "Insert directory listing for FILE, formatted according to SWITCHES.
3056Leaves point after the inserted text.
3057SWITCHES may be a string of options, or a list of strings.
3058Optional third arg WILDCARD means treat FILE as shell wildcard.
3059Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3060switches do not contain `d', so that a full listing is expected.
3061
3062This works by running a directory listing program
3063whose name is in the variable `insert-directory-program'.
3064If WILDCARD, it also runs the shell specified by `shell-file-name'."
3065 ;; We need the directory in order to find the right handler.
3066 (let ((handler (find-file-name-handler (expand-file-name file)
3067 'insert-directory)))
3068 (if handler
3069 (funcall handler 'insert-directory file switches
3070 wildcard full-directory-p)
3071 (if (eq system-type 'vax-vms)
3072 (vms-read-directory file switches (current-buffer))
3073 (let* ((coding-system-for-read
3074 (and enable-multibyte-characters
3075 (or file-name-coding-system
3076 default-file-name-coding-system)))
3077 ;; This is to control encoding the arguments in call-process.
3078 (coding-system-for-write coding-system-for-read)
3079 (result
3080 (if wildcard
3081 ;; Run ls in the directory of the file pattern we asked for.
3082 (let ((default-directory
3083 (if (file-name-absolute-p file)
3084 (file-name-directory file)
3085 (file-name-directory (expand-file-name file))))
3086 (pattern (file-name-nondirectory file))
3087 (beg 0))
3088 ;; Quote some characters that have special meanings in shells;
3089 ;; but don't quote the wildcards--we want them to be special.
3090 ;; We also currently don't quote the quoting characters
3091 ;; in case people want to use them explicitly to quote
3092 ;; wildcard characters.
3093 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3094 (setq pattern
3095 (concat (substring pattern 0 (match-beginning 0))
3096 "\\"
3097 (substring pattern (match-beginning 0)))
3098 beg (1+ (match-end 0))))
3099 (call-process shell-file-name nil t nil
3100 "-c" (concat "\\";; Disregard shell aliases!
3101 insert-directory-program
3102 " -d "
3103 (if (stringp switches)
3104 switches
3105 (mapconcat 'identity switches " "))
3106 " -- "
3107 pattern)))
3108 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3109 ;; directory if FILE is a symbolic link.
3110 (apply 'call-process
3111 insert-directory-program nil t nil
3112 (let (list)
3113 (if (listp switches)
3114 (setq list switches)
3115 (if (not (equal switches ""))
3116 (progn
3117 ;; Split the switches at any spaces
3118 ;; so we can pass separate options as separate args.
3119 (while (string-match " " switches)
3120 (setq list (cons (substring switches 0 (match-beginning 0))
3121 list)
3122 switches (substring switches (match-end 0))))
3123 (setq list (nreverse (cons switches list))))))
3124 (append list
3125 ;; Avoid lossage if FILE starts with `-'.
3126 '("--")
3127 (progn
3128 (if (string-match "\\`~" file)
3129 (setq file (expand-file-name file)))
3130 (list
3131 (if full-directory-p
3132 (concat (file-name-as-directory file) ".")
3133 file)))))))))
3134 (if (/= result 0)
3135 ;; We get here if ls failed.
3136 ;; Access the file to get a suitable error.
3137 (access-file file "Reading directory")))))))
3138
3139(defvar kill-emacs-query-functions nil
3140 "Functions to call with no arguments to query about killing Emacs.
3141If any of these functions returns nil, killing Emacs is cancelled.
3142`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3143but `kill-emacs', the low level primitive, does not.
3144See also `kill-emacs-hook'.")
3145
3146(defun save-buffers-kill-emacs (&optional arg)
3147 "Offer to save each buffer, then kill this Emacs process.
3148With prefix arg, silently save all file-visiting buffers, then kill."
3149 (interactive "P")
3150 (save-some-buffers arg t)
3151 (and (or (not (memq t (mapcar (function
3152 (lambda (buf) (and (buffer-file-name buf)
3153 (buffer-modified-p buf))))
3154 (buffer-list))))
3155 (yes-or-no-p "Modified buffers exist; exit anyway? "))
3156 (or (not (fboundp 'process-list))
3157 ;; process-list is not defined on VMS.
3158 (let ((processes (process-list))
3159 active)
3160 (while processes
3161 (and (memq (process-status (car processes)) '(run stop open))
3162 (let ((val (process-kill-without-query (car processes))))
3163 (process-kill-without-query (car processes) val)
3164 val)
3165 (setq active t))
3166 (setq processes (cdr processes)))
3167 (or (not active)
3168 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
3169 ;; Query the user for other things, perhaps.
3170 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
3171 (kill-emacs)))
3172\f
3173;; We use /: as a prefix to "quote" a file name
3174;; so that magic file name handlers will not apply to it.
3175
3176(setq file-name-handler-alist
3177 (cons '("\\`/:" . file-name-non-special)
3178 file-name-handler-alist))
3179
3180;; We depend on being the last handler on the list,
3181;; so that anything else which does need handling
3182;; has been handled already.
3183;; So it is safe for us to inhibit *all* magic file name handlers.
3184
3185(defun file-name-non-special (operation &rest arguments)
3186 (let ((file-name-handler-alist nil)
3187 (default-directory
3188 (if (eq operation 'insert-directory)
3189 (directory-file-name
3190 (expand-file-name
3191 (unhandled-file-name-directory default-directory)))
3192 default-directory))
3193 ;; Get a list of the indices of the args which are file names.
3194 (file-arg-indices
3195 (cdr (or (assq operation
3196 ;; The first four are special because they
3197 ;; return a file name. We want to include the /:
3198 ;; in the return value.
3199 ;; So just avoid stripping it in the first place.
3200 '((expand-file-name . nil)
3201 ;; `identity' means just return the first arg
3202 ;; as stripped of its quoting.
3203 (substitute-in-file-name . identity)
3204 (file-name-directory . nil)
3205 (file-name-as-directory . nil)
3206 (directory-file-name . nil)
3207 (file-name-completion 0 1)
3208 (file-name-all-completions 0 1)
3209 (rename-file 0 1)
3210 (copy-file 0 1)
3211 (make-symbolic-link 0 1)
3212 (add-name-to-file 0 1)))
3213 ;; For all other operations, treat the first argument only
3214 ;; as the file name.
3215 '(nil 0))))
3216 ;; Copy ARGUMENTS so we can replace elements in it.
3217 (arguments (copy-sequence arguments)))
3218 ;; Strip off the /: from the file names that have this handler.
3219 (save-match-data
3220 (while (consp file-arg-indices)
3221 (let ((pair (nthcdr (car file-arg-indices) arguments)))
3222 (and (car pair)
3223 (string-match "\\`/:" (car pair))
3224 (setcar pair
3225 (if (= (length (car pair)) 2)
3226 "/"
3227 (substring (car pair) 2)))))
3228 (setq file-arg-indices (cdr file-arg-indices))))
3229 (if (eq file-arg-indices 'identity)
3230 (car arguments)
3231 (apply operation arguments))))
3232\f
3233(define-key ctl-x-map "\C-f" 'find-file)
3234(define-key ctl-x-map "\C-r" 'find-file-read-only)
3235(define-key ctl-x-map "\C-v" 'find-alternate-file)
3236(define-key ctl-x-map "\C-s" 'save-buffer)
3237(define-key ctl-x-map "s" 'save-some-buffers)
3238(define-key ctl-x-map "\C-w" 'write-file)
3239(define-key ctl-x-map "i" 'insert-file)
3240(define-key esc-map "~" 'not-modified)
3241(define-key ctl-x-map "\C-d" 'list-directory)
3242(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
3243
3244(define-key ctl-x-4-map "f" 'find-file-other-window)
3245(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
3246(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
3247(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
3248(define-key ctl-x-4-map "\C-o" 'display-buffer)
3249
3250(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
3251(define-key ctl-x-5-map "f" 'find-file-other-frame)
3252(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
3253(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
3254
3255;;; files.el ends here