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