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